Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/main/java/net/tfminecraft/tfmccore/TFMCCore.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
import java.util.Random;

import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerCommandPreprocessEvent;
import org.bukkit.event.player.PlayerQuitEvent;
import org.bukkit.plugin.java.JavaPlugin;

Expand Down Expand Up @@ -49,6 +51,7 @@
import net.tfminecraft.tfmccore.stones.StoneListener;
import net.tfminecraft.tfmccore.tfmc.BukkitTfmcActions;
import net.tfminecraft.tfmccore.tfmc.TfmcCommand;
import net.tfminecraft.tfmccore.tfmc.TfmcCreditsRoster;
import net.tfminecraft.tfmccore.tfmc.TfmcConfig;
import net.tfminecraft.tfmccore.tfmc.TfmcCooldowns;
import net.tfminecraft.tfmccore.whistle.WhistleConfigLoader;
Expand Down Expand Up @@ -174,14 +177,25 @@ private void registerTfmcCommand() {
cooldowns.save();
}
TfmcCommand tfmc = tfmcCommand = new TfmcCommand(tfmcConfig, cooldowns, new BukkitTfmcActions(this),
Clock.systemDefaultZone(), new Random(), task -> getServer().getScheduler().runTask(this, task));
Clock.systemDefaultZone(), new Random(), task -> getServer().getScheduler().runTask(this, task),
new TfmcCreditsRoster(new File(getDataFolder(), "credits-roster.yml")));
getLifecycleManager().registerEventHandler(LifecycleEvents.COMMANDS,
event -> event.registrar().register(tfmc.build(), "TFMC player commands"));
getServer().getPluginManager().registerEvents(new Listener() {
@EventHandler
public void onQuit(PlayerQuitEvent event) {
tfmc.onQuit(event.getPlayer());
}

// /tfmc credits is kept out of the command tree so nobody is shown it; answer it here
// HIGH so other plugins' command gates (login, jail and the like) refuse it first
@EventHandler(priority = EventPriority.HIGH, ignoreCancelled = true)
public void onCredits(PlayerCommandPreprocessEvent event) {
if (TfmcCommand.isCredits(event.getMessage())) {
event.setCancelled(true);
tfmc.credits(event.getPlayer());
}
}
}, this);
}

Expand Down
62 changes: 62 additions & 0 deletions src/main/java/net/tfminecraft/tfmccore/tfmc/BukkitTfmcActions.java
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
package net.tfminecraft.tfmccore.tfmc;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
Expand All @@ -25,6 +31,8 @@
import net.luckperms.api.context.DefaultContextKeys;
import net.luckperms.api.context.ImmutableContextSet;
import net.luckperms.api.model.user.User;
import net.luckperms.api.model.user.UserManager;
import net.luckperms.api.node.Node;
import net.luckperms.api.node.NodeType;
import net.luckperms.api.node.types.InheritanceNode;
import net.luckperms.api.track.Track;
Expand Down Expand Up @@ -163,6 +171,60 @@ public CompletableFuture<TrackStep> stepTrack(Player player, String trackName, b
});
}

@Override
public CompletableFuture<Map<String, List<String>>> trackMembers(List<String> trackNames) {
LuckPerms api = luckPerms.get();
if (api == null) {
return CompletableFuture.failedFuture(new IllegalStateException("LuckPerms is not available"));
}
UserManager users = api.getUserManager();
// Searches storage, so offline players count too; one search per group on each track
Map<String, List<CompletableFuture<Map<UUID, Collection<Node>>>>> searches = new LinkedHashMap<>();
for (String name : trackNames) {
Track track = api.getTrackManager().getTrack(name);
List<CompletableFuture<Map<UUID, Collection<Node>>>> groups = new ArrayList<>();
if (track == null) {
LOGGER.warning("No LuckPerms track " + name + " for /tfmc credits");
} else {
for (String group : track.getGroups()) {
groups.add(users.searchAll(api.getNodeMatcherFactory().key("group." + group)));
}
}
searches.put(name, groups);
}
CompletableFuture<?>[] all = searches.values().stream().flatMap(List::stream).toArray(CompletableFuture[]::new);
return CompletableFuture.allOf(all).thenCompose(done -> {
Map<String, Set<UUID>> members = new LinkedHashMap<>();
Map<UUID, CompletableFuture<String>> names = new LinkedHashMap<>();
searches.forEach((track, groups) -> {
Set<UUID> ids = new LinkedHashSet<>();
for (CompletableFuture<Map<UUID, Collection<Node>>> group : groups) {
group.join().forEach((id, nodes) -> {
// Only the stored global group: the same rule track steps follow
if (nodes.stream().anyMatch(node -> node.getValue() && !node.hasExpired() && node.getContexts().isEmpty())) {
ids.add(id);
}
});
}
members.put(track, ids);
ids.forEach(id -> names.computeIfAbsent(id, unknown -> name(users, unknown)));
});
return CompletableFuture.allOf(names.values().toArray(CompletableFuture[]::new)).thenApply(named -> {
Map<String, List<String>> out = new LinkedHashMap<>();
members.forEach((track, ids) -> out.put(track, ids.stream()
.map(id -> names.get(id).join()).filter(Objects::nonNull).toList()));
return out;
});
});
}

/** The name as last seen on this server (with its capitals), else LuckPerms' stored one. */
private static CompletableFuture<String> name(UserManager users, UUID id) {
String seen = Bukkit.getOfflinePlayer(id).getName();
return seen != null ? CompletableFuture.completedFuture(seen)
: users.lookupUsername(id).exceptionally(error -> null);
}

@Override
public FlightState startFlight(Player player, float speed) {
FlightState previous = new FlightState(player.getAllowFlight(), player.isFlying(), player.getFlySpeed());
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/net/tfminecraft/tfmccore/tfmc/TfmcActions.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package net.tfminecraft.tfmccore.tfmc;

import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

Expand Down Expand Up @@ -51,6 +52,12 @@ public static TrackStep unchanged() {
/** Moves the player one step along a LuckPerms track they are already on. */
CompletableFuture<TrackStep> stepTrack(Player player, String track, boolean promote);

/**
* For each track, the names of every player (online or not) holding one of its groups
* globally, on duty or not. Groups held only in a server context do not count.
*/
CompletableFuture<Map<String, List<String>>> trackMembers(List<String> tracks);

/** Lets the player fly at {@code speed} and returns their previous flight settings. */
FlightState startFlight(Player player, float speed);

Expand Down
121 changes: 121 additions & 0 deletions src/main/java/net/tfminecraft/tfmccore/tfmc/TfmcCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,25 @@
import java.time.Clock;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.logging.Logger;
import java.util.random.RandomGenerator;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import org.bukkit.Bukkit;
import org.bukkit.Material;
Expand All @@ -33,6 +38,7 @@

import io.papermc.paper.command.brigadier.CommandSourceStack;
import io.papermc.paper.command.brigadier.Commands;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.minimessage.MiniMessage;
import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
Expand Down Expand Up @@ -62,10 +68,20 @@ private record ParrotFlight(TfmcActions.FlightState previous, Runnable cancelExp
private final RandomGenerator random;
private final Executor mainThread;
private final Map<UUID, ParrotFlight> parrots = new ConcurrentHashMap<>();
private final TfmcCreditsRoster creditRoster;
private volatile CompletableFuture<Map<String, List<String>>> creditMembers;
private volatile long creditMembersAt;

/** {@code mainThread} runs LuckPerms completions, which arrive on LuckPerms worker threads. */
public TfmcCommand(TfmcConfig config, TfmcCooldowns cooldowns, TfmcActions actions, Clock clock,
RandomGenerator random, Executor mainThread) {
this(config, cooldowns, actions, clock, random, mainThread, new TfmcCreditsRoster(null));
}

/** {@code creditRoster} remembers everyone /tfmc credits has listed. */
public TfmcCommand(TfmcConfig config, TfmcCooldowns cooldowns, TfmcActions actions, Clock clock,
RandomGenerator random, Executor mainThread, TfmcCreditsRoster creditRoster) {
this.creditRoster = creditRoster;
this.mainThread = mainThread;
this.config = config;
this.cooldowns = cooldowns;
Expand Down Expand Up @@ -395,6 +411,111 @@ private void poster(Player player, String name) {
() -> player.sendMessage(MINI.deserialize("<red>There is no poster called <name>.", Placeholder.unparsed("name", name))));
}

/** One block of /tfmc credits: its key, title and the LuckPerms tracks whose members it lists. */
record CreditSection(String key, String title, List<String> tracks) {}

private static final Pattern CREDITS = Pattern.compile("/(?:tfmccore:)?tfmc\\s+credits\\s*", Pattern.CASE_INSENSITIVE);

/**
* Whether a typed command is /tfmc credits. That subcommand is deliberately not in the command
* tree, so the client never suggests or completes it; TFMCCore answers it before Brigadier does.
*/
public static boolean isCredits(String message) {
return message != null && CREDITS.matcher(message.trim()).matches();
}

/** The sections in tfmc.yml credits.sections, highest first; staff then helpers when none are set. */
List<CreditSection> creditSections() {
List<CreditSection> sections = new ArrayList<>();
for (String key : config.keys("credits.sections")) {
String base = "credits.sections." + key;
sections.add(new CreditSection(key, config.string(base + ".title", key), config.lines(base + ".tracks")));
}
if (sections.isEmpty()) {
sections.add(new CreditSection("staff", "<#f1c40f><b>Staff</b>", List.of("staff")));
sections.add(new CreditSection("helpers", "<#ff00cc><b>Helpers</b>", List.of("helper+", "helper")));
}
return sections;
}

/**
* Shows the credits: everyone on each section's tracks and everyone the roster remembers (so
* those who step down stay listed), each player once in their highest section; then the extra
* lines. Members are looked up at most every credits.cache-seconds, since each lookup searches
* LuckPerms storage.
*/
public void credits(Player player) {
List<CreditSection> sections = creditSections();
List<String> tracks = sections.stream().flatMap(section -> section.tracks().stream()).distinct().toList();
long now = clock.millis();
CompletableFuture<Map<String, List<String>>> members = creditMembers;
// A live tfmc.yml without the credits section still caches (300 s), and a lookup still running is shared.
long cacheSeconds = (long) config.decimal("credits.cache-seconds", 300);
if (members == null || members.isCompletedExceptionally()
|| (members.isDone() && now - creditMembersAt >= cacheSeconds * 1000L)) {
// A lookup that hangs for a minute fails, so everyone waiting gets the remembered names instead.
members = creditMembers = actions.trackMembers(tracks).orTimeout(60, TimeUnit.SECONDS);
creditMembersAt = now;
}
members.whenCompleteAsync((found, error) -> {
if (error != null) {
LOGGER.warning("Failed to look up the credits: " + error.getMessage());
}
showCredits(player, sections, error == null ? found : Map.of());
}, mainThread);
}

private void showCredits(Player player, List<CreditSection> sections, Map<String, List<String>> members) {
Map<String, Integer> ranks = new HashMap<>();
for (int i = 0; i < sections.size(); i++) {
ranks.putIfAbsent(sections.get(i).key(), i);
}
// Remember who is on the tracks now; the roster keeps their highest section and best spelling
boolean changed = false;
for (CreditSection section : sections) {
for (String track : section.tracks()) {
for (String name : members.getOrDefault(track, List.of())) {
changed |= creditRoster.record(name, section.key(), ranks);
}
}
}
if (changed) {
creditRoster.save();
}
Set<String> excluded = new HashSet<>();
config.lines("credits.exclude").forEach(name -> excluded.add(name.toLowerCase(Locale.ROOT)));
Map<String, TfmcCreditsRoster.Entry> roster = creditRoster.players();

send(player, "credits.header");
String nameFormat = config.string("credits.name", "<gray><name>");
String separator = config.string("credits.separator", "<dark_gray>, ");
for (int i = 0; i < sections.size(); i++) {
CreditSection section = sections.get(i);
// The roster is in the order people joined; the top section keeps that, the rest are alphabetical
List<String> names = roster.entrySet().stream()
.filter(entry -> entry.getValue().section().equals(section.key()) && !excluded.contains(entry.getKey()))
.map(entry -> entry.getValue().name())
.collect(Collectors.toCollection(ArrayList::new));
if (names.isEmpty()) {
continue;
}
if (i > 0) {
names.sort(String.CASE_INSENSITIVE_ORDER);
}
Component line = Component.empty();
for (int n = 0; n < names.size(); n++) {
if (n > 0) {
line = line.append(MINI.deserialize(separator));
}
line = line.append(MINI.deserialize(nameFormat, Placeholder.unparsed("name", names.get(n))));
}
player.sendMessage(MINI.deserialize(section.title()));
player.sendMessage(line);
}
send(player, "credits.extra");
send(player, "credits.footer");
}

private void update(Player player, CompletableFuture<Void> change, String successPath) {
change.whenCompleteAsync((done, error) -> {
if (error != null) {
Expand Down
Loading