com.plotsquared.core.uuid.UUIDPipeline Maven / Gradle / Ivy
Show all versions of plotsquared-core Show documentation
/*
* PlotSquared, a land and world management plugin for Minecraft.
* Copyright (C) IntellectualSites
* Copyright (C) IntellectualSites team and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see
* Each request is then passed through a secondary list of
* consumers, that can then be used to cache them, etc
*/
public class UUIDPipeline {
private static final Logger LOGGER = LogManager.getLogger("PlotSquared/" + UUIDPipeline.class.getSimpleName());
private static final MiniMessage MINI_MESSAGE = MiniMessage.builder().build();
private final Executor executor;
private final List serviceList;
private final List>> consumerList;
/**
* Construct a new UUID pipeline
*
* @param executor Executor that is used to run asynchronous tasks inside
* of the pipeline
*/
public UUIDPipeline(final @NonNull Executor executor) {
this.executor = executor;
this.serviceList = Lists.newLinkedList();
this.consumerList = Lists.newLinkedList();
}
/**
* Register a UUID service
*
* @param uuidService UUID service to register
*/
public void registerService(final @NonNull UUIDService uuidService) {
this.serviceList.add(uuidService);
}
/**
* Register a mapping consumer
*
* @param mappingConsumer Consumer to register
*/
public void registerConsumer(final @NonNull Consumer<@NonNull List<@NonNull UUIDMapping>> mappingConsumer) {
this.consumerList.add(mappingConsumer);
}
/**
* Get a copy of the service list
*
* @return Copy of service list
*/
public @NonNull List<@NonNull UUIDService> getServiceListInstance() {
return Collections.unmodifiableList(this.serviceList);
}
/**
* Let all consumers act on the given mapping.
*
* @param mappings Mappings
*/
public void consume(final @NonNull List<@NonNull UUIDMapping> mappings) {
final Runnable runnable = () -> {
for (final Consumer> consumer : this.consumerList) {
consumer.accept(mappings);
}
};
if (PlotSquared.get().isMainThread(Thread.currentThread())) {
TaskManager.runTaskAsync(runnable);
} else {
runnable.run();
}
}
/**
* Consume a single mapping
*
* @param mapping Mapping to consume
*/
public void consume(final @NonNull UUIDMapping mapping) {
this.consume(Collections.singletonList(mapping));
}
/**
* This will store the given username-UUID pair directly, and overwrite
* any existing caches. This can be used to update usernames automatically
* whenever a player joins the server, to make sure an up-to-date UUID
* mapping is stored
*
* @param username Player username
* @param uuid Player uuid
*/
public void storeImmediately(final @NonNull String username, final @NonNull UUID uuid) {
this.consume(new UUIDMapping(uuid, username));
}
/**
* Get a single UUID from a username. This is blocking.
*
* @param username Username
* @param timeout Timeout in milliseconds
* @return The mapped uuid. Will return null if the request timed out.
*/
public @Nullable UUID getSingle(final @NonNull String username, final long timeout) {
ThreadUtils.catchSync("Blocking UUID retrieval from the main thread");
try {
final List mappings = this.getUUIDs(Collections.singletonList(username)).get(
timeout,
TimeUnit.MILLISECONDS
);
if (mappings.size() == 1) {
return mappings.get(0).uuid();
}
} catch (InterruptedException | ExecutionException e) {
e.printStackTrace();
} catch (TimeoutException ignored) {
// This is completely valid, we just don't care anymore
if (Settings.DEBUG) {
LOGGER.warn("(UUID) Request for {} timed out. Rate limit.", username);
}
}
return null;
}
/**
* Get a single username from a UUID. This is blocking.
*
* @param uuid UUID
* @param timeout Timeout in milliseconds
* @return The mapped username. Will return null if the request timeout.
*/
public @Nullable String getSingle(final @NonNull UUID uuid, final long timeout) {
ThreadUtils.catchSync("Blocking username retrieval from the main thread");
try {
final List mappings = this.getNames(Collections.singletonList(uuid)).get(timeout, TimeUnit.MILLISECONDS);
if (mappings.size() == 1) {
return mappings.get(0).username();
}
} catch (InterruptedException | ExecutionException e) {
e.printStackTrace();
} catch (TimeoutException ignored) {
// This is completely valid, we just don't care anymore
if (Settings.DEBUG) {
LOGGER.warn("(UUID) Request for {} timed out. Rate limit.", uuid);
}
}
return null;
}
/**
* Get a single UUID from a username. This is non-blocking.
*
* @param username Username
* @param uuid UUID consumer
*/
public void getSingle(final @NonNull String username, final @NonNull BiConsumer<@Nullable UUID, @Nullable Throwable> uuid) {
this.getUUIDs(Collections.singletonList(username))
.orTimeout(Settings.UUID.NON_BLOCKING_TIMEOUT, TimeUnit.MILLISECONDS)
.whenComplete((uuids, throwable) -> {
if (throwable != null) {
uuid.accept(null, throwable);
} else {
if (!uuids.isEmpty()) {
uuid.accept(uuids.get(0).uuid(), null);
} else {
uuid.accept(null, null);
}
}
});
}
/**
* Get a single username from a UUID. This is non-blocking.
*
* @param uuid UUID
* @param username Username consumer
*/
public void getSingle(final @NonNull UUID uuid, final @NonNull BiConsumer<@Nullable String, @Nullable Throwable> username) {
this.getNames(Collections.singletonList(uuid))
.orTimeout(Settings.UUID.NON_BLOCKING_TIMEOUT, TimeUnit.MILLISECONDS)
.whenComplete((uuids, throwable) -> {
if (throwable != null) {
username.accept(null, throwable);
} else {
if (!uuids.isEmpty()) {
username.accept(uuids.get(0).username(), null);
} else {
username.accept(null, null);
}
}
});
}
/**
* Asynchronously attempt to fetch the mapping from a list of UUIDs.
*
* This will timeout after the specified time and throws a {@link TimeoutException}
* if this happens
*
* @param requests UUIDs
* @param timeout Timeout in milliseconds
* @return Mappings
*/
public @NonNull CompletableFuture<@NonNull List<@NonNull UUIDMapping>> getNames(
final @NonNull Collection<@NonNull UUID> requests,
final long timeout
) {
return this.getNames(requests).orTimeout(timeout, TimeUnit.MILLISECONDS);
}
/**
* Asynchronously attempt to fetch the mapping from a list of names.
*
* This will timeout after the specified time and throws a {@link TimeoutException}
* if this happens
*
* @param requests Names
* @param timeout Timeout in milliseconds
* @return Mappings
*/
public @NonNull CompletableFuture> getUUIDs(
final @NonNull Collection requests,
final long timeout
) {
return this.getUUIDs(requests).orTimeout(timeout, TimeUnit.MILLISECONDS);
}
/**
* Asynchronously attempt to fetch the mapping from a list of UUIDs
*
* @param requests UUIDs
* @return Mappings
*/
public @NonNull CompletableFuture<@NonNull List<@NonNull UUIDMapping>> getNames(
final @NonNull Collection<@NonNull UUID> requests
) {
if (requests.isEmpty()) {
return CompletableFuture.completedFuture(Collections.emptyList());
}
final List serviceList = this.getServiceListInstance();
final List mappings = new ArrayList<>(requests.size());
final List remainingRequests = new ArrayList<>(requests);
for (final UUIDService service : serviceList) {
// We can chain multiple synchronous
// ones in a row
if (service.canBeSynchronous()) {
final List completedRequests = service.getNames(remainingRequests);
for (final UUIDMapping mapping : completedRequests) {
remainingRequests.remove(mapping.uuid());
}
mappings.addAll(completedRequests);
} else {
break;
}
if (remainingRequests.isEmpty()) {
return CompletableFuture.completedFuture(mappings);
}
}
return CompletableFuture.supplyAsync(() -> {
for (final UUIDService service : serviceList) {
final List completedRequests = service.getNames(remainingRequests);
for (final UUIDMapping mapping : completedRequests) {
remainingRequests.remove(mapping.uuid());
}
mappings.addAll(completedRequests);
if (remainingRequests.isEmpty()) {
break;
}
}
if (mappings.size() == requests.size()) {
this.consume(mappings);
return mappings;
} else if (Settings.DEBUG) {
LOGGER.info("(UUID) Failed to find all usernames");
}
if (Settings.UUID.UNKNOWN_AS_DEFAULT) {
for (final UUID uuid : remainingRequests) {
mappings.add(new UUIDMapping(
uuid,
MINI_MESSAGE.escapeTags(TranslatableCaption
.of("info.unknown")
.getComponent(ConsolePlayer.getConsole()))
));
}
return mappings;
} else {
throw new ServiceError("End of pipeline");
}
}, this.executor);
}
/**
* Asynchronously attempt to fetch the mapping from a list of names
*
* @param requests Names
* @return Mappings
*/
public @NonNull CompletableFuture<@NonNull List<@NonNull UUIDMapping>> getUUIDs(
final @NonNull Collection<@NonNull String> requests
) {
if (requests.isEmpty()) {
return CompletableFuture.completedFuture(Collections.emptyList());
}
final List serviceList = this.getServiceListInstance();
final List mappings = new ArrayList<>(requests.size());
final List remainingRequests = new ArrayList<>(requests);
for (final UUIDService service : serviceList) {
// We can chain multiple synchronous
// ones in a row
if (service.canBeSynchronous()) {
final List completedRequests = service.getUUIDs(remainingRequests);
for (final UUIDMapping mapping : completedRequests) {
remainingRequests.remove(mapping.username());
}
mappings.addAll(completedRequests);
} else {
break;
}
if (remainingRequests.isEmpty()) {
return CompletableFuture.completedFuture(mappings);
}
}
return CompletableFuture.supplyAsync(() -> {
for (final UUIDService service : serviceList) {
final List completedRequests = service.getUUIDs(remainingRequests);
for (final UUIDMapping mapping : completedRequests) {
remainingRequests.remove(mapping.username());
}
mappings.addAll(completedRequests);
if (remainingRequests.isEmpty()) {
break;
}
}
if (mappings.size() == requests.size()) {
this.consume(mappings);
return mappings;
} else if (Settings.DEBUG) {
LOGGER.info("(UUID) Failed to find all UUIDs");
}
throw new ServiceError("End of pipeline");
}, this.executor);
}
/**
* Get as many UUID mappings as possible under the condition
* that the operation cannot be blocking (for an extended amount of time)
*
* @return All mappings that could be provided immediately
*/
public @NonNull
final Collection<@NonNull UUIDMapping> getAllImmediately() {
final Set mappings = new LinkedHashSet<>();
for (final UUIDService service : this.getServiceListInstance()) {
mappings.addAll(service.getImmediately());
}
return mappings;
}
/**
* Get a single UUID mapping immediately, if possible
*
* @param object Username ({@link String}) or {@link UUID}
* @return Mapping, if it could be found immediately
*/
public @Nullable
final UUIDMapping getImmediately(final @NonNull Object object) {
for (final UUIDService uuidService : this.getServiceListInstance()) {
final UUIDMapping mapping = uuidService.getImmediately(object);
if (mapping != null) {
return mapping;
}
}
return null;
}
}