Compare commits

..
Author SHA1 Message Date
Ben d845237f1f feat(docs): export registered Bukkit command reference automatically 2026-11-09 17:25:04 -06:00
BenCodez e75ce256ec refactor(tests): improve VoteStreaksMenuTest structure and readability
- Enhanced readability by organizing imports and formatting code.
- Refactored test methods for better clarity and consistency.
- Ensured proper mocking and assertions in inventory-related tests.
2026-11-08 19:59:16 -06:00
Ben d1d5891b7f Merge pull request #1741 from BenCodez/vp-work/point-addition-publication-phase2-20261101
Preserve point placeholder fences across callback and legacy arithmetic
2026-11-08 12:43:26 -06:00
Ben 548c974b69 Merge pull request #1699 from BenCodez/codex/date-vote-milestones
Add owner-configured DateVoteMilestones with durable occurrence accounting
2026-11-08 12:24:14 -06:00
Ben 293a01f352 Merge current master into DateVoteMilestones 2026-11-08 00:15:40 -06:00
Ben 2abd12466e Merge pull request #1749 from BenCodez/fix/voteparty-shared-mysql-cache-1748
fix(voteparty): wait for published shared MySQL cache before rewards
2026-11-06 17:17:56 -06:00
Ben 01ac6fa8f0 test(voteparty): verify voter-list reset is not deferred 2026-11-06 17:13:19 -06:00
Ben 9b850812f7 fix(voteparty): clear recipient list immediately while deferring only SQL counter reset 2026-11-06 17:13:08 -06:00
Ben 56eac13558 test(voteparty): account for both worker cache-readiness checks 2026-11-06 17:10:10 -06:00
Ben 8d378a0cb5 test(voteparty): ensure shared SQL reset follows queued reward eligibility 2026-11-06 17:06:36 -06:00
Ben 136c9ec31e test(voteparty): cover worker-only cache checks and inline scheduler fallbacks 2026-11-06 17:05:59 -06:00
Ben 558f9e1f58 fix(voteparty): order shared SQL counter reset after eligibility snapshots 2026-11-06 17:04:36 -06:00
Ben 4113acdea0 fix(voteparty): keep all shared-cache checks on storage worker 2026-11-06 17:04:19 -06:00
Ben 10ab18db8d test(voteparty): ensure async vote paths avoid off-thread Bukkit lookup 2026-11-06 16:51:31 -06:00
Ben 8d5b046fe2 fix(voteparty): avoid Bukkit owner lookup from storage workers 2026-11-06 16:51:20 -06:00
Ben 26ba7af075 test(voteparty): verify deferred eligibility and first-party metadata survive reset 2026-11-06 16:49:03 -06:00
Ben 8e9c5aa6d6 fix(voteparty): preserve per-user eligibility and party context across deferred rewards 2026-11-06 16:48:12 -06:00
Ben 0c4914b676 test(voteparty): cover shared MySQL cache readiness and reward dispatch 2026-11-06 16:43:15 -06:00
Ben 67806e473b fix(voteparty): defer shared MySQL rewards until cache is published 2026-11-06 16:42:12 -06:00
Ben e8fa948ecd Merge pull request #1737 from BenCodez/vp-work/dependency-consolidation-20261029
Update compatible VotingPlugin dependencies
2026-11-03 17:10:46 -06:00
Ben 4b83cc08bd Update test runner and provided Gson 2026-11-02 05:39:31 -06:00
Ben 6e26c9c6c2 Use explicit types in point mutation callbacks 2026-11-01 20:28:38 -06:00
Ben dd005146f3 Preserve point placeholder fences across arithmetic paths 2026-11-01 19:36:07 -06:00
Ben b212f5cabb Verify packaged Redis dependency compatibility 2026-10-31 22:51:31 -06:00
Ben e09fa0f039 Merge pull request #1740 from BenCodez/fix/shared-mysql-getpoints-loading-fallback-20261031
fix(api): prevent shared MySQL getPoints() loading exceptions
2026-10-31 12:23:46 -06:00
Ben 79bbdb1395 docs(api): explain getPoints loading fallback and confirmed debit semantics 2026-10-31 12:16:30 -06:00
Ben 51f0b5e4a9 test(api): cover cold, invalidated and in-flight shared point reads 2026-10-31 12:16:16 -06:00
Ben eb9fc8618b fix(api): share publication fence with direct points reads 2026-10-31 12:15:29 -06:00
Ben 86735060bc fix(api): fail closed on unavailable shared MySQL point snapshots 2026-10-31 12:15:21 -06:00
Ben f2eb2152fc Merge pull request #1739 from BenCodez/fix/shared-mysql-point-cache-6923bd0c
fix(points): reconcile shared MySQL point placeholder publication
2026-10-30 21:25:47 -06:00
Ben d2bc2feb8e fix(points): avoid repeated reloads of published snapshots 2026-10-30 21:12:17 -06:00
Ben b34229ced0 fix(points): reconcile shared MySQL point placeholder publication 2026-10-30 20:05:22 -06:00
Ben 9f56166708 Merge pull request #1738 from BenCodez/fix/cooldown-reward-identity-20261029
Preserve player identity across asynchronous cooldown rewards
2026-10-29 18:58:23 -06:00
Ben 7746fc52dc Retry cooldown identity refresh before reward dispatch 2026-10-29 18:50:03 -06:00
Ben ee33a291a6 test(cooldown): restore globals after partial fixture setup 2026-10-29 18:08:53 -06:00
Ben 66d1c858c7 fix(cooldown): retain deferred reward identity and failure context 2026-10-29 17:21:59 -06:00
Ben 2e8cb4bd5d Update compatible VotingPlugin dependencies 2026-10-28 23:05:49 -06:00
Ben 334a00ed77 Fix offline date milestone placeholder identity 2026-10-28 19:31:07 -06:00
Ben fdcb9e6501 Integrate DateVoteMilestones with current master 2026-10-28 17:55:28 -06:00
Ben 2a1e4e19ce Merge pull request #1701 from BenCodez/fix/partial-startup-shutdown
Prevent shutdown exceptions after partial startup failures
2026-10-25 19:25:34 -06:00
Ben 73947ee4cc Retain shutdown sign publication ownership across retries
Reuse the accepted batch publication lease after failed I/O, coalesce pending retries, and retry display observation without repeating a confirmed write.
2026-10-25 18:08:27 -06:00
Ben dc127ce300 Keep shutdown sign publication within the bounded process drain
Capture sign state before asynchronous persistence, retain failed attempts for retry, and keep outstanding generation publication leases in the process-exit drain without blocking lifecycle cleanup.
2026-10-25 17:18:36 -06:00
Ben 1f27359df7 Merge current master into partial-startup cleanup
Retain independent Discord cleanup and display retirement, preserve shared server-data publication ownership, and cover cleanup failure and retry integration.
2026-10-25 15:39:29 -06:00
Ben c80e460640 Merge pull request #1717 from BenCodez/vp-work/top-voter-presence
Add optional checked-presence filtering for top-voter displays
2026-10-25 12:54:46 -06:00
Ben c3248a0a85 Merge pull request #1736 from BenCodez/fix/cold-offline-placeholder-cache
Populate cold offline placeholder entries in all-player modes
2026-10-25 11:17:20 -06:00
Ben 3db2ba2d2a Populate cold offline placeholder entries in all-player modes 2026-10-24 23:47:40 -06:00
Ben bfded64b30 Integrate startup shutdown ownership with current master 2026-10-24 22:33:22 -06:00
Ben 8c098ede6d Merge pull request #1733 from BenCodez/fix/folialib-official-repository
Resolve FoliaLib before the failing Velocity repository
2026-10-19 04:21:57 -06:00
Ben 6ff81d7919 fix(build): resolve FoliaLib from its official repository 2026-10-19 03:23:47 -06:00
Ben 0554c2b954 Merge pull request #1727 from BenCodez/fix/folialib-051-scheduler-fixtures
Fix FoliaLib 0.5.1 scheduler fixture compilation
2026-10-19 03:08:13 -06:00
Ben cfd4cf5cf0 test: support published and upgraded scheduler return types 2026-10-18 22:27:32 -06:00
Ben 84a8724ce2 test: align scheduler fixtures with FoliaLib 0.5.1 2026-10-18 22:10:31 -06:00
Ben 032c3834f3 Serialize Discord leaderboard edits and preserve queued refreshes 2026-10-17 23:27:52 -06:00
Ben bc33141f43 Complete top-voter presence display and recovery integration 2026-10-17 22:03:31 -06:00
Ben 8f637ef582 Complete date milestone owner controls and test-package integration 2026-10-17 21:54:34 -06:00
Ben 0c83e75a16 Merge pull request #1724 from BenCodez/docs/deprecate-uuid-only-lookups
Deprecate UUID-only user lookups with identity-aware API guidance
2026-10-16 20:14:54 -06:00
Ben 5081f95e63 Deprecate UUID-only user lookups without changing identity behavior 2026-10-16 19:52:01 -06:00
Ben 36bf96559e Merge pull request #1723 from BenCodez/fix/offline-uuid-compatibility
Resolve online player UUIDs to existing offline voting data
2026-10-16 18:34:26 -06:00
Ben 63c3c9aecf Fence offline identity refresh and login ownership 2026-10-16 18:27:33 -06:00
Ben 8acf825eaa Resolve live UUID lookups to existing offline voting identities 2026-10-16 18:14:50 -06:00
Ben e40bf57093 Merge pull request #1719 from BenCodez/refactor/standardize-test-packages
Standardize test packages
2026-10-16 13:10:08 -06:00
Ben 04a83ad54c Integrate current command, streak and dependency updates with top-voter displays 2026-10-16 12:55:27 -06:00
Ben 0c512eb8c1 Standardize test packages 2026-10-16 12:44:16 -06:00
Ben de9852a974 Merge pull request #1718 from BenCodez/maintenance/consolidated-dependency-refresh
Consolidate dependency updates and refresh Spigot API
2026-10-16 11:53:51 -06:00
BenCodez ad0c58d945 Refresh Spigot API and consolidate dependency updates 2026-10-16 11:19:55 -06:00
BenCodez dea8c3a8ba Add support for opening vote streaks menu via votegui
- Implemented command handling to open the vote streaks menu when the
"streaks" command is issued.
2026-10-16 10:57:51 -06:00
Ben f79e4c5d36 Merge pull request #1716 from BenCodez/feature/vote-streaks-menu
Add a read-only vote streak progression menu
2026-10-16 10:49:52 -06:00
Ben ca591ed39c Merge pull request #1708 from BenCodez/feature/configurable-vote-command
Make the player vote command configurable
2026-10-16 10:25:20 -06:00
Ben 8d3b35fa4f Restrict empty leaderboard skull clearing to confirmed display targets 2026-10-16 00:36:08 -06:00
Ben d3f7c43550 Preserve leaderboard refresh recovery and presence evidence 2026-10-15 22:55:43 -06:00
Ben cd531e323b Filter top-voter displays with bounded checked presence evidence 2026-10-15 21:49:44 -06:00
Ben 18f2fe92b2 Retain saturated Votifier receipts until overflow initialization 2026-10-15 18:36:07 -06:00
Ben 00617059fd Preserve date-event receipt ownership and integrate current lifecycle 2026-10-15 16:14:32 -06:00
BenCodez ccfe5f1cf1 Preserve custom vote streaks command precedence 2026-10-15 11:28:47 -06:00
BenCodez 2b59b83123 Merge master and preserve streak-menu cleanup 2026-10-15 10:56:21 -06:00
Ben e0c4a1c92f Fence server-data generations and retain timed-vote recovery across shutdown 2026-10-15 10:32:12 -06:00
Ben 1fbc1a1939 Merge pull request #1713 from BenCodez/fix/auto-create-site-setup-reminder
Warn when automatic vote-site creation remains enabled
2026-10-15 09:12:10 -06:00
BenCodez c6a099fdb1 Add a read-only vote streak progression menu 2026-10-15 09:02:42 -06:00
BenCodez 03bbdb4c93 Warn after startup while automatic vote-site creation remains enabled 2026-10-14 10:41:30 -06:00
BenCodez 4a2dae0e47 Use a brief automatic site setup reminder without extra settings 2026-10-14 08:44:22 -06:00
BenCodez 1ce14cc0ec Preserve reminder checkpoint ownership during recovery 2026-10-14 08:20:09 -06:00
BenCodez e2f326de2a Add owner reminder for automatic vote-site setup 2026-10-14 07:35:48 -06:00
Ben 071ba3edec Retain capture retirement while queue ownership is pending 2026-10-14 06:54:17 -06:00
Ben 4aa8f3cd85 Retain captured Votifier votes in bounded shutdown snapshots 2026-10-14 05:55:24 -06:00
Ben 3b4208c595 Bound timed-vote shutdown persistence and retain retryable recovery 2026-10-13 23:15:15 -06:00
Ben 013c9bb583 Align date milestones and add guarded event progress menus 2026-10-13 22:29:30 -06:00
Ben d7b5a89955 Preserve pending timed votes and late producers during cleanup 2026-10-13 22:03:46 -06:00
BenCodez f0cc7f15ae Preserve date milestone receipts and file ownership across reloads 2026-10-12 11:48:55 -06:00
BenCodez 42398de090 Retain overflow receipts until vote processing confirms completion 2026-10-12 00:10:09 -06:00
BenCodez 0518038d91 Make player vote command registration configurable 2026-10-12 00:00:18 -06:00
BenCodez cf51409f3f Retain bounded vote captures across failed overflow transfers 2026-10-11 13:58:53 -06:00
BenCodez 42f5819f1e Normalize added date milestone lines for diff checks 2026-10-11 12:35:02 -06:00
BenCodez cf8def4c8a Validate shutdown against latest AdvancedCore initialization fix 2026-10-11 11:06:37 -06:00
BenCodez a9b4af5fc5 Retain timed votes across shutdown races and failed persistence 2026-10-11 10:58:49 -06:00
BenCodez a89bb5594e Build startup regressions against corrected SQL dependencies 2026-10-11 10:25:34 -06:00
BenCodez 4409f8fdd9 Assert partial-startup shutdown emits no cleanup failure warnings 2026-10-10 23:25:48 -06:00
BenCodez 81993afd60 Prevent shutdown exceptions after partial startup failures 2026-10-10 23:09:46 -06:00
BenCodez b4aa30d283 Retain started Votifier receipts through shutdown cancellation 2026-10-09 17:21:41 -06:00
BenCodez d6d6dbc81d Ship an explicitly disabled date milestone example 2026-10-09 17:01:56 -06:00
BenCodez 63d9a58a57 Retain captured votes across cancelled executor admission 2026-10-09 17:01:56 -06:00
BenCodez 26441c1378 Persist local vote occurrence identities across queue replay 2026-10-09 16:37:49 -06:00
BenCodez 87545cc41f Capture startup Votifier votes before reward pipeline readiness 2026-10-08 20:47:22 -06:00
BenCodez 1535e27606 Separate date occurrence provenance from normal vote processing time 2026-10-08 20:03:13 -06:00
BenCodez 897f386f81 Start recovered date vote replay after its consumer is ready 2026-10-08 02:32:04 -06:00
BenCodez 57ebcbc72d Gate local date ingress and validate ordered progress filters 2026-10-08 02:13:58 -06:00
BenCodez e2f5503cfe Preserve normal proxy effects and explicit date accounting identity 2026-10-08 01:53:25 -06:00
BenCodez 31f5f2eeeb Require canonical transport identity and preserve original date vote time 2026-10-08 01:21:16 -06:00
BenCodez ff41566f4e Retain canonical proxy envelopes when date accounting is incomplete 2026-10-08 01:02:57 -06:00
BenCodez bd3c7382e8 Open proxy ingress after accepted vote handlers initialize 2026-10-08 00:45:01 -06:00
BenCodez 073634b899 Reserve date milestone rewards individually before submission 2026-10-08 00:01:42 -06:00
BenCodez 1f787df070 Initialize date vote definitions before proxy ingress 2026-10-07 23:36:10 -06:00
BenCodez 3c29bd8674 Respect reward processing and preserve queued date milestone handles 2026-10-07 23:20:02 -06:00
BenCodez bca38814e9 Add durable owner-configured DateVoteMilestones 2026-10-07 22:56:25 -06:00
390 changed files with 38044 additions and 8482 deletions

No files matched your search

+7
View File
@@ -26,6 +26,8 @@ mvn -B -f VotingPlugin/pom.xml -Dtest=BackendControlConnectorProtocolTest,Contro
CI runs `mvn -B -f VotingPlugin/pom.xml package`; see `.github/workflows/maven.yml`. Do not use the `dev` Maven profile in
automation because it copies a JAR into a developer-specific server directory.
All project tests and test-only helpers belong under `VotingPlugin/src/test/java/com/bencodez/votingplugin/tests/`, with package `com.bencodez.votingplugin.tests` or a meaningful subpackage. Keep paths and package declarations aligned, and update cross-test imports, resources, and build selectors when moving tests. Preserve package-phase artifact checks and test discovery. Do not widen production APIs to make tests accessible; use narrowly scoped test-only reflection for non-public seams. Platform API fixtures that must retain an external runtime class identity (such as `net.minecraft.network.chat.Component`) stay in that platform package and must not contain test cases.
Assign one owner to Maven validation in each worktree. Never run concurrent Maven commands in the same worktree, including focused tests alongside a clean/package build: compilation and cleanup share `target/` and can invalidate each other. Reviewers must inspect source only while that owner builds, or run validation in a separate worktree.
Keep the downloadable VotingPlugin JAR as small as practical. The 10 MiB size target is advisory:
@@ -58,6 +60,10 @@ For compatibility-sensitive changes, add regression coverage that exercises the
- `com.bencodez.votingplugin.core` and its subpackages are platform-independent. Classes there must not import Bukkit, Paper, Fabric, Forge, or NeoForge APIs. Keep loader-specific adapters outside this package and enforce the boundary with `CorePlatformIsolationTest`.
- `proxy/VotingPluginProxy` and the Bungee/Velocity platform packages own proxy lifecycle and vote routing.
- `listeners/` receives Bukkit-side vote/player events; `proxy/cache/` owns proxy pending-vote queues.
- `commands/CommandLoader` captures `VoteCommandEnabled`, `VoteCommandName` and `LoadCommandAliases` at startup.
Configuration reload must not change the registered player root or generated help/navigation. Preserve exact command
ownership, admin roots/aliases and canonical `VotingPlugin.Commands.Vote.*` permissions when disabling or renaming;
standalone player aliases retain their `vote...`/`v...` identities. See `docs/player-command-root.md`.
- `votesites/` resolves configured service names. Be alert to the distinction between read-only resolution and paths that
may auto-create a site.
- `user/` owns player totals, points, streaks, last-vote values, and backend offline rewards.
@@ -324,6 +330,7 @@ Control behavior in production.
- Trace whether the code runs on the connector worker, proxy thread, Bukkit primary thread, or a SQL executor.
- Preserve queued votes across saturation, reload, runtime replacement, scheduler rejection/cancellation, shutdown, and restart; overflow handling must be bounded, durable when promised, and observable rather than silently dropping work. Scheduler admission is never proof of durable ownership.
- Local Votifier captures remain owned after STARTED until normal callback completion or confirmed overflow transfer. Transfer execution stays fenced while the original callback runs; successful non-interrupted completion reconciles only its exact occurrence, while interruption/exception or failed transfer retains bounded recovery ownership. A callback completing after the final overflow snapshot is an explicit uncertain reconciliation case; a retired queue must not overwrite a successor, and ordinary partial external effects retain the existing at-least-once boundary.
- Proxy-to-backend guaranteed delivery is capability negotiated and at least once. Journal a reward-bearing envelope before
reporting transport acceptance, retain it until the matching backend completion acknowledgement is durable, persist
completed IDs before acknowledgement for restart-safe deduplication, retire receipts only through the durable
+2
View File
@@ -52,3 +52,5 @@ or disabling it; inspections gate disabled state immediately and report a newly
```
`LATEST` resolves to the latest stable release.
Owner-defined [DateVoteMilestones](docs/date-vote-milestones.md) count qualifying accepted votes within explicit date windows, independently of normal totals. This optional feature is disabled until events are configured.
+16 -9
View File
@@ -271,7 +271,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.5.4</version>
<version>3.6.1</version>
<executions>
<execution>
<id>default-test</id>
@@ -316,6 +316,13 @@
<enabled>false</enabled>
</releases>
</repository>
<repository>
<id>tcoded-releases</id>
<url>https://repo.tcoded.com/releases</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>velocity</id>
<url>https://nexus.velocitypowered.com/repository/maven-public/</url>
@@ -382,7 +389,7 @@
<dependency>
<groupId>net.neoforged</groupId>
<artifactId>mergetool</artifactId>
<version>2.0.0</version>
<version>2.0.7</version>
<classifier>api</classifier>
<scope>provided</scope>
</dependency>
@@ -401,12 +408,12 @@
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>2.6</version>
<version>2.7</version>
</dependency>
<dependency>
<groupId>org.spigotmc</groupId>
<artifactId>spigot-api</artifactId>
<version>26.2-R0.1-SNAPSHOT</version>
<version>26.3-R0.1-SNAPSHOT</version>
<scope>provided</scope>
<exclusions>
<exclusion>
@@ -424,7 +431,7 @@
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.14.0</version>
<version>2.15.0</version>
<scope>provided</scope>
</dependency>
<dependency>
@@ -475,7 +482,7 @@
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>7.5.3</version>
<version>8.0.2</version>
</dependency>
<dependency>
<groupId>me.clip</groupId>
@@ -525,7 +532,7 @@
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.12.2</version>
<version>6.1.3</version>
<scope>test</scope>
</dependency>
<dependency>
@@ -537,13 +544,13 @@
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>5.12.2</version>
<version>6.1.3</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<version>5.23.0</version>
<version>5.24.0</version>
<scope>test</scope>
</dependency>
<dependency>
@@ -71,11 +71,9 @@ import com.bencodez.votingplugin.broadcast.BroadcastSettings;
import com.bencodez.votingplugin.proxy.BungeeMethod;
import com.bencodez.votingplugin.commands.CommandLoader;
import com.bencodez.votingplugin.commands.executers.CommandAdminVote;
import com.bencodez.votingplugin.commands.executers.CommandVote;
import com.bencodez.votingplugin.commands.gui.AdminGUI;
import com.bencodez.votingplugin.commands.tabcompleter.AdminVoteTabCompleter;
import com.bencodez.votingplugin.commands.tabcompleter.AliasCommandFilterListener;
import com.bencodez.votingplugin.commands.tabcompleter.VoteTabCompleter;
import com.bencodez.votingplugin.config.BungeeSettings;
import com.bencodez.votingplugin.config.Config;
import com.bencodez.votingplugin.config.ConfigVoteSites;
@@ -87,6 +85,9 @@ import com.bencodez.votingplugin.cooldown.CoolDownCheck;
import com.bencodez.votingplugin.control.BackendControlAutoEnrollment;
import com.bencodez.votingplugin.control.BackendControlConnector;
import com.bencodez.votingplugin.data.ServerData;
import com.bencodez.votingplugin.maintenance.AutoCreateVoteSitesReminderService;
import com.bencodez.votingplugin.maintenance.AutoCreateVoteSitesReminderService.Settings;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState;
import com.bencodez.votingplugin.discord.DiscordHandler;
import com.bencodez.votingplugin.listeners.BlockBreak;
import com.bencodez.votingplugin.integration.votifier.VotifierIntegration;
@@ -156,49 +157,6 @@ import lombok.Setter;
public class VotingPluginMain extends AdvancedCorePlugin {
private final Object votingNPCLifecycle = new Object();
private final java.util.concurrent.atomic.AtomicLong votingNPCConfiguration = new java.util.concurrent.atomic.AtomicLong();
private volatile com.bencodez.votingplugin.npc.VotingNPCManager votingNPCManager;
public com.bencodez.votingplugin.npc.VotingNPCManager getVotingNPCManager() { return votingNPCManager; }
/** Optional NPC storage is lazy and asynchronous; configuration only schedules owner work. */
private void refreshVotingNPCs() {
boolean requested = getConfigFile().isVotingNPCsEnabled();
long generation = votingNPCConfiguration.incrementAndGet();
if (!requested && votingNPCManager == null) return;
getBukkitScheduler().runTask(this, () -> {
com.bencodez.votingplugin.npc.VotingNPCManager manager;
synchronized (votingNPCLifecycle) {
if (!isEnabled() || generation != votingNPCConfiguration.get()) return;
if (votingNPCManager == null && requested) {
try {
var created = new com.bencodez.votingplugin.npc.VotingNPCManager(this);
Bukkit.getPluginManager().registerEvents(created, this);
votingNPCManager = created;
} catch (RuntimeException | LinkageError unsupported) {
getLogger().warning("Voting NPCs are unavailable on this server; normal voting is unaffected.");
return;
}
}
manager = votingNPCManager;
}
if (manager != null) manager.configure(requested);
});
}
private void closeVotingNPCs() {
com.bencodez.votingplugin.npc.VotingNPCManager manager;
synchronized (votingNPCLifecycle) {
votingNPCConfiguration.incrementAndGet();
manager = votingNPCManager;
votingNPCManager = null;
}
if (manager != null) {
try { manager.close(); } catch (RuntimeException | LinkageError failure) { debug(failure); }
}
}
@Getter
public static VotingPluginMain plugin;
@@ -217,6 +175,9 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Getter
private BroadcastHandler broadcastHandler;
@Getter
private com.bencodez.votingplugin.streaks.VoteStreaksMenu voteStreaksMenu;
@Getter
private BackendProxyHandler backendProxyHandler;
private ProcessedVoteCache backendProcessedVoteCache;
@@ -256,6 +217,21 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Getter
private CommandLoader commandLoader;
/** Runtime command identity is captured at startup; configuration reload does not rename it. */
public String getVoteCommandPrefix() {
return "/" + (commandLoader == null ? "vote" : commandLoader.getVoteCommandName());
}
public boolean isVoteCommandEnabled() {
return commandLoader == null || commandLoader.isVoteCommandEnabled();
}
/** Retarget the built-in invalid-command help hint, including existing Config.yml text. */
public String formatVoteCommandMessage(String message) {
return message.replace("%votecommand%", getVoteCommandPrefix())
.replaceAll("(?i)/vote(?=\\s|$|[!.,])", getVoteCommandPrefix());
}
@Getter
private NameMCLikeCheckerTask nameMCLikeCheckerTask;
@@ -311,6 +287,7 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Getter
private TopVoterState topVoterState;
private volatile com.bencodez.votingplugin.topvoter.TopVoterDisplayFilter topVoterDisplayFilter;
@Getter
@@ -339,6 +316,8 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Getter
private ScheduledExecutorService voteTimer;
private volatile AutoCreateVoteSitesReminderService autoCreateVoteSitesSetupReminder;
private ScheduledExecutorService autoCreateVoteSitesReminderWorker;
@Getter
private UserManager votingPluginUserManager;
@@ -360,6 +339,9 @@ public class VotingPluginMain extends AdvancedCorePlugin {
private volatile VotingPluginBackgroundTask backgroundTask;
private volatile AtomicBoolean basicBungeeUpdateRunning;
private final AtomicBoolean unloadInProgress = new AtomicBoolean();
private Set<String> completedUnloadSteps;
private java.util.concurrent.CompletionStage<Void> signShutdownPublication;
private synchronized AtomicBoolean basicBungeeUpdateAdmission() {
if (basicBungeeUpdateRunning == null) basicBungeeUpdateRunning = new AtomicBoolean();
@@ -369,7 +351,13 @@ public class VotingPluginMain extends AdvancedCorePlugin {
private VotingPluginConfigHealth configHealth;
private VotifierIntegration votifierIntegration;
@Getter
private VotifierVoteOverflowQueue votifierVoteOverflowQueue;
private volatile VotifierVoteOverflowQueue votifierVoteOverflowQueue;
private VotiferEvent localVotifierListener;
private boolean acceptedVoteIngressRegistered;
private boolean timeQueueIngressRegistered;
private volatile boolean localVotifierIngressReady;
private volatile boolean localVotifierIngressClosed;
private volatile long dateVoteIngressGeneration;
private VoteLogManager voteLogManager;
private VotingPluginWebhookManager webhookManager;
@@ -548,6 +536,84 @@ public class VotingPluginMain extends AdvancedCorePlugin {
return topVoterState.getLastMonthTopVoters();
}
/** Display-only snapshots; raw getters remain the award/accounting contract. */
public LinkedHashMap<TopVoterPlayer, Integer> getTopVoterDisplay(TopVoter top) {
return projectTopVoterDisplay(getTopVoter(top));
}
public java.util.concurrent.CompletionStage<LinkedHashMap<TopVoterPlayer, Integer>> getTopVoterDisplayAsync(TopVoter top) {
var filter = topVoterDisplayFilter;
var raw = new LinkedHashMap<>(getTopVoter(top));
return filter == null || !isEnabled() ? java.util.concurrent.CompletableFuture.completedFuture(raw)
: filter.projectAsync(raw, configFile != null && configFile.isHideTopVoterIfNotPlayedBefore());
}
private final java.util.concurrent.atomic.AtomicLong topVoterDisplayGeneration = new java.util.concurrent.atomic.AtomicLong();
public long getTopVoterDisplayGeneration() { return topVoterDisplayGeneration.get(); }
public LinkedHashMap<TopVoterPlayer, Integer> getLastMonthTopVoterDisplay() {
return projectTopVoterDisplay(getLastMonthTopVoter());
}
public LinkedHashMap<TopVoterPlayer, Integer> getPreviousMonthTopVoterDisplay(YearMonth month) {
return projectTopVoterDisplay(getPreviousMonthsTopVoters().getOrDefault(month, new LinkedHashMap<>()));
}
private LinkedHashMap<TopVoterPlayer, Integer> projectTopVoterDisplay(LinkedHashMap<TopVoterPlayer, Integer> raw) {
var filter = topVoterDisplayFilter;
return filter == null || !isEnabled() ? new LinkedHashMap<>(raw)
: filter.project(raw, configFile != null && configFile.isHideTopVoterIfNotPlayedBefore());
}
public void initializeTopVoterDisplayFilter() {
retireTopVoterDisplayFilter();
boolean onlineMode = getOptions().isOnlineMode();
var filter = new com.bencodez.votingplugin.topvoter.TopVoterDisplayFilter(row ->
com.bencodez.votingplugin.topvoter.TopVoterPresenceIdentity
.identities(row, onlineMode, UuidLookup.getInstance()::getCachedUUID),
(row, aliases) -> checkTopVoterPresence(aliases, onlineMode), System::nanoTime,
this::topVoterDisplayRankingRows);
registerEvents(filter);
topVoterDisplayFilter = filter;
}
/** Cache capacity follows already loaded rankings, including disjoint historical identities. */
private long topVoterDisplayRankingRows() {
var state = topVoterState;
if (state == null) return 0L;
long rows = state.getLastMonthTopVoters().size();
for (var board : state.getTopVoters().values()) if (board != null) rows += board.size();
for (var board : state.getPreviousMonthsTopVoters().values()) if (board != null) rows += board.size();
return rows;
}
private java.util.concurrent.CompletionStage<com.bencodez.advancedcore.api.user.presence.PlayerPresence>
checkTopVoterPresence(java.util.List<java.util.UUID> aliases, boolean onlineMode) {
boolean completeOnlineHistory = onlineMode || aliases.stream().anyMatch(alias ->
alias != null && alias.version() == 4 && alias.variant() == 2);
if (!completeOnlineHistory) return checkPlayerPresenceIdentitiesAsync(aliases);
try {
return checkPlayerPresenceIdentitiesAsync(aliases, true);
} catch (NoSuchMethodError | AbstractMethodError unsupported) {
// Older SDKs can retain a positive but cannot certify the wider absence scope.
return checkPlayerPresenceIdentitiesAsync(aliases).thenApply(evidence ->
evidence == com.bencodez.advancedcore.api.user.presence.PlayerPresence.NEVER_JOINED
? com.bencodez.advancedcore.api.user.presence.PlayerPresence.UNKNOWN : evidence);
}
}
private void retireTopVoterDisplayFilter() {
topVoterDisplayGeneration.incrementAndGet();
if (discordHandler != null) discordHandler.retireLeaderboardPublications();
var filter = topVoterDisplayFilter;
topVoterDisplayFilter = null;
if (filter != null) {
filter.close();
org.bukkit.event.HandlerList.unregisterAll(filter);
}
}
public LinkedHashMap<YearMonth, LinkedHashMap<TopVoterPlayer, Integer>> getPreviousMonthsTopVoters() {
return topVoterState.getPreviousMonthsTopVoters();
}
@@ -651,6 +717,11 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Getter
private VoteStreakHandler voteStreakHandler;
@Getter
private final com.bencodez.votingplugin.specialrewards.datemilestones.DateVoteMilestones dateVoteMilestones =
new com.bencodez.votingplugin.specialrewards.datemilestones.DateVoteMilestones(this);
/**
* Registers a directly editable rewards path from SpecialRewards.yml.
*
@@ -664,6 +735,7 @@ public class VotingPluginMain extends AdvancedCorePlugin {
VoteSiteRewardRegistrar.register(this);
VotePartyRewardRegistrar.register(this);
VoteMilestoneRewardRegistrar.register(this);
dateVoteMilestones.reload();
VoteStreakRewardRegistrar.register(this);
TopVoterRewardRegistrar.register(this);
VoteShopRewardRegistrar.register(this);
@@ -735,8 +807,37 @@ public class VotingPluginMain extends AdvancedCorePlugin {
new VotingPluginMetrics().load(plugin);
}
/** Publish accepted and transport ingress only after the complete vote pipeline is initialized. */
void initializeDateVoteIngress(Runnable openProxy) {
if (localVotifierIngressClosed) throw new IllegalStateException("Vote ingress is shutting down");
if (localVotifierIngressReady) return;
if (voteMilestonesManager == null || voteStreakHandler == null || voteParty == null || specialRewards == null
|| topVoterHandler == null || voteShopManager == null || placeholders == null) {
throw new IllegalStateException("Accepted-vote handlers must initialize before transport ingress");
}
getDateVoteMilestones().reload();
if (!acceptedVoteIngressRegistered) {
getServer().getPluginManager().registerEvents(new PlayerVoteListener(this), this);
acceptedVoteIngressRegistered = true;
}
// Construction itself schedules persisted replay. Open it only after its consumer.
if (!timeQueueIngressRegistered && (!getBungeeSettings().isUseBungeecoord() || !getBungeeSettings().isGloblalDataEnabled())) {
timeQueueHandler = new TimeQueueHandler(this);
getServer().getPluginManager().registerEvents(timeQueueHandler, this);
timeQueueIngressRegistered = true;
}
if (getBungeeSettings().isUseBungeecoord()) openProxy.run();
localVotifierIngressReady = true;
VotifierVoteOverflowQueue overflow = votifierVoteOverflowQueue;
if (overflow != null) overflow.start();
}
@Override
public void onPostLoad() {
loadVoteTimer();
checkVotifier();
registerEarlyVotifierIngress();
serverData.refreshVotePartyDisplay();
ensureCommunicationSecret();
// auto conversion for Shop.yml
if (plugin.getShopFile().isJustCreated()) {
@@ -764,16 +865,20 @@ public class VotingPluginMain extends AdvancedCorePlugin {
voteTester = new VoteTester(plugin);
loadVoteTimer();
BoundedScheduledExecutor setupReminderWorker = new BoundedScheduledExecutor(1, 4);
setupReminderWorker.setThreadFactory(runnable -> {
Thread worker = new Thread(runnable, "VotingPlugin-SiteSetupReminder");
worker.setDaemon(true);
return worker;
});
autoCreateVoteSitesReminderWorker = setupReminderWorker;
autoCreateVoteSitesSetupReminder = new AutoCreateVoteSitesReminderService(getDataFolder().toPath(),
setupReminderWorker, getLogger(), autoCreateVoteSitesReminderSettings());
autoCreateVoteSitesSetupReminder.start();
getVotingPluginUserManager().startSharedPointTransferRecovery();
if (bungeeSettings.isUseBungeecoord()) {
loadBungeeHandler();
}
// Proxy ingress opens below, after every accepted-vote handler is initialized.
if (!bungeeSettings.isUseBungeecoord() || !bungeeSettings.isGloblalDataEnabled()) {
this.timeQueueHandler = new TimeQueueHandler(this);
}
if (Bukkit.getPluginManager().getPlugin("PlaceholderAPI") != null) {
if (getConfigFile().isLoadInteralExpansion()) {
@@ -788,10 +893,8 @@ public class VotingPluginMain extends AdvancedCorePlugin {
voteStreakHandler.reload();
registerCommands();
checkVotifier();
registerEvents();
refreshPlaceholderPlayerPresence();
refreshVotingNPCs();
loadVoteBroadcast();
@@ -815,6 +918,7 @@ public class VotingPluginMain extends AdvancedCorePlugin {
});
topVoterState = new TopVoterState();
initializeTopVoterDisplayFilter();
topVoterHandler = new TopVoterHandler(this);
new AdminGUI(this).loadHook();
@@ -879,11 +983,7 @@ public class VotingPluginMain extends AdvancedCorePlugin {
}
VotingPluginRewardRegistrar.register(this);
// Recovered Votifier votes may now traverse the fully initialized vote,
// reward, placeholder, shop, and vote-party pipeline.
if (votifierVoteOverflowQueue != null) {
votifierVoteOverflowQueue.start();
}
initializeDateVoteIngress(this::loadBungeeHandler);
plugin.getLogger().info("Enabled VotingPlugin " + plugin.getDescription().getVersion());
if (plugin.getDescription().getVersion().contains("SNAPSHOT")) {
@@ -1944,9 +2044,112 @@ public class VotingPluginMain extends AdvancedCorePlugin {
configFile.saveData();
}
@Getter
private volatile com.bencodez.votingplugin.util.ServerDataPublicationFence serverDataPublicationFence;
private volatile com.bencodez.votingplugin.data.GenerationFencedServerDataFile fencedServerDataFile;
private java.util.concurrent.CompletableFuture<Void> serverDataFinalPublication;
private boolean serverDataFinalPublicationReserved;
private boolean serverDataFinalStageAttached;
private volatile boolean serverDataEnableCleanupStarted;
private volatile boolean serverDataEnableAdmissionRejected;
@Override
public com.bencodez.advancedcore.data.ServerData getServerDataFile() {
var file = super.getServerDataFile();
var current = fencedServerDataFile;
if (current != null && current.wraps(file)) {
// The SDK replaces its file after pre-load. A failed new generation has
// no file to finalize; never expose the predecessor as its current owner.
return current.belongsTo(serverDataPublicationFence) ? current : null;
}
synchronized (this) {
file = super.getServerDataFile();
var owner = serverDataPublicationFence;
if (file == null || owner == null) return file;
current = fencedServerDataFile;
if (current != null && current.wraps(file) && !current.belongsTo(owner)) return null;
if (current == null || !current.wraps(file)) {
current = new com.bencodez.votingplugin.data.GenerationFencedServerDataFile(this, file, owner);
fencedServerDataFile = current;
}
return current;
}
}
/** Capture the existing AdvancedCore executors which can still publish server-data state. */
public ScheduledExecutorService[] getServerDataWriterExecutors() {
var checker = getTimeChecker();
return new ScheduledExecutorService[] { getTimer(), getLoginTimer(), getInventoryTimer(),
checker == null ? null : checker.getTimer() };
}
@Override
public void onEnable() {
synchronized (this) {
// Bind a retained SDK file before changing owner. AdvancedCore replaces its
// private file only later in loadHook(), after onPreLoad().
if (serverDataPublicationFence != null) getServerDataFile();
serverDataPublicationFence = com.bencodez.votingplugin.util.ServerDataPublicationFence.beginGeneration(
getDataFolder().toPath().resolve("ServerData.yml"));
try { serverDataPublicationFence.retainForProcessExit(); }
catch (RuntimeException | Error registrationFailure) {
serverDataEnableAdmissionRejected = true;
try { serverDataPublicationFence.retire(); }
catch (RuntimeException | Error cleanupFailure) {
if (cleanupFailure != registrationFailure) registrationFailure.addSuppressed(cleanupFailure);
}
throw registrationFailure;
}
serverDataFinalPublication = new java.util.concurrent.CompletableFuture<>();
serverDataFinalPublicationReserved = false;
serverDataFinalStageAttached = false;
serverDataEnableCleanupStarted = false;
serverDataEnableAdmissionRejected = false;
}
// Failed startup can already own SDK writers; disable must retire them before replacement.
try { super.onEnable(); }
catch (RuntimeException | Error failure) {
// SDK admission can fail before its startup-cleanup try/catch. Such an
// attempt admitted no new writers and must not strand an empty plugin owner.
// An admitted startup failure already entered our onDisable; preserve its drain.
if (!serverDataEnableCleanupStarted) {
serverDataEnableAdmissionRejected = true;
try {
serverDataPublicationFence.retire();
serverDataFinalPublication.complete(null);
} catch (RuntimeException | Error cleanupFailure) {
if (cleanupFailure != failure) failure.addSuppressed(cleanupFailure);
}
}
throw failure;
}
}
/** Start a fresh ingress generation only after the prior consumers retired. */
private void resetDateVoteIngressForEnable() {
if ((localVotifierListener != null || acceptedVoteIngressRegistered || timeQueueIngressRegistered)
&& (completedUnloadSteps == null || !completedUnloadSteps.contains("event handlers")
|| localVotifierListener != null && !completedUnloadSteps.contains("local Votifier ingress"))) {
throw new IllegalStateException("Previous vote ingress did not retire");
}
dateVoteIngressGeneration++;
localVotifierIngressReady = false;
localVotifierIngressClosed = false;
acceptedVoteIngressRegistered = false;
timeQueueIngressRegistered = false;
localVotifierListener = null;
timeQueueHandler = null;
}
@Override
public void onPreLoad() {
resetDateVoteIngressForEnable();
plugin = this;
unloadInProgress.set(false);
completedUnloadSteps = new java.util.HashSet<>();
signShutdownPublication = null;
setupFiles();
if ("SQLITE".equalsIgnoreCase(configFile.getData().getString("DataStorage", "SQLITE"))) {
@@ -1988,11 +2191,83 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Override
public void onDisable() {
if (offlineVoteOwnerHandoffs != null) offlineVoteOwnerHandoffs.close();
// The rejected enable owns no SDK shutdown stage to complete a new reservation.
if (serverDataEnableAdmissionRejected) return;
runShutdownStep("server-data process drain", this::beginServerDataProcessDrain);
serverDataEnableCleanupStarted = true;
runShutdownStep("Discord leaderboards", () -> {
if (discordHandler != null) discordHandler.close();
});
runShutdownStep("setup reminder", this::stopAutoCreateVoteSitesSetupReminder);
runShutdownStep("server-data writer retirement", () -> {
if (serverDataPublicationFence != null) {
retainServerDataFinalPublication();
var coreWriters = getServerDataWriterExecutors();
var writers = java.util.Arrays.copyOf(coreWriters, coreWriters.length + 1);
writers[coreWriters.length] = voteTimer;
serverDataPublicationFence.retainUntilTermination(writers);
}
});
try {
shutdownVoteReminders();
runShutdownStep("offline vote handoffs", () -> {
if (offlineVoteOwnerHandoffs != null) offlineVoteOwnerHandoffs.close();
});
} finally {
super.onDisable();
try { shutdownVoteReminders(); }
finally {
try { super.onDisable(); }
finally { runShutdownStep("server-data publication owner", () -> {
if (serverDataPublicationFence != null) serverDataPublicationFence.retire();
}); }
}
}
}
/** Reserve before SDK shutdown can enqueue a final file publication. No YAML lock or wait. */
private void retainServerDataFinalPublication() {
synchronized (this) {
if (serverDataFinalPublicationReserved) return;
if (serverDataFinalPublication == null)
serverDataFinalPublication = new java.util.concurrent.CompletableFuture<>();
serverDataPublicationFence.retainUntilSuccessfulPublication(serverDataFinalPublication);
serverDataFinalPublicationReserved = true;
}
}
@Override
public void onShutdownComplete(java.util.concurrent.CompletionStage<Void> finalFilesStage) {
java.util.concurrent.CompletableFuture<Void> publication;
synchronized (this) {
publication = serverDataFinalStageAttached ? null : serverDataFinalPublication;
serverDataFinalStageAttached = true;
}
try {
if (publication != null) {
try {
java.util.Objects.requireNonNull(finalFilesStage).whenComplete((ignored, failure) -> {
if (failure == null) publication.complete(null);
else publication.completeExceptionally(failure);
});
} catch (Throwable failure) { publication.completeExceptionally(failure); }
}
} finally { super.onShutdownComplete(finalFilesStage); }
}
private Settings autoCreateVoteSitesReminderSettings() {
return new Settings(true, configFile.isAutoCreateVoteSites(),
AutoCreateVoteSitesReminderState.DEFAULT_THRESHOLD_MILLIS,
AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS);
}
private void stopAutoCreateVoteSitesSetupReminder() {
AutoCreateVoteSitesReminderService current = autoCreateVoteSitesSetupReminder;
autoCreateVoteSitesSetupReminder = null;
ScheduledExecutorService worker = autoCreateVoteSitesReminderWorker;
autoCreateVoteSitesReminderWorker = null;
try {
if (current != null) current.closeAsync();
} finally {
if (worker != null) worker.shutdown();
}
}
@@ -2005,49 +2280,112 @@ public class VotingPluginMain extends AdvancedCorePlugin {
@Override
public void onUnLoad() {
closeVotingNPCs();
placeholderPlayerPresence.clear();
stopBackendHostedControlLifecycle();
stopBackendControlConnectorLifecycle();
if (getBackendProxyHandler() != null) {
try {
getBackendProxyHandler().closeForShutdown();
} catch (Exception e) {
debug(e);
}
runShutdownStep("server-data process drain", this::beginServerDataProcessDrain);
if (!unloadInProgress.compareAndSet(false, true)) {
runShutdownStep("time queue retry", () -> {
if (timeQueueHandler != null) timeQueueHandler.saveForShutdown();
});
return;
}
if (backendOrderedVoteOverflowQueue != null) {
backendOrderedVoteOverflowQueue.close();
backendOrderedVoteOverflowQueue = null;
}
if (webhookManager != null) {
webhookManager.shutdown();
}
voteTimer.shutdown();
try {
voteTimer.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {
e.printStackTrace();
}
voteTimer.shutdownNow();
if (votifierVoteOverflowQueue != null) {
votifierVoteOverflowQueue.close();
votifierVoteOverflowQueue = null;
}
if (timeQueueHandler != null) {
timeQueueHandler.save();
}
if (completedUnloadSteps == null) completedUnloadSteps = new java.util.HashSet<>();
runUnloadStep("Discord leaderboards", () -> {
if (discordHandler != null) discordHandler.close();
});
runUnloadStep("top voter display", this::retireTopVoterDisplayFilter);
runUnloadStep("streak menu", () -> {
if (voteStreaksMenu != null) voteStreaksMenu.close();
});
runUnloadStep("setup reminder", this::stopAutoCreateVoteSitesSetupReminder);
runUnloadStep("player presence", placeholderPlayerPresence::clear);
runUnloadStep("backend hosted Control", this::stopBackendHostedControlLifecycle);
runUnloadStep("backend Control connector", this::stopBackendControlConnectorLifecycle);
runUnloadStep("backend proxy", () -> {
if (getBackendProxyHandler() != null) getBackendProxyHandler().closeForShutdown();
});
runUnloadStep("backend ordered vote queue", () -> {
if (backendOrderedVoteOverflowQueue != null) {
backendOrderedVoteOverflowQueue.close();
backendOrderedVoteOverflowQueue = null;
}
});
runUnloadStep("webhook manager", () -> {
if (webhookManager != null) webhookManager.shutdown();
});
runUnloadStep("local Votifier ingress", () -> {
localVotifierIngressClosed = true;
localVotifierIngressReady = false;
if (localVotifierListener != null) localVotifierListener.stop();
});
runUnloadStep("vote timer", this::shutdownVoteTimer);
runUnloadStep("Votifier vote queue", () -> {
if (votifierVoteOverflowQueue != null) {
votifierVoteOverflowQueue.close();
votifierVoteOverflowQueue = null;
}
});
runShutdownStep("time queue", () -> {
if (timeQueueHandler != null) timeQueueHandler.saveForShutdown();
});
runUnloadStep("vote reminders", this::shutdownVoteReminders);
runUnloadStep("cooldown checker", () -> {
if (coolDownCheck != null) {
coolDownCheck.shutdown();
coolDownCheck = null;
}
});
runShutdownStep("signs", this::shutdownSigns);
runUnloadStep("event handlers", () -> HandlerList.unregisterAll(this));
// Late producers must see rejection until their overflow and handler cleanup finishes.
if (completedUnloadSteps.contains("vote timer")) voteTimer = null;
if (plugin == this) plugin = null;
} finally { unloadInProgress.set(false); }
}
shutdownVoteReminders();
private void beginServerDataProcessDrain() {
var owner = serverDataPublicationFence;
if (owner != null) owner.beginShutdown(System.nanoTime());
}
if (coolDownCheck != null) {
coolDownCheck.shutdown();
coolDownCheck = null;
private void shutdownSigns() {
if (signs == null) return;
var previous = signShutdownPublication;
if (previous != null && !previous.toCompletableFuture().isCompletedExceptionally()) return;
signShutdownPublication = java.util.Objects.requireNonNull(signs.storeSignsForShutdown());
}
private void runUnloadStep(String name, Runnable step) {
if (!completedUnloadSteps.contains(name) && runShutdownStep(name, step)) completedUnloadSteps.add(name);
}
private boolean runShutdownStep(String name, Runnable step) {
try {
step.run();
return true;
} catch (RuntimeException | Error failure) {
try {
getLogger().log(java.util.logging.Level.WARNING, "Failed to shut down " + name, failure);
} catch (RuntimeException | Error ignored) {
// Logging must not prevent the next independent cleanup step.
}
return false;
}
}
getSigns().storeSigns();
HandlerList.unregisterAll(plugin);
plugin = null;
private void shutdownVoteTimer() {
if (voteTimer == null) return;
try {
voteTimer.shutdown();
if (!voteTimer.awaitTermination(1, TimeUnit.SECONDS)) voteTimer.shutdownNow();
} catch (InterruptedException interrupted) {
Thread.currentThread().interrupt();
voteTimer.shutdownNow();
} catch (RuntimeException failure) {
try {
getLogger().log(java.util.logging.Level.WARNING, "Failed to shut down vote timer", failure);
} catch (RuntimeException | Error ignored) { }
voteTimer.shutdownNow();
}
}
/**
@@ -2058,12 +2396,6 @@ public class VotingPluginMain extends AdvancedCorePlugin {
commandLoader.loadCommands();
commandLoader.loadAliases();
// /vote, /v
getCommand("vote").setExecutor(new CommandVote(this));
getCommand("vote").setTabCompleter(new VoteTabCompleter());
// getCommand("v").setExecutor(new CommandVote(this));
// getCommand("v").setTabCompleter(new VoteTabCompleter());
// /adminvote, /av
getCommand("adminvote").setExecutor(new CommandAdminVote(this));
getCommand("adminvote").setTabCompleter(new AdminVoteTabCompleter());
@@ -2082,23 +2414,44 @@ public class VotingPluginMain extends AdvancedCorePlugin {
}
}
// Export documentation only after both handler lists and the player command label are ready.
// A filesystem problem must never stop registration or normal voting.
try {
if (com.bencodez.votingplugin.commands.CommandDocumentationExporter.write(getDataFolder().toPath(),
getVoteCommandPrefix(), getVoteCommand(), getAdminVoteCommand())) {
getLogger().info("Updated generated command documentation in GeneratedDocs/");
}
} catch (IOException | RuntimeException error) {
getLogger().warning("Unable to write generated command documentation: " + error.getMessage());
}
plugin.debug("Loaded Commands");
}
/**
* Register events.
*/
/** Capture external events early; only the existing bounded workers may buffer/process them. */
void registerEarlyVotifierIngress() {
if (localVotifierIngressClosed || !isVotifierLoaded() || localVotifierListener != null) return;
long generation = dateVoteIngressGeneration;
java.util.function.BooleanSupplier ready = () -> dateVoteIngressGeneration == generation
&& localVotifierIngressReady && !localVotifierIngressClosed;
VotiferEvent listener = new VotiferEvent(this, ready);
// Publish the memory owner before capture. Its independent worker loads
// disk state; vote-executor cancellation cannot discard queue setup.
votifierVoteOverflowQueue = VotifierVoteOverflowQueue.initializeConfirmedAsync(this,
listener::processVoteConfirmed, ready);
localVotifierListener = listener;
if (localVotifierIngressReady) votifierVoteOverflowQueue.start();
getServer().getPluginManager().registerEvents(listener, this);
}
private void registerEvents() {
voteStreaksMenu = new com.bencodez.votingplugin.streaks.VoteStreaksMenu(this);
getServer().getPluginManager().registerEvents(voteStreaksMenu, this);
PluginManager pm = getServer().getPluginManager();
pm.registerEvents(new PlayerJoinEvent(this), this);
if (isVotifierLoaded()) {
VotiferEvent votifierEvent = new VotiferEvent(this);
votifierVoteOverflowQueue = new VotifierVoteOverflowQueue(this, votifierEvent::processVote);
pm.registerEvents(votifierEvent, this);
}
pm.registerEvents(new PlayerVoteListener(this), this);
pm.registerEvents(new com.bencodez.votingplugin.listeners.DateVoteMenuOpenGuard(), this);
pm.registerEvents(new PlayerPostVoteLoggerListener(this), this);
pm.registerEvents(new PlayerSpecialRewardLoggerListener(this), this);
pm.registerEvents(new VoteShopPurchaseLoggerListener(this), this);
@@ -2112,9 +2465,6 @@ public class VotingPluginMain extends AdvancedCorePlugin {
pm.registerEvents(new PlayerInteract(this), this);
}
if (timeQueueHandler != null) {
pm.registerEvents(timeQueueHandler, plugin);
}
pm.registerEvents(new VotingPluginUpdateEvent(this), this);
/*
@@ -2145,15 +2495,19 @@ public class VotingPluginMain extends AdvancedCorePlugin {
/** Captures Bukkit presence while the lifecycle caller owns platform access. */
public void refreshPlaceholderPlayerPresence() {
boolean onlineMode = getOptions().isOnlineMode();
placeholderPlayerPresence.replace(Bukkit::getOnlinePlayers,
player -> placeholderStorageUuid(player, onlineMode));
placeholderPlayerPresence.refresh(Bukkit::getOnlinePlayers, (player, capture) ->
com.bencodez.votingplugin.util.BukkitCompletionScheduler.run(this, player, () -> {
if (!player.isOnline()) return;
UUID storageUuid = placeholderPlayerPresence.storageUuid(player);
capture.accept(storageUuid == null ? placeholderStorageUuid(player, onlineMode) : storageUuid);
}, () -> { }, () -> { }));
}
static UUID placeholderStorageUuid(Player player, boolean onlineMode) {
if (onlineMode) return player.getUniqueId();
String cachedUuid = UuidLookup.getInstance().getCachedUUID(player.getName());
String resolvedUuid = UuidLookup.getInstance().getUUIDWithoutStorage(player.getName());
try {
return UUID.fromString(cachedUuid);
return UUID.fromString(resolvedUuid);
} catch (IllegalArgumentException | NullPointerException ignored) {
return player.getUniqueId();
}
@@ -2169,9 +2523,13 @@ public class VotingPluginMain extends AdvancedCorePlugin {
private void reloadPlugin(boolean userStorage, boolean reconcileHostedControl,
boolean updateActiveBackendRuntime) {
if (offlineVoteOwnerHandoffs != null) offlineVoteOwnerHandoffs.pause();
retireTopVoterDisplayFilter();
try {
if (voteStreaksMenu != null) voteStreaksMenu.suspend();
configFile.reloadData();
configFile.loadValues();
AutoCreateVoteSitesReminderService setupReminder = autoCreateVoteSitesSetupReminder;
if (setupReminder != null) setupReminder.reload(autoCreateVoteSitesReminderSettings());
configVoteSites.reloadData();
@@ -2186,10 +2544,13 @@ public class VotingPluginMain extends AdvancedCorePlugin {
updateAdvancedCoreHook();
reloadAdvancedCore(userStorage);
initializeTopVoterDisplayFilter();
// PerServerPoints can switch shared point storage on during a live reload.
// Re-evaluate after storage has reloaded; UserManager keeps this lifecycle task unique.
getVotingPluginUserManager().startSharedPointTransferRecovery();
getOptions().setServer(bungeeSettings.getServer());
getDateVoteMilestones().reload();
reloadBackendProxyRuntime(updateActiveBackendRuntime, userStorage);
checkYMLError();
@@ -2217,11 +2578,11 @@ public class VotingPluginMain extends AdvancedCorePlugin {
loadDirectlyDefined();
refreshVotingNPCs();
if (reconcileHostedControl) restartBackendControlConnector();
setUpdate(true);
} finally {
if (voteStreaksMenu != null) voteStreaksMenu.resume();
if (offlineVoteOwnerHandoffs != null) offlineVoteOwnerHandoffs.resume();
}
}
@@ -569,7 +569,8 @@ public class BackendProxyMessageRouter {
}
String totalsRaw = nvl(fields.get(VotingPluginWire.K_TOTALS));
VoteTotalsSnapshot totals = totalsRaw.isEmpty() ? null : VoteTotalsSnapshot.parseStorage(totalsRaw);
VoteTotalsSnapshot totals = !com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.hasPayload(totalsRaw)
? null : VoteTotalsSnapshot.parseStorage(totalsRaw);
VoteSite voteSite = plugin.getVoteSiteManager()
.getVoteSite(plugin.getVoteSiteManager().getVoteSiteName(true, service), true);
if (voteSite == null) {
@@ -715,16 +716,29 @@ public class BackendProxyMessageRouter {
user.cache();
boolean wasOnline = vote.wasOnlineKnown ? vote.wasOnline : user.isOnline();
boolean queuedDelivery = vote.queuedDeliveryKnown ? vote.queuedDelivery : vote.delayValidated;
var event = user.bungeeVotePluginMessagingEvent(vote.service, vote.time, totals, !vote.manageTotals,
wasOnline, vote.broadcast, vote.num, queuedDelivery, vote.delayValidationKnown,
vote.queuedDeliveryKnown, voteId,
VotingPluginWire.SUB_VOTE_ONLINE.equals(msg.getSubChannel()));
if ((event == null || !event.isCancelled()) && plugin.getBungeeSettings().isPerServerPoints()) {
com.bencodez.votingplugin.events.PlayerVoteEvent dispatchedEvent = null;
VotingPluginUser.DateMilestoneAccountingException dateAccountingFailure = null;
try {
// Keep totals correlation for replay fencing, but only the original wire ID
// identifies a canonical transport occurrence in the native event.
dispatchedEvent = user.bungeeVotePluginMessagingEvent(vote.service, vote.time, totals, !vote.manageTotals,
wasOnline, vote.broadcast, vote.num, queuedDelivery, vote.delayValidationKnown,
vote.queuedDeliveryKnown, vote.voteId,
VotingPluginWire.SUB_VOTE_ONLINE.equals(msg.getSubChannel()), vote.realVote,
vote.canonicalOccurrenceTime);
} catch (VotingPluginUser.DateMilestoneAccountingException incomplete) {
dateAccountingFailure = incomplete;
}
if ((dispatchedEvent == null || !dispatchedEvent.isCancelled())
&& plugin.getBungeeSettings().isPerServerPoints()) {
user.addPoints(plugin.getConfigFile().getPointsOnVote());
}
if (vote.service != null && !vote.service.isEmpty()) {
plugin.getServerData().addServiceSite(vote.service);
}
// Date accounting cannot suppress normal points/service observations. Keep
// the reservation incomplete so reconciliation cannot replay normal rewards.
if (dateAccountingFailure != null) throw dateAccountingFailure;
return new WireVoteResult(voteId, true, false);
}
@@ -0,0 +1,207 @@
package com.bencodez.votingplugin.commands;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.AtomicMoveNotSupportedException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.bencodez.advancedcore.api.command.CommandHandler;
import com.bencodez.advancedcore.api.command.PlayerCommandHandler;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
/**
* Exports the actual Bukkit command-handler registrations as a deterministic
* machine-readable manifest and an administrator-friendly Markdown reference.
* It never executes a command or accesses user data.
*/
public final class CommandDocumentationExporter {
public static final String DIRECTORY = "GeneratedDocs";
public static final String JSON_NAME = "commands.json";
public static final String MARKDOWN_NAME = "commands.md";
private CommandDocumentationExporter() {
}
public static final class CommandRow {
private final String root;
private final String syntax;
private final String description;
private final String permissionExpression;
private final List<String> permissions;
private final List<String> allTargetPermissions;
private final boolean multiplePermissionChecks;
private final String sender;
private CommandRow(String root, String syntax, String description, String permissionExpression,
List<String> permissions, List<String> allTargetPermissions,
boolean multiplePermissionChecks, String sender) {
this.root = root;
this.syntax = syntax;
this.description = description;
this.permissionExpression = permissionExpression;
this.permissions = List.copyOf(permissions);
this.allTargetPermissions = List.copyOf(allTargetPermissions);
this.multiplePermissionChecks = multiplePermissionChecks;
this.sender = sender;
}
}
/** Capture only loaded handlers, including conditionally registered handlers. */
public static List<CommandRow> capture(String playerRoot, List<? extends CommandHandler> playerHandlers,
List<? extends CommandHandler> adminHandlers) {
List<CommandRow> result = new ArrayList<>();
result.addAll(captureGroup(playerRoot, playerHandlers));
result.addAll(captureGroup("/av", adminHandlers));
return List.copyOf(result);
}
private static List<CommandRow> captureGroup(String root, List<? extends CommandHandler> handlers) {
List<CommandRow> result = new ArrayList<>();
if (handlers == null) return result;
for (CommandHandler handler : handlers) {
if (handler == null) continue;
String syntax = safe(handler.getHelpLineCommand(root));
if (syntax.isEmpty()) continue;
String permission = safe(handler.getPerm());
List<String> allTarget = List.of();
if (handler instanceof PlayerCommandHandler) {
List<String> additional = ((PlayerCommandHandler) handler).getAdditionalPermissions();
if (additional != null) allTarget = new ArrayList<>(new LinkedHashSet<>(additional));
}
String sender = handler.isForceConsole() ? "console" :
handler.isAllowConsole() ? "player or console" : "player";
result.add(new CommandRow(root, syntax, safe(handler.getHelpMessage()), permission,
splitPermissions(permission), allTarget, handler.isAllowMultiplePermissions(), sender));
}
result.sort(Comparator.comparing((CommandRow row) -> row.syntax, String.CASE_INSENSITIVE_ORDER)
.thenComparing(row -> row.permissionExpression, String.CASE_INSENSITIVE_ORDER));
return result;
}
private static String safe(String text) {
return text == null ? "" : text.trim();
}
private static List<String> splitPermissions(String expression) {
Set<String> unique = new LinkedHashSet<>();
for (String part : expression.split("\\|")) {
String value = part.trim();
if (!value.isEmpty()) unique.add(value);
}
return new ArrayList<>(unique);
}
/** Stable JSON for future documentation bots; it contains no credentials or player data. */
public static String toJson(List<CommandRow> rows) {
JsonObject doc = new JsonObject();
doc.addProperty("schemaVersion", 1);
doc.addProperty("scope", "VotingPlugin Bukkit registered handlers");
JsonArray commands = new JsonArray();
for (CommandRow row : rows) {
JsonObject object = new JsonObject();
object.addProperty("root", row.root);
object.addProperty("syntax", row.syntax);
object.addProperty("description", row.description);
object.addProperty("permissionExpression", row.permissionExpression);
object.add("permissions", asArray(row.permissions));
object.add("allTargetPermissions", asArray(row.allTargetPermissions));
object.addProperty("multiplePermissionChecks", row.multiplePermissionChecks);
object.addProperty("sender", row.sender);
commands.add(object);
}
doc.add("commands", commands);
return new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create().toJson(doc) + "\n";
}
private static JsonArray asArray(List<String> values) {
JsonArray array = new JsonArray();
for (String value : values) array.add(value);
return array;
}
/** Reader-friendly generated snapshot for reviewing changes without running code. */
public static String toMarkdown(List<CommandRow> rows) {
StringBuilder markdown = new StringBuilder();
markdown.append("# VotingPlugin Bukkit commands (generated)\n\n");
markdown.append("This page is generated from the command handlers loaded by the running server. ");
markdown.append("It is not a canonical release reference: configured command labels and ");
markdown.append("conditionally loaded commands may differ between servers.\n\n");
markdown.append("Permission expressions separated by | may provide alternatives when ");
markdown.append("multiple-permission checks are enabled. Extra all-target permissions ");
markdown.append("apply only to supported bulk player commands.\n\n");
markdown.append("This export does not cover separate Velocity/BungeeCord proxy commands ");
markdown.append("or standalone plugin.yml convenience aliases.\n\n");
Map<String, List<CommandRow>> groups = new LinkedHashMap<>();
for (CommandRow row : rows) groups.computeIfAbsent(row.root, key -> new ArrayList<>()).add(row);
for (Map.Entry<String, List<CommandRow>> group : groups.entrySet()) {
markdown.append("## ").append(escapeCell(group.getKey())).append("\n\n");
markdown.append("| Command | Description | Permission expression | All-target permissions | Sender |\n");
markdown.append("|---|---|---|---|---|\n");
for (CommandRow row : group.getValue()) {
markdown.append("| ").append(code(row.syntax));
markdown.append(" | ").append(escapeCell(row.description));
markdown.append(" | ").append(code(row.permissionExpression.isEmpty() ? "(none)" : row.permissionExpression));
markdown.append(" | ").append(row.allTargetPermissions.isEmpty() ? "—" :
code(String.join(", ", row.allTargetPermissions)));
markdown.append(" | ").append(escapeCell(row.sender)).append(" |\n");
}
markdown.append("\n");
}
return markdown.toString();
}
private static String code(String value) {
return String.valueOf((char) 96) + escapeCell(value) + (char) 96;
}
private static String escapeCell(String value) {
return safe(value).replace("\r", " ").replace("\n", " ").replace("|", "\\|")
.replace(String.valueOf((char) 96), "&#96;");
}
/**
* Write only when content changes, using temporary files and atomic moves
* when supported. No writes occur outside the plugin data folder.
*/
public static boolean write(Path pluginDataFolder, String playerRoot,
List<? extends CommandHandler> playerHandlers, List<? extends CommandHandler> adminHandlers)
throws IOException {
List<CommandRow> rows = capture(playerRoot, playerHandlers, adminHandlers);
Path directory = pluginDataFolder.resolve(DIRECTORY);
Files.createDirectories(directory);
boolean jsonChanged = writeIfChanged(directory.resolve(JSON_NAME), toJson(rows));
boolean markdownChanged = writeIfChanged(directory.resolve(MARKDOWN_NAME), toMarkdown(rows));
return jsonChanged || markdownChanged;
}
private static boolean writeIfChanged(Path target, String content) throws IOException {
if (Files.isSymbolicLink(target)) throw new IOException("Refusing to overwrite symbolic link: " + target);
if (Files.isRegularFile(target) && content.equals(Files.readString(target, StandardCharsets.UTF_8))) {
return false;
}
Path temporary = Files.createTempFile(target.getParent(), target.getFileName().toString(), ".tmp");
try {
Files.writeString(temporary, content, StandardCharsets.UTF_8);
try {
Files.move(temporary, target, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING);
} catch (AtomicMoveNotSupportedException unsupported) {
Files.move(temporary, target, StandardCopyOption.REPLACE_EXISTING);
}
} finally {
Files.deleteIfExists(temporary);
}
return true;
}
}
@@ -56,6 +56,7 @@ import com.bencodez.simpleapi.valuerequest.ValueRequest;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.core.maintenance.MaintenanceConfirmation;
import com.bencodez.votingplugin.commands.executers.CommandAliases;
import com.bencodez.votingplugin.commands.executers.CommandVote;
import com.bencodez.votingplugin.commands.gui.AdminGUI;
import com.bencodez.votingplugin.commands.gui.admin.AdminVoteHelp;
import com.bencodez.votingplugin.commands.gui.admin.AdminVotePerms;
@@ -82,6 +83,7 @@ import com.bencodez.votingplugin.commands.gui.player.VoteTotal;
import com.bencodez.votingplugin.commands.gui.player.VoteURL;
import com.bencodez.votingplugin.commands.gui.player.VoteURLVoteSite;
import com.bencodez.votingplugin.commands.tabcompleter.AliasesTabCompleter;
import com.bencodez.votingplugin.commands.tabcompleter.VoteTabCompleter;
import com.bencodez.votingplugin.events.PlayerVoteEvent;
import com.bencodez.votingplugin.events.PlayerVoteSiteCoolDownEndEvent;
import com.bencodez.votingplugin.presets.VoteSitePresetSetupHandler;
@@ -115,6 +117,13 @@ public class CommandLoader {
private String playerPerm = "VotingPlugin.Player";
private VotingPluginMain plugin;
private final boolean startupVoteCommandEnabled;
private final String startupVoteCommandName;
private final boolean startupLoadCommandAliases;
private boolean playerCommandConfigured;
private PluginCommand playerRootCommand;
private boolean voteCommandEnabled;
private String voteCommandName = "vote";
/**
* Constructs a new CommandLoader.
@@ -123,6 +132,131 @@ public class CommandLoader {
*/
public CommandLoader(VotingPluginMain plugin) {
this.plugin = plugin;
var config = plugin.getConfigFile();
startupVoteCommandEnabled = config == null || config.isVoteCommandEnabled();
startupVoteCommandName = config == null ? "vote" : config.getVoteCommandName();
startupLoadCommandAliases = config == null || config.isLoadCommandAliases();
voteCommandEnabled = startupVoteCommandEnabled;
}
/** The label actually registered at startup, including its namespace on conflict. */
public String getVoteCommandName() {
return voteCommandName;
}
public boolean isVoteCommandEnabled() {
return voteCommandEnabled;
}
/** Runs a generated player navigation action only while its command is available. */
public void performVoteCommand(Player player, String arguments) {
if (voteCommandEnabled) {
player.performCommand(voteCommandName + (arguments.isEmpty() ? "" : " " + arguments));
}
}
/** Configure only once: reloading configuration must not change command ownership. */
private void configurePlayerCommand() {
if (playerCommandConfigured) return;
playerCommandConfigured = true;
try {
CommandMap commandMap = getCommandMap();
PluginCommand root = ownedCommand("vote");
playerRootCommand = root;
if (!startupVoteCommandEnabled) {
for (String name : plugin.getDescription().getCommands().keySet()) {
if (name.equalsIgnoreCase("vote") || name.toLowerCase(Locale.ROOT).startsWith("vote")) {
PluginCommand command = ownedCommand(name);
if (command != null) unregisterCommand(commandMap, command);
}
}
voteCommandEnabled = false;
return;
}
if (root == null) {
voteCommandEnabled = false;
plugin.getLogger().warning("Unable to locate VotingPlugin's player command; player commands were not enabled.");
return;
}
String name = startupVoteCommandName == null ? "" : startupVoteCommandName.trim().toLowerCase(Locale.ROOT);
if (!name.matches("[a-z0-9][a-z0-9_-]{0,63}") || isReservedCommandName(name)) {
plugin.getLogger().warning("Invalid or reserved VoteCommandName; using vote. Command settings require a restart.");
name = "vote";
}
String namespace = plugin.getDescription().getName().toLowerCase(Locale.ROOT);
String fallback = namespace + ":" + name;
org.bukkit.command.Command existingFallback = commandMap.getCommand(fallback);
org.bukkit.command.Command existingLabel = commandMap.getCommand(name);
boolean ownedLabelCollision = existingLabel instanceof PluginCommand owned
&& owned.getPlugin() == plugin && owned != root;
if (!name.equals("vote") && ((existingFallback != null && existingFallback != root) || ownedLabelCollision)) {
plugin.getLogger().warning("VoteCommandName namespace is already owned; keeping vote. Command settings require a restart.");
name = "vote";
fallback = namespace + ":vote";
}
if (!name.equals("vote")) {
// Bukkit's register writes the fallback even when the bare label collides.
// Check it before unregistering or publishing the renamed command.
unregisterCommand(commandMap, root);
root.setName(name);
root.setLabel(name);
root.setAliases(List.of());
if (existingLabel != null && existingLabel != root) {
// SimpleCommandMap may overwrite another command's bare alias. Register
// only our free fallback in that case, preserving the alias owner too.
root.setLabel(fallback);
if (!root.register(commandMap)) throw new IllegalStateException("Player command registration was rejected");
Map<String, org.bukkit.command.Command> registrations = getKnownCommands(commandMap);
// Paper forwards put/get to Brigadier; HashMap.putIfAbsent can bypass it.
if (registrations.get(fallback) != null) throw new IllegalStateException("Player command namespace became occupied");
registrations.put(fallback, root);
} else {
commandMap.register(namespace, root);
}
}
voteCommandName = commandMap.getCommand(name) == root ? name : fallback;
voteCommandEnabled = commandMap.getCommand(voteCommandName) == root;
if (voteCommandEnabled) {
root.setExecutor(new CommandVote(plugin));
root.setTabCompleter(new VoteTabCompleter());
if (!voteCommandName.equals(name)) {
plugin.getLogger().warning("Player command label is already owned; use /" + voteCommandName + " instead.");
}
} else {
plugin.getLogger().warning("Unable to register VotingPlugin's player command without replacing another owner.");
}
} catch (ReflectiveOperationException | RuntimeException failure) {
throw new IllegalStateException("Unable to configure VotingPlugin's player command safely", failure);
}
}
private boolean isReservedCommandName(String name) {
for (var entry : plugin.getDescription().getCommands().entrySet()) {
if (entry.getKey().equalsIgnoreCase("vote")) continue;
if (entry.getKey().equalsIgnoreCase(name)) return true;
Object aliases = entry.getValue().get("aliases");
if (aliases instanceof String alias && alias.equalsIgnoreCase(name)) return true;
if (aliases instanceof Iterable<?> values) {
for (Object alias : values) if (name.equalsIgnoreCase(String.valueOf(alias))) return true;
}
}
return false;
}
private PluginCommand ownedCommand(String name) {
PluginCommand command = plugin.getCommand(name);
if (command != null && command.getPlugin() == plugin) return command;
try {
// A plugin may have displaced the primary and fallback labels while a short
// alias still points at our command. Disable must remove that object too.
for (org.bukkit.command.Command candidate : getKnownCommands(getCommandMap()).values()) {
if (candidate instanceof PluginCommand owned && owned.getPlugin() == plugin
&& owned.getName().equalsIgnoreCase(name)) return owned;
}
} catch (ReflectiveOperationException failure) {
throw new IllegalStateException("Unable to inspect owned command registrations", failure);
}
return null;
}
void runForCommandSender(CommandSender sender, Runnable task) {
@@ -220,7 +354,7 @@ public class CommandLoader {
java.util.List<VotingPluginUser> users = new java.util.ArrayList<>();
try {
for (String uuidString : plugin.getUserManager().getAllUUIDs()) {
users.add(plugin.getVotingPluginUserManager().getVotingPluginUser(UUID.fromString(uuidString)));
users.add(plugin.getVotingPluginUserManager().getVotingPluginUser(UUID.fromString(uuidString), true));
}
} catch (Throwable failure) {
plugin.debug(failure);
@@ -403,26 +537,28 @@ public class CommandLoader {
* @return true if player has permission
*/
public boolean hasPermission(Player player, String cmd) {
cmd = cmd.toLowerCase(Locale.ROOT);
if (cmd.startsWith("votingplugin:")) {
cmd = cmd.substring("votingplugin:".length());
}
if (commands.containsKey(cmd)) {
return commands.get(cmd).hasPerm(player);
for (var entry : commands.entrySet()) {
if (entry.getKey().equalsIgnoreCase(cmd)) return entry.getValue().hasPerm(player);
}
boolean adminCommand = false;
String rootLabel = voteCommandName.substring(voteCommandName.indexOf(':') + 1);
if (cmd.startsWith("vote")) {
cmd = cmd.substring("vote".length());
} else if (cmd.startsWith("v")) {
cmd = cmd.substring(1);
} else if (cmd.startsWith("av")) {
if (cmd.equals("adminvote") || cmd.startsWith("adminvote ")) {
adminCommand = true;
cmd = cmd.substring("av".length());
} else if (cmd.startsWith("adminvote")) {
cmd = cmd.substring("adminvote".length()).trim();
} else if (cmd.equals("av") || cmd.startsWith("av ")) {
adminCommand = true;
cmd = cmd.substring("adminvote".length());
cmd = cmd.substring("av".length()).trim();
} else if (voteCommandEnabled && (cmd.equals(rootLabel) || cmd.startsWith(rootLabel + " "))) {
cmd = cmd.substring(rootLabel.length()).trim();
} else {
return false;
}
// plugin.debug(cmd);
if (!adminCommand) {
@@ -459,13 +595,11 @@ public class CommandLoader {
* @return true if it's a VotingPlugin command
*/
public boolean isVotingPluginCommand(Player player, String cmd) {
if (plugin.getCommand(cmd) != null || cmd.startsWith("votingplugin")) {
return true;
}
for (String str : commands.keySet()) {
if (str.equalsIgnoreCase(cmd)) {
return true;
}
try {
org.bukkit.command.Command command = getCommandMap().getCommand(cmd);
return command instanceof PluginCommand owned && owned.getPlugin() == plugin;
} catch (ReflectiveOperationException failure) {
plugin.debug(failure);
}
return false;
}
@@ -473,9 +607,31 @@ public class CommandLoader {
/**
* Load admin vote command.
*/
private void clearDiscordMessageId(CommandSender sender, TopVoter top) {
try {
plugin.getTimer().execute(() -> {
boolean confirmed;
try { confirmed = clearDiscordMessageId(top); }
catch (RuntimeException failure) { confirmed = false; }
String message = confirmed ? "&cCleared discord message ID for " + top.toString()
: "&cUnable to confirm the cleared Discord message ID; check storage before restarting.";
runForCommandSender(sender, () -> sender.sendMessage(MessageAPI.colorize(message)));
});
} catch (RuntimeException rejected) {
runForCommandSender(sender, () -> sender.sendMessage(MessageAPI.colorize(
"&cUnable to schedule clearing the Discord message ID; no changes made.")));
}
}
private boolean clearDiscordMessageId(TopVoter top) {
var discord = plugin.getDiscordHandler();
return discord != null ? discord.clearTopVoterMessageId(top)
: plugin.getServerData().setTopVoterMessageIdConfirmed(top, 0L);
}
private void loadAdminVoteCommand() {
plugin.setAdminVoteCommand(new ArrayList<>());
com.bencodez.votingplugin.npc.VotingNPCCommands.register(plugin);
DateVoteMilestoneCommands.register(plugin, adminPerm);
plugin.getAdminVoteCommand().add(new CommandHandler(plugin, new String[] { "CurrentPluginTime" },
"VotingPlugin.Commands.AdminVote.CurrentPluginTime|" + adminPerm, "Current plugin time") {
@@ -710,7 +866,7 @@ public class CommandLoader {
@Override
public void executeSinglePlayer(CommandSender sender, String[] args) {
VotingPluginUser user = plugin.getVotingPluginUserManager().getVotingPluginUser(args[1]);
user.cache();
if (!UserStorage.MYSQL.equals(plugin.getStorageType())) user.cache();
user.removePoints(Integer.parseInt(args[3]), removed -> {
if (!removed) {
runForCommandSender(sender, () -> sender.sendMessage(MessageAPI.colorize(
@@ -2814,9 +2970,7 @@ public class CommandLoader {
public void execute(CommandSender sender, String[] args) {
String topVoter = args[1];
TopVoter top = TopVoter.getTopVoter(topVoter);
plugin.getServerData().setTopVoterMessageId(top, 0);
plugin.getDiscordHandler().getTopVoterMessageIds().put(top, 0L);
sendMessage(sender, "&cCleared discord message ID for " + top.toString());
clearDiscordMessageId(sender, top);
}
});
@@ -2970,9 +3124,10 @@ public class CommandLoader {
public void loadAliases() {
commands = new HashMap<>();
aliasCommandNames.clear();
configurePlayerCommand();
// Bukkit registers plugin.yml commands before this loader runs.
if (!plugin.getConfigFile().isLoadCommandAliases()) {
if (!startupLoadCommandAliases) {
unregisterOptionalPluginYMLCommands();
} else {
unregisterDisabledPluginYMLCommands();
@@ -2980,7 +3135,7 @@ public class CommandLoader {
// If false: still wire permissions, but don't wire alias executors/tab
// completers.
final boolean enableAliases = plugin.getConfigFile().isLoadCommandAliases();
final boolean enableAliases = startupLoadCommandAliases;
// ---------------------------
// /vote aliases
@@ -3012,16 +3167,18 @@ public class CommandLoader {
}
registerAdditionalPermissions(Bukkit.getPluginManager(), cmdHandle);
if (argLength > 0) {
if (argLength > 0 && voteCommandEnabled) {
String[] args = cmdHandle.getArgs()[0].split("&");
for (String arg : args) {
String commandName = "vote" + arg;
// A renamed root may equal a synthetic alias absent from plugin.yml.
if (ownedCommand(commandName) == playerRootCommand && playerRootCommand != null) continue;
commands.put(commandName, cmdHandle);
aliasCommandNames.add(commandName.toLowerCase(Locale.ROOT));
try {
PluginCommand command = plugin.getCommand(commandName);
PluginCommand command = ownedCommand(commandName);
if (command == null) {
plugin.devDebug("Command " + commandName + " not found in plugin.yml");
continue;
@@ -3095,11 +3252,13 @@ public class CommandLoader {
for (String arg : args) {
String commandName = "adminvote" + arg;
// A renamed root may equal a synthetic alias absent from plugin.yml.
if (ownedCommand(commandName) == playerRootCommand && playerRootCommand != null) continue;
commands.put(commandName, cmdHandle);
aliasCommandNames.add(commandName.toLowerCase(Locale.ROOT));
try {
PluginCommand command = plugin.getCommand(commandName);
PluginCommand command = ownedCommand(commandName);
if (command == null) {
plugin.devDebug("Command " + commandName + " not found in plugin.yml");
continue;
@@ -3165,8 +3324,8 @@ public class CommandLoader {
|| commandName.equalsIgnoreCase("av")) {
continue;
}
PluginCommand command = plugin.getCommand(commandName);
if (command != null) {
PluginCommand command = ownedCommand(commandName);
if (command != null && command != playerRootCommand) {
unregisterCommand(commandMap, command);
}
}
@@ -3180,8 +3339,8 @@ public class CommandLoader {
try {
CommandMap commandMap = getCommandMap();
for (String commandName : disabledAliasCommandNames) {
PluginCommand command = plugin.getCommand(commandName);
if (command != null) {
PluginCommand command = ownedCommand(commandName);
if (command != null && command != playerRootCommand) {
unregisterCommand(commandMap, command);
}
}
@@ -3193,22 +3352,7 @@ public class CommandLoader {
/** Removes the command and all labels that still point to it from Bukkit's map. */
private void unregisterCommand(CommandMap commandMap, PluginCommand command) throws ReflectiveOperationException {
command.unregister(commandMap);
java.lang.reflect.Field field = null;
Class<?> commandMapClass = commandMap.getClass();
while (commandMapClass != null && field == null) {
try {
field = commandMapClass.getDeclaredField("knownCommands");
} catch (NoSuchFieldException ignored) {
commandMapClass = commandMapClass.getSuperclass();
}
}
if (field == null) {
throw new NoSuchFieldException("knownCommands");
}
field.setAccessible(true);
@SuppressWarnings("unchecked")
Map<String, org.bukkit.command.Command> knownCommands =
(Map<String, org.bukkit.command.Command>) field.get(commandMap);
Map<String, org.bukkit.command.Command> knownCommands = getKnownCommands(commandMap);
Set<String> removedLabels = new HashSet<>();
for (Map.Entry<String, org.bukkit.command.Command> entry : knownCommands.entrySet()) {
if (entry.getValue() == command) {
@@ -3237,6 +3381,27 @@ public class CommandLoader {
}
}
/** Reads the same Bukkit-owned map used by exact-object unregister. */
private Map<String, org.bukkit.command.Command> getKnownCommands(CommandMap commandMap) throws ReflectiveOperationException {
java.lang.reflect.Field field = null;
Class<?> commandMapClass = commandMap.getClass();
while (commandMapClass != null && field == null) {
try {
field = commandMapClass.getDeclaredField("knownCommands");
} catch (NoSuchFieldException ignored) {
commandMapClass = commandMapClass.getSuperclass();
}
}
if (field == null) {
throw new NoSuchFieldException("knownCommands");
}
field.setAccessible(true);
@SuppressWarnings("unchecked")
Map<String, org.bukkit.command.Command> knownCommands =
(Map<String, org.bukkit.command.Command>) field.get(commandMap);
return knownCommands;
}
/** Gets Bukkit's command map without depending on a CraftBukkit package name. */
private CommandMap getCommandMap() throws ReflectiveOperationException {
java.lang.reflect.Method method = plugin.getServer().getClass().getMethod("getCommandMap");
@@ -3300,14 +3465,6 @@ public class CommandLoader {
* Load tab complete.
*/
public void loadTabComplete() {
TabCompleteHandler.getInstance().addTabCompleteOption(new TabCompleteHandle("(npcid)", new ArrayList<>()) {
@Override public void reload() { updateReplacements(); }
@Override public void updateReplacements() {
var manager = plugin.getVotingNPCManager();
setReplace(manager == null ? new ArrayList<>() : new ArrayList<>(manager.definitions().stream()
.map(com.bencodez.votingplugin.npc.VotingNPCDefinition::id).toList()));
}
});
ArrayList<String> sites = new ArrayList<>();
for (VoteSite site : plugin.getVoteSiteManager().getVoteSitesEnabled()) {
sites.add(site.getKey());
@@ -3495,7 +3652,15 @@ public class CommandLoader {
*/
private void loadVoteCommand() {
plugin.setVoteCommand(new ArrayList<>());
plugin.getVoteCommand().add(new CommandHandler(plugin, new String[] { "Help&?" },
plugin.getVoteCommand().add(new CommandHandler(plugin, new String[] { "DateEvents" },
"VotingPlugin.Commands.Vote.DateEvents|" + playerPerm, "View date-window vote milestone progress") {
@Override public void execute(CommandSender sender, String[] args) {
if (sender instanceof Player player) plugin.getDateVoteMilestones().progress(player);
else sender.sendMessage("Run /vote dateevents as a player.");
}
});
plugin.getVoteCommand().add(new CommandHandler(plugin, new String[] { "Help&?" },
"VotingPlugin.Commands.Vote.Help|" + playerPerm, "View help page") {
@Override
@@ -4078,6 +4243,9 @@ public class CommandLoader {
}
}
// Preserve administrator-defined matches ahead of this new fallback.
com.bencodez.votingplugin.streaks.VoteStreaksCommand.register(plugin);
ArrayList<CommandHandler> avCommands = com.bencodez.advancedcore.command.CommandLoader.getInstance()
.getBasicCommands("VotingPlugin");
for (CommandHandler cmd : avCommands) {
@@ -4144,7 +4312,7 @@ public class CommandLoader {
} else if (MessageAPI.startsWithIgnoreCase(slot, "today")) {
new VoteToday(plugin, player, user, 1).open();
} else if (MessageAPI.startsWithIgnoreCase(slot, "help")) {
player.performCommand("vote help");
performVoteCommand(player, "help");
} else if (MessageAPI.startsWithIgnoreCase(slot, "shop")) {
new VoteShop(plugin, player, user).open();
} else if (MessageAPI.startsWithIgnoreCase(slot, "lastmonth")) {
@@ -4153,6 +4321,8 @@ public class CommandLoader {
new VoteBest(plugin, player, user).open();
} else if (MessageAPI.startsWithIgnoreCase(slot, "streak")) {
new VoteStreak(plugin, player, user).open();
} else if (MessageAPI.startsWithIgnoreCase(slot, "streaks")) {
plugin.getVoteStreaksMenu().open(player);
}
}
@@ -0,0 +1,41 @@
package com.bencodez.votingplugin.commands;
import com.bencodez.advancedcore.api.command.CommandHandler;
import com.bencodez.simpleapi.command.TabCompleteHandler;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.specialrewards.datemilestones.DateVoteMilestones.AdminAction;
import org.bukkit.command.CommandSender;
/** Exact-target administration; storage and confirmed completion belong to the manager. */
final class DateVoteMilestoneCommands {
private DateVoteMilestoneCommands() { }
static void register(VotingPluginMain plugin, String adminPermission) {
// The SDK only matches registered variable tokens; its built-in player token also rewrites fuzzy names.
for (String token : new String[] { "(player-id)", "(date-event)", "(vote-count)", "(date-milestone)" })
TabCompleteHandler.getInstance().addTabCompleteOption(token, new java.util.ArrayList<>());
for (AdminAction action : AdminAction.values()) {
String[] arguments = switch (action) {
case Status, Preview -> new String[] { "DateVoteMilestone&DVM", action.name(), "(player-id)", "(date-event)" };
case SetVotes -> new String[] { "DateVoteMilestone&DVM", action.name(), "(player-id)", "(date-event)", "(vote-count)" };
case Force, ForceNoLimits -> new String[] { "DateVoteMilestone&DVM", action.name(), "(player-id)", "(date-event)", "(date-milestone)" };
};
String description = switch (action) {
case Status, Preview -> "Inspect date event counts and reward fences without submitting rewards";
case SetVotes -> "Set date event count (0-4096), preserving receipt IDs and reward fences";
case Force -> "Force selected date milestones, preserving prior submission and uncertain reservation fences";
case ForceNoLimits -> "Repeat submitted date milestones; uncertain reservations remain blocked";
};
CommandHandler handler = new CommandHandler(plugin, arguments,
"VotingPlugin.Commands.AdminVote.DateVoteMilestone." + action.name() + "|" + adminPermission, description) {
@Override public void execute(CommandSender sender, String[] args) {
var manager = plugin.getDateVoteMilestones();
if (manager == null) { sender.sendMessage("Date milestones are unavailable."); return; }
manager.administer(sender, action, args[2], args[3], args.length > 4 ? args[4] : null);
}
};
handler.setAllowMultiplePermissions(true);
plugin.getAdminVoteCommand().add(handler);
}
}
}
@@ -74,7 +74,7 @@ public class CommandAliases implements CommandExecutor {
if (adminCommand) {
sender.sendMessage(MessageAPI.colorize(plugin.getConfigFile().getFormatInvalidCommandAdminVote()));
} else {
sender.sendMessage(MessageAPI.colorize(plugin.getConfigFile().getFormatInvalidCommandVote()));
sender.sendMessage(MessageAPI.colorize(plugin.formatVoteCommandMessage(plugin.getConfigFile().getFormatInvalidCommandVote())));
}
return true;
}
@@ -35,7 +35,7 @@ public class CommandVote implements CommandExecutor {
}
// invalid command
sender.sendMessage(MessageAPI.colorize(plugin.getConfigFile().getFormatInvalidCommandVote()));
sender.sendMessage(MessageAPI.colorize(plugin.formatVoteCommandMessage(plugin.getConfigFile().getFormatInvalidCommandVote())));
return true;
}
@@ -77,16 +77,16 @@ public class AdminVotePerms extends GUIHandler {
for (CommandHandler handle : plugin.getVoteCommand()) {
if (sender instanceof Player) {
if (handle.hasPerm(sender)) {
msg.add("&6" + handle.getHelpLineCommand("/vote") + " : "
msg.add("&6" + handle.getHelpLineCommand(plugin.getVoteCommandPrefix()) + " : "
+ handle.getPerm().split(Pattern.quote("|"))[0] + " : &atrue");
} else {
msg.add("&6" + handle.getHelpLineCommand("/vote") + " : "
msg.add("&6" + handle.getHelpLineCommand(plugin.getVoteCommandPrefix()) + " : "
+ handle.getPerm().split(Pattern.quote("|"))[0] + " : &cfalse");
}
} else {
msg.add(handle.getHelpLineCommand("/vote") + " : " + handle.getPerm().split(Pattern.quote("|"))[0]);
msg.add(handle.getHelpLineCommand(plugin.getVoteCommandPrefix()) + " : " + handle.getPerm().split(Pattern.quote("|"))[0]);
}
addAdditionalPermissions(msg, sender, handle, "/vote");
addAdditionalPermissions(msg, sender, handle, plugin.getVoteCommandPrefix());
}
@@ -164,13 +164,13 @@ public class AdminVotePerms extends GUIHandler {
for (CommandHandler handle : plugin.getVoteCommand()) {
if (handle.hasPerm(p)) {
msg.add("&6" + handle.getHelpLineCommand("/vote") + " : "
msg.add("&6" + handle.getHelpLineCommand(plugin.getVoteCommandPrefix()) + " : "
+ handle.getPerm().split(Pattern.quote("|"))[0] + " : &atrue");
} else {
msg.add("&6" + handle.getHelpLineCommand("/vote") + " : "
msg.add("&6" + handle.getHelpLineCommand(plugin.getVoteCommandPrefix()) + " : "
+ handle.getPerm().split(Pattern.quote("|"))[0] + " : &cfalse");
}
addAdditionalPermissions(msg, p, handle, "/vote");
addAdditionalPermissions(msg, p, handle, plugin.getVoteCommandPrefix());
}
@@ -237,7 +237,7 @@ public class AdminVotePerms extends GUIHandler {
msg.add(" ");
for (CommandHandler handle : plugin.getVoteCommand()) {
msg.add(handle.getHelpLineCommand("/vote"));
msg.add(handle.getHelpLineCommand(plugin.getVoteCommandPrefix()));
msg.add(" " + handle.getPerm());
msg.add(" " + handle.getHelpMessage());
for (String permission : additionalPermissions(handle)) {
@@ -80,7 +80,7 @@ public class AdminVoteTopPoints extends GUIHandler {
LinkedHashMap<TopVoterPlayer, Integer> raw = new LinkedHashMap<>();
for (String uuidString : plugin.getVotingPluginUserManager().getAllUUIDs()) {
UUID uuid = UUID.fromString(uuidString);
VotingPluginUser vpUser = plugin.getVotingPluginUserManager().getVotingPluginUser(uuid);
VotingPluginUser vpUser = plugin.getVotingPluginUserManager().getVotingPluginUser(uuid, true);
vpUser.userDataFetechMode(UserDataFetchMode.NO_CACHE);
int points = vpUser.getPoints();
if (points <= 0) continue;
@@ -0,0 +1,170 @@
package com.bencodez.votingplugin.commands.gui.player;
import java.time.Instant;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.function.BooleanSupplier;
import org.bukkit.Material;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.entity.HumanEntity;
import com.bencodez.advancedcore.api.inventory.BInventory;
import com.bencodez.advancedcore.api.inventory.BInventory.ClickEvent;
import com.bencodez.advancedcore.api.inventory.BInventoryButton;
import com.bencodez.advancedcore.api.item.ItemBuilder;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.core.datemilestones.DateVoteProgressSnapshot;
import com.bencodez.votingplugin.core.datemilestones.DateVoteProgressSnapshot.Availability;
import com.bencodez.votingplugin.core.datemilestones.DateVoteProgressSnapshot.Event;
import com.bencodez.votingplugin.core.datemilestones.DateVoteProgressSnapshot.Milestone;
/** Entity-thread presentation of an immutable storage-worker result. */
public final class DateVoteEventsMenu {
private static final int PAGE_SIZE = 45;
private static final int LIMIT = 64;
private static final String OPEN_GUARD = "DateVoteEventsOpenGuard";
private record OpenGuard(java.util.UUID owner, BooleanSupplier eligible) { }
private static final DateTimeFormatter TIME = DateTimeFormatter.ofPattern("uuuu-MM-dd HH:mm:ss");
private final VotingPluginMain plugin;
private final Player player;
private final DateVoteProgressSnapshot snapshot;
private final BooleanSupplier current;
private DateVoteEventsMenu(VotingPluginMain plugin, Player player, DateVoteProgressSnapshot snapshot,
BooleanSupplier current) {
this.plugin = plugin;
this.player = player;
this.snapshot = snapshot;
this.current = current;
}
public static void open(VotingPluginMain plugin, Player player, DateVoteProgressSnapshot snapshot,
BooleanSupplier current) {
new DateVoteEventsMenu(plugin, player, snapshot, current).list(0);
}
private boolean eligible() {
return current.getAsBoolean() && plugin.isEnabled() && player.isOnline()
&& (player.hasPermission("VotingPlugin.Commands.Vote.DateEvents")
|| player.hasPermission("VotingPlugin.Player"));
}
private BInventory inventory(String title) {
BInventory inventory = new BInventory(title);
inventory.setMaxInvSize(54);
inventory.setPages(false);
inventory.runClicksSync();
inventory.dontClose();
inventory.addData(OPEN_GUARD, new OpenGuard(player.getUniqueId(), this::eligible));
return inventory;
}
/** Called at Bukkit's final InventoryOpenEvent, after AdvancedCore's deferred callback. */
public static boolean permitsOpen(BInventory inventory, HumanEntity viewer) {
Object value = inventory.getData(OPEN_GUARD);
return !(value instanceof OpenGuard guard)
|| guard.owner().equals(viewer.getUniqueId()) && guard.eligible().getAsBoolean();
}
private void list(int page) {
if (!eligible()) return;
List<Event> events = snapshot.events().stream().limit(LIMIT).toList();
BInventory inventory = inventory("Date vote events " + (page + 1) + "/" + pages(events.size()));
int end = Math.min(events.size(), (page + 1) * PAGE_SIZE);
for (int index = page * PAGE_SIZE; index < end; index++) {
Event event = events.get(index);
inventory.addButton(index % PAGE_SIZE, button(Material.PAPER,
event.definition().displayName(), eventLore(event), () -> detail(event, 0, page)));
}
List<String> summary = new ArrayList<>();
if (events.isEmpty()) summary.add("No date vote events configured.");
else if (events.stream().noneMatch(event -> event.definition().enabled()))
summary.add("No enabled date vote events.");
else summary.add("Select an event to view milestones.");
summary.add("Snapshot: " + Instant.ofEpochMilli(snapshot.capturedAt()));
inventory.addButton(49, button(Material.BOOK, "Date vote events", summary, () -> {}));
if (page > 0) inventory.addButton(45, button(Material.ARROW, "Previous page", List.of(), () -> list(page - 1)));
if (end < events.size()) inventory.addButton(53, button(Material.ARROW, "Next page", List.of(), () -> list(page + 1)));
if (eligible()) inventory.openInventory(player);
}
private void detail(Event event, int page, int listPage) {
if (!eligible()) return;
List<Milestone> milestones = event.milestones().stream().limit(LIMIT).toList();
BInventory inventory = inventory("Date vote milestones " + (page + 1) + "/" + pages(milestones.size()));
int end = Math.min(milestones.size(), (page + 1) * PAGE_SIZE);
for (int index = page * PAGE_SIZE; index < end; index++) {
Milestone milestone = milestones.get(index);
List<String> lore = new ArrayList<>();
lore.add("ID: " + milestone.id());
lore.add("Enabled: " + milestone.enabled());
lore.add("Award state: " + event.awardState(milestone.threshold()));
List<String> types = milestone.rewardTypes().stream().limit(LIMIT)
.map(type -> type.matches("[A-Za-z0-9_-]{1,64}") ? type : "Other").distinct().toList();
lore.add("Reward types: " + (types.isEmpty() ? "none" : String.join(", ", types)));
inventory.addButton(index % PAGE_SIZE, button(Material.PAPER, milestone.threshold() + " votes", lore, () -> {}));
}
List<String> summary = eventLore(event);
if (milestones.isEmpty()) summary.add("No milestones configured.");
inventory.addButton(48, button(Material.BOOK, event.definition().displayName(), summary, () -> {}));
inventory.addButton(49, button(Material.ARROW, "Back to events", List.of(), () -> list(listPage)));
if (page > 0) inventory.addButton(45, button(Material.ARROW, "Previous page", List.of(), () -> detail(event, page - 1, listPage)));
if (end < milestones.size()) inventory.addButton(53, button(Material.ARROW, "Next page", List.of(), () -> detail(event, page + 1, listPage)));
if (eligible()) inventory.openInventory(player);
}
private List<String> eventLore(Event event) {
var definition = event.definition();
List<String> lore = new ArrayList<>();
lore.add("ID: " + definition.id());
lore.add("Status: " + event.status(snapshot.capturedAt()));
ZoneId zone = ZoneId.of(definition.timezone());
lore.add("Start: " + TIME.format(Instant.ofEpochMilli(definition.start()).atZone(zone)));
lore.add("End (exclusive): " + TIME.format(Instant.ofEpochMilli(definition.end()).atZone(zone)));
lore.add("Timezone: " + definition.timezone());
if (event.availability() == Availability.OWNED) {
lore.add("Votes: " + event.votes());
lore.add("Next milestone: " + (event.nextThreshold().isPresent() ? event.nextThreshold().getAsInt() + " votes" : "none"));
} else if (event.availability() == Availability.REMOTE) {
lore.add("Progress owned by: " + definition.accountingServer());
lore.add("Progress unavailable on this server.");
} else {
lore.add("Progress unavailable: accounting read failed.");
}
return lore;
}
private static int pages(int size) {
return Math.max(1, (size + PAGE_SIZE - 1) / PAGE_SIZE);
}
private BInventoryButton button(Material material, String name, List<String> lore, Runnable action) {
List<String> lines = List.copyOf(lore);
return new BInventoryButton(new ItemBuilder(material)) {
// ItemBuilder evaluates display Javascript and formatting while rendering. Render only
// the blank material through it, then apply snapshot text literally to Bukkit metadata.
@Override public ItemStack getItem() {
ItemStack item = new ItemBuilder(material).toItemStack();
ItemMeta meta = item.getItemMeta();
if (meta != null) {
meta.setDisplayName(name);
meta.setLore(lines);
item.setItemMeta(meta);
}
return item;
}
@Override public ItemStack getItem(Player ignored) { return getItem(); }
@Override public ItemStack getItem(Player ignored, HashMap<String, String> placeholders) { return getItem(); }
@Override public void onClick(ClickEvent click) {
if (eligible()) action.run();
}
}.dontClose();
}
}
@@ -55,6 +55,7 @@ public class VoteHelp extends GUIHandler {
*/
public ArrayList<TextComponent> helpText(CommandSender sender) {
ArrayList<TextComponent> msg = new ArrayList<>();
if (!plugin.isVoteCommandEnabled()) return msg;
HashMap<String, TextComponent> unsorted = new HashMap<>();
boolean requirePerms = plugin.getConfigFile().isFormatCommandsVoteHelpRequirePermission();
@@ -70,7 +71,7 @@ public class VoteHelp extends GUIHandler {
}
for (CommandHandler cmdHandle : plugin.getVoteCommand()) {
if (!requirePerms || cmdHandle.hasPerm(sender)) {
unsorted.put(cmdHandle.getHelpLineCommand("/vote"), cmdHandle.getHelpLine("/vote",
unsorted.put(cmdHandle.getHelpLineCommand(plugin.getVoteCommandPrefix()), cmdHandle.getHelpLine(plugin.getVoteCommandPrefix(),
plugin.getConfigFile().getFormatCommandsVoteHelpLine(), hoverColor));
}
}
@@ -92,14 +93,15 @@ public class VoteHelp extends GUIHandler {
*/
public ArrayList<TextComponent> helpTextLegacy(CommandSender sender) {
ArrayList<TextComponent> msg = new ArrayList<>();
if (!plugin.isVoteCommandEnabled()) return msg;
HashMap<String, TextComponent> unsorted = new HashMap<>();
boolean requirePerms = plugin.getConfigFile().isFormatCommandsVoteHelpRequirePermission();
for (CommandHandler cmdHandle : plugin.getVoteCommand()) {
if (!requirePerms || cmdHandle.hasPerm(sender)) {
unsorted.put(cmdHandle.getHelpLineCommand("/vote"),
cmdHandle.getHelpLine("/vote", plugin.getConfigFile().getFormatCommandsVoteHelpLine()));
unsorted.put(cmdHandle.getHelpLineCommand(plugin.getVoteCommandPrefix()),
cmdHandle.getHelpLine(plugin.getVoteCommandPrefix(), plugin.getConfigFile().getFormatCommandsVoteHelpLine()));
}
}
ArrayList<String> unsortedList = new ArrayList<>();
@@ -60,7 +60,7 @@ public class VoteToday extends GUIHandler {
Player clicked = player.getServer().getPlayer(payload.owner());
if (clicked != null) {
VotingPluginUser clickedUser = plugin.getVotingPluginUserManager()
.getVotingPluginUser(uuid);
.getVotingPluginUser(uuid, true);
new VoteGUI(plugin, clicked, clickedUser).open(
GUIMethod.valueOf(plugin.getGui().getGuiMethodGUI().toUpperCase()));
}
@@ -161,7 +161,7 @@ public class VoteToday extends GUIHandler {
inv.addButton(inv.getNextSlot(), new BInventoryButton(item) {
@Override
public void onClick(ClickEvent clickEvent) {
VotingPluginUser user = plugin.getVotingPluginUserManager().getVotingPluginUser(uuid);
VotingPluginUser user = plugin.getVotingPluginUserManager().getVotingPluginUser(uuid, true);
new VoteGUI(plugin, player, user)
.open(GUIMethod.valueOf(plugin.getGui().getGuiMethodGUI().toUpperCase()));
}
@@ -51,7 +51,7 @@ public class VoteTopVoter extends GUIHandler {
String topVoter = top.getName();
@SuppressWarnings("unchecked")
LinkedHashMap<TopVoterPlayer, Integer> topVotes = (LinkedHashMap<TopVoterPlayer, Integer>) plugin.getTopVoter(top)
LinkedHashMap<TopVoterPlayer, Integer> topVotes = (LinkedHashMap<TopVoterPlayer, Integer>) plugin.getTopVoterDisplay(top)
.clone();
com.bencodez.simpleapi.dialog.MultiActionDialogBuilder dialog = plugin.getDialogService().multiAction(player)
@@ -148,7 +148,7 @@ public class VoteTopVoter extends GUIHandler {
String topVoter = top.getName();
@SuppressWarnings("unchecked")
LinkedHashMap<TopVoterPlayer, Integer> topVotes = (LinkedHashMap<TopVoterPlayer, Integer>) plugin
.getTopVoter(top).clone();
.getTopVoterDisplay(top).clone();
users = topVotes.entrySet();
ConfigurationSection customization = plugin.getGui().getChestVoteTopCustomization();
@@ -31,7 +31,7 @@ public class VoteTopVoterLastMonth extends GUIHandler {
@Override
public void onDialog(Player player) {
Set<Entry<TopVoterPlayer, Integer>> users = plugin.getLastMonthTopVoter().entrySet();
Set<Entry<TopVoterPlayer, Integer>> users = plugin.getLastMonthTopVoterDisplay().entrySet();
com.bencodez.simpleapi.dialog.MultiActionDialogBuilder dialog = plugin.getDialogService().multiAction(player)
.placeholder("player", user.getPlayerName())
@@ -91,7 +91,7 @@ public class VoteTopVoterLastMonth extends GUIHandler {
public void onChest(Player player) {
Set<Entry<TopVoterPlayer, Integer>> users = null;
users = plugin.getLastMonthTopVoter().entrySet();
users = plugin.getLastMonthTopVoterDisplay().entrySet();
BInventory inv = new BInventory(plugin.getGui().getChestVoteTopName());
inv.addPlaceholder("topvoter", "Last Month");
@@ -60,7 +60,7 @@ public class VoteTopVoterPreviousMonths extends GUIHandler {
return;
}
Set<Entry<TopVoterPlayer, Integer>> users = plugin.getPreviousMonthsTopVoters().get(yearMonth).entrySet();
Set<Entry<TopVoterPlayer, Integer>> users = plugin.getPreviousMonthTopVoterDisplay(yearMonth).entrySet();
com.bencodez.simpleapi.dialog.MultiActionDialogBuilder dialog = plugin.getDialogService().multiAction(player)
.placeholder("player", user.getPlayerName())
@@ -160,7 +160,7 @@ public class VoteTopVoterPreviousMonths extends GUIHandler {
player.sendMessage(ChatColor.RED + "Can't open previous months, no data");
return;
}
users = plugin.getPreviousMonthsTopVoters().get(yearMonth).entrySet();
users = plugin.getPreviousMonthTopVoterDisplay(yearMonth).entrySet();
BInventory inv = new BInventory(plugin.getGui().getChestVoteTopName());
inv.addPlaceholder("topvoter", yearMonth.toString());
@@ -177,7 +177,7 @@ public class VoteURL extends GUIHandler {
}
if (plugin.getGui().isChestVoteURLBackButton()) {
dialog.button("&eBack", "&7Return to previous menu", payload -> player.performCommand("vote gui"));
dialog.button("&eBack", "&7Return to previous menu", payload -> plugin.getCommandLoader().performVoteCommand(player, "gui"));
}
dialog.open();
@@ -24,9 +24,6 @@ import com.bencodez.votingplugin.topvoter.TopVoter;
import lombok.Getter;
public class Config extends YMLFile {
/** Opt-in persistent vanilla voting NPCs; missing configuration preserves legacy behavior. */
public boolean isVotingNPCsEnabled() { return getData().getBoolean("VotingNPCs.Enabled", false); }
/** Explicit permission for executable deployment over private-network plaintext HTTP. */
public boolean getControlAllowInsecureHttpPluginDeployment() {
@@ -525,6 +522,15 @@ public class Config extends YMLFile {
@Getter
private boolean limitMonthlyVotes = false;
/** Restart-only player command registration. Missing keys preserve /vote. */
@ConfigDataBoolean(path = "VoteCommandEnabled", defaultValue = true)
@Getter
private boolean voteCommandEnabled = true;
@ConfigDataString(path = "VoteCommandName", defaultValue = "vote")
@Getter
private String voteCommandName = "vote";
@ConfigDataBoolean(path = "LoadCommandAliases")
@Getter
private boolean loadCommandAliases = true;
@@ -803,6 +809,10 @@ public class Config extends YMLFile {
@Getter
private boolean topVoterAwardsTies = true;
@ConfigDataBoolean(path = "HideTopVoterIfNotPlayedBefore")
@Getter
private boolean hideTopVoterIfNotPlayedBefore = false;
@ConfigDataBoolean(path = "TopVoterIgnorePermission")
@Getter
private boolean topVoterIgnorePermission = false;
@@ -26,6 +26,10 @@ import lombok.Getter;
*/
public class GUI extends YMLFile {
@ConfigDataString(path = "CHEST.VoteStreaks.Name")
@Getter
private String chestVoteStreaksName = "&6Vote streaks";
@ConfigDataString(path = "BOOK.VoteURLBookGUI.AlreadyVotedColor")
@Getter
private String bookVoteURLBookGUIAlreadyVotedColor = "RED";
@@ -11,10 +11,13 @@ import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import com.bencodez.advancedcore.api.rewards.Reward;
import com.bencodez.advancedcore.api.rewards.RewardOptions;
import com.bencodez.advancedcore.api.user.AdvancedCoreUser;
import com.bencodez.advancedcore.api.user.UserDataFetchMode;
@@ -36,12 +39,14 @@ public class CoolDownCheck implements Listener {
private final VotingPluginMain plugin;
private final Map<UUID, ScheduledFuture<?>> perSiteTasks = new ConcurrentHashMap<>();
private final Map<UUID, Object> perSiteGenerations = new ConcurrentHashMap<>();
private final Map<UUID, ScheduledFuture<?>> allSiteTasks = new ConcurrentHashMap<>();
@Getter
private final ScheduledExecutorService timer;
private volatile boolean cooldownCheckEnabled = false;
private volatile boolean stopped = false;
/**
* Constructs a new cooldown check manager.
@@ -74,6 +79,8 @@ public class CoolDownCheck implements Listener {
* Shuts down the cooldown check timer.
*/
public void shutdown() {
stopped = true;
perSiteGenerations.clear();
timer.shutdownNow();
for (ScheduledFuture<?> f : perSiteTasks.values()) {
@@ -147,6 +154,7 @@ public class CoolDownCheck implements Listener {
user.updateTempCacheWithColumns(cols);
cols.clear(); // help GC (only useful if reused)
}
capturePlayerName(user);
checkPerSite(site, user);
} finally {
@@ -219,13 +227,20 @@ public class CoolDownCheck implements Listener {
* Site-specific version used by batch checks / checkAllVoteSite.
*/
private void checkPerSite(VoteSite site, VotingPluginUser user) {
checkPerSite(site, user, null);
}
private HashMap<String, Boolean> checkPerSite(VoteSite site, VotingPluginUser user,
HashMap<String, Boolean> coolDownChecks) {
if (!plugin.getConfigFile().isPerSiteCoolDownEvents() || site == null) {
return;
return coolDownChecks;
}
HashMap<String, Boolean> coolDownChecks = user.getCoolDownCheckSiteList();
if (coolDownChecks == null) {
coolDownChecks = user.getCoolDownCheckSiteList();
}
if (Boolean.TRUE.equals(coolDownChecks.get(site.getKey()))) {
return;
return coolDownChecks;
}
if (user.canVoteSite(site)) {
@@ -237,6 +252,7 @@ public class CoolDownCheck implements Listener {
PlayerVoteSiteCoolDownEndEvent event = new PlayerVoteSiteCoolDownEndEvent(user, site);
plugin.getServer().getPluginManager().callEvent(event);
}
return coolDownChecks;
}
/**
@@ -267,8 +283,8 @@ public class CoolDownCheck implements Listener {
*/
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
public void onCoolDownEnd(PlayerVoteCoolDownEndEvent event) {
plugin.getRewardHandler().giveReward(event.getPlayer(), plugin.getSpecialRewardsConfig().getData(),
"VoteCoolDownEndedReward", new RewardOptions());
dispatchCooldownReward(event.getPlayer(), plugin.getSpecialRewardsConfig().getData(),
"VoteCoolDownEndedReward", "all", new RewardOptions());
}
/**
@@ -278,11 +294,73 @@ public class CoolDownCheck implements Listener {
*/
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
public void onCoolDownEnd(PlayerVoteSiteCoolDownEndEvent event) {
plugin.getRewardHandler().giveReward(event.getPlayer(), event.getSite().getSiteData(), "CoolDownEndRewards",
new RewardOptions().addPlaceholder("sitename", event.getSite().getDisplayName())
dispatchCooldownReward(event.getPlayer(), event.getSite().getSiteData(), "CoolDownEndRewards",
"site:" + event.getSite().getKey(), new RewardOptions()
.addPlaceholder("sitename", event.getSite().getDisplayName())
.addPlaceholder("url", event.getSite().getVoteURL(false)));
}
private void dispatchCooldownReward(VotingPluginUser user, ConfigurationSection data, String path,
String site, RewardOptions options) {
boolean configured = false;
try {
configured = hasConfiguredCooldownReward(data, path);
} catch (RuntimeException ignored) {
// Preserve legacy dispatch even when diagnostic configuration inspection fails.
}
if (!configured) {
plugin.getRewardHandler().giveReward(user, data, path, options);
return;
}
String occurrence = UUID.randomUUID().toString();
String player = user.getUUID();
String safeSite = String.valueOf(site).replaceAll("[\\r\\n\\p{Cntrl}]", "?");
long time = System.currentTimeMillis();
String context = " occurrence=" + occurrence + " player=" + player + " site=" + safeSite + " time=" + time;
logCooldownDiagnostic(false, "Cooldown reward status=attempted" + context);
options.setAsyncFailureObserver(failure -> logCooldownFailure(context, failure));
try {
plugin.getRewardHandler().giveReward(user, data, path, options);
} catch (RuntimeException | Error failure) {
logCooldownFailure(context, failure);
throw failure;
}
}
private boolean hasConfiguredCooldownReward(ConfigurationSection data, String path) {
if (data == null) return false;
if (data instanceof FileConfiguration) {
return plugin.getRewardHandler().hasRewards((FileConfiguration) data, path);
}
if (data.isList(path)) return !data.getList(path, new ArrayList<>()).isEmpty();
if (data.isConfigurationSection(path)) return !data.getConfigurationSection(path).getKeys(false).isEmpty();
return data.isString(path) && !data.getString(path, "").isEmpty();
}
private void logCooldownFailure(String context, Throwable failure) {
int completed = -1;
Throwable current = failure;
for (int depth = 0; current != null && depth < 32; depth++, current = current.getCause()) {
if (current instanceof Reward.RewardReplayFailure) {
completed = ((Reward.RewardReplayFailure) current).getCompletedInjectionCount();
break;
}
}
String error = failure == null ? "unknown" : failure.getClass().getSimpleName();
logCooldownDiagnostic(true, "Cooldown reward outcome=unknown/partial" + context + " error=" + error
+ " completedInjections=" + (completed < 0 ? "unknown" : completed)
+ "; inspect effects before reissuing");
}
private void logCooldownDiagnostic(boolean warning, String message) {
try {
if (warning) plugin.getLogger().warning(message);
else plugin.getLogger().info(message);
} catch (RuntimeException ignored) {
// A broken logger must not suppress or retry the reward.
}
}
/**
* Schedules a cooldown check for a user.
*
@@ -324,7 +402,7 @@ public class CoolDownCheck implements Listener {
* @param force whether to force the schedule
*/
public void schedulePerSite(VotingPluginUser user, boolean force) {
if (!plugin.getConfigFile().isPerSiteCoolDownEvents()) {
if (stopped || !plugin.getConfigFile().isPerSiteCoolDownEvents()) {
return;
}
@@ -333,6 +411,7 @@ public class CoolDownCheck implements Listener {
}
final UUID uuid = user.getJavaUUID();
final String scheduledName = user.getPlayerName();
final NextSite next = user.getNextSiteAvailable();
@@ -340,8 +419,13 @@ public class CoolDownCheck implements Listener {
if (existing != null) {
existing.cancel(false);
}
if (stopped) {
perSiteGenerations.remove(uuid);
return null;
}
if (next == null || next.getSite() == null || next.getSecondsUntilAvailable() <= 0) {
perSiteGenerations.remove(uuid);
plugin.extraDebug(user.getUUID() + "/" + user.getPlayerName() + " not scheduling per-site cooldown check");
return null; // remove entry
}
@@ -349,21 +433,60 @@ public class CoolDownCheck implements Listener {
plugin.devDebug("PerSiteCoolDownEvent schedule: site=" + next.getSite().getKey() + " time="
+ next.getSecondsUntilAvailable() + " seconds");
return timer.schedule(() -> {
if (!plugin.isEnabled()) {
return;
}
// Only check the next site; this will set the cooldown-end flag + fire event if ready
checkPerSite(next.getSite(), user);
// Schedule the following site (if any)
schedulePerSite(user, false);
}, next.getSecondsUntilAvailable() + 2, TimeUnit.SECONDS);
Object generation = new Object();
perSiteGenerations.put(uuid, generation);
try {
return timer.schedule(() -> runPerSiteTimer(uuid, scheduledName, next, generation, 0),
next.getSecondsUntilAvailable() + 2, TimeUnit.SECONDS);
} catch (RuntimeException | Error failure) {
perSiteGenerations.remove(uuid, generation);
throw failure;
}
});
}
private void runPerSiteTimer(UUID uuid, String scheduledName, NextSite next, Object generation, int retries) {
if (stopped || !plugin.isEnabled() || perSiteGenerations.get(uuid) != generation) return;
UUID occurrence = UUID.randomUUID();
boolean[] retried = { false };
try {
VotingPluginUser current;
try {
// The batch user's temporary row may have been cleared or replaced by a newer vote.
current = plugin.getVotingPluginUserManager().getVotingPluginUser(uuid, false);
if (!current.isCached()) current.userDataFetechMode(UserDataFetchMode.NO_CACHE);
String storedName = current.getData().getString("PlayerName", current.getUserDataFetchMode());
String name = storedName != null && !storedName.isBlank() ? storedName : scheduledName;
if (name != null && !name.isBlank()) current.setPlayerName(name);
} catch (RuntimeException refreshFailure) {
if (retries < 3) {
perSiteTasks.compute(uuid, (key, existing) -> {
if (stopped || !plugin.isEnabled() || perSiteGenerations.get(uuid) != generation) return existing;
ScheduledFuture<?> retry = timer.schedule(
() -> runPerSiteTimer(uuid, scheduledName, next, generation, retries + 1),
30, TimeUnit.SECONDS);
retried[0] = true;
return retry;
});
if (retried[0]) return;
}
throw refreshFailure;
}
if (perSiteGenerations.get(uuid) != generation) return;
checkPerSite(next.getSite(), current);
if (perSiteGenerations.get(uuid) == generation) schedulePerSite(current, false);
} catch (RuntimeException | Error failure) {
String siteKey = String.valueOf(next.getSite().getKey()).replaceAll("[\\r\\n\\p{Cntrl}]", "?");
logCooldownDiagnostic(true, "Cooldown timer failed: occurrence=" + occurrence + " player=" + uuid
+ " site=" + siteKey + " time=" + System.currentTimeMillis() + " error="
+ failure.getClass().getSimpleName() + "; reward outcome is uncertain; inspect effects before reissuing");
throw failure;
} finally {
if (!retried[0]) perSiteGenerations.remove(uuid, generation);
}
}
/**
* Handles a vote event for cooldown scheduling.
*
@@ -381,6 +504,14 @@ public class CoolDownCheck implements Listener {
}
}
/** Preserve the name needed by asynchronous rewards after the temporary row is cleared. */
private static void capturePlayerName(VotingPluginUser user) {
String name = user.getPlayerName();
if (name != null && !name.isBlank()) {
user.setPlayerName(name);
}
}
/**
* Performance-optimized: scan users ONCE, process all daily-delay sites.
*/
@@ -421,9 +552,11 @@ public class CoolDownCheck implements Listener {
user.updateTempCacheWithColumns(cols);
cols.clear();
}
capturePlayerName(user);
HashMap<String, Boolean> coolDownChecks = null;
for (int i = 0; i < dailySites.size(); i++) {
checkPerSite(dailySites.get(i), user);
coolDownChecks = checkPerSite(dailySites.get(i), user, coolDownChecks);
}
check(user);
@@ -0,0 +1,64 @@
package com.bencodez.votingplugin.core.datemilestones;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.security.MessageDigest;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.HexFormat;
import java.util.List;
import java.util.Set;
/** Immutable owner-defined event accounting contract; display text is not identity. */
public record DateVoteEvent(String id, String displayName, boolean enabled, long start, long end,
String timezone, List<Integer> thresholds, Set<String> sites, String accountingServer) {
public DateVoteEvent {
if (id == null || !id.matches("[A-Za-z0-9_-]{1,64}")) throw new IllegalArgumentException("Invalid event ID");
if (start <= 0 || end <= start) throw new IllegalArgumentException("End must be after start");
ZoneId.of(timezone);
if (thresholds.isEmpty() || thresholds.size() > 64 || thresholds.stream().anyMatch(n -> n <= 0 || n > 4096)
|| thresholds.stream().distinct().count() != thresholds.size()) throw new IllegalArgumentException("Invalid thresholds (1–4096, unique, max 64)");
thresholds = thresholds.stream().sorted().toList();
if (sites.size() > 100 || sites.stream().anyMatch(s -> s == null || s.length() > 128 || s.isBlank()))
throw new IllegalArgumentException("Invalid site filters");
sites = Set.copyOf(sites);
if (accountingServer == null || accountingServer.length() > 128) throw new IllegalArgumentException("Invalid accounting server");
if (displayName == null || displayName.length() > 256) throw new IllegalArgumentException("Invalid display name");
}
public boolean matches(long occurredAt, String site, boolean real, boolean proxy, String server) {
return enabled && real && occurredAt >= start && occurredAt < end && (sites.isEmpty() || sites.contains(site))
&& (!proxy || !accountingServer.isBlank() && accountingServer.equals(server));
}
public String fingerprint() {
try {
var bytes = new ByteArrayOutputStream();
try (var data = new DataOutputStream(bytes)) {
data.writeLong(start); data.writeLong(end); data.writeUTF(timezone);
data.writeInt(thresholds.size());
for (int threshold : thresholds) data.writeInt(threshold);
data.writeInt(sites.size());
for (String site : sites.stream().sorted().toList()) data.writeUTF(site);
data.writeUTF(accountingServer);
}
return hash(bytes.toByteArray());
} catch (java.io.IOException impossible) { throw new IllegalStateException(impossible); }
}
/** Portable case-sensitive identity, including on case-insensitive filesystems. */
public String fileId() { return fileId(id); }
public static String fileId(String id) {
if (id == null || !id.matches("[A-Za-z0-9_-]{1,64}")) throw new IllegalArgumentException("Invalid event ID");
return hash(id.getBytes(StandardCharsets.UTF_8));
}
private static String hash(byte[] bytes) {
try { return HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256").digest(bytes)); }
catch (java.security.NoSuchAlgorithmException impossible) { throw new IllegalStateException(impossible); }
}
public static long timestamp(String localIso, String timezone) {
LocalDateTime time = LocalDateTime.parse(localIso);
ZoneId zone = ZoneId.of(timezone);
if (zone.getRules().getValidOffsets(time).size() != 1)
throw new IllegalArgumentException("Ambiguous/nonexistent local time; choose an unambiguous boundary");
return time.atZone(zone).toInstant().toEpochMilli();
}
}
@@ -0,0 +1,36 @@
package com.bencodez.votingplugin.core.datemilestones;
import java.util.List;
import java.util.OptionalInt;
import java.util.Set;
/** Immutable worker result; viewing this snapshot never mutates accounting or rewards. */
public record DateVoteProgressSnapshot(long capturedAt, List<Event> events) {
public DateVoteProgressSnapshot { events = List.copyOf(events); }
public enum Availability { OWNED, REMOTE, UNAVAILABLE }
public record Milestone(int threshold, String id, boolean enabled, List<String> rewardTypes) {
public Milestone { rewardTypes = List.copyOf(rewardTypes); }
}
public record Event(DateVoteEvent definition, Availability availability, int votes,
Set<Integer> submitted, Set<Integer> deferred, Set<Integer> reserved, List<Milestone> milestones) {
public Event {
submitted = Set.copyOf(submitted); deferred = Set.copyOf(deferred); reserved = Set.copyOf(reserved);
milestones = List.copyOf(milestones);
}
public String status(long now) {
return !definition.enabled() ? "disabled" : now < definition.start() ? "upcoming"
: now >= definition.end() ? "ended" : "active";
}
public OptionalInt nextThreshold() {
return availability == Availability.OWNED ? milestones.stream().filter(m -> m.enabled() && m.threshold() > votes)
.mapToInt(Milestone::threshold).min() : OptionalInt.empty();
}
public String awardState(int threshold) {
if (availability != Availability.OWNED) return "progress unavailable";
if (reserved.contains(threshold)) return "pending review";
if (submitted.contains(threshold)) return "submitted";
if (deferred.contains(threshold)) return "deferred";
return votes >= threshold ? "reached" : "not reached";
}
}
}
@@ -0,0 +1,127 @@
package com.bencodez.votingplugin.core.maintenance;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
/**
* Cumulative active-runtime clock for the owner-facing auto-create setup reminder.
* This class performs no persistence or notification. One owned worker must
* serialize the entire propose, persist, commit, then notify sequence, including
* reload and shutdown checkpoints. Method synchronization alone does not serialize
* the external persistence step. Only notify after a successful commit.
*
* <p>Reconstruct this state from its durable snapshot and a fresh monotonic clock
* reading on startup; never persist the process-local clock anchor. Samples must
* be less than {@link Long#MAX_VALUE} nanoseconds apart (the normal nanoTime elapsed
* time contract). Negative clock readings and signed clock wrap are supported.
*/
public final class AutoCreateVoteSitesReminderState {
public static final long NEVER_REMINDED = -1;
/** The first reminder is emitted on the first active checkpoint. */
public static final long DEFAULT_THRESHOLD_MILLIS = 0;
/** Subsequent reminders are bounded to one every 48 active hours. */
public static final long DEFAULT_REPEAT_MILLIS = TimeUnit.HOURS.toMillis(48);
public static final long MAX_INTERVAL_MILLIS = Long.MAX_VALUE / 1_000_000;
private static final long NANOS_PER_MILLI = 1_000_000;
/** Immutable durable data; a reminder marker must refer to accrued runtime. */
public record Snapshot(long totalRuntimeMillis, long lastReminderRuntimeMillis) {
public Snapshot {
if (totalRuntimeMillis < 0 || lastReminderRuntimeMillis < NEVER_REMINDED
|| lastReminderRuntimeMillis > totalRuntimeMillis) {
throw new IllegalArgumentException("Invalid reminder runtime snapshot");
}
}
}
/**
* A tentative checkpoint, valid only until this state commits any candidate.
* Persist {@link #snapshot()} before committing; discard on a failed write and
* propose again. Creating or discarding candidates changes no committed state.
*/
public static final class Candidate {
private final Object epoch;
private final Snapshot snapshot;
private final long checkpointNanos;
private final boolean reminderDue;
private Candidate(Object epoch, Snapshot snapshot, long checkpointNanos, boolean reminderDue) {
this.epoch = epoch;
this.snapshot = snapshot;
this.checkpointNanos = checkpointNanos;
this.reminderDue = reminderDue;
}
public Snapshot snapshot() {
return snapshot;
}
public boolean reminderDue() {
return reminderDue;
}
}
private Snapshot snapshot;
private long checkpointNanos;
private Object epoch = new Object();
public AutoCreateVoteSitesReminderState(Snapshot snapshot, long nowNanos) {
this.snapshot = Objects.requireNonNull(snapshot, "snapshot");
this.checkpointNanos = nowNanos;
}
public synchronized Snapshot snapshot() {
return snapshot;
}
/**
* Accrue runtime regardless of either flag. Both flags are required to propose a
* reminder, at the inclusive threshold or repeat boundary. Settings are sampled
* for each proposal; changing them does not reset accumulated runtime or markers.
* Backward samples accrue nothing and leave the clock anchor unchanged.
*/
public synchronized Candidate propose(long nowNanos, boolean reminderEnabled, boolean autoCreateEnabled,
long thresholdMillis, long repeatMillis) {
validateInterval(thresholdMillis);
validateInterval(repeatMillis);
if (repeatMillis == 0) {
throw new IllegalArgumentException("Reminder repeat interval must be positive");
}
long elapsedNanos = nowNanos - checkpointNanos;
long elapsedMillis = elapsedNanos > 0 ? elapsedNanos / NANOS_PER_MILLI : 0;
long total = saturatingAdd(snapshot.totalRuntimeMillis(), elapsedMillis);
long lastReminder = snapshot.lastReminderRuntimeMillis();
boolean due = reminderEnabled && autoCreateEnabled && total >= thresholdMillis
&& (lastReminder == NEVER_REMINDED || total - lastReminder >= repeatMillis);
Snapshot next = new Snapshot(total, due ? total : lastReminder);
// Consume only whole milliseconds so frequent checkpoints do not lose time.
long nextCheckpoint = checkpointNanos + elapsedMillis * NANOS_PER_MILLI;
return new Candidate(epoch, next, nextCheckpoint, due);
}
/**
* Publish a checkpoint only after its durable write succeeded. A successful
* commit invalidates every other candidate from that epoch, including this one.
* Foreign, stale, or duplicate candidates are rejected without changing state.
*/
public synchronized void commit(Candidate candidate) {
Objects.requireNonNull(candidate, "candidate");
if (candidate.epoch != epoch) {
throw new IllegalArgumentException("Candidate is not current for this reminder state");
}
snapshot = candidate.snapshot;
checkpointNanos = candidate.checkpointNanos;
epoch = new Object();
}
private static void validateInterval(long millis) {
if (millis < 0 || millis > MAX_INTERVAL_MILLIS) {
throw new IllegalArgumentException("Reminder interval is outside the supported range");
}
}
private static long saturatingAdd(long total, long elapsed) {
return elapsed > Long.MAX_VALUE - total ? Long.MAX_VALUE : total + elapsed;
}
}
@@ -1,7 +1,5 @@
package com.bencodez.votingplugin.core.vote;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.UUID;
/** The accepted vote sequence. Platform operations are supplied by the receiving adapter. */
@@ -67,12 +65,15 @@ public final class SharedVoteProcessor {
boolean forceProxyRouting();
boolean wasOnline();
boolean realVote();
default long currentTimeMillis() { return System.currentTimeMillis(); }
boolean addTotals();
boolean broadcastEnabled();
boolean hasBroadcastHandler();
void broadcast(UUID uuid, String name, String siteDisplayName, boolean online);
boolean hasProxyTextTotals();
UUID proxyVoteId();
/** Local receipt identity, without implying proxy provenance. */
default UUID localOccurrenceId() { return null; }
default boolean identifiedQueuedProxyVote() { return false; }
default boolean proxyQueueClassificationKnown() { return false; }
default boolean proxyDelayValidationKnown() { return false; }
@@ -105,6 +106,7 @@ public final class SharedVoteProcessor {
int enabledSiteCount();
void setMonthTotal(U user, int total);
void milestones(U user, UUID voteId, boolean forceProxyRouting);
default void dateMilestones(U user, S site, long voteTime, UUID voteId) { }
void cooldown(U user, S site);
void voteStreak(U user, long voteTime, UUID voteId);
void postVote(S site, U user, String playerName, long voteTime, UUID voteId, boolean cached);
@@ -186,10 +188,8 @@ public final class SharedVoteProcessor {
+ (legacyRecordedProxyVote ? "; legacy timestamp matches LastVotes: " + ops.incomingTime()
: "; stable vote ID identifies this queued delivery: " + ops.proxyVoteId()));
}
UUID voteId = UUID.randomUUID();
if (ops.proxyVote() && ops.proxyVoteId() != null) {
voteId = ops.proxyVoteId();
}
UUID voteId = ops.proxyVote() ? ops.proxyVoteId() : ops.localOccurrenceId();
if (voteId == null) voteId = UUID.randomUUID();
String userId = ops.userId(user);
ops.cache(user);
ops.updateName(user);
@@ -217,7 +217,7 @@ public final class SharedVoteProcessor {
voteTime = ops.incomingTime();
} else {
ops.setTimeNow(user, site);
voteTime = LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli();
voteTime = ops.currentTimeMillis();
}
boolean cached = false;
if (SharedVoteDelivery.shouldDeliverNow(ops::proxyVote, () -> ops.userOnline(user),
@@ -251,6 +251,7 @@ public final class SharedVoteProcessor {
}
}
ops.milestones(user, voteId, ops.forceProxyRouting());
ops.dateMilestones(user, site, voteTime, voteId);
ops.cooldown(user, site);
ops.voteStreak(user, voteTime, voteId);
ops.postVote(site, user, playerName, voteTime, voteId, cached);
@@ -0,0 +1,247 @@
package com.bencodez.votingplugin.data;
import java.io.File;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.function.Consumer;
import java.util.function.Supplier;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.plugin.Plugin;
import com.bencodez.advancedcore.api.time.TimeType;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.util.ServerDataPublicationFence;
/**
* Routes SDK publications through this generation's ownership lease. The SDK's
* original file/configuration remains authoritative; no YAML snapshot is copied.
*/
public final class GenerationFencedServerDataFile extends com.bencodez.advancedcore.data.ServerData {
private final com.bencodez.advancedcore.data.ServerData delegate;
private final ServerDataPublicationFence fence;
private final VotingPluginMain ownerPlugin;
public GenerationFencedServerDataFile(VotingPluginMain plugin,
com.bencodez.advancedcore.data.ServerData delegate, ServerDataPublicationFence fence) {
super(plugin);
this.ownerPlugin = java.util.Objects.requireNonNull(plugin);
this.delegate = java.util.Objects.requireNonNull(delegate);
this.fence = java.util.Objects.requireNonNull(fence);
}
public boolean wraps(com.bencodez.advancedcore.data.ServerData file) { return delegate == file; }
public boolean belongsTo(ServerDataPublicationFence owner) { return fence == owner; }
/** Checkpoint callers use the same monitor as native final publication. */
@Override public Object publicationMonitor() {
return java.util.Objects.requireNonNull(delegate.publicationMonitor(), "Server-data publication monitor");
}
private void withOwner(Runnable operation) {
try (var lease = fence.acquire()) {
synchronized (publicationMonitor()) {
try { operation.run(); }
catch (RuntimeException | Error failure) {
try { refreshVotePartyDisplay(); }
catch (RuntimeException | Error observationFailure) {
if (observationFailure != failure) failure.addSuppressed(observationFailure);
}
throw failure;
}
refreshVotePartyDisplay();
}
}
}
private <T> T withOwnedValue(Supplier<T> operation) {
try (var lease = fence.acquire()) {
synchronized (publicationMonitor()) { return operation.get(); }
}
}
@Override public FileConfiguration getData() { return delegate.getData(); }
@Override public File getdFile() { return delegate.getdFile(); }
@Override public JavaPlugin getPlugin() { return delegate.getPlugin(); }
@Override public boolean isJustCreated() { return delegate.isJustCreated(); }
@Override public boolean isFailedToRead() { return delegate.isFailedToRead(); }
@Override public boolean isIgnoreCase() { return delegate.isIgnoreCase(); }
@Override public void setIgnoreCase(boolean value) {
withOwner(() -> delegate.setIgnoreCase(value));
}
@Override public void createSection(String path) {
mutateOrdinaryData(data -> data.createSection(path));
}
@Override public void setData(FileConfiguration data) {
withOwner(() -> delegate.setData(data));
}
@Override public void setValue(String path, Object value) {
mutateOrdinaryData(data -> data.set(path, value));
}
@Override public void onFileCreation() {
withOwner(delegate::onFileCreation);
}
@Override public void setup() {
withOwner(delegate::setup);
}
@Override public void loadValues() {
withOwner(delegate::loadValues);
}
@Override public void reloadData() {
withOwner(delegate::reloadData);
}
private void refreshVotePartyDisplay() {
var wrapper = ownerPlugin.getServerData();
if (wrapper != null) {
synchronized (publicationMonitor()) {
if (delegate.getData() != null) wrapper.refreshVotePartyDisplay();
}
}
}
@Override public void saveData() {
withOwner(() -> {
refreshVotePartyDisplay();
delegate.saveData();
});
}
@Override public void saveDataChecked() {
withOwner(() -> {
refreshVotePartyDisplay();
delegate.saveDataChecked();
});
}
@Override protected void saveTimeChangeTransitionData() { saveDataChecked(); }
@Override public void mutateOrdinaryData(Consumer<FileConfiguration> mutation) {
// Delegate admission, live mutation and saving to the actual SDK owner.
// The projection is published inside that owner's callback before I/O.
withOwner(() -> delegate.mutateOrdinaryData(data -> applyOwnedMutation(mutation, data)));
}
private void refreshIfLiveMutation(FileConfiguration data) {
var wrapper = ownerPlugin.getServerData();
if (wrapper == null) return;
synchronized (publicationMonitor()) {
// Native final publication mutates a staged candidate first. Legacy
// adapters may instead mutate the live owner before their save.
if (data == delegate.getData()) wrapper.refreshVotePartyDisplay();
}
}
private void applyOwnedMutation(Consumer<FileConfiguration> mutation, FileConfiguration data) {
try { mutation.accept(data); }
catch (RuntimeException | Error failure) {
try { refreshIfLiveMutation(data); }
catch (RuntimeException | Error observationFailure) {
if (observationFailure != failure) failure.addSuppressed(observationFailure);
}
throw failure;
}
refreshIfLiveMutation(data);
}
private void finishFinalPublication(ServerDataPublicationFence.Lease lease,
CompletableFuture<Void> result, Throwable failure) {
Throwable outcome = failure;
try {
// Partial startup may have no display wrapper. In that case, do not
// introduce a YAML-observation dependency into final-stage drain.
refreshVotePartyDisplay();
} catch (Throwable observationFailure) {
if (outcome == null) outcome = observationFailure;
else if (outcome != observationFailure) outcome.addSuppressed(observationFailure);
}
// Refresh observes only the actual live owner; it never acknowledges a
// failed/cancelled publication or releases its retained generation.
if (outcome != null) { result.completeExceptionally(outcome); return; }
try { lease.close(); result.complete(null); }
catch (Throwable releaseFailure) { result.completeExceptionally(releaseFailure); }
}
/** Retain this handle only for retries of the same accepted mutation. */
FinalPublication prepareFinalPublication(Consumer<FileConfiguration> mutation) {
return new FinalPublication(mutation);
}
final class FinalPublication {
private final Consumer<FileConfiguration> mutation;
private ServerDataPublicationFence.Lease lease;
private CompletableFuture<Void> attempt;
private boolean publicationConfirmed;
private FinalPublication(Consumer<FileConfiguration> mutation) { this.mutation = mutation; }
CompletionStage<Void> publish() {
CompletableFuture<Void> result;
ServerDataPublicationFence.Lease owner;
boolean refreshOnly;
synchronized (this) {
if (attempt != null && !attempt.isCompletedExceptionally())
return attempt.minimalCompletionStage();
if (lease == null) {
try { lease = fence.acquire(); }
catch (Throwable failure) { return CompletableFuture.failedFuture(failure); }
}
owner = lease;
result = new CompletableFuture<>();
attempt = result;
refreshOnly = publicationConfirmed;
}
// No operation lock is held across the actual owner's YAML or I/O.
if (refreshOnly) finish(owner, result, null);
else {
try {
java.util.Objects.requireNonNull(mutation, "mutation");
java.util.Objects.requireNonNull(delegate.mutateFinalData(data -> applyOwnedMutation(mutation, data)))
.whenComplete((ignored, failure) -> finish(owner, result, failure));
} catch (Throwable failure) { finish(owner, result, failure); }
}
return result.minimalCompletionStage();
}
private void finish(ServerDataPublicationFence.Lease owner,
CompletableFuture<Void> result, Throwable failure) {
if (failure == null) {
synchronized (this) { publicationConfirmed = true; }
}
// A retry after a display-observation failure must not repeat a
// confirmed mutation. Failed publication instead retains this one
// lease until this same operation has a confirmed successful retry.
finishFinalPublication(owner, result, failure);
}
}
@Override public CompletionStage<Void> mutateFinalData(Consumer<FileConfiguration> mutation) {
// Ordinary one-shot callers retain failed ownership conservatively.
// A caller with an explicit retry contract retains the operation handle.
return prepareFinalPublication(mutation).publish();
}
@Override public void setData(String path, Object value) { mutateOrdinaryData(data -> data.set(path, value)); }
@Override public void setIgnoreTime(boolean value) { withOwner(() -> delegate.setIgnoreTime(value)); }
@Override public void setLastUpdated() { withOwner(delegate::setLastUpdated); }
@Override public void setPluginVersion(Plugin plugin) { withOwner(() -> delegate.setPluginVersion(plugin)); }
@Override public void setPrevDay(int value) { withOwner(() -> delegate.setPrevDay(value)); }
@Override public void setPrevMonth(String value) { withOwner(() -> delegate.setPrevMonth(value)); }
@Override public void setPrevWeekDay(int value) { withOwner(() -> delegate.setPrevWeekDay(value)); }
@Override public TimeChangeTransitionState beginTimeChangeTransition(TimeType type, String period, String marker) {
return withOwnedValue(() -> delegate.beginTimeChangeTransition(type, period, marker));
}
@Override public TimeChangeTransitionState getPendingTimeChangeTransition(TimeType type) {
return withOwnedValue(() -> delegate.getPendingTimeChangeTransition(type));
}
@Override public void completeTimeChangeTransition(TimeChangeTransitionState transition) {
withOwner(() -> delegate.completeTimeChangeTransition(transition));
}
@Override public void failTimeChangeTransition(TimeChangeTransitionState transition) {
withOwner(() -> delegate.failTimeChangeTransition(transition));
}
@Override public boolean isPendingTimeChangeTransition(TimeChangeTransitionState transition) {
return withOwnedValue(() -> delegate.isPendingTimeChangeTransition(transition));
}
}
@@ -18,9 +18,182 @@ import com.bencodez.votingplugin.signs.SignHandler;
import com.bencodez.votingplugin.timequeue.VoteTimeQueue;
import com.bencodez.votingplugin.topvoter.TopVoter;
public class ServerData {
public class ServerData {
/** Immutable live display values, separate from durable publication acknowledgement. */
public record VotePartyDisplay(int total, int extraRequired) {
public int required(int configured) { return extraRequired > 0 ? configured + extraRequired : configured; }
public int needed(int configured) { return required(configured) - total; }
}
private volatile VotePartyDisplay votePartyDisplay = new VotePartyDisplay(0, 0);
/** Snapshot-only: never acquires a YAML owner or waits for filesystem publication. */
public VotePartyDisplay getVotePartyDisplay() { return votePartyDisplay; }
/** Called during startup before placeholders are registered. */
public void refreshVotePartyDisplay() { mutateData(this::captureVotePartyDisplay); }
private void captureVotePartyDisplay() {
var data = getFile().getData().getConfigurationSection("VotingPlugin");
votePartyDisplay = data == null ? new VotePartyDisplay(0, 0)
: new VotePartyDisplay(data.getInt("VoteParty.Total"), data.getInt("VotePartyExtraRequired"));
}
private VotingPluginMain plugin = VotingPluginMain.plugin;
private volatile com.bencodez.advancedcore.data.ServerData generationFile;
private final Object generationBinding = new Object();
private volatile com.bencodez.votingplugin.util.ServerDataPublicationFence generationFence;
private com.bencodez.advancedcore.data.ServerData getFile() {
var current = generationFile;
if (current != null) return current;
synchronized (generationBinding) {
if (generationFile == null) {
var owner = getPublicationFence();
// Reject an old lazy wrapper before exposing successor mutable state.
try (var lease = owner == null ? null : owner.acquire()) {
var file = plugin.getServerDataFile();
if (file instanceof GenerationFencedServerDataFile guarded && !guarded.belongsTo(owner))
throw new IllegalStateException("Server-data file belongs to another generation");
generationFile = file;
}
}
return generationFile;
}
}
private record SignCoordinates(String world, int x, int y, int z) {
static SignCoordinates capture(Location location) {
return new SignCoordinates(location.getWorld().getName(), (int) location.getX(),
(int) location.getY(), (int) location.getZ());
}
void store(ConfigurationSection data, String path) {
data.set(path + ".World", world);
data.set(path + ".X", x);
data.set(path + ".Y", y);
data.set(path + ".Z", z);
}
}
/** Detached shutdown payload: no platform object is accessed by its publisher. */
public static final class SignSnapshot {
private final String count;
private final SignCoordinates location;
private final SignCoordinates skull;
private final String data;
private final int position;
private SignSnapshot(String count, Location location, Location skull, String data, int position) {
this.count = count;
this.location = SignCoordinates.capture(location);
this.skull = skull == null ? null : SignCoordinates.capture(skull);
this.data = data;
this.position = position;
}
private void store(ConfigurationSection target) {
location.store(target, "Signs." + count);
target.set("Signs." + count + ".Data", data);
target.set("Signs." + count + ".Position", position);
if (skull != null) skull.store(target, "Signs." + count + ".Skull");
}
}
public static SignSnapshot captureSignSnapshot(String count, Location location, Location skull,
String data, int position) {
return new SignSnapshot(count, location, skull, data, position);
}
private record ShutdownSignPublication(List<SignSnapshot> snapshot,
java.util.function.Supplier<java.util.concurrent.CompletionStage<Void>> publisher) { }
private final Object shutdownSignBinding = new Object();
private ShutdownSignPublication shutdownSignPublication;
/** Worker-only: one accepted sign batch, with the same publication owner across retries. */
public java.util.concurrent.CompletionStage<Void> publishShutdownSigns(List<SignSnapshot> signs) {
var snapshot = List.copyOf(signs);
ShutdownSignPublication publication;
synchronized (shutdownSignBinding) {
if (shutdownSignPublication == null) {
var file = getFile();
java.util.function.Consumer<org.bukkit.configuration.file.FileConfiguration> mutation = candidate -> {
var target = candidate.getConfigurationSection("VotingPlugin");
if (target == null) target = candidate.createSection("VotingPlugin");
for (var sign : snapshot) sign.store(target);
};
java.util.function.Supplier<java.util.concurrent.CompletionStage<Void>> publisher;
if (file instanceof GenerationFencedServerDataFile guarded) {
var retained = guarded.prepareFinalPublication(mutation);
publisher = retained::publish;
} else publisher = () -> file.mutateFinalData(mutation);
shutdownSignPublication = new ShutdownSignPublication(snapshot, publisher);
} else if (!shutdownSignPublication.snapshot().equals(snapshot)) {
return java.util.concurrent.CompletableFuture.failedFuture(
new IllegalStateException("Shutdown sign publication already owns a different batch"));
}
publication = shutdownSignPublication;
}
return publication.publisher().get();
}
/** Only YAML work belongs here; platform callbacks run outside the file owner. */
private void mutateData(Runnable mutation) {
var fence = getPublicationFence();
try (var owner = fence == null ? null : fence.acquire()) {
synchronized (publicationMonitor()) {
mutation.run();
}
}
}
/** Admit the complete ordinary mutation before changing live YAML or its display. */
private void mutateSavedData(Runnable mutation) {
mutateData(() -> getFile().mutateOrdinaryData(ignored -> {
try { mutation.run(); }
catch (RuntimeException | Error failure) {
try { captureVotePartyDisplay(); }
catch (RuntimeException | Error observationFailure) {
if (observationFailure != failure) failure.addSuppressed(observationFailure);
}
throw failure;
}
captureVotePartyDisplay();
}));
}
/** Store a scalar and save under the same YAML ownership as final SDK snapshots. */
public void setInt(String path, int value) {
mutateSavedData(() -> {
getData().set(path, value);
});
}
/** Store a detached string list, preventing later caller mutation of live YAML. */
public void setStringList(String path, List<String> values) {
var snapshot = values == null ? null : new ArrayList<>(values);
mutateSavedData(() -> {
getData().set(path, snapshot);
});
}
/** All mutations serialize with the actual SDK YAML owner. */
private Object publicationMonitor() {
var file = getFile();
return java.util.Objects.requireNonNull(file.publicationMonitor(), "Server-data publication monitor");
}
private com.bencodez.votingplugin.util.ServerDataPublicationFence getPublicationFence() {
var current = generationFence;
if (current != null) return current;
synchronized (generationBinding) {
if (generationFence == null) generationFence = plugin.getServerDataPublicationFence();
return generationFence;
}
}
/**
* Constructs a new ServerData.
@@ -29,6 +202,7 @@ public class ServerData {
*/
public ServerData(VotingPluginMain plugin) {
this.plugin = plugin;
this.generationFence = plugin.getServerDataPublicationFence();
}
/**
@@ -36,13 +210,15 @@ public class ServerData {
*
* @param placeholder the placeholder to add
*/
public void addAutoCachedPlaceholder(String placeholder) {
List<String> p = getAutoCachedPlaceholder();
if (!ArrayUtils.containsIgnoreCase(p, placeholder)) {
p.add(placeholder);
setAutoCachedPlaceholder(p);
}
public void addAutoCachedPlaceholder(String placeholder) {
mutateData(() -> {
List<String> p = getAutoCachedPlaceholder();
if (!ArrayUtils.containsIgnoreCase(p, placeholder)) {
p.add(placeholder);
setAutoCachedPlaceholder(p);
}
});
}
/**
@@ -50,12 +226,14 @@ public class ServerData {
*
* @param site the service site to add
*/
public synchronized void addServiceSite(String site) {
ArrayList<String> l = getServiceSites();
if (!getServiceSites().contains(site)) {
l.add(site);
}
setServiceSites(ArrayUtils.removeDuplicates(l));
public void addServiceSite(String site) {
mutateData(() -> {
ArrayList<String> l = getServiceSites();
if (!getServiceSites().contains(site)) {
l.add(site);
}
setServiceSites(ArrayUtils.removeDuplicates(l));
});
}
/**
@@ -65,19 +243,20 @@ public class ServerData {
* @param data the data
* @param position the position
*/
public void addSign(Location location, String data, int position) {
int count = nextSignNumber();
getData().set("Signs." + count + ".World", location.getWorld().getName());
getData().set("Signs." + count + ".X", location.getBlockX());
getData().set("Signs." + count + ".Y", location.getBlockY());
getData().set("Signs." + count + ".Z", location.getBlockZ());
getData().set("Signs." + count + ".Data", data);
getData().set("Signs." + count + ".Position", position);
saveData();
plugin.getSigns().getSigns().add(new SignHandler(plugin, "" + count, getSignLocation("" + count),
getSignSkullLocation("" + count), getSignData("" + count), getSignPosition("" + count)));
public void addSign(Location location, String data, int position) {
var coordinates = new SignCoordinates(location.getWorld().getName(), location.getBlockX(),
location.getBlockY(), location.getBlockZ());
int[] selected = new int[1];
mutateSavedData(() -> {
int count = nextSignNumber();
selected[0] = count;
coordinates.store(getData(), "Signs." + count);
getData().set("Signs." + count + ".Data", data);
getData().set("Signs." + count + ".Position", position);
});
String count = Integer.toString(selected[0]);
plugin.getSigns().getSigns().add(new SignHandler(plugin, count, getSignLocation(count),
getSignSkullLocation(count), getSignData(count), getSignPosition(count)));
}
/**
@@ -87,10 +266,14 @@ public class ServerData {
* @param vote the vote time queue entry
*/
public void addTimeVoted(int num, VoteTimeQueue vote) {
getData().set("TimedVoteCache." + num + ".Name", vote.getName());
getData().set("TimedVoteCache." + num + ".Service", vote.getService());
getData().set("TimedVoteCache." + num + ".Time", vote.getTime());
saveData();
mutateData(() -> {
getData().set("TimedVoteCache." + num + ".Name", vote.getName());
getData().set("TimedVoteCache." + num + ".Service", vote.getService());
getData().set("TimedVoteCache." + num + ".Time", vote.getTime());
getData().set("TimedVoteCache." + num + ".LocalOccurrenceId", vote.getLocalOccurrenceId() == null ? null : vote.getLocalOccurrenceId().toString());
getData().set("TimedVoteCache." + num + ".CanonicalOccurrenceTime", vote.getCanonicalOccurrenceTime() == 0L ? null : vote.getCanonicalOccurrenceTime());
saveTimedVoteCache();
});
}
/**
@@ -98,16 +281,28 @@ public class ServerData {
*
* @param ident the vote shop identifier
*/
public void addVoteShopPurchase(String ident) {
setVoteShopPurchases(ident, (getVoteShopPurchases(ident) + 1));
public void addVoteShopPurchase(String ident) {
mutateData(() -> {
setVoteShopPurchases(ident, (getVoteShopPurchases(ident) + 1));
});
}
/** Assign a legacy local cache row its identity before replay is scheduled. */
public void setTimedVoteLocalOccurrenceId(String key, UUID occurrenceId) {
mutateData(() -> {
getData().set("TimedVoteCache." + key + ".LocalOccurrenceId", occurrenceId.toString());
saveTimedVoteCache();
});
}
/**
* Clears the timed vote cache.
*/
public void clearTimedVoteCache() {
getData().set("TimedVoteCache", null);
saveData();
public void clearTimedVoteCache() {
mutateData(() -> {
getData().set("TimedVoteCache", null);
saveTimedVoteCache();
});
}
/**
@@ -142,13 +337,15 @@ public class ServerData {
*
* @return the data
*/
public ConfigurationSection getData() {
ConfigurationSection data = plugin.getServerDataFile().getData().getConfigurationSection("VotingPlugin");
if (data == null) {
plugin.getServerDataFile().getData().createSection("VotingPlugin");
data = plugin.getServerDataFile().getData().getConfigurationSection("VotingPlugin");
}
return data;
public ConfigurationSection getData() {
var fence = getPublicationFence();
try (var owner = fence == null ? null : fence.acquire()) {
synchronized (publicationMonitor()) {
ConfigurationSection data = getFile().getData().getConfigurationSection("VotingPlugin");
if (data == null) data = getFile().getData().createSection("VotingPlugin");
return data;
}
}
}
/**
@@ -165,9 +362,10 @@ public class ServerData {
*
* @return the service sites
*/
@SuppressWarnings("unchecked")
public ArrayList<String> getServiceSites() {
return (ArrayList<String>) getData().getList("GottenServiceSites", new ArrayList<>());
public ArrayList<String> getServiceSites() {
synchronized (publicationMonitor()) {
return new ArrayList<>(getData().getStringList("GottenServiceSites"));
}
}
/**
@@ -176,9 +374,11 @@ public class ServerData {
*
* @return persisted service-site observations
*/
public synchronized List<String> getServiceSitesReadOnly() {
ConfigurationSection root = plugin.getServerDataFile().getData().getConfigurationSection("VotingPlugin");
return root == null ? List.of() : List.copyOf(root.getStringList("GottenServiceSites"));
public List<String> getServiceSitesReadOnly() {
synchronized (publicationMonitor()) {
ConfigurationSection root = getFile().getData().getConfigurationSection("VotingPlugin");
return root == null ? List.of() : List.copyOf(root.getStringList("GottenServiceSites"));
}
}
/**
@@ -339,8 +539,11 @@ public class ServerData {
/**
* Reload data.
*/
public void reloadData() {
plugin.getServerDataFile().reloadData();
public void reloadData() {
mutateData(() -> {
getFile().reloadData();
captureVotePartyDisplay();
});
}
/**
@@ -359,36 +562,168 @@ public class ServerData {
* @param top the top voter type
* @param messageId the message ID
*/
public void setTopVoterMessageId(TopVoter top, long messageId) {
getData().set("DiscordSRV.TopVoterMessageId." + top.toString(), messageId);
saveData();
public void setTopVoterMessageId(TopVoter top, long messageId) {
mutateSavedData(() -> {
getData().set("DiscordSRV.TopVoterMessageId." + top.toString(), messageId);
});
}
/**
/**
* Uses the existing writer and confirms this ID in the saved file. Legacy void saves may
* swallow I/O failure; queued/custom writers may also remain unconfirmed at this point.
* False is an uncertain outcome, never permission to delete a possibly recorded message.
* Call only on the existing worker, under this facade's normal save ordering.
*/
public synchronized boolean setTopVoterMessageIdConfirmed(TopVoter top, long messageId) {
setTopVoterMessageId(top, messageId);
try {
var saved = new org.bukkit.configuration.file.YamlConfiguration();
saved.load(plugin.getServerDataFile().getdFile());
return saved.getLong("VotingPlugin.DiscordSRV.TopVoterMessageId." + top.toString(), 0) == messageId;
} catch (java.io.IOException | org.bukkit.configuration.InvalidConfigurationException | RuntimeException failure) {
return false;
}
}
/**
* Removes the sign.
*
* @param sign the sign
*/
public void removeSign(String sign) {
getData().set("Signs." + sign + ".World", null);
getData().set("Signs." + sign + ".X", null);
getData().set("Signs." + sign + ".Y", null);
getData().set("Signs." + sign + ".Z", null);
getData().set("Signs." + sign + ".Data", null);
getData().set("Signs." + sign + ".Position", null);
getData().set("Signs." + sign, null);
getData().set("Signs." + sign + ".Skull.World", null);
getData().set("Signs." + sign + ".Skull.X", null);
getData().set("Signs." + sign + ".Skull.Y", null);
getData().set("Signs." + sign + ".Skull.Z", null);
saveData();
public void removeSign(String sign) {
mutateSavedData(() -> {
getData().set("Signs." + sign + ".World", null);
getData().set("Signs." + sign + ".X", null);
getData().set("Signs." + sign + ".Y", null);
getData().set("Signs." + sign + ".Z", null);
getData().set("Signs." + sign + ".Data", null);
getData().set("Signs." + sign + ".Position", null);
getData().set("Signs." + sign, null);
getData().set("Signs." + sign + ".Skull.World", null);
getData().set("Signs." + sign + ".Skull.X", null);
getData().set("Signs." + sign + ".Skull.Y", null);
getData().set("Signs." + sign + ".Skull.Z", null);
});
}
/**
* Save data.
*/
public synchronized void saveData() {
plugin.getServerDataFile().saveData();
/** Checkpoint the pending suffix without retiring its live queue entries. */
public void replaceTimedVoteCache(java.util.Collection<VoteTimeQueue> pending) {
mutateData(() -> {
Object previous = getData().get("TimedVoteCache");
try {
setTimedVoteCache(pending);
saveTimedVoteCache();
} catch (RuntimeException | Error failure) {
getData().set("TimedVoteCache", previous);
throw failure;
}
});
}
/** Publish the recovery suffix and conservative in-flight record in one file save. */
public void prepareTimedVoteDispatch(UUID id, VoteTimeQueue vote,
java.util.Collection<VoteTimeQueue> pending) {
mutateData(() -> {
String path = "UncertainTimedVotes." + id;
Object previousCache = getData().get("TimedVoteCache");
Object previousRecord = getData().get(path);
try {
setTimedVoteCache(pending);
getData().set(path, null);
getData().createSection(path, timedVoteFields(vote));
saveTimedVoteCache();
} catch (RuntimeException | Error failure) {
getData().set("TimedVoteCache", previousCache);
getData().set(path, previousRecord);
throw failure;
}
});
}
/** Restore an undispatched occurrence and its pending suffix for ordinary restart recovery. */
public void abortTimedVoteDispatch(UUID id, java.util.Collection<VoteTimeQueue> pending) {
mutateData(() -> {
String path = "UncertainTimedVotes." + id;
Object previousCache = getData().get("TimedVoteCache");
Object previousRecord = getData().get(path);
try {
setTimedVoteCache(pending);
getData().set(path, null);
saveTimedVoteCache();
} catch (RuntimeException | Error failure) {
getData().set("TimedVoteCache", previousCache);
getData().set(path, previousRecord);
throw failure;
}
});
}
/** Clear only a confirmed dispatch record; failed writes retain its live representation. */
public void completeTimedVoteDispatch(UUID id) {
mutateData(() -> {
String path = "UncertainTimedVotes." + id;
Object previous = getData().get(path);
try {
getData().set(path, null);
saveTimedVoteCache();
} catch (RuntimeException | Error failure) {
getData().set(path, previous);
throw failure;
}
});
}
private void setTimedVoteCache(java.util.Collection<VoteTimeQueue> pending) {
java.util.Map<String, Object> rows = new java.util.LinkedHashMap<>();
int index = 0;
for (VoteTimeQueue vote : pending) rows.put(Integer.toString(index++), timedVoteFields(vote));
getData().set("TimedVoteCache", null);
getData().createSection("TimedVoteCache", rows);
}
private static java.util.Map<String, Object> timedVoteFields(VoteTimeQueue vote) {
java.util.Map<String, Object> fields = new java.util.LinkedHashMap<>();
fields.put("Name", vote.getName());
fields.put("Service", vote.getService());
fields.put("Time", vote.getTime());
if (vote.getLocalOccurrenceId() != null) fields.put("LocalOccurrenceId", vote.getLocalOccurrenceId().toString());
if (vote.getCanonicalOccurrenceTime() != 0L) fields.put("CanonicalOccurrenceTime", vote.getCanonicalOccurrenceTime());
return fields;
}
/** Retain an ambiguous event delivery without making it eligible for automatic replay. */
public void addUncertainTimedVote(java.util.UUID id, VoteTimeQueue vote) {
mutateData(() -> {
String path = "UncertainTimedVotes." + id;
getData().set(path + ".Name", vote.getName());
getData().set(path + ".Service", vote.getService());
getData().set(path + ".Time", vote.getTime());
getData().set(path + ".LocalOccurrenceId", vote.getLocalOccurrenceId() == null ? null : vote.getLocalOccurrenceId().toString());
getData().set(path + ".CanonicalOccurrenceTime", vote.getCanonicalOccurrenceTime() == 0L ? null : vote.getCanonicalOccurrenceTime());
saveTimedVoteCache();
});
}
/** Timed votes must observe write failures before their in-memory queue is retired. */
private void saveTimedVoteCache() {
var fence = getPublicationFence();
try (var owner = fence == null ? null : fence.acquire()) {
var file = getFile();
if (file instanceof GenerationFencedServerDataFile guarded) guarded.saveDataChecked();
else file.getData().save(file.getdFile());
} catch (java.io.IOException failure) {
throw new java.io.UncheckedIOException("Failed to save timed vote cache", failure);
}
}
/** Saves server data through the existing general-purpose file helper. */
public void saveData() {
mutateData(() -> {
// Publish the complete live display projection before entering disk I/O.
// A failed save still does not acknowledge durable storage.
captureVotePartyDisplay();
getFile().saveData();
});
}
/**
@@ -396,13 +731,10 @@ public class ServerData {
*
* @param disabledReminders the list of UUIDs with disabled reminders
*/
public void saveDisabledReminders(ArrayList<UUID> disabledReminders) {
ArrayList<String> uuids = new ArrayList<>();
for (UUID uuid : disabledReminders) {
uuids.add(uuid.toString());
}
getData().set("DisabledReminders", uuids);
saveData();
public void saveDisabledReminders(ArrayList<UUID> disabledReminders) {
ArrayList<String> uuids = new ArrayList<>();
for (UUID uuid : disabledReminders) uuids.add(uuid.toString());
setStringList("DisabledReminders", uuids);
}
/**
@@ -410,9 +742,8 @@ public class ServerData {
*
* @param placeholders the list of placeholders
*/
public void setAutoCachedPlaceholder(List<String> placeholders) {
getData().set("AutoCachePlaceholders", placeholders);
saveData();
public void setAutoCachedPlaceholder(List<String> placeholders) {
setStringList("AutoCachePlaceholders", placeholders);
}
/**
@@ -420,9 +751,8 @@ public class ServerData {
*
* @param current the current vote count
*/
public void setBungeeVotePartyCurrent(int current) {
getData().set("BungeeVotePartyCurrent", current);
saveData();
public void setBungeeVotePartyCurrent(int current) {
setInt("BungeeVotePartyCurrent", current);
}
/**
@@ -430,9 +760,8 @@ public class ServerData {
*
* @param required the required vote count
*/
public void setBungeeVotePartyRequired(int required) {
getData().set("BungeeVotePartyRequired", required);
saveData();
public void setBungeeVotePartyRequired(int required) {
setInt("BungeeVotePartyRequired", required);
}
/**
@@ -440,9 +769,8 @@ public class ServerData {
*
* @param list the service sites list
*/
public void setServiceSites(ArrayList<String> list) {
getData().set("GottenServiceSites", list);
saveData();
public void setServiceSites(ArrayList<String> list) {
setStringList("GottenServiceSites", list);
}
/**
@@ -450,9 +778,10 @@ public class ServerData {
*
* @param value the converted status
*/
public void setShopConverted(boolean value) {
getData().set("VoteShopConverted", value);
saveData();
public void setShopConverted(boolean value) {
mutateSavedData(() -> {
getData().set("VoteShopConverted", value);
});
}
/**
@@ -464,21 +793,15 @@ public class ServerData {
* @param data the sign data
* @param position the sign position
*/
public void setSign(String count, Location location, Location skullLocation, String data, int position) {
getData().set("Signs." + count + ".World", location.getWorld().getName());
getData().set("Signs." + count + ".X", (int) location.getX());
getData().set("Signs." + count + ".Y", (int) location.getY());
getData().set("Signs." + count + ".Z", (int) location.getZ());
getData().set("Signs." + count + ".Data", data);
getData().set("Signs." + count + ".Position", position);
if (skullLocation != null) {
getData().set("Signs." + count + ".Skull.World", skullLocation.getWorld().getName());
getData().set("Signs." + count + ".Skull.X", (int) skullLocation.getX());
getData().set("Signs." + count + ".Skull.Y", (int) skullLocation.getY());
getData().set("Signs." + count + ".Skull.Z", (int) skullLocation.getZ());
}
saveData();
public void setSign(String count, Location location, Location skullLocation, String data, int position) {
var coordinates = SignCoordinates.capture(location);
var skull = skullLocation == null ? null : SignCoordinates.capture(skullLocation);
mutateSavedData(() -> {
coordinates.store(getData(), "Signs." + count);
getData().set("Signs." + count + ".Data", data);
getData().set("Signs." + count + ".Position", position);
if (skull != null) skull.store(getData(), "Signs." + count + ".Skull");
});
}
/**
@@ -487,21 +810,20 @@ public class ServerData {
* @param count the sign count
* @param skullLocation the skull location
*/
public void setSkullLocation(String count, Location skullLocation) {
if (skullLocation != null) {
getData().set("Signs." + count + ".Skull.World", skullLocation.getWorld().getName());
getData().set("Signs." + count + ".Skull.X", (int) skullLocation.getX());
getData().set("Signs." + count + ".Skull.Y", (int) skullLocation.getY());
getData().set("Signs." + count + ".Skull.Z", (int) skullLocation.getZ());
}
public void setSkullLocation(String count, Location skullLocation) {
if (skullLocation == null) return;
var coordinates = SignCoordinates.capture(skullLocation);
mutateData(() -> coordinates.store(getData(), "Signs." + count + ".Skull"));
}
/**
* Sets the version.
*/
public void setVersion() {
getData().set("Version", Bukkit.getVersion());
saveData();
public void setVersion() {
String version = Bukkit.getVersion();
mutateSavedData(() -> {
getData().set("Version", version);
});
}
/**
@@ -509,9 +831,10 @@ public class ServerData {
*
* @param value the extra required votes
*/
public void setVotePartyExtraRequired(int value) {
getData().set("VotePartyExtraRequired", value);
saveData();
public void setVotePartyExtraRequired(int value) {
mutateSavedData(() -> {
getData().set("VotePartyExtraRequired", value);
});
}
/**
@@ -520,42 +843,45 @@ public class ServerData {
* @param ident the vote shop identifier
* @param amount the purchase amount
*/
public void setVoteShopPurchases(String ident, int amount) {
getData().set("VoteShopPurchases." + ident, amount);
saveData();
public void setVoteShopPurchases(String ident, int amount) {
mutateSavedData(() -> {
getData().set("VoteShopPurchases." + ident, amount);
});
}
/**
* Updates the last vote party timestamp to today.
*/
public void updateLastVoteParty() {
getData().set("LastVoteParty", plugin.getTimeChecker().getTime().getDayOfYear());
saveData();
public void updateLastVoteParty() {
int day = plugin.getTimeChecker().getTime().getDayOfYear();
setInt("LastVoteParty", day);
}
/**
* Updates the last vote party week timestamp to this week.
*/
public void updateLastVotePartyWeek() {
getData().set("LastVotePartyWeek",
plugin.getTimeChecker().getTime().get(WeekFields.of(Locale.getDefault()).weekOfYear()));
saveData();
public void updateLastVotePartyWeek() {
int week = plugin.getTimeChecker().getTime().get(WeekFields.of(Locale.getDefault()).weekOfYear());
setInt("LastVotePartyWeek", week);
}
/**
* Updates placeholders to lowercase format.
*/
public void updatePlaceholders() {
boolean data = getData().getBoolean("AutoCacheUpdated", false);
if (!data) {
List<String> placeholders = getAutoCachedPlaceholder();
for (int i = 0; i < placeholders.size(); i++) {
placeholders.set(i, placeholders.get(i).toLowerCase());
}
setAutoCachedPlaceholder(placeholders);
getData().set("AutoCacheUpdated", true);
saveData();
}
public void updatePlaceholders() {
mutateData(() -> {
boolean data = getData().getBoolean("AutoCacheUpdated", false);
if (!data) {
mutateSavedData(() -> {
List<String> placeholders = getAutoCachedPlaceholder();
for (int i = 0; i < placeholders.size(); i++) {
placeholders.set(i, placeholders.get(i).toLowerCase());
}
getData().set("AutoCachePlaceholders", placeholders);
getData().set("AutoCacheUpdated", true);
});
}
});
}
/**
@@ -3,10 +3,8 @@ package com.bencodez.votingplugin.discord;
import java.awt.Color;
import java.time.Instant;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
@@ -27,6 +25,7 @@ import github.scarsz.discordsrv.api.events.DiscordReadyEvent;
import github.scarsz.discordsrv.dependencies.jda.api.EmbedBuilder;
import github.scarsz.discordsrv.dependencies.jda.api.JDA;
import github.scarsz.discordsrv.dependencies.jda.api.entities.TextChannel;
import github.scarsz.discordsrv.dependencies.jda.api.entities.Message;
import github.scarsz.discordsrv.dependencies.jda.api.requests.ErrorResponse;
import github.scarsz.discordsrv.dependencies.jda.api.exceptions.ErrorResponseException;
import github.scarsz.discordsrv.util.DiscordUtil;
@@ -40,8 +39,45 @@ public class DiscordHandler {
private final VotingPluginMain plugin;
@Getter
private final HashMap<TopVoter, Long> topVoterMessageIds = new HashMap<TopVoter, Long>();
private final Set<TopVoter> recoveringTopVoters = new HashSet<>();
/** Identity, rather than generation alone, owns every request and its callbacks. */
private static final class Publication {
final long generation;
final boolean persistent;
boolean sending, editing, recovering, again, completing, retired;
long requestedGeneration;
final AtomicBoolean sendCompleted = new AtomicBoolean(false);
Publication(long generation, boolean persistent, boolean sending) {
this.generation = generation; this.requestedGeneration = generation;
this.persistent = persistent; this.sending = sending; this.editing = !sending;
}
}
private static final int PENDING = 0, WRITING = 1, RETAINED = 2, DISCARDED = 3, DETACHED = 4;
private static final int MAX_OWNED_RECEIPTS = 128;
/** External success is owned here before any cancellable worker handoff. */
private static final class SentReceipt {
final TopVoter top;
final Message message;
final long id;
final long generation;
final AtomicBoolean cleanupRequested = new AtomicBoolean(false);
int state = PENDING;
boolean confirmed;
SentReceipt(TopVoter top, Message message, long generation) {
this.top = top; this.message = message; this.id = message.getIdLong(); this.generation = generation;
}
}
private final java.util.EnumMap<TopVoter, Publication> publications = new java.util.EnumMap<>(TopVoter.class);
/** Guarded by publications; includes uncertain saves until confirmed replacement or explicit detachment. */
private final java.util.Set<SentReceipt> ownedReceipts = new java.util.HashSet<>();
private final AtomicBoolean closed = new AtomicBoolean(false);
private final AtomicBoolean discordReady = new AtomicBoolean(false);
private static final class DisplayUpdate {
private final long generation;
private long requestedGeneration;
private boolean again;
private DisplayUpdate(long generation) { this.generation = generation; this.requestedGeneration = generation; }
}
private final java.util.EnumMap<TopVoter, DisplayUpdate> preparing = new java.util.EnumMap<>(TopVoter.class);
/**
* Constructs a new Discord handler.
@@ -149,14 +185,347 @@ public class DiscordHandler {
* @param top the top voter
*/
public void updateTopVoterMessageId(TopVoter top) {
plugin.extraDebug("Updating Discord Top Voter message for: " + top);
prepareTopVoterMessage(top, plugin.getTopVoterDisplayGeneration());
}
long channelId = plugin.getConfigFile().getDiscordSRVTopVoterChannel(top);
LinkedHashMap<TopVoterPlayer, Integer> topVoters = plugin.getTopVoter(top);
private void prepareTopVoterMessage(TopVoter top, long generation) {
DisplayUpdate update;
synchronized (preparing) {
if (!currentGeneration(generation)) return;
DisplayUpdate pending = preparing.get(top);
if (pending != null) {
pending.again = true;
pending.requestedGeneration = generation;
return;
}
update = new DisplayUpdate(generation);
preparing.put(top, update);
}
try {
plugin.getTopVoterDisplayAsync(top).whenComplete((snapshot, failure) -> {
try {
plugin.getTimer().execute(() -> {
if (!releasePreparation(top, update)) return;
if (!currentGeneration(update.generation)) {
retryRequestedPreparation(top, update);
return;
}
// Joins and TTL/scope changes can revoke omissions while publication is queued.
// Recheck current evidence without opening another asynchronous deadline.
if (update.again || (failure == null && snapshot != null)) {
try { publishTopVoterMessage(top, plugin.getTopVoterDisplay(top), update.generation); }
catch (RuntimeException unavailable) { warnLeaderboardFailure("preparing a current display for " + top); }
} else plugin.getLogger().warning("Unable to prepare Discord Top Voters: " + top);
});
} catch (RuntimeException rejected) {
if (releasePreparation(top, update)) {
try { if (currentGeneration(update.generation)) warnLeaderboardFailure("preparation worker admission for " + top); }
finally { retryRequestedPreparation(top, update); }
}
}
});
} catch (RuntimeException unavailable) {
if (releasePreparation(top, update)) {
try { if (currentGeneration(update.generation)) warnLeaderboardFailure("preparing evidence for " + top); }
finally { retryRequestedPreparation(top, update); }
}
}
}
String title = plugin.getConfigFile().getDiscordSRVTopVoterTitle(top);
private boolean releasePreparation(TopVoter top, DisplayUpdate update) {
synchronized (preparing) { return preparing.remove(top, update); }
}
private void retryRequestedPreparation(TopVoter top, DisplayUpdate update) {
// The retired request's evidence never changes ownership to a replacement filter.
if (update.again && update.requestedGeneration != update.generation)
prepareTopVoterMessage(top, update.requestedGeneration);
}
void publishTopVoterMessage(TopVoter top, LinkedHashMap<TopVoterPlayer, Integer> prepared) {
publishTopVoterMessage(top, prepared, plugin.getTopVoterDisplayGeneration());
}
void publishTopVoterMessage(TopVoter top, LinkedHashMap<TopVoterPlayer, Integer> prepared, long generation) {
if (!currentGeneration(generation)) return;
boolean newMessage = plugin.getConfigFile().isDiscordSRVTopVoterNewMessageOnUpdate(top);
TextChannel channel;
try { channel = leaderboardChannel(plugin.getConfigFile().getDiscordSRVTopVoterChannel(top)); }
catch (RuntimeException unavailable) { warnLeaderboardFailure("channel lookup for " + top); return; }
if (channel == null) { warnLeaderboardFailure("missing channel for " + top); return; }
Publication publication;
long existingId;
synchronized (publications) {
if (!currentGeneration(generation)) return;
Publication pending = publications.get(top);
if (pending != null && (pending.editing || (!pending.retired && pending.generation == generation
&& (pending.sending || pending.completing)))) {
pending.again = true;
pending.requestedGeneration = generation;
return;
}
existingId = topVoterMessageIds.getOrDefault(top, 0L);
publication = new Publication(generation, !newMessage, existingId <= 0 || newMessage);
publications.put(top, publication);
}
try {
var embed = buildTopVoterEmbed(plugin.getConfigFile().getDiscordSRVTopVoterTitle(top), plugin.getTopVoterDisplay(top)).build();
if (!current(top, publication)) { finish(top, publication); return; }
if (publication.sending) send(top, channel, publication, embed);
else channel.editMessageEmbedsById(existingId, embed).queue(
message -> finishEdit(top, publication, existingId),
error -> handleMessageUpdateFailure(top, channel, publication, error));
} catch (RuntimeException unavailable) { failPublication(top, publication, "preparing or submitting a message"); }
}
private boolean current(TopVoter top, Publication publication) {
if (!currentGeneration(publication.generation)) return false;
synchronized (publications) { return publications.get(top) == publication && !publication.retired; }
}
/** Never hold the publication lock while waiting for the ServerData save monitor. */
private boolean persist(TopVoter top, Publication publication, long id) {
var data = plugin.getServerData();
synchronized (data) {
if (!current(top, publication)) return false;
data.setTopVoterMessageId(top, id);
}
return current(top, publication);
}
private void finish(TopVoter top, Publication publication) {
boolean again, prepareAgain;
long generation;
synchronized (publications) {
if (publications.get(top) != publication) return;
publications.remove(top);
again = publication.again;
generation = publication.requestedGeneration;
prepareAgain = publication.retired || generation != publication.generation;
}
// A queued request is independent of whether the previous network operation succeeded.
if (again) {
if (prepareAgain) prepareTopVoterMessage(top, generation);
else dispatchLeaderboard(generation,
() -> publishTopVoterMessage(top, plugin.getTopVoterDisplay(top), generation), () -> { });
}
}
private void warnLeaderboardFailure(String stage) {
// Provider exceptions can contain request URLs or message content. Report the phase only.
plugin.getLogger().warning("Unable to publish Discord Top Voters (" + stage
+ "). Check the Discord channel, permissions and configuration; a later update can retry.");
}
private void failPublication(TopVoter top, Publication publication, String stage) {
try { if (current(top, publication)) warnLeaderboardFailure(stage + " for " + top); }
finally { finish(top, publication); }
}
private void send(TopVoter top, TextChannel channel, Publication publication,
github.scarsz.discordsrv.dependencies.jda.api.entities.MessageEmbed embed) {
if (!current(top, publication)) { finish(top, publication); return; }
channel.sendMessageEmbeds(embed).queue(message -> {
if (!publication.sendCompleted.compareAndSet(false, true)) return;
SentReceipt receipt = new SentReceipt(top, message, publication.generation);
boolean admitted;
synchronized (publications) {
admitted = !closed.get() && (!publication.persistent || ownedReceipts.size() < MAX_OWNED_RECEIPTS);
if (admitted && publication.persistent) ownedReceipts.add(receipt);
publication.completing = true;
}
if (!admitted) {
discardCreatedMessage(publication, receipt); finish(top, publication); return;
}
dispatchLeaderboard(publication.generation, () -> {
try {
if (!current(top, publication)) return;
if (publication.persistent) { retainCreatedMessage(top, publication, receipt); return; }
if (!current(top, publication)) return;
synchronized (publications) {
if (publications.get(top) == publication) topVoterMessageIds.put(top, receipt.id);
}
} catch (RuntimeException failure) { warnLeaderboardFailure("storing a message ID for " + top); }
finally { discardCreatedMessage(publication, receipt); finish(top, publication); }
}, () -> { discardCreatedMessage(publication, receipt); finish(top, publication); });
}, failure -> failPublication(top, publication, "sending a message"));
}
/** Retry an uncertain ID save after a successful edit, without creating another external post. */
private void finishEdit(TopVoter top, Publication publication, long id) {
synchronized (publications) { publication.editing = false; publication.completing = true; }
if (!current(top, publication)) { finish(top, publication); return; }
SentReceipt retry;
synchronized (publications) {
retry = ownedReceipts.stream().filter(receipt -> receipt.top == top && receipt.id == id
&& receipt.state == RETAINED && !receipt.confirmed).findFirst().orElse(null);
}
if (retry == null) { finish(top, publication); return; }
dispatchLeaderboard(publication.generation, () -> {
try { retainCreatedMessage(top, publication, retry); }
finally { discardCreatedMessage(publication, retry); finish(top, publication); }
}, () -> finish(top, publication));
}
/** Never hold publication ownership while waiting for the existing save monitor or file I/O. */
private void retainCreatedMessage(TopVoter top, Publication publication, SentReceipt receipt) {
var obsolete = new java.util.ArrayList<SentReceipt>();
var data = plugin.getServerData();
boolean uncertain = false;
synchronized (data) {
if (!current(top, publication)) return;
synchronized (publications) {
if (!current(top, publication) || (receipt.state != PENDING && receipt.state != RETAINED)) return;
receipt.state = WRITING;
}
try {
boolean confirmed = data.setTopVoterMessageIdConfirmed(top, receipt.id);
long actual = data.getTopVoterMessageId(top);
synchronized (publications) {
if (receipt.state == DETACHED) return;
// A reentrant newer confirmed write already owns the file. Reconcile only this older post.
if (actual != receipt.id && ownedReceipts.stream().anyMatch(other -> other != receipt
&& other.top == top && other.id == actual && other.state == RETAINED && other.confirmed)) return;
receipt.state = RETAINED;
receipt.confirmed = confirmed && actual == receipt.id;
uncertain = !receipt.confirmed;
if (actual == receipt.id && (publications.get(top) == publication
|| topVoterMessageIds.getOrDefault(top, 0L) <= 0)) topVoterMessageIds.put(top, receipt.id);
if (receipt.confirmed) {
var iterator = ownedReceipts.iterator();
while (iterator.hasNext()) {
SentReceipt previous = iterator.next();
if (previous != receipt && previous.top == top && previous.state == RETAINED) {
previous.state = DISCARDED; iterator.remove(); obsolete.add(previous);
}
}
}
}
} catch (RuntimeException failure) {
// The legacy writer may have mutated or saved before throwing; do not delete a possibly recorded post.
synchronized (publications) {
if (receipt.state == DETACHED) return;
receipt.state = RETAINED; receipt.confirmed = false;
if (publications.get(top) == publication && topVoterMessageIds.getOrDefault(top, 0L) <= 0)
topVoterMessageIds.put(top, receipt.id);
}
uncertain = true;
}
}
obsolete.forEach(this::removeCreatedMessage);
if (uncertain) warnMessageStorage();
}
private void discardCreatedMessage(Publication publication, SentReceipt receipt) {
if (!publication.persistent) return; // Append mode deliberately keeps its posts.
synchronized (publications) {
if (receipt.state != PENDING && receipt.state != WRITING) return;
receipt.state = DISCARDED; ownedReceipts.remove(receipt);
}
removeCreatedMessage(receipt);
}
/** Detach the administrator's old posts; clearing an ID never authorizes deleting those posts. */
public boolean clearTopVoterMessageId(TopVoter top) {
var data = plugin.getServerData();
synchronized (data) {
synchronized (publications) {
publications.remove(top);
synchronized (preparing) { preparing.remove(top); }
topVoterMessageIds.put(top, 0L);
ownedReceipts.removeIf(receipt -> {
if (receipt.top != top || (receipt.state != PENDING && receipt.state != RETAINED
&& receipt.state != WRITING)) return false;
receipt.state = DETACHED; return true;
});
}
try { if (data.setTopVoterMessageIdConfirmed(top, 0L)) return true; }
catch (RuntimeException failure) { /* The outgoing diagnostic remains redacted. */ }
}
warnMessageStorage(); return false;
}
/** Retire invalidated generations before worker cancellation; close invalidates every generation. */
public void retireLeaderboardPublications() {
var abandoned = new java.util.ArrayList<SentReceipt>();
var restart = new java.util.EnumMap<TopVoter, Long>(TopVoter.class);
synchronized (publications) {
// An admitted edit can still write on Discord after retirement. Keep its
// bounded slot until its network callback rather than submitting overlapping edits.
publications.entrySet().removeIf(entry -> {
Publication publication = entry.getValue();
if (currentGeneration(publication.generation) && !publication.retired) return false;
boolean again = publication.again && currentGeneration(publication.requestedGeneration);
if (!publication.editing) {
if (again) restart.put(entry.getKey(), publication.requestedGeneration);
return true;
}
publication.retired = true;
publication.again = again;
return false;
});
synchronized (preparing) {
preparing.entrySet().removeIf(entry -> {
DisplayUpdate update = entry.getValue();
if (currentGeneration(update.generation)) return false;
if (update.again && currentGeneration(update.requestedGeneration))
restart.put(entry.getKey(), update.requestedGeneration);
return true;
});
}
var iterator = ownedReceipts.iterator();
while (iterator.hasNext()) {
SentReceipt receipt = iterator.next();
if (receipt.state == PENDING && !currentGeneration(receipt.generation)) {
receipt.state = DISCARDED; iterator.remove(); abandoned.add(receipt);
}
}
}
abandoned.forEach(this::removeCreatedMessage);
// Old worker completions can be cancelled; transfer explicit requests now,
// outside both ownership monitors and without waiting for those callbacks.
restart.forEach(this::prepareTopVoterMessage);
}
public void close() {
synchronized (publications) {
if (!closed.compareAndSet(false, true)) return;
}
retireLeaderboardPublications();
boolean uncertain;
synchronized (publications) {
uncertain = ownedReceipts.stream().anyMatch(receipt -> receipt.state == WRITING || !receipt.confirmed);
}
if (uncertain) warnMessageStorage();
}
private void warnMessageStorage() {
plugin.getLogger().warning("Unable to confirm Discord Top Voters message ID storage. "
+ "The post remains tracked in memory; check storage before restarting and reconcile posts manually.");
}
/** JDA owns asynchronous deletion; cleanup does not depend on the retiring plugin worker. */
private void removeCreatedMessage(SentReceipt receipt) {
if (!receipt.cleanupRequested.compareAndSet(false, true)) return;
try {
receipt.message.delete().queue(ignored -> { }, failure -> {
if (!(failure instanceof ErrorResponseException response)
|| response.getErrorResponse() != ErrorResponse.UNKNOWN_MESSAGE) warnMessageCleanup();
});
} catch (RuntimeException failure) { warnMessageCleanup(); }
}
private void warnMessageCleanup() {
plugin.getLogger().warning("Unable to remove an untracked Discord Top Voters message. "
+ "Check Discord permissions and remove the unwanted post manually.");
}
TextChannel leaderboardChannel(long channelId) {
return DiscordUtil.getJda().getTextChannelById(channelId);
}
/** Render an inspected display snapshot without accessing the Discord runtime. */
static EmbedBuilder buildTopVoterEmbed(String title, LinkedHashMap<TopVoterPlayer, Integer> topVoters) {
EmbedBuilder eb = new EmbedBuilder().setTitle(title).setColor(Color.CYAN).setTimestamp(Instant.now());
if (topVoters == null || topVoters.isEmpty()) {
@@ -187,34 +556,7 @@ public class DiscordHandler {
eb.setDescription(sb.toString()).setFooter("Top 10 • Updated");
}
TextChannel channel = DiscordUtil.getJda().getTextChannelById(channelId);
if (channel == null) {
plugin.getLogger().warning("Discord channel ID " + channelId + " not found: " + top);
return;
}
long existingId;
synchronized (recoveringTopVoters) {
if (recoveringTopVoters.contains(top)) {
plugin.debug("Skipping Discord Top Voter update while recovery is in progress: " + top);
return;
}
existingId = topVoterMessageIds.getOrDefault(top, 0L);
}
if (existingId <= 0 || newMessage) {
channel.sendMessageEmbeds(eb.build()).queue(msg -> {
long newId = msg.getIdLong();
topVoterMessageIds.put(top, newId);
if (!newMessage)
plugin.getServerData().setTopVoterMessageId(top, newId);
plugin.debug("Posted new Top Voters " + top + " (ID: " + newId + ")");
}, err -> plugin.getLogger().warning("Error sending Top Voters " + top + ": " + err.getMessage()));
} else {
channel.editMessageEmbedsById(existingId, eb.build()).queue(
m -> plugin.debug("Edited Top Voters " + top + " (ID: " + existingId + ")"),
err -> handleMessageUpdateFailure(top, channel, eb, existingId, err));
}
return eb;
}
/**
@@ -224,41 +566,65 @@ public class DiscordHandler {
* condition as recoverable so one deleted message cannot permanently stop
* leaderboard updates.
*/
private void handleMessageUpdateFailure(TopVoter top, TextChannel channel, EmbedBuilder eb, long existingId,
Throwable error) {
if (plugin.getConfigFile().isDiscordSRVTopVoterAutoRecoverMessageOnFailure()
&& error instanceof ErrorResponseException
&& ((ErrorResponseException) error).getErrorResponse() == ErrorResponse.UNKNOWN_MESSAGE) {
synchronized (recoveringTopVoters) {
if (topVoterMessageIds.getOrDefault(top, 0L) != existingId || !recoveringTopVoters.add(top)) {
plugin.debug("Skipping stale Discord Top Voter recovery because another update handled: " + top);
return;
private boolean currentGeneration(long generation) {
return !closed.get() && plugin.isEnabled() && plugin.getTopVoterDisplayGeneration() == generation;
}
private void dispatchLeaderboard(long generation, Runnable action, Runnable discarded) {
if (!currentGeneration(generation)) { discarded.run(); return; }
try {
plugin.getTimer().execute(() -> {
try {
if (currentGeneration(generation)) action.run(); else discarded.run();
} catch (RuntimeException failure) {
try { if (currentGeneration(generation)) warnLeaderboardFailure("asynchronous publication"); }
finally { discarded.run(); }
}
}
plugin.getLogger().warning("Discord Top Voters " + top + " message " + existingId
+ " no longer exists; clearing the stored ID and posting a replacement.");
synchronized (recoveringTopVoters) {
topVoterMessageIds.put(top, 0L);
}
plugin.getServerData().setTopVoterMessageId(top, 0L);
channel.sendMessageEmbeds(eb.build()).queue(msg -> {
long newId = msg.getIdLong();
synchronized (recoveringTopVoters) {
topVoterMessageIds.put(top, newId);
plugin.getServerData().setTopVoterMessageId(top, newId);
recoveringTopVoters.remove(top);
}
plugin.debug("Recovered Top Voters " + top + " with replacement message (ID: " + newId + ")");
}, sendError -> {
synchronized (recoveringTopVoters) {
recoveringTopVoters.remove(top);
}
plugin.getLogger().warning("Error recovering Top Voters " + top + ": " + sendError.getMessage());
});
} catch (RuntimeException rejected) {
try { if (currentGeneration(generation)) warnLeaderboardFailure("worker admission"); }
finally { discarded.run(); }
}
}
private void handleMessageUpdateFailure(TopVoter top, TextChannel channel, Publication publication,
Throwable error) {
synchronized (publications) { publication.editing = false; }
if (!current(top, publication)) { finish(top, publication); return; }
if (!plugin.getConfigFile().isDiscordSRVTopVoterAutoRecoverMessageOnFailure()
|| !(error instanceof ErrorResponseException response)
|| response.getErrorResponse() != ErrorResponse.UNKNOWN_MESSAGE) {
failPublication(top, publication, "editing a message");
return;
}
plugin.getLogger().warning("Error editing Top Voters " + top + ": " + error.getMessage());
synchronized (publications) {
if (publications.get(top) != publication || publication.recovering) return;
publication.recovering = true;
publication.sending = true;
}
dispatchLeaderboard(publication.generation, () -> {
try {
if (!persist(top, publication, 0L)) { finish(top, publication); return; }
synchronized (publications) {
if (publications.get(top) != publication) return;
topVoterMessageIds.put(top, 0L);
}
// Persistence can block while a join, TTL, reload or disable revokes the earlier frame.
var replacement = buildTopVoterEmbed(plugin.getConfigFile().getDiscordSRVTopVoterTitle(top),
plugin.getTopVoterDisplay(top)).build();
send(top, channel, publication, replacement);
} catch (RuntimeException failure) { failPublication(top, publication, "recovering a deleted message"); }
}, () -> {
// Rejected admission has no effects; the same failed edit may be retried.
boolean again = false;
synchronized (publications) {
if (publications.get(top) == publication) {
publication.recovering = false; publication.sending = false;
again = publication.again;
}
}
if (again) finish(top, publication);
});
}
/**
@@ -13,6 +13,11 @@ import lombok.Getter;
import lombok.Setter;
public class PlayerPostVoteEvent extends Event {
/** Original accepted occurrence time; ordinary cooldown/event time remains separate. */
@Getter
@Setter
private Long canonicalOccurrenceTime;
/** The Constant handlers. */
private static final HandlerList handlers = new HandlerList();
@@ -77,6 +82,11 @@ public class PlayerPostVoteEvent extends Event {
@Setter
private UUID voteUUID;
/** Original explicit proxy transport ID; voteUUID retains the legacy correlation fallback. */
@Getter
@Setter
private UUID proxyVoteId;
/**
* Constructs a new PlayerPostVoteEvent.
*
@@ -19,7 +19,17 @@ import lombok.Setter;
* <p>Cancellation follows Bukkit's {@code ignoreCancelled} dispatch contract.
* Integrations must cancel before the MONITOR vote consumer runs.</p>
*/
public class PlayerVoteEvent extends Event implements Cancellable {
public class PlayerVoteEvent extends Event implements Cancellable {
/** Stable local receipt identity, separate from proxy transport provenance. */
@Getter
@Setter
private UUID localOccurrenceId;
/** Original accepted occurrence time; ordinary cooldown/event time remains separate. */
@Getter
@Setter
private Long canonicalOccurrenceTime;
/** The Constant handlers. */
private static final HandlerList handlers = new HandlerList();
@@ -45,7 +55,7 @@ public class PlayerVoteEvent extends Event implements Cancellable {
@Setter
private VoteTotalsSnapshot bungeeTextTotals;
/** Stable identity supplied by a proxy delivery, independent of totals. */
/** Original explicit proxy transport ID; null for legacy totals-only correlation. */
@Getter
@Setter
private UUID proxyVoteId;
@@ -86,6 +96,20 @@ public class PlayerVoteEvent extends Event implements Cancellable {
@Setter
private boolean wasOnline;
/** Native receipt ownership is released only after the accepted consumer returns. */
@Getter
@Setter
private boolean nativeProcessingStarted;
@Getter
@Setter
private boolean nativeProcessingCompleted;
/** Missing date accounting is surfaced after event dispatch so durable proxy envelopes are not acknowledged. */
@Getter
@Setter
private boolean dateMilestoneAccountingFailed;
/** Whether this is an identified queued proxy delivery. */
@Getter
@Setter
@@ -0,0 +1,18 @@
package com.bencodez.votingplugin.listeners;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.inventory.InventoryOpenEvent;
import com.bencodez.advancedcore.api.inventory.GUISession;
import com.bencodez.votingplugin.commands.gui.player.DateVoteEventsMenu;
/** Fence the actual platform open, including AdvancedCore's additional scheduling handoff. */
public final class DateVoteMenuOpenGuard implements Listener {
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
public void onOpen(InventoryOpenEvent event) {
GUISession session = GUISession.extractSession(event.getInventory());
if (session != null && !DateVoteEventsMenu.permitsOpen(session.getInventoryGUI(), event.getPlayer()))
event.setCancelled(true);
}
}
@@ -35,7 +35,7 @@ public class PlayerJoinEvent implements Listener {
public void onPlayerJoin(org.bukkit.event.player.PlayerJoinEvent event) {
if (event == null || event.getPlayer() == null) return;
Player player = event.getPlayer();
plugin.getPlaceholderPlayerPresence().playerOnline(placeholderUuid(player), player);
plugin.getPlaceholderPlayerPresence().captureOnline(placeholderUuid(player), player);
}
private UUID placeholderUuid(Player player) {
@@ -83,7 +83,7 @@ public class PlayerJoinEvent implements Listener {
Player player = event.getPlayer();
if (player != null) {
plugin.getPlaceholderPlayerPresence().playerOnline(user.getJavaUUID(), player);
if (!plugin.getPlaceholderPlayerPresence().updateStorageUuid(user.getJavaUUID(), player)) return;
}
if (player != null && plugin.isYmlError()) {
@@ -160,17 +160,19 @@ public class PlayerJoinEvent implements Listener {
plugin.getBackendProxyHandler().playerOffline(player.getName());
}
final UUID serverUuid = player.getUniqueId();
final String playerName = player.getName();
plugin.getLoginTimer().execute(new Runnable() {
@Override
public void run() {
VotingPluginMain.plugin.getAdvancedTab().remove(player.getUniqueId());
VotingPluginMain.plugin.getAdvancedTab().remove(serverUuid);
// Use AdvancedCore UUIDLookup to derive the correct UUID (online/offline aware)
String uuid = UuidLookup.getInstance().getUUID(player.getName());
String uuid = UuidLookup.getInstance().getUUID(playerName);
if (isBlank(uuid)) {
// Fallback to online UUID if lookup fails
uuid = player.getUniqueId().toString();
uuid = serverUuid.toString();
}
VotingPluginUser user = plugin.getVotingPluginUserManager().getVotingPluginUser(uuid);
@@ -35,7 +35,9 @@ public class PlayerVoteListener implements Listener {
// Keep the production boundary defensive for direct/custom dispatchers
// as well as Bukkit's Cancellable-aware event dispatcher.
if (event.isCancelled()) return;
SharedVoteProcessor.process(new BukkitOperations(plugin, event));
BukkitOperations operations = new BukkitOperations(plugin, event);
SharedVoteProcessor.process(operations);
if (event.isNativeProcessingStarted()) event.setNativeProcessingCompleted(true);
}
private static final class BukkitOperations implements SharedVoteProcessor.Operations<VoteSite, VotingPluginUser> {
@@ -47,7 +49,11 @@ public class PlayerVoteListener implements Listener {
this.event = event;
}
@Override public boolean enabled() { return plugin.isEnabled(); }
@Override public boolean enabled() {
boolean enabled = plugin.isEnabled();
if (enabled) event.setNativeProcessingStarted(true);
return enabled;
}
@Override public String incomingName() { return event.getPlayer(); }
@Override public String serviceSite() { return event.getServiceSite(); }
@Override public void debug(String message) { plugin.debug(message); }
@@ -131,6 +137,7 @@ public class PlayerVoteListener implements Listener {
}
@Override public boolean hasProxyTextTotals() { return event.getBungeeTextTotals() != null; }
@Override public UUID proxyVoteId() { return resolveProxyVoteId(event); }
@Override public UUID localOccurrenceId() { return event.getLocalOccurrenceId(); }
@Override public boolean identifiedQueuedProxyVote() { return event.isQueuedProxyVote(); }
@Override public boolean proxyQueueClassificationKnown() { return event.isProxyQueueClassificationKnown(); }
@Override public boolean proxyDelayValidationKnown() { return event.isProxyDelayValidationKnown(); }
@@ -176,6 +183,20 @@ public class PlayerVoteListener implements Listener {
plugin.getVoteMilestonesManager().handleVote(user, event.getBungeeTextTotals(), forceProxyRouting,
voteId, new HashMap<String, String>());
}
@Override public void dateMilestones(VotingPluginUser user, VoteSite site, long voteTime, UUID voteId) {
long occurrenceTime = event.getCanonicalOccurrenceTime() == null
? proxyVote() ? incomingTime() : voteTime : event.getCanonicalOccurrenceTime();
if (com.bencodez.votingplugin.util.BukkitCompletionScheduler.isPlatformOwnedThread()) {
// An asynchronous event flag does not identify the thread that dispatched it.
// A proxy caller cannot acknowledge accounting that has only been admitted.
event.setDateMilestoneAccountingFailed(!plugin.getDateVoteMilestones().deferAccepted(user, site.getKey(), voteId, occurrenceTime,
realVote(), proxyVote(), event.getProxyVoteId() != null && occurrenceTime > 0,
targetedProxyVote(), forceProxyRouting()));
return;
}
if (!plugin.getDateVoteMilestones().accepted(user, site.getKey(), voteId, occurrenceTime, realVote(), proxyVote(),
event.getProxyVoteId() != null && occurrenceTime > 0, targetedProxyVote(), forceProxyRouting())) event.setDateMilestoneAccountingFailed(true);
}
@Override public void cooldown(VotingPluginUser user, VoteSite site) { plugin.getCoolDownCheck().vote(user, site); }
@Override public void voteStreak(VotingPluginUser user, long voteTime, UUID voteId) {
plugin.getVoteStreakHandler().processVote(user, voteTime, voteId);
@@ -184,6 +205,9 @@ public class PlayerVoteListener implements Listener {
long voteTime, UUID voteId, boolean cached) {
PlayerPostVoteEvent post = new PlayerPostVoteEvent(site, user, event.isRealVote(), event.isForceBungee(),
voteTime, cached, site.getServiceSite(), user.getJavaUUID(), playerName, voteId);
post.setProxyVoteId(event.getProxyVoteId());
post.setCanonicalOccurrenceTime(event.getCanonicalOccurrenceTime() == null
? event.isBungee() ? event.getTime() : voteTime : event.getCanonicalOccurrenceTime());
plugin.getServer().getPluginManager().callEvent(post);
}
@Override public boolean placeholderCacheAlways() { return plugin.getConfigFile().getPlaceholderCacheLevel().isCacheAlways(); }
@@ -1,6 +1,9 @@
package com.bencodez.votingplugin.listeners;
import java.util.concurrent.RejectedExecutionException;
import java.util.UUID;
import java.util.LinkedHashMap;
import java.util.Map;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
@@ -17,16 +20,133 @@ import com.vexsoftware.votifier.model.VotifierEvent;
public class VotiferEvent implements Listener {
private VotingPluginMain plugin;
private final VotingPluginMain plugin;
private final java.util.function.BooleanSupplier ready;
private volatile boolean accepting = true;
private static final int MAX_CAPTURED = VotifierVoteOverflowQueue.MAX_CAPTURED;
private boolean retirementQueued;
private final Object captureLock = new Object();
// Receipt ownership only. Entries leave at completed processing or confirmed
// overflow transfer; STARTED work remains owned until then.
private final Map<UUID, CapturedVote> captured = new LinkedHashMap<>();
private static final class CapturedVote {
final String username, site;
final long occurredAt;
final UUID id;
boolean transferring, transferFailureReported;
volatile boolean started, completed, finished, transferred;
VotifierVoteOverflowQueue recoveryOwner;
CapturedVote(String username, String site, long occurredAt, UUID id) {
this.username = username; this.site = site; this.occurredAt = occurredAt; this.id = id;
}
}
/**
* Instantiates a new votifer event.
*
* @param plugin the plugin
*/
public VotiferEvent(VotingPluginMain plugin) {
this.plugin = plugin;
}
public VotiferEvent(VotingPluginMain plugin) { this(plugin, () -> true); }
public VotiferEvent(VotingPluginMain plugin, java.util.function.BooleanSupplier ready) {
this.plugin = plugin; this.ready = ready;
}
/** Retire admission and reconcile tasks before the vote executor is cancelled. */
public void stop() {
synchronized (captureLock) {
accepting = false;
if (retirementQueued) return;
retirementQueued = true;
var overflow = plugin.getVotifierVoteOverflowQueue();
if (overflow == null) {
for (CapturedVote vote : java.util.List.copyOf(captured.values())) transferLocked(vote);
return;
}
var snapshot = captured.values().stream().map(vote -> new VotifierVoteOverflowQueue.RetiringCapture(
vote.username, vote.site, vote.occurredAt, vote.id,
() -> !vote.started || vote.finished && !vote.completed, () -> vote.completed,
admitted -> transferred(vote, admitted))).toList();
overflow.retireCaptures(snapshot);
}
}
public int getPendingCaptureCount() {
synchronized (captureLock) { return captured.size(); }
}
private void runCaptured(CapturedVote vote) {
synchronized (captureLock) {
if (!captured.containsKey(vote.id) || vote.transferring || vote.started) return;
if (!accepting || !ready.getAsBoolean()) {
if (accepting || !retirementQueued) transferLocked(vote);
return;
}
vote.started = true;
}
boolean completed = false;
try { completed = processCapturedVote(vote.site, vote.username, vote.occurredAt, vote.id)
&& !Thread.currentThread().isInterrupted(); }
finally {
VotifierVoteOverflowQueue acknowledge = null;
synchronized (captureLock) {
vote.completed = completed;
vote.finished = true;
if (completed) {
captured.remove(vote.id);
if (vote.transferred) acknowledge = vote.recoveryOwner;
} else if (accepting && !vote.transferred && !vote.transferring) {
// Retain the same occurrence and hand it to recovery after
// the normal callback has finished, including partial failures.
transferLocked(vote);
}
}
if (completed && vote.recoveryOwner != null) vote.recoveryOwner.releaseCapture(vote.id);
if (acknowledge != null) acknowledge.acknowledgeOccurrence(vote.id);
else if (vote.transferred && vote.recoveryOwner != null) vote.recoveryOwner.resumeTransfers();
}
}
private void transferLocked(CapturedVote vote) {
if (vote.transferring) return;
vote.transferring = true;
VotifierVoteOverflowQueue overflow = vote.recoveryOwner != null
? vote.recoveryOwner : plugin.getVotifierVoteOverflowQueue();
vote.recoveryOwner = overflow;
if (overflow == null) { transferred(vote, false); return; }
overflow.enqueueAfterInitialization(vote.username, vote.site, vote.occurredAt, vote.id,
() -> !vote.started || vote.finished && !vote.completed,
accepted -> transferred(vote, accepted));
}
private void transferred(CapturedVote vote, boolean admitted) {
boolean completed, retry, reportFailure;
synchronized (captureLock) {
if (vote.transferred && !admitted) return; // Older failure cannot revoke confirmed queue ownership.
vote.transferred = admitted; completed = vote.completed;
if (!admitted) vote.transferring = false;
if (admitted || completed) captured.remove(vote.id);
retry = !admitted && !completed && captured.get(vote.id) == vote;
reportFailure = !admitted && !completed && !vote.transferFailureReported;
if (reportFailure) vote.transferFailureReported = true;
}
if (admitted && completed) vote.recoveryOwner.acknowledgeOccurrence(vote.id);
if (completed) return; // Current normal processing won; do not leave an ordinary duplicate retry.
if (reportFailure) plugin.getLogger().severe("Votifier vote queue unavailable or full; "
+ (retry ? "captured receipt retained for retry for " : "vote was not admitted for ")
+ MinecraftUsernameValidator.sanitizeForLog(vote.username));
else if (admitted) plugin.getLogger().warning("Vote pipeline unavailable or retiring; queued Votifier vote for retry");
if (retry && vote.recoveryOwner != null) vote.recoveryOwner.retryCaptureTransfers(this::retryCapturedTransfers);
}
private void retryCapturedTransfers() {
synchronized (captureLock) {
for (CapturedVote vote : java.util.List.copyOf(captured.values())) {
// Ordinary queued/running callbacks retain their original execution.
// Only receipts which already attempted a failed handoff need retry.
if (vote.transferFailureReported && !vote.transferring) transferLocked(vote);
}
}
}
/**
* Processes a validated vote. The overflow queue invokes this callback from
@@ -35,7 +155,23 @@ public class VotiferEvent implements Listener {
* @param voteSite the validated service site
* @param voteUsername the validated player name
*/
public void processVote(String voteSite, String voteUsername) {
public void processVote(String voteSite, String voteUsername) { processVote(voteSite, voteUsername, 0L); }
public void processVote(String voteSite, String voteUsername, long occurredAt) {
processVote(voteSite, voteUsername, occurredAt, UUID.randomUUID());
}
public void processVote(String voteSite, String voteUsername, long occurredAt, UUID localOccurrenceId) {
processCapturedVote(voteSite, voteUsername, occurredAt, localOccurrenceId);
}
/** False retains overflow ownership; partial ordinary effects may still have occurred. */
public boolean processVoteConfirmed(String voteSite, String voteUsername, long occurredAt, UUID localOccurrenceId) {
return processCapturedVote(voteSite, voteUsername, occurredAt, localOccurrenceId);
}
private boolean processCapturedVote(String voteSite, String voteUsername, long occurredAt, UUID localOccurrenceId) {
java.util.Objects.requireNonNull(localOccurrenceId, "localOccurrenceId");
try {
plugin.getServerData().addServiceSite(voteSite);
if (plugin.getBungeeSettings().isUseBungeecoord() && !plugin.getBungeeSettings().isVotifierBypass()
@@ -46,7 +182,7 @@ public class VotiferEvent implements Listener {
|| plugin.getBackendProxyHandler().getMethod().equals(BungeeMethod.REDIS))) {
plugin.getLogger().severe(
"Ignoring vote from votifier since a proxy vote transport is enabled; receive votes on the proxy or enable VotifierBypass, then check: https://github.com/BenCodez/VotingPlugin/wiki/Bungeecord-Setups");
return;
return true;
}
String matchSite = "";
@@ -77,22 +213,29 @@ public class VotiferEvent implements Listener {
if (plugin.getTimeChecker().isActiveProcessing()
&& plugin.getConfigFile().isQueueVotesDuringTimeChange()) {
plugin.debug("Adding vote to time queue " + voteUsername + "/" + voteSite);
plugin.getTimeQueueHandler().addVote(voteUsername, voteSite);
return;
plugin.getTimeQueueHandler().addVote(voteUsername, voteSite, occurredAt, localOccurrenceId);
return true;
}
String voteSiteName = plugin.getVoteSiteManager().getVoteSiteName(true, serviceSite, matchSite);
PlayerVoteEvent voteEvent = new PlayerVoteEvent(
plugin.getVoteSiteManager().getVoteSite(voteSiteName, true), voteUsername, voteSite, true);
voteEvent.setLocalOccurrenceId(localOccurrenceId);
if (occurredAt > 0) voteEvent.setCanonicalOccurrenceTime(occurredAt);
plugin.getServer().getPluginManager().callEvent(voteEvent);
if (voteEvent.isCancelled()) {
plugin.debug("Vote cancelled");
}
// Bukkit may skip disabled listeners or catch their exceptions while
// returning normally. Dispatch alone is not confirmed processing.
return voteEvent.isNativeProcessingCompleted()
|| voteEvent.isCancelled() && !voteEvent.isNativeProcessingStarted();
} catch (Exception e) {
plugin.getLogger().severe("Error occured during vote processing");
e.printStackTrace();
return false; // An exception does not prove ordinary accounting/rewards completed.
}
}
@@ -103,6 +246,9 @@ public class VotiferEvent implements Listener {
*/
@EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
public void onVotiferEvent(VotifierEvent event) {
if (!accepting) return;
final long occurredAt = System.currentTimeMillis();
final UUID localOccurrenceId = UUID.randomUUID();
Vote vote = event.getVote();
String str = vote.getServiceName();
@@ -135,16 +281,58 @@ public class VotiferEvent implements Listener {
plugin.debug("VoteSite: " + voteSite);
plugin.debug("IP: " + IP);
try {
plugin.getVoteTimer().submit(() -> processVote(voteSite, voteUsername));
} catch (RejectedExecutionException rejected) {
VotifierVoteOverflowQueue overflow = plugin.getVotifierVoteOverflowQueue();
if (overflow == null || !overflow.enqueue(voteUsername, voteSite)) {
plugin.getLogger().severe("Votifier vote queue is full; vote was not admitted for "
+ MinecraftUsernameValidator.sanitizeForLog(voteUsername));
} else {
plugin.getLogger().warning("Vote executor saturated; queued Votifier vote for retry");
}
}
CapturedVote capturedVote = new CapturedVote(voteUsername, voteSite, occurredAt, localOccurrenceId);
VotifierVoteOverflowQueue.CaptureAdmission admission;
synchronized (captureLock) {
if (!accepting) return;
var overflow = plugin.getVotifierVoteOverflowQueue();
capturedVote.recoveryOwner = overflow;
if (captured.size() >= MAX_CAPTURED) {
// The overflow owns its independent bounded admission lane.
transferLocked(capturedVote);
return;
}
admission = overflow == null ? VotifierVoteOverflowQueue.CaptureAdmission.ACCEPTED
: overflow.reserveCapture(localOccurrenceId);
if (admission == VotifierVoteOverflowQueue.CaptureAdmission.REJECTED) {
plugin.getLogger().severe("Votifier capture capacity unavailable; vote was not admitted");
return;
}
// Reserve known capacity and publish capture ownership together with
// respect to stop's snapshot. Unknown capacity remains provisional.
captured.put(localOccurrenceId, capturedVote);
}
if (admission == VotifierVoteOverflowQueue.CaptureAdmission.WAITING_FOR_LOAD) {
capturedVote.recoveryOwner.reserveCaptureAfterInitialization(localOccurrenceId,
admitted -> admitCaptured(capturedVote, admitted));
} else admitCaptured(capturedVote, true);
}
private void admitCaptured(CapturedVote vote, boolean admitted) {
synchronized (captureLock) {
if (captured.get(vote.id) != vote) {
if (admitted && vote.recoveryOwner != null) vote.recoveryOwner.releaseCapture(vote.id);
return;
}
if (!admitted) {
captured.remove(vote.id);
plugin.getLogger().severe("Votifier capture capacity unavailable; vote was not admitted");
return;
}
if (!accepting) {
if (!retirementQueued) transferLocked(vote);
return;
}
}
try {
var timer = plugin.getVoteTimer();
if (timer == null) {
synchronized (captureLock) { transferLocked(vote); }
return;
}
timer.submit(() -> runCaptured(vote));
} catch (RejectedExecutionException rejected) {
synchronized (captureLock) { transferLocked(vote); }
}
}
}
@@ -4,6 +4,9 @@ import java.io.File;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.SeekableByteChannel;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.nio.channels.OverlappingFileLockException;
import java.nio.charset.StandardCharsets;
import java.nio.file.AtomicMoveNotSupportedException;
import java.nio.file.Files;
@@ -17,10 +20,15 @@ import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Properties;
import java.util.UUID;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import org.bukkit.configuration.file.YamlConfiguration;
@@ -37,22 +45,65 @@ import com.bencodez.votingplugin.util.ServiceSiteValidator;
public final class VotifierVoteOverflowQueue implements AutoCloseable {
/* Keep the overflow bounded independently of the executor's 256 admissions. */
private static final int MAX_ENTRIES = 256;
public static final int MAX_CAPTURED = 256;
private static final int MAX_RETAINED_ENTRIES = MAX_ENTRIES + MAX_CAPTURED;
private static final long MAX_FILE_BYTES = 4L * 1024L * 1024L;
private static final long RETRY_DELAY_MILLIS = 250L;
private static final String QUEUE_FILE = "VotifierVoteQueue.yml";
private static final String OWNER_FILE = "VotifierVoteQueue.yml.owner";
private static final String SHARED_OWNER_PROPERTY_PREFIX = "com.bencodez.votingplugin.VotifierVoteOverflowQueue.owner.";
private static final int MAX_OWNER_RESERVATIONS = 1024;
private final VotingPluginMain plugin;
private final BiConsumer<String, String> processor;
@FunctionalInterface
public interface VoteProcessor { void process(String serviceSite, String username, long occurredAt); }
@FunctionalInterface
public interface OccurrenceProcessor {
void process(String serviceSite, String username, long occurredAt, UUID localOccurrenceId);
/** Legacy callbacks confirm completion by returning normally. */
default boolean processConfirmed(String serviceSite, String username, long occurredAt, UUID localOccurrenceId) {
process(serviceSite, username, occurredAt, localOccurrenceId);
return true;
}
}
@FunctionalInterface
public interface ConfirmedOccurrenceProcessor {
boolean processConfirmed(String serviceSite, String username, long occurredAt, UUID localOccurrenceId);
}
private final OccurrenceProcessor processor;
private final java.util.function.BooleanSupplier processingAllowed;
private final Path file;
private final Path ownerFile;
private FileChannel ownerChannel;
private FileLock ownerLock;
private String ownerKey;
private String ownerToken;
private Properties ownerProperties;
private final ScheduledThreadPoolExecutor worker;
private final Object lock = new Object();
private final Object persistenceWriteLock = new Object();
private final ArrayDeque<PendingVote> entries = new ArrayDeque<>();
private boolean drainScheduled;
private boolean drainRetryScheduled;
private boolean captureRetryScheduled;
private boolean persistenceScheduled;
private boolean persistenceDirty;
private boolean started;
private boolean closed;
private boolean closing;
private final java.util.concurrent.CompletableFuture<Void> closePublication = new java.util.concurrent.CompletableFuture<>();
private boolean closeFailureReported;
private volatile boolean loaded;
private volatile boolean loadFailed;
private int pendingIngress;
private int pendingCaptureAdmissions;
private int pendingRetirementCaptures;
private boolean retirementRequested;
private boolean initializationRetryScheduled;
private boolean initializationFailureReported;
private boolean queueFileObserved;
private final Set<UUID> captureReservations = new java.util.HashSet<>();
private final boolean asynchronousInitialization;
private long stateVersion;
private long durableVersion;
@@ -63,16 +114,56 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
* @param processor callback receiving service site and player name
*/
public VotifierVoteOverflowQueue(VotingPluginMain plugin, BiConsumer<String, String> processor) {
this(plugin, (site, user, occurredAt, id) -> processor.accept(site, user), () -> true);
}
/** Additive callback retains receipt occurrence and fences a retired startup generation. */
public VotifierVoteOverflowQueue(VotingPluginMain plugin, VoteProcessor processor,
java.util.function.BooleanSupplier processingAllowed) {
this(plugin, (site, user, time, id) -> processor.process(site, user, time), processingAllowed);
}
public VotifierVoteOverflowQueue(VotingPluginMain plugin, OccurrenceProcessor processor,
java.util.function.BooleanSupplier processingAllowed) {
this(plugin, processor, processingAllowed, false);
}
/** Memory-only construction; all loading and handoffs run on the existing queue worker. */
public static VotifierVoteOverflowQueue initializeAsync(VotingPluginMain plugin, OccurrenceProcessor processor,
java.util.function.BooleanSupplier processingAllowed) {
return new VotifierVoteOverflowQueue(plugin, processor, processingAllowed, true);
}
/** Named factory preserves existing void callback/lambda contracts without ambiguous overloads. */
public static VotifierVoteOverflowQueue initializeConfirmedAsync(VotingPluginMain plugin,
ConfirmedOccurrenceProcessor processor, java.util.function.BooleanSupplier processingAllowed) {
java.util.Objects.requireNonNull(processor, "processor");
return initializeAsync(plugin, new OccurrenceProcessor() {
@Override public void process(String site, String user, long time, UUID id) {
processor.processConfirmed(site, user, time, id);
}
@Override public boolean processConfirmed(String site, String user, long time, UUID id) {
return processor.processConfirmed(site, user, time, id);
}
}, processingAllowed);
}
private VotifierVoteOverflowQueue(VotingPluginMain plugin, OccurrenceProcessor processor,
java.util.function.BooleanSupplier processingAllowed, boolean asynchronousInitialization) {
this.asynchronousInitialization = asynchronousInitialization;
this.plugin = plugin;
this.processor = processor;
this.processingAllowed = processingAllowed;
this.file = new File(plugin.getDataFolder(), QUEUE_FILE).toPath();
this.ownerFile = new File(plugin.getDataFolder(), OWNER_FILE).toPath();
this.worker = new ScheduledThreadPoolExecutor(1, runnable -> {
Thread thread = new Thread(runnable, "VotingPlugin-Votifier-Overflow");
thread.setDaemon(true);
return thread;
});
this.worker.setRemoveOnCancelPolicy(true);
load();
if (asynchronousInitialization) worker.execute(this::load);
else load();
}
/**
@@ -97,10 +188,88 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
* @return false when the bounded overflow is full or shutting down
*/
public boolean enqueue(String username, String serviceSite) {
if (username == null || serviceSite == null) return false;
return enqueue(username, serviceSite, System.currentTimeMillis());
}
public boolean enqueue(String username, String serviceSite, long occurredAt) {
return enqueue(username, serviceSite, occurredAt, UUID.randomUUID());
}
public boolean enqueue(String username, String serviceSite, long occurredAt, UUID localOccurrenceId) {
return enqueueStored(username, serviceSite, occurredAt, localOccurrenceId, false);
}
/** Transfer stays behind initial loading and is bounded independently of executor admissions. */
public void enqueueAfterInitialization(String username, String serviceSite, long occurredAt, UUID localOccurrenceId,
Consumer<Boolean> completion) {
enqueueAfterInitialization(username, serviceSite, occurredAt, localOccurrenceId, () -> true, completion);
}
/** A STARTED original callback retains execution ownership until its outcome is known. */
public void enqueueAfterInitialization(String username, String serviceSite, long occurredAt, UUID localOccurrenceId,
java.util.function.BooleanSupplier executionReleased, Consumer<Boolean> completion) {
if (username == null || serviceSite == null || occurredAt <= 0 || localOccurrenceId == null) {
completion.accept(false);
return;
}
var finished = new java.util.concurrent.atomic.AtomicBoolean();
class Transfer implements Runnable {
void finish(boolean accepted) {
if (!finished.compareAndSet(false, true)) return;
synchronized (lock) { pendingIngress--; }
completion.accept(accepted);
}
@Override public void run() {
try {
synchronized (lock) {
if (!closed && !loaded) {
// Admission owns this receipt, including the saturated
// path which has no entry in the listener's capture map.
scheduleInitializationRetryLocked();
worker.schedule(this, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
return;
}
}
} catch (RejectedExecutionException rejected) { finish(false); return; }
boolean accepted = false;
try { accepted = enqueueStored(username, serviceSite, occurredAt, localOccurrenceId, true, executionReleased); }
finally { finish(accepted); }
}
}
boolean submitted = false;
synchronized (lock) {
if (!closed && !closing && pendingIngress < MAX_ENTRIES) {
pendingIngress++;
try {
worker.execute(new Transfer());
submitted = true;
} catch (RejectedExecutionException rejected) { pendingIngress--; }
}
}
if (!submitted) completion.accept(false);
}
private boolean enqueueStored(String username, String serviceSite, long occurredAt, UUID localOccurrenceId,
boolean admittedTransfer) {
return enqueueStored(username, serviceSite, occurredAt, localOccurrenceId, admittedTransfer, () -> true);
}
private boolean enqueueStored(String username, String serviceSite, long occurredAt, UUID localOccurrenceId,
boolean admittedTransfer, java.util.function.BooleanSupplier executionReleased) {
if (username == null || serviceSite == null || occurredAt <= 0 || localOccurrenceId == null) return false;
synchronized (lock) {
if (closed || entries.size() >= MAX_ENTRIES) return false;
entries.addLast(new PendingVote(username, serviceSite, System.currentTimeMillis()));
if (closed || closing && !admittedTransfer || !loaded || loadFailed) return false;
var existing = occurrence(localOccurrenceId);
if (existing != null) {
boolean same = matches(existing, username, serviceSite, occurredAt);
if (same) captureReservations.remove(localOccurrenceId);
return same;
}
int entryLimit = closing && admittedTransfer ? MAX_RETAINED_ENTRIES : MAX_ENTRIES;
if (entries.size() >= entryLimit || !captureReservations.contains(localOccurrenceId)
&& entries.size() + captureReservations.size() >= MAX_RETAINED_ENTRIES) return false;
entries.addLast(new PendingVote(username, serviceSite, occurredAt, localOccurrenceId, executionReleased));
captureReservations.remove(localOccurrenceId);
stateVersion++;
requestPersistenceLocked();
scheduleDrainLocked();
@@ -108,6 +277,162 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
}
}
public enum CaptureAdmission { ACCEPTED, WAITING_FOR_LOAD, REJECTED }
/** Reserve final-snapshot capacity before the normal executor owns this receipt. */
public CaptureAdmission reserveCapture(UUID id) {
java.util.Objects.requireNonNull(id);
synchronized (lock) {
if (closed || closing || loadFailed) return CaptureAdmission.REJECTED;
if (!loaded) return CaptureAdmission.WAITING_FOR_LOAD;
if (captureReservations.contains(id)) return CaptureAdmission.ACCEPTED;
if (captureReservations.size() >= MAX_CAPTURED
|| entries.size() + captureReservations.size() >= MAX_RETAINED_ENTRIES)
return CaptureAdmission.REJECTED;
captureReservations.add(id);
return CaptureAdmission.ACCEPTED;
}
}
/** Unknown disk capacity is provisional; keep at most one deferred admission per capture. */
public void reserveCaptureAfterInitialization(UUID id, Consumer<Boolean> completion) {
java.util.Objects.requireNonNull(id); java.util.Objects.requireNonNull(completion);
boolean admitted;
synchronized (lock) {
admitted = !closed && !closing && pendingCaptureAdmissions < MAX_CAPTURED;
if (admitted) pendingCaptureAdmissions++;
}
if (!admitted) { completion.accept(false); return; }
var finished = new java.util.concurrent.atomic.AtomicBoolean();
class Admission implements Runnable {
void finish(boolean accepted) {
if (!finished.compareAndSet(false, true)) return;
synchronized (lock) { pendingCaptureAdmissions--; }
completion.accept(accepted);
}
@Override public void run() {
var result = reserveCapture(id);
if (result != CaptureAdmission.WAITING_FOR_LOAD) {
finish(result == CaptureAdmission.ACCEPTED);
return;
}
try { worker.schedule(this, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS); }
catch (RejectedExecutionException rejected) { finish(false); }
}
}
var admission = new Admission();
try { worker.execute(admission); }
catch (RejectedExecutionException rejected) { admission.finish(false); }
}
public void releaseCapture(UUID id) {
synchronized (lock) { captureReservations.remove(id); }
}
public record RetiringCapture(String username, String serviceSite, long time, UUID id,
java.util.function.BooleanSupplier executionReleased,
java.util.function.BooleanSupplier completed, Consumer<Boolean> completion) {
public RetiringCapture {
java.util.Objects.requireNonNull(username); java.util.Objects.requireNonNull(serviceSite);
java.util.Objects.requireNonNull(id); java.util.Objects.requireNonNull(executionReleased);
java.util.Objects.requireNonNull(completed); java.util.Objects.requireNonNull(completion);
if (time <= 0) throw new IllegalArgumentException("capture receipt time must be positive");
}
}
/** One FIFO batch, before close's final snapshot; normal overflow admission stays capped at256. */
public void retireCaptures(List<RetiringCapture> captures) {
var snapshot = List.copyOf(captures);
if (snapshot.size() > MAX_CAPTURED) throw new IllegalArgumentException("capture retirement exceeds capacity");
if (snapshot.isEmpty()) return;
class Transfer implements Runnable {
@Override public void run() {
synchronized (lock) {
if (!closed && (!loaded || loadFailed)) {
scheduleInitializationRetryLocked();
worker.schedule(this, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
return;
}
}
boolean[] results = new boolean[snapshot.size()];
try {
for (int index = 0; index < snapshot.size(); index++) {
var capture = snapshot.get(index);
boolean completed = false;
try { completed = capture.completed().getAsBoolean(); }
catch (RuntimeException | Error unknown) { /* Retain unconfirmed completion. */ }
synchronized (lock) {
if (!closed && loaded && !loadFailed) {
var existing = occurrence(capture.id());
if (completed) {
captureReservations.remove(capture.id());
results[index] = true;
} else if (existing != null) {
results[index] = matches(existing, capture.username(), capture.serviceSite(), capture.time());
if (results[index]) captureReservations.remove(capture.id());
} else if (entries.size() < MAX_RETAINED_ENTRIES
&& (captureReservations.contains(capture.id())
|| entries.size() + captureReservations.size() < MAX_RETAINED_ENTRIES)) {
entries.addLast(new PendingVote(capture.username(), capture.serviceSite(), capture.time(),
capture.id(), capture.executionReleased()));
captureReservations.remove(capture.id());
stateVersion++; requestPersistenceLocked();
results[index] = true;
}
}
}
}
// Retain the whole batch before any external completion callback.
for (int index = 0; index < snapshot.size(); index++) {
try { snapshot.get(index).completion().accept(results[index]); }
catch (RuntimeException | Error failure) {
try { plugin.getLogger().warning("Votifier retirement callback failed; queue ownership is retained"); }
catch (RuntimeException | Error ignored) { }
}
}
} finally {
synchronized (lock) { pendingRetirementCaptures -= snapshot.size(); }
}
}
}
boolean submitted = false;
synchronized (lock) {
if (!closed && !closing && pendingRetirementCaptures + snapshot.size() <= MAX_CAPTURED) {
pendingRetirementCaptures += snapshot.size();
try { worker.execute(new Transfer()); retirementRequested = true; submitted = true; }
catch (RejectedExecutionException rejected) { pendingRetirementCaptures -= snapshot.size(); }
}
}
if (!submitted) for (var capture : snapshot) {
try { capture.completion().accept(false); }
catch (RuntimeException | Error ignored) { /* Reject every bounded caller, including the suffix. */ }
}
}
private void scheduleInitializationRetryLocked() {
if (closed || initializationRetryScheduled || loaded && !loadFailed) return;
initializationRetryScheduled = true;
worker.schedule(() -> {
synchronized (lock) {
initializationRetryScheduled = false;
if (closed) return;
}
load();
}, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
}
private PendingVote occurrence(UUID id) {
for (var vote : entries) if (vote.localOccurrenceId.equals(id)) return vote;
return null;
}
private static boolean matches(PendingVote vote, String username, String site, long time) {
return vote.username.equals(username) && vote.serviceSite.equals(site) && vote.time == time;
}
/** Completion only; transfers separately report load/capacity admission failure. */
public boolean isInitializationComplete() { return loaded; }
/**
* Returns the number of votes waiting for admission or completion.
*
@@ -126,7 +451,7 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
}
private void scheduleDrainLocked() {
if (closed || !started || drainScheduled) return;
if (closed || closing || !loaded || loadFailed || !started || drainScheduled) return;
drainScheduled = true;
try {
worker.schedule(this::drain, 0, TimeUnit.MILLISECONDS);
@@ -137,7 +462,14 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
private void drain() {
while (true) {
// A generation fence parks its receipts instead of repeatedly submitting
// callbacks which are forbidden to execute (including inline submitters).
if (!processingAllowed.getAsBoolean()) {
synchronized (lock) { drainScheduled = false; }
return;
}
synchronized (lock) {
if (closed || closing || !loaded || loadFailed) { drainScheduled = false; return; }
if (durableVersion != stateVersion) {
drainScheduled = false;
return;
@@ -152,10 +484,23 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
// Serialize admission with enqueue so the version proven durable
// above cannot change in the gap before submit accepts this vote.
plugin.getVoteTimer().submit(() -> {
boolean attempted = false;
boolean completed = false;
try {
processor.accept(pending.serviceSite, pending.username);
if (!processingAllowed.getAsBoolean()) return;
synchronized (lock) {
if (closed || closing || !entries.contains(pending)) return;
}
attempted = true;
completed = processor.processConfirmed(pending.serviceSite, pending.username,
pending.time, pending.localOccurrenceId) && !Thread.currentThread().isInterrupted();
} catch (RuntimeException | Error failure) {
plugin.getLogger().warning("Queued Votifier processing failed; retained receipt for retry: "
+ failure.getClass().getSimpleName());
throw failure;
} finally {
acknowledge(pending);
if (completed) acknowledge(pending);
else retainFailedAttempt(pending, attempted);
}
});
} catch (RejectedExecutionException rejected) {
@@ -168,27 +513,102 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
// The queue is closing; the persisted entry remains for restart.
}
return;
} catch (RuntimeException | Error failure) {
// An inline submitter can expose callback failure on this worker.
// Retain retry ownership without leaving drainScheduled stuck true.
drainScheduled = false;
retainFailedAttempt(pending, true);
throw failure;
}
}
}
}
private PendingVote nextUnsubmittedLocked() {
long now = System.nanoTime();
boolean retryWaiting = false;
for (PendingVote pending : entries) {
if (!pending.submitted) return pending;
if (pending.submitted || !pending.executionReleased.getAsBoolean()) continue;
if (pending.retryNotBeforeNanos != 0 && now - pending.retryNotBeforeNanos < 0) {
retryWaiting = true;
continue;
}
return pending;
}
if (retryWaiting) scheduleDrainRetryLocked();
return null;
}
private void retainFailedAttempt(PendingVote pending, boolean attempted) {
synchronized (lock) {
pending.submitted = false;
if (closed || closing || !entries.contains(pending) || !attempted) return;
// Inline submitters must not retry this same receipt in the current drain.
pending.retryNotBeforeNanos = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(RETRY_DELAY_MILLIS);
scheduleDrainRetryLocked();
}
}
private void scheduleDrainRetryLocked() {
if (closed || closing || !loaded || loadFailed || !started || drainRetryScheduled) return;
drainRetryScheduled = true;
try {
worker.schedule(() -> {
synchronized (lock) {
drainRetryScheduled = false;
scheduleDrainLocked();
}
}, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
} catch (RejectedExecutionException rejected) { drainRetryScheduled = false; }
}
private void acknowledge(PendingVote pending) {
synchronized (lock) {
entries.remove(pending);
if (closed) {
plugin.getLogger().warning("Completed Votifier callback outlived queue shutdown; retained occurrence requires reconciliation");
return;
}
if (!entries.remove(pending)) return;
stateVersion++;
requestPersistenceLocked();
scheduleDrainLocked();
}
}
/** Reconcile a receipt whose original normal callback completed during transfer. */
public void acknowledgeOccurrence(UUID localOccurrenceId) {
synchronized (lock) {
if (closed) {
// A nonterminating callback outlived the final snapshot. A retired
// writer cannot overwrite a successor's queue; retain uncertainty.
plugin.getLogger().warning("Completed Votifier callback outlived queue shutdown; retained occurrence requires reconciliation");
return;
}
if (!entries.removeIf(pending -> pending.localOccurrenceId.equals(localOccurrenceId))) return;
stateVersion++; requestPersistenceLocked(); scheduleDrainLocked();
}
}
/** Wake the same bounded drain when an original transferred callback finishes uncertainly. */
public void resumeTransfers() { scheduleDrain(); }
/** One wakeup for the ingress listener's bounded failed-transfer captures.
* Retry runs outside the queue monitor and never adds another executor or waiter list. */
public void retryCaptureTransfers(Runnable retry) {
synchronized (lock) {
if (closed || closing || captureRetryScheduled) return;
captureRetryScheduled = true;
try {
worker.schedule(() -> {
synchronized (lock) {
captureRetryScheduled = false;
if (closed || closing) return;
}
retry.run();
}, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
} catch (RejectedExecutionException rejected) { captureRetryScheduled = false; }
}
}
private void requestPersistenceLocked() {
persistenceDirty = true;
if (persistenceScheduled) return;
@@ -239,18 +659,32 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
}
private void load() {
ArrayDeque<PendingVote> recovered = new ArrayDeque<>();
boolean successful = false;
try {
if (!Files.exists(file, LinkOption.NOFOLLOW_LINKS)) return;
synchronized (lock) { if (closed || loaded && !loadFailed) return; }
if (!acquireOwner()) {
synchronized (lock) {
if (asynchronousInitialization && !closing || pendingRetirementCaptures > 0 || pendingIngress > 0) {
scheduleInitializationRetryLocked();
return;
}
}
throw new IOException("queue file is owned by another active instance");
}
if (!Files.exists(file, LinkOption.NOFOLLOW_LINKS)) {
if (queueFileObserved) throw new IOException("queue file disappeared before recovery");
successful = true;
return;
}
queueFileObserved = true;
YamlConfiguration yaml = new YamlConfiguration();
yaml.loadFromString(readQueueFile());
Object raw = yaml.get("Votes");
if (!(raw instanceof List<?> values)) return;
if (!(raw instanceof List<?> values)) throw new IOException("queue votes are not a list");
if (values.size() > MAX_RETAINED_ENTRIES) throw new IOException("queue exceeds entry capacity");
boolean skipped = false;
for (Object value : values) {
if (entries.size() >= MAX_ENTRIES) {
skipped = true;
break;
}
if (!(value instanceof Map<?, ?> map)) {
skipped = true;
continue;
@@ -265,16 +699,111 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
skipped = true;
continue;
}
entries.addLast(new PendingVote(name, site, timestamp.longValue()));
UUID localOccurrenceId;
if (!map.containsKey("LocalOccurrenceId")) {
localOccurrenceId = UUID.randomUUID();
skipped = true; // Publish the migration before admitting any recovered row.
} else {
Object rawId = map.get("LocalOccurrenceId");
try {
if (!(rawId instanceof String id)) throw new IllegalArgumentException();
localOccurrenceId = UUID.fromString(id);
if (!localOccurrenceId.toString().equalsIgnoreCase(id)) throw new IllegalArgumentException();
} catch (IllegalArgumentException malformed) {
skipped = true;
continue; // Explicit corrupt IDs cannot become fresh occurrences.
}
}
recovered.addLast(new PendingVote(name, site, timestamp.longValue(), localOccurrenceId));
}
synchronized (lock) { entries.clear(); entries.addAll(recovered); }
if (skipped) {
synchronized (lock) {
stateVersion++;
requestPersistenceLocked();
}
}
successful = true;
} catch (Exception failure) {
plugin.getLogger().warning("Unable to load queued Votifier votes: " + failure.getClass().getSimpleName());
loadFailed = true;
if (!initializationFailureReported) {
initializationFailureReported = true;
plugin.getLogger().warning("Unable to load queued Votifier votes: " + failure.getClass().getSimpleName());
}
} finally {
if (ownerLock == null && !loadFailed) return;
if (successful) loadFailed = false;
loaded = true;
synchronized (lock) {
scheduleDrainLocked();
if (loadFailed && pendingRetirementCaptures > 0) scheduleInitializationRetryLocked();
}
}
}
private boolean acquireOwner() throws IOException {
if (ownerLock != null && ownerLock.isValid()) return true;
Path parent = ownerFile.toAbsolutePath().normalize().getParent();
if (parent == null || Files.isSymbolicLink(ownerFile)) throw new IOException("queue ownership file is unsafe");
Files.createDirectories(parent);
String key = SHARED_OWNER_PROPERTY_PREFIX + hashOwnerPath(parent.toRealPath().resolve(ownerFile.getFileName()));
String token = UUID.randomUUID().toString();
Properties properties = System.getProperties();
synchronized (properties) {
if (properties.getProperty(key) != null) return false;
int reservations = 0;
for (Object property : properties.keySet())
if (property instanceof String name && name.startsWith(SHARED_OWNER_PROPERTY_PREFIX)) reservations++;
if (reservations >= MAX_OWNER_RESERVATIONS) return false;
properties.setProperty(key, token);
}
try {
FileChannel channel = FileChannel.open(ownerFile, StandardOpenOption.CREATE, StandardOpenOption.WRITE,
LinkOption.NOFOLLOW_LINKS);
try {
FileLock acquired;
try { acquired = channel.tryLock(); }
catch (OverlappingFileLockException busy) { acquired = null; }
if (acquired == null) { channel.close(); clearOwnerReservation(properties, key, token); return false; }
ownerKey = key; ownerToken = token; ownerProperties = properties; ownerChannel = channel; ownerLock = acquired;
return true;
} catch (IOException | RuntimeException failure) {
channel.close();
clearOwnerReservation(properties, key, token);
throw failure;
}
} catch (IOException | RuntimeException failure) {
clearOwnerReservation(properties, key, token);
throw failure;
}
}
private void releaseOwner() {
try { if (ownerLock != null) ownerLock.release(); } catch (IOException ignored) { }
try { if (ownerChannel != null) ownerChannel.close(); } catch (IOException ignored) { }
clearOwnerReservation(ownerProperties, ownerKey, ownerToken);
ownerLock = null;
ownerChannel = null;
ownerKey = null;
ownerToken = null;
ownerProperties = null;
}
private static void clearOwnerReservation(Properties properties, String key, String token) {
if (properties == null || key == null || token == null) return;
synchronized (properties) {
if (token.equals(properties.getProperty(key))) properties.remove(key);
}
}
private static String hashOwnerPath(Path path) throws IOException {
try {
byte[] digest = MessageDigest.getInstance("SHA-256").digest(path.toString().getBytes(StandardCharsets.UTF_8));
StringBuilder result = new StringBuilder(digest.length * 2);
for (byte value : digest) result.append(String.format("%02x", value));
return result.toString();
} catch (NoSuchAlgorithmException impossible) {
throw new IOException("SHA-256 unavailable", impossible);
}
}
@@ -298,6 +827,8 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
}
private void writeSnapshotLocked(List<PendingVote> snapshot) throws IOException {
if (ownerLock == null || !ownerLock.isValid()) throw new IOException("queue file ownership is unavailable");
if (snapshot.size() > MAX_RETAINED_ENTRIES) throw new IOException("queue snapshot exceeds entry capacity");
YamlConfiguration yaml = new YamlConfiguration();
List<Map<String, Object>> values = new ArrayList<>();
for (PendingVote pending : snapshot) {
@@ -305,6 +836,7 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
value.put("Username", pending.username);
value.put("ServiceSite", pending.serviceSite);
value.put("Time", pending.time);
value.put("LocalOccurrenceId", pending.localOccurrenceId.toString());
values.add(value);
}
yaml.set("Votes", values);
@@ -330,21 +862,26 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
@Override
public void close() {
List<PendingVote> snapshot;
List<PendingVote> snapshot = null;
boolean initializedWorker;
synchronized (lock) {
if (closed) return;
closed = true;
// At-least-once delivery: retain any unacknowledged callback. A callback
// interrupted during shutdown must be replayed rather than silently lost.
snapshot = new ArrayList<>(entries);
persistenceScheduled = false;
initializedWorker = asynchronousInitialization || retirementRequested || pendingIngress > 0;
if (!initializedWorker) {
if (closed) return;
closed = true;
// Legacy callers keep their existing close path until retirement admission.
snapshot = new ArrayList<>(entries);
persistenceScheduled = false;
}
}
if (initializedWorker) { closeInitializedWorker(); return; }
worker.shutdownNow();
try {
worker.awaitTermination(1, TimeUnit.SECONDS);
} catch (InterruptedException interrupted) {
Thread.currentThread().interrupt();
}
if (loadFailed) { releaseOwner(); return; }
try {
synchronized (persistenceWriteLock) {
writeSnapshotLocked(snapshot);
@@ -353,18 +890,87 @@ public final class VotifierVoteOverflowQueue implements AutoCloseable {
plugin.getLogger().warning("Unable to persist queued Votifier votes during shutdown: "
+ failure.getClass().getSimpleName());
}
releaseOwner();
}
private void closeInitializedWorker() {
synchronized (lock) {
if (!closing && !closed) {
closing = true;
// Keep the existing worker and file owner through failed final publication.
worker.execute(this::finishClosePublication);
}
}
try { closePublication.get(1, TimeUnit.SECONDS); }
catch (java.util.concurrent.TimeoutException pending) {
plugin.getLogger().warning("Votifier queue shutdown publication is still pending on its worker; recovery is unconfirmed");
} catch (InterruptedException interrupted) { Thread.currentThread().interrupt(); }
catch (java.util.concurrent.ExecutionException failure) {
throw new IllegalStateException("Votifier queue shutdown publication failed", failure.getCause());
}
}
private void finishClosePublication() {
List<PendingVote> snapshot;
long version;
synchronized (lock) {
if (closed) return;
if (pendingRetirementCaptures > 0 || pendingIngress > 0) {
if (!loaded || loadFailed) scheduleInitializationRetryLocked();
worker.schedule(this::finishClosePublication, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
return;
}
snapshot = new ArrayList<>(entries);
version = stateVersion;
}
if (loadFailed || !loaded) {
// Unreadable/unowned storage is unknown; never replace it with an empty guess.
synchronized (lock) { closed = true; }
releaseOwner(); worker.shutdown(); closePublication.complete(null);
return;
}
try { synchronized (persistenceWriteLock) { writeSnapshotLocked(snapshot); } }
catch (IOException failure) {
if (!closeFailureReported) {
closeFailureReported = true;
try { plugin.getLogger().warning("Unable to publish final Votifier queue; its worker retains ownership for retry"); }
catch (RuntimeException | Error ignored) { }
}
worker.schedule(this::finishClosePublication, RETRY_DELAY_MILLIS, TimeUnit.MILLISECONDS);
return;
}
synchronized (lock) {
// A confirmed original callback may have removed a receipt during IO.
if (version != stateVersion) {
worker.execute(this::finishClosePublication);
return;
}
closed = true;
durableVersion = version;
}
releaseOwner(); worker.shutdown(); closePublication.complete(null);
}
private static final class PendingVote {
private final String username;
private final String serviceSite;
private final long time;
private final UUID localOccurrenceId;
private final java.util.function.BooleanSupplier executionReleased;
private boolean submitted;
private long retryNotBeforeNanos;
private PendingVote(String username, String serviceSite, long time) {
private PendingVote(String username, String serviceSite, long time, UUID localOccurrenceId) {
this(username, serviceSite, time, localOccurrenceId, () -> true);
}
private PendingVote(String username, String serviceSite, long time, UUID localOccurrenceId,
java.util.function.BooleanSupplier executionReleased) {
this.username = username;
this.serviceSite = serviceSite;
this.time = time;
this.localOccurrenceId = localOccurrenceId;
this.executionReleased = java.util.Objects.requireNonNull(executionReleased);
}
}
}
@@ -0,0 +1,212 @@
package com.bencodez.votingplugin.maintenance;
import java.io.IOException;
import java.nio.file.Path;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.LongSupplier;
import java.util.logging.Logger;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState.Candidate;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState.Snapshot;
import com.bencodez.votingplugin.util.DurableFiles.PublishedException;
/** Owner-only console reminder; all file work runs on its bounded background worker. */
public final class AutoCreateVoteSitesReminderService {
public record Settings(boolean enabled, boolean autoCreateEnabled, long afterMillis, long repeatMillis) {
public Settings {
if (afterMillis < 0 || repeatMillis <= 0
|| afterMillis > AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS
|| repeatMillis > AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS) {
throw new IllegalArgumentException("Reminder intervals must be non-negative and bounded");
}
}
}
@FunctionalInterface
interface StoreFactory {
AutoCreateVoteSitesReminderStore create(Path directory) throws IOException;
}
private final Path directory;
private final ScheduledExecutorService executor;
private final Logger logger;
private final LongSupplier clock;
private final StoreFactory storeFactory;
private final long startedNanos;
private final AtomicBoolean started = new AtomicBoolean();
private final AtomicBoolean recoveryRequested = new AtomicBoolean();
private record CloseRequest(CompletableFuture<Void> result, long stoppedNanos) { }
private final AtomicReference<CloseRequest> closing = new AtomicReference<>();
private final Object clockGate = new Object();
private volatile Settings settings;
private volatile ScheduledFuture<?> task;
// Accessed only inside the serialized worker checkpoint, never by gameplay callers.
private AutoCreateVoteSitesReminderStore store;
private AutoCreateVoteSitesReminderState state;
private boolean failed;
private boolean checkpointRequired;
private boolean waitingReported;
public AutoCreateVoteSitesReminderService(Path directory, ScheduledExecutorService executor,
Logger logger, Settings settings) {
this(directory, executor, logger, settings, System::nanoTime, AutoCreateVoteSitesReminderStore::new);
}
AutoCreateVoteSitesReminderService(Path directory, ScheduledExecutorService executor,
Logger logger, Settings settings, LongSupplier clock, StoreFactory storeFactory) {
this.directory = Objects.requireNonNull(directory);
this.executor = Objects.requireNonNull(executor);
this.logger = Objects.requireNonNull(logger);
this.settings = Objects.requireNonNull(settings);
this.clock = Objects.requireNonNull(clock);
this.storeFactory = Objects.requireNonNull(storeFactory);
startedNanos = clock.getAsLong();
}
public void start() {
if (closing.get() != null || !started.compareAndSet(false, true)) return;
try {
task = executor.scheduleWithFixedDelay(this::tick, 0, 60, TimeUnit.SECONDS);
if (closing.get() != null) task.cancel(false);
} catch (RuntimeException rejected) {
logger.warning("AutoCreateVoteSites setup reminder could not start; voting is unaffected.");
}
}
/** Reload is a snapshot update, never synchronous file I/O or another periodic task. */
public void reload(Settings next) {
settings = Objects.requireNonNull(next);
recoveryRequested.set(true);
}
private void tick() {
long nowNanos;
synchronized (clockGate) {
if (closing.get() != null) return;
nowNanos = clock.getAsLong();
}
try {
checkpoint(nowNanos, false);
} catch (IOException | RuntimeException failure) {
logger.warning("AutoCreateVoteSites setup reminder paused after a checkpoint failure; "
+ "repair its checkpoint if necessary and reload or restart. Voting is unaffected.");
}
}
private synchronized void checkpoint(long nowNanos, boolean finalCheckpoint) throws IOException {
CloseRequest stopped = closing.get();
if (stopped != null) {
if (!finalCheckpoint) return;
nowNanos = stopped.stoppedNanos();
}
if (failed && !recoveryRequested.getAndSet(false)) {
if (finalCheckpoint) throw new IOException("Reminder checkpoint remains unavailable");
return;
}
try {
if (store == null) store = storeFactory.create(directory);
if (!store.tryAcquireLease()) {
if (finalCheckpoint) throw new IOException("Final reminder checkpoint has no storage ownership");
if (!waitingReported) {
logger.warning("AutoCreateVoteSites setup reminder is waiting for a retiring reminder worker; "
+ "voting is unaffected.");
waitingReported = true;
}
return;
}
waitingReported = false;
if (state == null || failed) {
Snapshot saved;
try {
saved = store.load();
} catch (IOException | RuntimeException unverified) {
checkpointRequired = true;
throw unverified;
}
if (saved == null && checkpointRequired) {
throw new IOException("Reminder checkpoint was removed while running");
}
if (saved != null) checkpointRequired = true;
state = new AutoCreateVoteSitesReminderState(saved == null ? new Snapshot(0, -1) : saved,
state == null && !failed ? startedNanos : nowNanos);
failed = false;
} else if (checkpointRequired && store.load() == null) {
throw new IOException("Reminder checkpoint was removed while running");
}
recoveryRequested.set(false);
Settings current = settings;
Candidate candidate = state.propose(nowNanos, !finalCheckpoint && current.enabled(),
current.autoCreateEnabled(), current.afterMillis(), current.repeatMillis());
try {
store.save(candidate.snapshot());
} catch (PublishedException uncertain) {
checkpointRequired = true;
throw uncertain;
}
checkpointRequired = true;
state.commit(candidate);
// Do not publish a stale warning if shutdown or configuration changed during I/O.
if (candidate.reminderDue() && closing.get() == null && current.equals(settings)) {
logger.warning("After voting-site setup, set AutoCreateVoteSites: false in Config.yml.");
}
} catch (IOException | RuntimeException failure) {
failed = true;
throw failure;
}
}
/** Cancel promptly; enqueue the final checkpoint without blocking the server thread. */
public CompletableFuture<Void> closeAsync() {
CloseRequest request;
synchronized (clockGate) {
CloseRequest existing = closing.get();
if (existing != null) return existing.result();
request = new CloseRequest(new CompletableFuture<>(), clock.getAsLong());
closing.set(request);
}
CompletableFuture<Void> result = request.result();
long stoppedNanos = request.stoppedNanos();
ScheduledFuture<?> current = task;
if (current != null) current.cancel(false);
if (!started.get()) {
result.complete(null);
return result;
}
try {
executor.execute(() -> {
Exception failure = null;
try {
checkpoint(stoppedNanos, true);
} catch (IOException | RuntimeException checkpointFailure) {
failure = checkpointFailure;
} finally {
if (store != null) {
try {
store.releaseLease();
} catch (IOException | RuntimeException cleanupFailure) {
if (failure == null) failure = cleanupFailure;
else failure.addSuppressed(cleanupFailure);
}
}
}
if (failure == null) result.complete(null);
else {
logger.warning("AutoCreateVoteSites reminder checkpoint or cleanup did not complete; "
+ "inspect its storage before reloading.");
result.completeExceptionally(failure);
}
});
} catch (RuntimeException rejected) {
result.completeExceptionally(rejected);
}
return result;
}
}
@@ -0,0 +1,240 @@
package com.bencodez.votingplugin.maintenance;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.nio.channels.OverlappingFileLockException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.nio.file.OpenOption;
import java.nio.file.StandardOpenOption;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.PosixFileAttributeView;
import java.nio.file.attribute.PosixFilePermissions;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Arrays;
import java.util.Objects;
import java.util.Set;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState.Snapshot;
import com.bencodez.votingplugin.util.DurableFiles;
/**
* A fixed, checksummed active-runtime checkpoint in the plugin's existing data
* directory. One reminder worker owns all load/save operations. This store never
* creates the directory, repairs corrupt records, or follows a record symlink.
*/
public final class AutoCreateVoteSitesReminderStore {
private static final String FILE_NAME = ".auto-create-sites-reminder.dat";
private static final byte[] MAGIC = "VPACR001".getBytes(StandardCharsets.US_ASCII);
private static final int HEADER_BYTES = 24;
private static final int RECORD_BYTES = 56;
private final Path directory;
private final Path target;
private final Publisher publisher;
private FileChannel leaseChannel;
private FileLock lease;
@FunctionalInterface
interface Publisher {
void publish(Path staged, Path target) throws IOException;
}
public AutoCreateVoteSitesReminderStore(Path dataDirectory) throws IOException {
this(dataDirectory, DurableFiles::publishStagedFile);
}
AutoCreateVoteSitesReminderStore(Path dataDirectory, Publisher publisher) throws IOException {
this.directory = Objects.requireNonNull(dataDirectory, "dataDirectory").toAbsolutePath().normalize();
this.target = directory.resolve(FILE_NAME);
this.publisher = Objects.requireNonNull(publisher, "publisher");
validateDirectory();
}
/**
* Nonblocking admission across plugin instances/class loaders in one JVM, held
* through final publication. Multiple JVMs sharing the directory are unsupported:
* closing another channel may release native locks on some platforms.
*/
public boolean tryAcquireLease() throws IOException {
if (lease != null && lease.isValid()) return true;
validateDirectory();
Path lockPath = directory.resolve(".auto-create-sites-reminder.lock");
try {
BasicFileAttributes attributes = Files.readAttributes(lockPath, BasicFileAttributes.class,
LinkOption.NOFOLLOW_LINKS);
if (!attributes.isRegularFile() || attributes.isSymbolicLink() || attributes.size() != 0) {
throw new IOException("Invalid reminder ownership file");
}
} catch (NoSuchFileException absent) {
// Create only this fixed empty metadata file inside the checked data directory.
}
Set<OpenOption> options = Set.of(StandardOpenOption.CREATE, StandardOpenOption.WRITE,
LinkOption.NOFOLLOW_LINKS);
FileChannel channel = Files.getFileAttributeView(directory, PosixFileAttributeView.class,
LinkOption.NOFOLLOW_LINKS) == null ? FileChannel.open(lockPath, options)
: FileChannel.open(lockPath, options,
PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rw-------")));
boolean acquired = false;
try {
if (channel.size() != 0) throw new IOException("Invalid reminder ownership file");
FileLock candidate;
try {
candidate = channel.tryLock();
} catch (OverlappingFileLockException busy) {
return false;
}
if (candidate == null) return false;
leaseChannel = channel;
lease = candidate;
acquired = true;
return true;
} finally {
if (!acquired) channel.close();
}
}
/** Closing the channel releases its lock; keep the fixed lock file for successors. */
public void releaseLease() throws IOException {
FileChannel channel = leaseChannel;
leaseChannel = null;
lease = null;
if (channel != null) channel.close();
}
/** Returns null only when the record is absent from a valid existing directory. */
public Snapshot load() throws IOException {
validateDirectory();
try {
return readRecord(target);
} catch (NoSuchFileException absent) {
// A missing/replaced data directory is a failure, not an absent checkpoint.
validateDirectory();
if (Files.notExists(target, LinkOption.NOFOLLOW_LINKS)) {
return null;
}
throw absent;
}
}
/**
* Publish a checked same-directory staged record using DurableFiles. Existing
* invalid or unreadable records block replacement. PublishedException propagates
* unchanged: the new record may already be visible, so no rollback is attempted.
*/
public void save(Snapshot snapshot) throws IOException {
Objects.requireNonNull(snapshot, "snapshot");
load();
Path staged = createStagedFile();
Throwable failure = null;
try {
ByteBuffer record = ByteBuffer.wrap(encode(snapshot));
try (FileChannel channel = FileChannel.open(staged, StandardOpenOption.WRITE,
StandardOpenOption.TRUNCATE_EXISTING, LinkOption.NOFOLLOW_LINKS)) {
while (record.hasRemaining()) {
if (channel.write(record) <= 0) {
throw new IOException("Could not write reminder checkpoint");
}
}
}
if (!snapshot.equals(readRecord(staged))) {
throw new IOException("Staged reminder checkpoint did not match");
}
// Recheck after staging, before replacing any existing destination.
load();
publisher.publish(staged, target);
} catch (IOException | RuntimeException | Error primary) {
failure = primary;
throw primary;
} finally {
try {
Files.deleteIfExists(staged);
} catch (IOException | RuntimeException cleanup) {
if (failure != null) {
failure.addSuppressed(cleanup);
} else {
throw new DurableFiles.PublishedException(cleanup instanceof IOException io ? io
: new IOException("Reminder staging cleanup failed after publication", cleanup));
}
}
}
}
private void validateDirectory() throws IOException {
BasicFileAttributes attributes = Files.readAttributes(directory, BasicFileAttributes.class,
LinkOption.NOFOLLOW_LINKS);
if (!attributes.isDirectory() || attributes.isSymbolicLink()) {
throw new IOException("Reminder data directory must be an existing directory");
}
}
private Path createStagedFile() throws IOException {
if (Files.getFileAttributeView(directory, PosixFileAttributeView.class, LinkOption.NOFOLLOW_LINKS) != null) {
return Files.createTempFile(directory, ".auto-create-sites-reminder-", ".tmp",
PosixFilePermissions.asFileAttribute(PosixFilePermissions.fromString("rw-------")));
}
return Files.createTempFile(directory, ".auto-create-sites-reminder-", ".tmp");
}
private static Snapshot readRecord(Path recordPath) throws IOException {
BasicFileAttributes attributes = Files.readAttributes(recordPath, BasicFileAttributes.class,
LinkOption.NOFOLLOW_LINKS);
if (!attributes.isRegularFile() || attributes.isSymbolicLink() || attributes.size() != RECORD_BYTES) {
throw new IOException("Invalid reminder checkpoint file");
}
ByteBuffer record = ByteBuffer.allocate(RECORD_BYTES);
try (FileChannel channel = FileChannel.open(recordPath, StandardOpenOption.READ, LinkOption.NOFOLLOW_LINKS)) {
if (channel.size() != RECORD_BYTES) {
throw new IOException("Invalid reminder checkpoint length");
}
while (record.hasRemaining()) {
if (channel.read(record) <= 0) {
throw new IOException("Incomplete reminder checkpoint");
}
}
if (channel.size() != RECORD_BYTES || channel.read(ByteBuffer.allocate(1)) != -1) {
throw new IOException("Trailing reminder checkpoint data");
}
}
return decode(record.array());
}
private static byte[] encode(Snapshot snapshot) {
ByteBuffer record = ByteBuffer.allocate(RECORD_BYTES).order(ByteOrder.BIG_ENDIAN);
record.put(MAGIC).putLong(snapshot.totalRuntimeMillis()).putLong(snapshot.lastReminderRuntimeMillis());
record.put(digest(Arrays.copyOf(record.array(), HEADER_BYTES)));
return record.array();
}
private static Snapshot decode(byte[] record) throws IOException {
if (!Arrays.equals(MAGIC, Arrays.copyOf(record, MAGIC.length))) {
throw new IOException("Invalid reminder checkpoint schema");
}
byte[] expected = digest(Arrays.copyOf(record, HEADER_BYTES));
if (!MessageDigest.isEqual(expected, Arrays.copyOfRange(record, HEADER_BYTES, RECORD_BYTES))) {
throw new IOException("Invalid reminder checkpoint checksum");
}
ByteBuffer header = ByteBuffer.wrap(record).order(ByteOrder.BIG_ENDIAN);
header.position(MAGIC.length);
try {
return new Snapshot(header.getLong(), header.getLong());
} catch (IllegalArgumentException invalid) {
throw new IOException("Invalid reminder checkpoint counters", invalid);
}
}
private static byte[] digest(byte[] header) {
try {
return MessageDigest.getInstance("SHA-256").digest(header);
} catch (NoSuchAlgorithmException unavailable) {
throw new IllegalStateException("SHA-256 is unavailable", unavailable);
}
}
}
@@ -1,119 +0,0 @@
package com.bencodez.votingplugin.npc;
import java.util.Arrays;
import java.util.UUID;
import java.util.concurrent.CompletionStage;
import org.bukkit.Location;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import com.bencodez.advancedcore.api.command.CommandHandler;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
/** Normal /av command handlers; no separate command map or player GUI registry. */
public final class VotingNPCCommands {
private static final String PERMISSION = "VotingPlugin.Commands.AdminVote.NPC";
private VotingNPCCommands() { }
public static void register(VotingPluginMain plugin) {
add(plugin, new String[] { "NPC", "Create", "(string)" }, false);
add(plugin, new String[] { "NPC", "Create", "(string)", "(list)" }, false);
add(plugin, new String[] { "NPC", "List" }, true);
add(plugin, new String[] { "NPC", "Inspect", "(npcid)" }, true);
add(plugin, new String[] { "NPC", "Remove", "(npcid)" }, true);
}
private static void add(VotingPluginMain plugin, String[] pattern, boolean console) {
plugin.getAdminVoteCommand().add(new CommandHandler(plugin, pattern, PERMISSION + "|VotingPlugin.Admin",
"Manage saved vanilla voting NPCs", console) {
@Override public void execute(CommandSender sender, String[] args) {
// CommandHandler invokes execute asynchronously. Capture location,
// permission and messages only after reaching the sender's owner.
String[] captured = args.clone();
onSender(plugin, sender, () -> executeOwned(plugin, sender, captured));
}
});
}
private static boolean allowed(CommandSender sender) {
return (!(sender instanceof Player player) || player.isOnline())
&& (sender.hasPermission(PERMISSION) || sender.hasPermission("VotingPlugin.Admin"));
}
private static void onSender(VotingPluginMain plugin, CommandSender sender, Runnable action) {
Player player = sender instanceof Player candidate ? candidate : null;
BukkitCompletionScheduler.run(plugin, player, action, player == null ? action : () -> { }, () -> { });
}
private static void executeOwned(VotingPluginMain plugin, CommandSender sender, String[] args) {
if (!allowed(sender)) return;
VotingNPCManager manager = plugin.getVotingNPCManager();
if (manager == null || !manager.available()) {
sender.sendMessage("Voting NPCs are disabled, unsupported, or waiting for valid storage. Check VotingNPCs.Enabled in Config.yml and reload.");
return;
}
switch (args[1].toLowerCase(java.util.Locale.ROOT)) {
case "create":
if (!(sender instanceof Player player)) { sender.sendMessage("Create a voting NPC from in game."); return; }
try {
Location at = player.getLocation();
String name = args.length > 3 ? String.join(" ", Arrays.copyOfRange(args, 3, args.length)) : "&aVote";
VotingNPCDefinition definition = new VotingNPCDefinition(args[2], UUID.randomUUID(), at.getWorld().getUID(),
at.getX(), at.getY(), at.getZ(), at.getYaw(), at.getPitch(), name);
confirm(plugin, sender, manager, manager.create(definition),
ignored -> "Saved voting NPC '" + definition.id() + "'. Its villager appears when the area is loaded and available.");
} catch (IllegalArgumentException invalid) {
sender.sendMessage("Use a lowercase ID of 1-40 letters, digits, underscores or hyphens, and a name of 1-128 characters without controls.");
}
break;
case "remove":
confirm(plugin, sender, manager, manager.remove(args[2]), removed -> removed
? "Removed saved voting NPC '" + args[2] + "'; exact entity cleanup has been requested."
: "No voting NPC has that ID.");
break;
case "inspect":
manager.definitions().stream().filter(value -> value.id().equals(args[2])).findFirst().ifPresentOrElse(value ->
sender.sendMessage("Voting NPC " + value.id() + ": world " + value.world() + ", "
+ value.x() + ", " + value.y() + ", " + value.z() + "; " + manager.runtimeState(value.id())),
() -> sender.sendMessage("No voting NPC has that ID."));
break;
case "list":
sender.sendMessage("Saved voting NPCs: " + manager.definitions().size() + "/64; tracked runtime slots: " + manager.runtimeCount());
for (var value : manager.definitions()) sender.sendMessage(value.id() + ": " + manager.runtimeState(value.id()));
break;
default:
sender.sendMessage("Use /av npc create <id> [name], list, inspect <id>, or remove <id>.");
}
}
private static String failureMessage(VotingNPCManager manager, Throwable failure) {
while ((failure instanceof java.util.concurrent.CompletionException
|| failure instanceof java.util.concurrent.ExecutionException) && failure.getCause() != null) {
failure = failure.getCause();
}
if (manager.available()) {
if (failure instanceof VotingNPCRegistry.ValidationFailure validation) {
return switch (validation.reason) {
case DUPLICATE_ID -> "That voting NPC ID already exists. Use a different ID or remove it first.";
case DUPLICATE_IDENTITY -> "That voting NPC identity already exists. No definition was changed.";
case LIMIT -> "The 64 voting NPC limit has been reached. Remove an NPC before creating another.";
};
}
if (failure instanceof java.util.concurrent.RejectedExecutionException) {
return "Voting NPC storage is busy. Wait for pending changes to finish before retrying.";
}
}
return "Voting NPC change was not confirmed. Check storage and reload before retrying; no success is assumed.";
}
private static <T> void confirm(VotingPluginMain plugin, CommandSender sender, VotingNPCManager manager, CompletionStage<T> completion,
java.util.function.Function<T, String> message) {
completion.whenComplete((value, failure) -> onSender(plugin, sender, () -> {
if (!allowed(sender)) return;
sender.sendMessage(failure == null ? message.apply(value)
: failureMessage(manager, failure));
}));
}
}
@@ -1,29 +0,0 @@
package com.bencodez.votingplugin.npc;
import java.util.Objects;
import java.util.UUID;
import java.util.regex.Pattern;
/** Durable definition; it contains no live world, player, entity or reward state. */
public record VotingNPCDefinition(String id, UUID identity, UUID world, double x, double y, double z,
float yaw, float pitch, String name) {
private static final Pattern ID = Pattern.compile("[a-z0-9][a-z0-9_-]{0,39}");
public VotingNPCDefinition {
if (id == null || !ID.matcher(id).matches()) throw new IllegalArgumentException("Invalid voting NPC ID");
Objects.requireNonNull(identity, "identity");
Objects.requireNonNull(world, "world");
if (!Double.isFinite(x) || !Double.isFinite(y) || !Double.isFinite(z)
|| Math.abs(x) > 30_000_000 || Math.abs(z) > 30_000_000
|| !Float.isFinite(yaw) || !Float.isFinite(pitch)) {
throw new IllegalArgumentException("Invalid voting NPC position");
}
if (name == null || name.isEmpty() || name.length() > 128
|| name.codePoints().anyMatch(Character::isISOControl)) {
throw new IllegalArgumentException("Invalid voting NPC name");
}
}
public int chunkX() { return Math.floorDiv((int) Math.floor(x), 16); }
public int chunkZ() { return Math.floorDiv((int) Math.floor(z), 16); }
}
@@ -1,450 +0,0 @@
package com.bencodez.votingplugin.npc;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import org.bukkit.Bukkit;
import org.bukkit.ChatColor;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.entity.Entity;
import org.bukkit.entity.LivingEntity;
import org.bukkit.entity.Player;
import org.bukkit.entity.Villager;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.entity.EntityCombustEvent;
import org.bukkit.event.entity.EntityDamageEvent;
import org.bukkit.event.entity.EntityInteractEvent;
import org.bukkit.event.entity.EntityTargetEvent;
import org.bukkit.event.entity.EntityTeleportEvent;
import org.bukkit.event.entity.EntityTransformEvent;
import org.bukkit.event.player.PlayerInteractAtEntityEvent;
import org.bukkit.event.player.PlayerInteractEntityEvent;
import org.bukkit.event.player.PlayerQuitEvent;
import org.bukkit.event.vehicle.VehicleEnterEvent;
import org.bukkit.event.world.ChunkLoadEvent;
import org.bukkit.event.world.ChunkUnloadEvent;
import org.bukkit.event.world.WorldLoadEvent;
import org.bukkit.event.world.WorldUnloadEvent;
import org.bukkit.inventory.EquipmentSlot;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
/** Persistent definitions, transient public villagers, and no vote/reward accounting. */
public final class VotingNPCManager implements Listener, AutoCloseable {
private final VotingPluginMain plugin;
private final VotingNPCScheduler scheduler;
private final Consumer<Player> open;
private final Map<String, RuntimeNPC> resources = new ConcurrentHashMap<>();
private final Set<String> capacityDemand = ConcurrentHashMap.newKeySet();
private final AtomicBoolean capacityWakeQueued = new AtomicBoolean();
private final Map<UUID, RuntimeNPC> entities = new ConcurrentHashMap<>();
private final Set<ChunkKey> unloadingChunks = ConcurrentHashMap.newKeySet();
private final Set<UUID> unloadingWorlds = ConcurrentHashMap.newKeySet();
private final Map<UUID, Long> recentClicks = new LinkedHashMap<>();
private volatile VotingNPCRegistry registry;
private volatile boolean enabled;
private volatile boolean closed;
private volatile long configuration;
private final AtomicBoolean warned = new AtomicBoolean();
private record ChunkKey(UUID world, int x, int z) { }
private static final class RuntimeNPC {
final VotingNPCDefinition definition;
final Location anchor;
final long configuration;
boolean closed, cleanupQueued, reconstructRequested;
Villager entity;
UUID entityId;
RuntimeNPC(VotingNPCDefinition definition, World world, long configuration) {
this.definition = definition;
this.configuration = configuration;
anchor = new Location(world, definition.x(), definition.y(), definition.z(), definition.yaw(), definition.pitch());
}
}
public VotingNPCManager(VotingPluginMain plugin) {
this(plugin, new VotingNPCScheduler(plugin), null, player -> openVotingSites(plugin, player));
}
static void openVotingSites(VotingPluginMain plugin, Player player) {
// Reuse the normal command's permissions, asynchronous user loading,
// configured GUI, cooldown display, and URL handling; no root alias.
for (var handler : plugin.getVoteCommand()) {
if (handler.runCommand(player, new String[] { "URL" })) return;
}
player.sendMessage("Voting-site selection is unavailable.");
}
VotingNPCManager(VotingPluginMain plugin, VotingNPCScheduler scheduler, VotingNPCRegistry registry, Consumer<Player> open) {
this.plugin = plugin;
this.scheduler = scheduler;
this.registry = registry;
this.open = open;
}
public static boolean supported() {
try {
Entity.class.getMethod("setPersistent", boolean.class);
Entity.class.getMethod("setGravity", boolean.class);
Entity.class.getMethod("setInvulnerable", boolean.class);
LivingEntity.class.getMethod("setAI", boolean.class);
LivingEntity.class.getMethod("setCollidable", boolean.class);
World.class.getMethod("spawn", Location.class, Class.class, Consumer.class);
return true;
} catch (ReflectiveOperationException | LinkageError unavailable) { return false; }
}
/** Configuration callers do no file I/O and do not wait for storage. */
public void configure(boolean requested) {
VotingNPCRegistry owner;
CompletionStage<List<VotingNPCDefinition>> loading;
long generation;
boolean activate;
synchronized (this) {
if (closed) return;
generation = ++configuration;
activate = requested && supported();
enabled = activate;
if (!activate) { owner = null; loading = null; }
else {
if (registry == null) {
registry = new VotingNPCRegistry(plugin.getDataFolder().toPath().resolve("VotingNPCs.json"));
loading = registry.initialLoad();
} else loading = registry.reload();
owner = registry;
}
}
if (!activate) {
for (RuntimeNPC npc : resources.values()) retire(npc);
if (requested) report(new IllegalStateException("Vanilla voting NPC API is unavailable"));
return;
}
loading.whenComplete((definitions, failure) -> {
synchronized (VotingNPCManager.this) {
if (closed || !enabled || generation != configuration || registry != owner) return;
}
if (failure != null) {
for (RuntimeNPC npc : resources.values()) retire(npc);
report(failure);
} else {
warned.set(false);
reconcile();
}
});
}
public boolean available() {
VotingNPCRegistry owner = registry;
return !closed && enabled && owner != null && owner.available();
}
public List<VotingNPCDefinition> definitions() {
VotingNPCRegistry owner = registry;
return owner == null ? List.of() : owner.snapshot();
}
/** Returns durable definition completion; runtime creation can still await a loaded chunk. */
public CompletionStage<VotingNPCDefinition> create(VotingNPCDefinition definition) {
VotingNPCRegistry owner = registry;
if (!available()) return CompletableFuture.failedFuture(new IllegalStateException("Enable VotingNPCs and load valid storage first"));
CompletionStage<VotingNPCDefinition> completion = owner.create(definition);
completion.whenComplete((value, failure) -> mutationFinished(owner, failure));
return completion;
}
public CompletionStage<Boolean> remove(String id) {
VotingNPCRegistry owner = registry;
if (!available()) return CompletableFuture.failedFuture(new IllegalStateException("Enable VotingNPCs and load valid storage first"));
CompletionStage<Boolean> completion = owner.remove(id);
completion.whenComplete((value, failure) -> mutationFinished(owner, failure));
return completion;
}
private void mutationFinished(VotingNPCRegistry owner, Throwable failure) {
if (owner != registry || closed) return;
if (failure == null) reconcile();
else if (!owner.available()) {
for (RuntimeNPC npc : resources.values()) retire(npc);
report(failure);
}
}
private boolean current(RuntimeNPC npc) {
return available() && definitions().contains(npc.definition);
}
private void reconcile() {
retryPendingCleanup();
capacityDemand.retainAll(definitions().stream().map(VotingNPCDefinition::id).toList());
List<VotingNPCDefinition> snapshot = definitions();
Set<ChunkKey> chunks = new HashSet<>();
Set<UUID> worlds = new HashSet<>();
for (var value : snapshot) { chunks.addAll(occupiedChunks(value)); worlds.add(value.world()); }
unloadingChunks.retainAll(chunks);
unloadingWorlds.retainAll(worlds);
for (RuntimeNPC npc : resources.values()) if (!current(npc)) retire(npc);
if (!available()) return;
scheduler.global(() -> {
if (!available()) return;
for (var value : definitions()) ensure(value);
}, this::report);
}
/** Same conservative half-block bounds used for creation ownership and chunk availability. */
private static Set<ChunkKey> occupiedChunks(VotingNPCDefinition value) {
Set<ChunkKey> chunks = new HashSet<>();
for (double dx : new double[] { -.5, .5 }) for (double dz : new double[] { -.5, .5 }) {
chunks.add(new ChunkKey(value.world(), (int) Math.floor(value.x() + dx) >> 4,
(int) Math.floor(value.z() + dz) >> 4));
}
return chunks;
}
private boolean unloading(VotingNPCDefinition value) {
return occupiedChunks(value).stream().anyMatch(unloadingChunks::contains);
}
private void ensure(VotingNPCDefinition value) {
if (!available() || !definitions().contains(value) || unloadingWorlds.contains(value.world()) || unloading(value)) return;
World world = Bukkit.getWorld(value.world());
if (world == null) return;
RuntimeNPC npc = new RuntimeNPC(value, world, configuration);
RuntimeNPC previous;
synchronized (resources) {
previous = resources.get(value.id());
if (previous == null) {
if (resources.size() >= VotingNPCStore.MAX_NPCS) {
if (capacityDemand.size() < VotingNPCStore.MAX_NPCS) capacityDemand.add(value.id());
return;
}
resources.put(value.id(), npc);
capacityDemand.remove(value.id());
}
}
if (previous != null) {
synchronized (previous) { if (previous.closed) previous.reconstructRequested = true; }
return;
}
scheduler.region(npc.anchor, () -> spawn(npc), failure -> { retire(npc); report(failure); });
}
private boolean loadedArea(RuntimeNPC npc) {
World world = npc.anchor.getWorld();
if (Bukkit.getWorld(npc.definition.world()) != world || unloadingWorlds.contains(npc.definition.world())
|| unloading(npc.definition)) return false;
for (double dx : new double[] { -.5, .5 }) for (double dz : new double[] { -.5, .5 }) {
Location edge = npc.anchor.clone().add(dx, 0, dz);
if (!scheduler.owns(edge) || !world.isChunkLoaded(edge.getBlockX() >> 4, edge.getBlockZ() >> 4)) return false;
}
return true;
}
private void spawn(RuntimeNPC npc) {
try {
synchronized (npc) {
if (npc.closed || !current(npc) || !loadedArea(npc)) {
boolean capacityReleased = !npc.closed && !current(npc);
forget(npc, capacityReleased);
return;
}
if (npc.entity != null) return;
Villager spawned = npc.anchor.getWorld().spawn(npc.anchor, Villager.class, villager -> {
npc.entity = villager;
npc.entityId = villager.getUniqueId();
entities.put(npc.entityId, npc);
villager.setPersistent(false);
villager.setAI(false);
villager.setGravity(false);
villager.setInvulnerable(true);
villager.setSilent(true);
villager.setCollidable(false);
villager.setCanPickupItems(false);
villager.setRemoveWhenFarAway(false);
villager.setCustomName(ChatColor.translateAlternateColorCodes('&', npc.definition.name()));
villager.setCustomNameVisible(true);
});
if (spawned != npc.entity || !spawned.isValid() || !current(npc) || npc.closed) {
throw new IllegalStateException("Voting NPC spawn was cancelled or superseded");
}
}
} catch (RuntimeException | LinkageError failure) { retire(npc); report(failure); }
}
private void retire(RuntimeNPC npc) {
Villager entity;
synchronized (npc) {
npc.closed = true;
entity = npc.entity;
if (entity == null) { forget(npc, false); return; }
if (npc.cleanupQueued) return;
npc.cleanupQueued = true;
}
scheduler.entity(entity, () -> {
try { entity.remove(); forget(npc); }
catch (RuntimeException | LinkageError failure) { cleanupFailed(npc, failure); }
}, () -> forget(npc), failure -> cleanupFailed(npc, failure));
}
private void cleanupFailed(RuntimeNPC npc, Throwable failure) {
synchronized (npc) {
npc.cleanupQueued = false;
npc.reconstructRequested = true;
}
// Keep the exact identity and capacity reservation. Rejected scheduling
// is not successful removal and must not permit duplicate reconstruction.
report(failure);
}
private void retryPendingCleanup() {
for (RuntimeNPC npc : resources.values()) {
synchronized (npc) {
if (!npc.closed || !npc.reconstructRequested || npc.cleanupQueued || npc.entity == null) continue;
}
retire(npc);
}
}
private void forget(RuntimeNPC npc) { forget(npc, false); }
private void forget(RuntimeNPC npc, boolean capacityReleased) {
boolean reconstruct, removed;
synchronized (npc) {
reconstruct = npc.entity != null && (npc.reconstructRequested || npc.configuration != configuration
|| definitions().stream().anyMatch(value -> value.id().equals(npc.definition.id()) && !value.equals(npc.definition)));
if (npc.entityId != null) entities.remove(npc.entityId, npc);
npc.entity = null;
removed = resources.remove(npc.definition.id(), npc);
}
// A successor sharing this configured ID must wait for exact predecessor
// cleanup. Missing/unloaded spawn attempts do not recursively retry.
if (reconstruct && available()) scheduler.global(() -> {
for (var value : definitions()) if (value.id().equals(npc.definition.id())) ensure(value);
}, this::report);
if (removed && !capacityDemand.isEmpty() && available()
&& capacityWakeQueued.compareAndSet(false, true)) {
scheduler.global(() -> {
capacityWakeQueued.set(false);
for (var value : definitions()) if (capacityDemand.contains(value.id())) ensure(value);
}, failure -> {
capacityWakeQueued.set(false);
report(failure);
});
}
}
private void report(Throwable failure) {
if (warned.compareAndSet(false, true)) {
try {
plugin.getLogger().warning("Voting NPCs could not complete an operation; definitions are retained. Check API support and VotingNPCs.json, then reload. Cause: "
+ failure.getClass().getSimpleName());
} catch (RuntimeException ignored) { /* Reporting must not prevent independent cleanup. */ }
}
}
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void interact(PlayerInteractEntityEvent event) {
RuntimeNPC npc = entities.get(event.getRightClicked().getUniqueId());
if (npc == null) return;
boolean cancelled = event.isCancelled();
event.setCancelled(true); // Only this exact owned entity; never trading.
if (cancelled || event.getHand() != EquipmentSlot.HAND || !current(npc)) return;
synchronized (npc) { if (npc.closed) { retire(npc); return; } }
Player player = event.getPlayer();
long now = System.nanoTime();
synchronized (recentClicks) {
recentClicks.entrySet().removeIf(entry -> now - entry.getValue() >= 300_000_000L);
if (recentClicks.containsKey(player.getUniqueId()) || recentClicks.size() >= 256) return;
recentClicks.put(player.getUniqueId(), now);
}
BukkitCompletionScheduler.run(plugin, player, () -> {
if (!player.isOnline() || !current(npc) || !player.getWorld().getUID().equals(npc.definition.world())
|| player.getLocation().distanceSquared(npc.anchor) > 36) return;
synchronized (npc) { if (npc.closed) return; }
open.accept(player);
}, () -> { }, () -> { });
}
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void interactAt(PlayerInteractAtEntityEvent event) { interact(event); }
private boolean owned(Entity entity) { return entity != null && entities.containsKey(entity.getUniqueId()); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void damage(EntityDamageEvent event) { if (owned(event.getEntity())) event.setCancelled(true); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void combust(EntityCombustEvent event) { if (owned(event.getEntity())) event.setCancelled(true); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void teleport(EntityTeleportEvent event) { if (owned(event.getEntity())) event.setCancelled(true); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void transform(EntityTransformEvent event) { if (owned(event.getEntity())) event.setCancelled(true); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void target(EntityTargetEvent event) { if (owned(event.getEntity()) || owned(event.getTarget())) event.setCancelled(true); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void blockInteract(EntityInteractEvent event) { if (owned(event.getEntity())) event.setCancelled(true); }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void vehicle(VehicleEnterEvent event) { if (owned(event.getEntered())) event.setCancelled(true); }
@EventHandler public void quit(PlayerQuitEvent event) { synchronized (recentClicks) { recentClicks.remove(event.getPlayer().getUniqueId()); } }
@EventHandler(priority = EventPriority.MONITOR)
public void chunkLoad(ChunkLoadEvent event) {
UUID world = event.getWorld().getUID();
unloadingChunks.remove(new ChunkKey(world, event.getChunk().getX(), event.getChunk().getZ()));
retryPendingCleanup();
ChunkKey chunk = new ChunkKey(world, event.getChunk().getX(), event.getChunk().getZ());
for (var value : definitions()) if (occupiedChunks(value).contains(chunk)) ensure(value);
}
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
public void chunkUnload(ChunkUnloadEvent event) {
ChunkKey chunk = new ChunkKey(event.getWorld().getUID(), event.getChunk().getX(), event.getChunk().getZ());
if (definitions().stream().noneMatch(value -> occupiedChunks(value).contains(chunk))) return;
unloadingChunks.add(chunk);
for (RuntimeNPC npc : resources.values()) if (occupiedChunks(npc.definition).contains(chunk)) retire(npc);
}
@EventHandler(priority = EventPriority.MONITOR)
public void worldLoad(WorldLoadEvent event) {
UUID world = event.getWorld().getUID();
if (definitions().stream().noneMatch(value -> value.world().equals(world))) return;
unloadingWorlds.remove(world);
reconcile();
}
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
public void worldUnload(WorldUnloadEvent event) {
UUID world = event.getWorld().getUID();
if (definitions().stream().noneMatch(value -> value.world().equals(world))) return;
unloadingWorlds.add(world);
for (RuntimeNPC npc : resources.values()) if (npc.definition.world().equals(world)) retire(npc);
}
public int runtimeCount() { return resources.size(); }
public String runtimeState(String id) {
RuntimeNPC npc = resources.get(id);
if (npc == null) return "waiting for a loaded, available area";
synchronized (npc) {
if (npc.closed) return "cleanup pending";
return npc.entity == null ? "creation scheduled" : "villager created";
}
}
@Override public void close() {
synchronized (this) { if (closed) return; closed = true; enabled = false; ++configuration; }
VotingNPCRegistry owner = registry;
if (owner != null) owner.close();
for (RuntimeNPC npc : new ArrayList<>(resources.values())) retire(npc);
synchronized (recentClicks) { recentClicks.clear(); }
}
}
@@ -1,206 +0,0 @@
package com.bencodez.votingplugin.npc;
import java.io.IOException;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.nio.channels.OverlappingFileLockException;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.StandardOpenOption;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;
/**
* One bounded, daemon file owner. Completion means the definition was persisted,
* not that a world entity has spawned. Callbacks have no player/region ownership.
*/
final class VotingNPCRegistry implements AutoCloseable {
enum Rejection { DUPLICATE_ID, DUPLICATE_IDENTITY, LIMIT }
static final class ValidationFailure extends IllegalArgumentException {
private static final long serialVersionUID = 1L;
final Rejection reason;
ValidationFailure(Rejection reason) { super("Voting NPC request rejected"); this.reason = reason; }
}
private final Object admission = new Object();
private final ArrayBlockingQueue<Runnable> queue = new ArrayBlockingQueue<>(128);
private final CountDownLatch stopped = new CountDownLatch(1);
private final VotingNPCStore store;
private final Path lockPath;
private final CompletableFuture<List<VotingNPCDefinition>> initial;
private volatile Map<String, VotingNPCDefinition> definitions = Map.of();
private volatile boolean available;
private volatile boolean closed;
// Only the file worker accesses these resources.
private FileChannel lockChannel;
private FileLock lease;
private boolean storageReady;
VotingNPCRegistry(Path file) {
this(file, new VotingNPCStore(file));
}
VotingNPCRegistry(Path file, VotingNPCStore store) {
this.store = store;
lockPath = file.toAbsolutePath().normalize().resolveSibling(file.getFileName() + ".lock");
initial = submit(false, this::readDefinitions);
Thread thread = new Thread(this::work, "VotingPlugin-NPC-storage");
thread.setDaemon(true);
try { thread.start(); }
catch (RuntimeException | Error failure) {
closed = true;
initial.completeExceptionally(failure);
stopped.countDown();
throw failure;
}
}
CompletionStage<List<VotingNPCDefinition>> initialLoad() { return initial; }
boolean available() { return !closed && available; }
List<VotingNPCDefinition> snapshot() { return List.copyOf(definitions.values()); }
CompletionStage<List<VotingNPCDefinition>> reload() {
synchronized (admission) {
if (closed) return rejected("Voting NPC registry is closed");
var completion = submit(false, this::readDefinitions);
// A rejected reload changes nothing. The worker publishes readiness
// under this same short lock, after admission has finished.
if (!completion.isCompletedExceptionally()) available = false;
return completion;
}
}
CompletionStage<VotingNPCDefinition> create(VotingNPCDefinition definition) {
return submit(true, () -> {
if (definition == null) throw new IllegalArgumentException("Voting NPC definition is required");
if (definitions.containsKey(definition.id())) throw new ValidationFailure(Rejection.DUPLICATE_ID);
if (definitions.values().stream().anyMatch(value -> value.identity().equals(definition.identity()))) {
throw new ValidationFailure(Rejection.DUPLICATE_IDENTITY);
}
if (definitions.size() >= VotingNPCStore.MAX_NPCS) throw new ValidationFailure(Rejection.LIMIT);
var next = new LinkedHashMap<>(definitions);
next.put(definition.id(), definition);
publish(next);
return definition;
});
}
CompletionStage<Boolean> remove(String id) {
return submit(true, () -> {
if (!definitions.containsKey(id)) return false;
var next = new LinkedHashMap<>(definitions);
next.remove(id);
publish(next);
return true;
});
}
private List<VotingNPCDefinition> readDefinitions() throws IOException {
try {
ownFile();
List<VotingNPCDefinition> loaded = store.load();
var next = new LinkedHashMap<String, VotingNPCDefinition>();
for (VotingNPCDefinition value : loaded) next.put(value.id(), value);
definitions = java.util.Collections.unmodifiableMap(next);
storageReady = true;
synchronized (admission) { available = true; }
return loaded;
} catch (IOException | RuntimeException failure) {
storageReady = false;
synchronized (admission) { available = false; }
throw failure;
}
}
private void publish(LinkedHashMap<String, VotingNPCDefinition> next) throws IOException {
// The worker holds the process-independent lease through shutdown drain.
try { store.save(List.copyOf(next.values())); }
catch (IOException | RuntimeException | Error failure) {
// A failed write may already be visible. Neither later admitted
// mutations nor a new request may overwrite it from the old map.
storageReady = false;
synchronized (admission) { available = false; }
throw failure;
}
definitions = java.util.Collections.unmodifiableMap(next);
}
private <T> CompletableFuture<T> submit(boolean needsReady, Callable<T> action) {
synchronized (admission) {
if (closed || (needsReady && !available)) return rejected("Voting NPC storage is not available");
var completion = new CompletableFuture<T>();
Runnable task = () -> {
try {
if (needsReady && !storageReady) throw new RejectedExecutionException("Reload valid voting NPC storage before editing");
completion.complete(action.call());
}
catch (Throwable failure) { completion.completeExceptionally(failure); }
};
if (!queue.offer(task)) completion.completeExceptionally(new RejectedExecutionException("Voting NPC storage queue is full"));
return completion;
}
}
private static <T> CompletableFuture<T> rejected(String message) {
return CompletableFuture.failedFuture(new RejectedExecutionException(message));
}
private void ownFile() throws IOException {
if (lease != null && lease.isValid()) return;
if (!Files.isDirectory(lockPath.getParent().toRealPath(), LinkOption.NOFOLLOW_LINKS)) {
throw new IOException("Voting NPC data directory is unavailable");
}
FileChannel candidate = FileChannel.open(lockPath, StandardOpenOption.CREATE,
StandardOpenOption.WRITE, LinkOption.NOFOLLOW_LINKS);
try {
FileLock acquired;
try { acquired = candidate.tryLock(); }
catch (OverlappingFileLockException overlap) { throw new IOException("Voting NPC file still has an active owner", overlap); }
if (acquired == null) throw new IOException("Voting NPC file still has an active owner");
lockChannel = candidate;
lease = acquired;
} finally {
if (lockChannel != candidate) candidate.close();
}
}
private void work() {
try {
while (!closed || !queue.isEmpty()) {
Runnable task;
try { task = queue.take(); }
catch (InterruptedException interrupted) { continue; }
task.run();
}
} finally {
available = false;
try {
if (lockChannel != null) lockChannel.close();
} catch (IOException ignored) {
// Closing this channel releases its OS lease; never do this I/O
// under an admission or executor lock on a gameplay caller.
} finally { stopped.countDown(); }
}
}
/** Stops admission without blocking or interrupting an accepted file write. */
@Override public void close() {
synchronized (admission) {
if (closed) return;
closed = true;
queue.offer(() -> { }); // Wake an idle worker; a full queue already wakes it.
}
}
/** Test/owner-worker observation only; gameplay callers must never wait here. */
boolean awaitClosed(long time, TimeUnit unit) throws InterruptedException { return stopped.await(time, unit); }
}
@@ -1,77 +0,0 @@
package com.bencodez.votingplugin.npc;
import java.lang.reflect.Method;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.entity.Entity;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
/** World creation uses a region; subsequent cleanup follows the actual entity. */
class VotingNPCScheduler {
private final VotingPluginMain plugin;
private final Method locationOwner;
private final Method entityOwner;
VotingNPCScheduler(VotingPluginMain plugin) {
this.plugin = plugin;
Method location = null, entity = null;
try {
Class.forName("io.papermc.paper.threadedregions.RegionizedServer");
location = Bukkit.class.getMethod("isOwnedByCurrentRegion", Location.class);
entity = Bukkit.class.getMethod("isOwnedByCurrentRegion", Entity.class);
} catch (ClassNotFoundException ordinaryServer) {
// Spigot/Paper have a single world-owner thread.
} catch (ReflectiveOperationException unavailable) {
throw new IllegalStateException("Voting NPC region ownership API is unavailable", unavailable);
}
locationOwner = location;
entityOwner = entity;
}
boolean owns(Location location) { return owns(locationOwner, location); }
boolean owns(Entity entity) { return owns(entityOwner, entity); }
private boolean owns(Method method, Object value) {
if (method == null) return Bukkit.isPrimaryThread();
try { return Boolean.TRUE.equals(method.invoke(null, value)); }
catch (ReflectiveOperationException failure) { throw new IllegalStateException("Cannot verify voting NPC ownership", failure); }
}
void global(Runnable action, Consumer<Throwable> failure) {
try {
plugin.getBukkitScheduler().getFoliaLib().getImpl().runNextTick(ignored -> action.run())
.whenComplete((ignored, failed) -> { if (failed != null) failure.accept(failed); });
} catch (RuntimeException | LinkageError rejected) { failure.accept(rejected); }
}
void region(Location anchor, Runnable action, Consumer<Throwable> failure) {
try {
if (owns(anchor)) action.run();
else plugin.getBukkitScheduler().getFoliaLib().getImpl().runAtLocation(anchor, ignored -> action.run())
.whenComplete((ignored, failed) -> { if (failed != null) failure.accept(failed); });
} catch (RuntimeException | LinkageError rejected) { failure.accept(rejected); }
}
void entity(Entity entity, Runnable action, Runnable retired, Consumer<Throwable> failure) {
AtomicBoolean executed = new AtomicBoolean();
Runnable run = () -> { if (executed.compareAndSet(false, true)) action.run(); };
Runnable gone = () -> { if (executed.compareAndSet(false, true)) retired.run(); };
try {
if (owns(entity)) { run.run(); return; }
plugin.getBukkitScheduler().getFoliaLib().getImpl().runAtEntityWithFallback(entity,
ignored -> run.run(), gone).whenComplete((status, failed) -> {
if (failed != null) failure.accept(failed);
else if (status instanceof Enum<?> result && "ENTITY_RETIRED".equals(result.name())) gone.run();
else if (!BukkitCompletionScheduler.isSuccessfulEntityTaskResult(status)) {
// Scheduler retirement does not prove the entity was removed.
failure.accept(new IllegalStateException("Voting NPC entity scheduler is unavailable"));
}
});
} catch (RuntimeException | LinkageError rejected) { failure.accept(rejected); }
}
}
@@ -1,199 +0,0 @@
package com.bencodez.votingplugin.npc;
import java.io.IOException;
import java.io.StringReader;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.charset.CharacterCodingException;
import java.nio.charset.CodingErrorAction;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.nio.file.StandardOpenOption;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.UUID;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonToken;
import com.google.gson.stream.JsonWriter;
import com.bencodez.votingplugin.util.DurableFiles;
/** Single storage-worker owner. Never call this file boundary on a gameplay thread. */
class VotingNPCStore {
static final int MAX_NPCS = 64;
private static final int MAX_BYTES = 128 * 1024;
private static final Set<String> FIELDS = Set.of("id", "identity", "world", "x", "y", "z", "yaw", "pitch", "name");
private final Path file;
private boolean initialized;
private boolean uncertain;
VotingNPCStore(Path file) { this.file = file.toAbsolutePath().normalize(); }
synchronized List<VotingNPCDefinition> load() throws IOException {
initialized = false;
checkParent();
BasicFileAttributes attributes;
try { attributes = Files.readAttributes(file, BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); }
catch (NoSuchFileException missing) {
if (uncertain) throw new IOException("Uncertain voting NPC definitions are missing", missing);
initialized = true;
return List.of();
}
if (!attributes.isRegularFile() || attributes.isSymbolicLink() || attributes.size() > MAX_BYTES) {
throw new IOException("Voting NPC definitions are not a bounded regular file");
}
byte[] bytes;
try (var input = Files.newInputStream(file, LinkOption.NOFOLLOW_LINKS)) {
bytes = input.readNBytes(MAX_BYTES + 1);
}
if (bytes.length > MAX_BYTES) throw new IOException("Voting NPC definitions exceed limit");
String text;
try { text = StandardCharsets.UTF_8.newDecoder().onMalformedInput(CodingErrorAction.REPORT)
.onUnmappableCharacter(CodingErrorAction.REPORT).decode(ByteBuffer.wrap(bytes)).toString(); }
catch (CharacterCodingException invalid) { throw new IOException("Invalid voting NPC encoding", invalid); }
List<VotingNPCDefinition> result = decode(text);
uncertain = false;
initialized = true;
return result;
}
synchronized void save(List<VotingNPCDefinition> definitions) throws IOException {
if (!initialized || uncertain) throw new IOException("Load valid voting NPC definitions before editing");
validate(definitions);
byte[] bytes = encode(definitions).getBytes(StandardCharsets.UTF_8);
if (bytes.length > MAX_BYTES) throw new IOException("Voting NPC definitions exceed limit");
checkParent();
if (Files.isSymbolicLink(file)) throw new IOException("Voting NPC definitions cannot be a symbolic link");
Path staged = Files.createTempFile(file.getParent(), ".voting-npcs-", ".tmp");
boolean published = false;
Throwable primary = null;
try {
try (FileChannel output = FileChannel.open(staged, StandardOpenOption.WRITE)) {
ByteBuffer buffer = ByteBuffer.wrap(bytes);
while (buffer.hasRemaining()) output.write(buffer);
output.force(true);
}
Files.move(staged, file, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING);
published = true;
forceDirectory(file.getParent());
} catch (IOException | RuntimeException | Error failure) {
// A visible replacement followed by a failed directory sync is not a
// rollback. Fence later mutations rather than overwrite it from old state.
if (published) uncertain = true;
primary = failure;
throw failure;
} finally {
try { Files.deleteIfExists(staged); }
catch (IOException cleanupFailure) {
if (primary != null) primary.addSuppressed(cleanupFailure);
else {
if (published) uncertain = true;
throw cleanupFailure;
}
}
}
}
private void checkParent() throws IOException {
// Operators may place the data directory below a directory alias. Only
// the definitions and lease files themselves must remain non-links.
if (!Files.isDirectory(file.getParent().toRealPath(), LinkOption.NOFOLLOW_LINKS)) {
throw new IOException("Voting NPC data directory is unavailable");
}
}
/** Kept as a narrow I/O seam so failure-after-publication can be tested. */
void forceDirectory(Path directory) throws IOException {
DurableFiles.forceDirectory(directory);
}
private static void validate(List<VotingNPCDefinition> values) throws IOException {
if (values == null || values.size() > MAX_NPCS) throw new IOException("Voting NPC definition limit exceeded");
Set<String> ids = new HashSet<>();
Set<UUID> identities = new HashSet<>();
for (VotingNPCDefinition value : values) {
if (value == null || !ids.add(value.id()) || !identities.add(value.identity())) {
throw new IOException("Duplicate or missing voting NPC identity");
}
}
}
private static String encode(List<VotingNPCDefinition> values) throws IOException {
var text = new java.io.StringWriter();
try (JsonWriter writer = new JsonWriter(text)) {
writer.setIndent(" ");
writer.beginObject().name("version").value(1).name("npcs").beginArray();
for (VotingNPCDefinition value : values) {
writer.beginObject().name("id").value(value.id()).name("identity").value(value.identity().toString())
.name("world").value(value.world().toString()).name("x").value(value.x()).name("y").value(value.y())
.name("z").value(value.z()).name("yaw").value(value.yaw()).name("pitch").value(value.pitch())
.name("name").value(value.name()).endObject();
}
writer.endArray().endObject();
}
return text.toString() + "\n";
}
private static List<VotingNPCDefinition> decode(String text) throws IOException {
try (JsonReader reader = new JsonReader(new StringReader(text))) {
Set<String> keys = new HashSet<>();
List<VotingNPCDefinition> values = null;
reader.beginObject();
while (reader.hasNext()) {
String key = reader.nextName();
if (!keys.add(key)) throw new IOException("Duplicate voting NPC document field");
if (key.equals("version")) {
if (reader.peek() != JsonToken.NUMBER || !reader.nextString().equals("1")) {
throw new IOException("Unsupported voting NPC document version");
}
} else if (key.equals("npcs")) {
values = new ArrayList<>();
reader.beginArray();
while (reader.hasNext()) {
if (values.size() >= MAX_NPCS) throw new IOException("Voting NPC definition limit exceeded");
values.add(readDefinition(reader));
}
reader.endArray();
} else throw new IOException("Unknown voting NPC document field");
}
reader.endObject();
if (!keys.equals(Set.of("version", "npcs")) || reader.peek() != JsonToken.END_DOCUMENT) {
throw new IOException("Incomplete or trailing voting NPC document");
}
validate(values);
return List.copyOf(values);
} catch (IllegalArgumentException | IllegalStateException invalid) {
throw new IOException("Invalid voting NPC definitions", invalid);
}
}
private static VotingNPCDefinition readDefinition(JsonReader reader) throws IOException {
var fields = new java.util.HashMap<String, String>();
reader.beginObject();
while (reader.hasNext()) {
String field = reader.nextName();
if (!FIELDS.contains(field) || fields.containsKey(field)) throw new IOException("Unknown or duplicate voting NPC field");
boolean numeric = Set.of("x", "y", "z", "yaw", "pitch").contains(field);
if (reader.peek() != (numeric ? JsonToken.NUMBER : JsonToken.STRING)) throw new IOException("Invalid voting NPC field type");
fields.put(field, reader.nextString());
}
reader.endObject();
if (!fields.keySet().equals(FIELDS)) throw new IOException("Missing voting NPC field");
return new VotingNPCDefinition(fields.get("id"), uuid(fields.get("identity")), uuid(fields.get("world")),
Double.parseDouble(fields.get("x")), Double.parseDouble(fields.get("y")), Double.parseDouble(fields.get("z")),
Float.parseFloat(fields.get("yaw")), Float.parseFloat(fields.get("pitch")), fields.get("name"));
}
private static UUID uuid(String text) {
UUID value = UUID.fromString(text);
if (!value.toString().equals(text)) throw new IllegalArgumentException("Noncanonical voting NPC identity");
return value;
}
}
@@ -67,6 +67,8 @@ public class PlaceHolders {
private record PlatformUpdateKey(UUID uuid, PlaceHolder<VotingPluginUser> placeholder) { }
private final ConcurrentHashMap<PlatformUpdateKey, Long> platformUpdateGenerations = new ConcurrentHashMap<>();
private boolean userDataChangeListenerRegistered;
private final PointPlaceholderFence pointFence = new PointPlaceholderFence();
private final ConcurrentHashMap<UUID, Object> pointRecoveryWorkers = new ConcurrentHashMap<>();
@Getter
private PlaceholderCacheLevel cacheLevel;
@@ -130,6 +132,8 @@ public class PlaceHolders {
public String getPlaceHolder(OfflinePlayer p, String identifier1, boolean javascript) {
boolean forceProcess = false;
boolean useCache = true;
if (identifier1.regionMatches(true, 0, "DateVoteMilestones_", 0, "DateVoteMilestones_".length()))
return getPlaceholderValue(p, identifier1, false, true, false);
String identifier = identifier1.toLowerCase();
boolean custom = false;
if (identifier.endsWith("_process")
@@ -168,7 +172,9 @@ public class PlaceHolders {
* @param identifier the placeholder identifier
* @return the placeholder value
*/
public String getPlaceHolder(Player p, String identifier) {
public String getPlaceHolder(Player p, String identifier) {
if (identifier.regionMatches(true, 0, "DateVoteMilestones_", 0, "DateVoteMilestones_".length()))
return getPlaceholderValue(p, identifier, false, true, false);
if (plugin.getConfigFile().isUseJavascriptPlaceholders()) {
identifier = PlaceholderUtils.replaceJavascript(p, identifier);
}
@@ -185,7 +191,118 @@ public class PlaceHolders {
* @return the placeholder value
*/
public String getPlaceholderValue(OfflinePlayer p, String identifier, boolean javascript, boolean forceProcess,
boolean useCache) {
if (p == null || !isPointIdentifier(identifier)) {
return getPlaceholderValueUnfenced(p, identifier, javascript, forceProcess, useCache);
}
VotingPluginUser pointUser = resolvePlaceholderUser(p);
UUID uuid = pointUser.getJavaUUID();
var generation = pointFence.generation(uuid);
try {
if (!pointFence.readable(uuid, generation)) {
if (pointFence.recoverable(uuid)) schedulePointRecovery(pointUser);
return "...";
}
if (com.bencodez.advancedcore.api.user.UserStorage.MYSQL.equals(plugin.getStorageType())) {
var snapshot = publishedPointSnapshot(pointUser);
if (snapshot == null) {
schedulePointRecovery(pointUser);
return "...";
}
// A complete row with invalid data is unavailable, not a missing snapshot to reload.
if (pointBalance(snapshot, pointUser.getPointsPath()) == null) return "...";
}
String value = getPlaceholderValueUnfenced(p, identifier, javascript, forceProcess, useCache);
return pointFence.readable(uuid, generation) ? value : "...";
} finally {
pointFence.release(uuid);
}
}
/**
* Snapshot-only point balance for direct API users on Bukkit/Folia threads.
* A pending/uncertain debit or incomplete publication is unavailable, not
* a genuine zero. This shares the same mutation fence as point placeholders.
*
* @param user the requested user
* @return a published point balance, or empty until it is safe to read
*/
public java.util.OptionalInt getPointBalanceIfReady(VotingPluginUser user) {
if (user == null || !plugin.isEnabled() || plugin.getPlaceholders() != this) {
return java.util.OptionalInt.empty();
}
UUID uuid = user.getJavaUUID();
var generation = pointFence.generation(uuid);
try {
if (!pointFence.readable(uuid, generation)) {
if (pointFence.recoverable(uuid)) schedulePointRecovery(user);
return java.util.OptionalInt.empty();
}
var snapshot = publishedPointSnapshot(user);
if (snapshot == null) {
schedulePointRecovery(user);
return java.util.OptionalInt.empty();
}
Integer amount = pointBalance(snapshot, user.getPointsPath());
if (amount == null || !pointFence.readable(uuid, generation)) {
return java.util.OptionalInt.empty();
}
return java.util.OptionalInt.of(amount);
} finally {
pointFence.release(uuid);
}
}
private java.util.Map<String, com.bencodez.simpleapi.sql.data.DataValue> publishedPointSnapshot(VotingPluginUser user) {
var cache = plugin.getUserManager().getDataManager().getUserDataCache().get(user.getJavaUUID());
return cache == null ? null : cache.snapshotIfPublished();
}
private Integer pointBalance(VotingPluginUser user) {
if (!com.bencodez.advancedcore.api.user.UserStorage.MYSQL.equals(plugin.getStorageType())) return user.getPoints();
return pointBalance(publishedPointSnapshot(user), user.getPointsPath());
}
private Integer pointBalance(java.util.Map<String, com.bencodez.simpleapi.sql.data.DataValue> snapshot, String column) {
if (snapshot == null) return null;
// AC publishes a complete row; absence has the historical integer default.
if (!snapshot.containsKey(column)) return 0;
var value = snapshot.get(column);
if (value == null) return null;
try {
if (value.isInt()) return value.getInt();
if (value.isString()) return Integer.valueOf(value.getString());
} catch (NumberFormatException malformed) {
return null;
}
return null;
}
private void schedulePointRecovery(VotingPluginUser user) {
schedulePlaceholderCheck(user);
}
private static boolean isPointIdentifier(String identifier) {
String key = identifier.toLowerCase(Locale.ROOT);
return key.equals("points") || key.equals("points_format") || key.startsWith("enoughpoints_");
}
private String getPlaceholderValueUnfenced(OfflinePlayer p, String identifier, boolean javascript, boolean forceProcess,
boolean useCache) {
// This family owns a bounded snapshot cache and preserves case-sensitive event IDs.
// Bypass legacy cache enrollment/name resolution, which can perform storage work.
String datePrefix = "DateVoteMilestones_";
if (identifier.regionMatches(true, 0, datePrefix, 0, datePrefix.length())) {
if (p == null) return "no player";
var manager = plugin.getDateVoteMilestones();
if (manager == null) return "unavailable";
if (p instanceof Player online) {
UUID storageId = plugin.getPlaceholderPlayerPresence().storageUuid(online);
return storageId == null ? "unavailable" : manager.placeholder(storageId, identifier.substring(datePrefix.length()));
}
UUID playerId = p.getUniqueId();
return playerId == null ? "unavailable" : manager.placeholder(playerId, p::getName, identifier.substring(datePrefix.length()));
}
if (plugin.getConfigFile().isUseJavascriptPlaceholders() && javascript && p != null) {
identifier = PlaceholderUtils.replaceJavascript(p, identifier);
}
@@ -205,6 +322,12 @@ public class PlaceHolders {
return "no player";
}
// These ranks use bounded snapshot projections; persistent result caches outlive presence evidence.
if (plugin.getConfigFile().isHideTopVoterIfNotPlayedBefore() && switch (identifier.toLowerCase(Locale.ROOT)) {
case "top_all_position", "top_month_position", "top_lastmonth_position", "top_week_position",
"top_daily_position" -> true;
default -> false;
}) useCache = false;
VotingPluginUser user = resolvePlaceholderUser(p);
if (useCache) {
if (!cachedPlaceholders.contains(identifier)) {
@@ -420,6 +543,14 @@ public class PlaceHolders {
}
}.withDescription("Best monthly total").updateDataKey("HighestMonthlyTotal"));
placeholders.add(new PlaceHolder<VotingPluginUser>("DateVoteMilestones_") {
@Override public String placeholderRequest(VotingPluginUser user, String identifier) {
var manager = plugin.getDateVoteMilestones();
return manager == null || user == null ? "unavailable"
: manager.placeholder(user.getJavaUUID(), identifier.substring("DateVoteMilestones_".length()));
}
}.withDescription("Date event votes/next/status/award snapshots; loading and unavailable are distinct").useStartsWith());
placeholders.add(new PlaceHolder<VotingPluginUser>("DailyVoteStreak") {
@Override
@@ -492,7 +623,8 @@ public class PlaceHolders {
@Override
public String placeholderRequest(VotingPluginUser user, String identifier) {
return Integer.toString(user.getPoints());
Integer points = pointBalance(user);
return points == null ? "..." : Integer.toString(points);
}
}.withDescription("User points").updateDataKey("Points"));
@@ -501,7 +633,8 @@ public class PlaceHolders {
@Override
public String placeholderRequest(VotingPluginUser user, String identifier) {
NumberFormat numberFormat = NumberFormat.getNumberInstance(Locale.US);
return numberFormat.format(user.getPoints());
Integer points = pointBalance(user);
return points == null ? "..." : numberFormat.format(points);
}
}.withDescription("User points").updateDataKey("Points"));
@@ -609,7 +742,7 @@ public class PlaceHolders {
public String placeholderRequest(VotingPluginUser user, String identifier) {
int num = 1;
UUID toMatch = UUID.fromString(user.getUUID());
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.AllTime).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.AllTime).entrySet()) {
if (entry.getKey().getUuid().equals(toMatch)) {
return "" + num;
}
@@ -627,7 +760,9 @@ public class PlaceHolders {
return "invalid";
}
int number = Integer.parseInt(identifier.split("_")[1]);
if (user.getPoints() >= number) {
Integer points = pointBalance(user);
if (points == null) return "...";
if (points >= number) {
return "true";
}
return "false";
@@ -705,7 +840,7 @@ public class PlaceHolders {
public String placeholderRequest(String identifier) {
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.AllTime).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.AllTime).entrySet()) {
if (num == number) {
return "" + entry.getValue().intValue();
}
@@ -724,7 +859,7 @@ public class PlaceHolders {
}
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.AllTime).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.AllTime).entrySet()) {
if (num == number) {
return entry.getKey().getPlayerName();
}
@@ -740,7 +875,7 @@ public class PlaceHolders {
public String placeholderRequest(VotingPluginUser user, String identifier) {
int num = 1;
UUID toMatch = UUID.fromString(user.getUUID());
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Monthly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Monthly).entrySet()) {
if (entry.getKey().getUuid().equals(toMatch)) {
return "" + num;
}
@@ -757,7 +892,7 @@ public class PlaceHolders {
public String placeholderRequest(VotingPluginUser user, String identifier) {
int num = 1;
UUID toMatch = UUID.fromString(user.getUUID());
for (Entry<TopVoterPlayer, Integer> entry : plugin.getLastMonthTopVoter().entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getLastMonthTopVoterDisplay().entrySet()) {
if (entry.getKey().getUuid().equals(toMatch)) {
return "" + num;
}
@@ -775,7 +910,7 @@ public class PlaceHolders {
}
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getLastMonthTopVoter().entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getLastMonthTopVoterDisplay().entrySet()) {
if (num == number) {
return entry.getKey().getPlayerName();
}
@@ -791,7 +926,7 @@ public class PlaceHolders {
public String placeholderRequest(String identifier) {
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getLastMonthTopVoter().entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getLastMonthTopVoterDisplay().entrySet()) {
if (num == number) {
return "" + entry.getValue().intValue();
}
@@ -812,7 +947,7 @@ public class PlaceHolders {
}
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Monthly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Monthly).entrySet()) {
if (num == number) {
return entry.getKey().getPlayerName();
}
@@ -828,7 +963,7 @@ public class PlaceHolders {
public String placeholderRequest(String identifier) {
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Monthly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Monthly).entrySet()) {
if (num == number) {
return "" + entry.getValue().intValue();
}
@@ -844,7 +979,7 @@ public class PlaceHolders {
public String placeholderRequest(VotingPluginUser user, String identifier) {
int num = 1;
UUID toMatch = UUID.fromString(user.getUUID());
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Weekly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Weekly).entrySet()) {
if (entry.getKey().getUuid().equals(toMatch)) {
return "" + num;
}
@@ -863,7 +998,7 @@ public class PlaceHolders {
}
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Weekly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Weekly).entrySet()) {
if (num == number) {
return entry.getKey().getPlayerName();
}
@@ -879,7 +1014,7 @@ public class PlaceHolders {
public String placeholderRequest(String identifier) {
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Weekly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Weekly).entrySet()) {
if (num == number) {
return "" + entry.getValue().intValue();
}
@@ -895,7 +1030,7 @@ public class PlaceHolders {
public String placeholderRequest(VotingPluginUser user, String identifier) {
int num = 1;
UUID toMatch = UUID.fromString(user.getUUID());
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Daily).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Daily).entrySet()) {
if (entry.getKey().getUuid().equals(toMatch)) {
return "" + num;
}
@@ -914,7 +1049,7 @@ public class PlaceHolders {
}
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Daily).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Daily).entrySet()) {
if (num == number) {
return entry.getKey().getPlayerName();
}
@@ -938,7 +1073,7 @@ public class PlaceHolders {
public String placeholderRequest(String identifier) {
int num = 1;
int number = Integer.parseInt(identifier.split("_")[2]);
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Daily).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Daily).entrySet()) {
if (num == number) {
return "" + entry.getValue().intValue();
}
@@ -954,7 +1089,7 @@ public class PlaceHolders {
@Override
public String placeholderRequest(String identifier) {
return Integer.toString(plugin.getVoteParty().getTotalVotes());
return Integer.toString(plugin.getServerData().getVotePartyDisplay().total());
}
}.withDescription("Current amount of voteparty votes"));
@@ -962,7 +1097,8 @@ public class PlaceHolders {
@Override
public String placeholderRequest(String identifier) {
return Integer.toString(plugin.getVoteParty().getNeededVotes());
return Integer.toString(plugin.getServerData().getVotePartyDisplay()
.needed(plugin.getSpecialRewardsConfig().getVotePartyVotesRequired()));
}
}.withDescription("Voteparty votes needed"));
@@ -970,7 +1106,8 @@ public class PlaceHolders {
@Override
public String placeholderRequest(String identifier) {
return Integer.toString(plugin.getVoteParty().getVotesRequired());
return Integer.toString(plugin.getServerData().getVotePartyDisplay()
.required(plugin.getSpecialRewardsConfig().getVotePartyVotesRequired()));
}
}.withDescription("Amount of votes needed for voteparty"));
@@ -1407,6 +1544,13 @@ public class PlaceHolders {
@SuppressWarnings("unchecked")
private void updateCachedPlaceholder(PlaceHolder<VotingPluginUser> placeholder, VotingPluginUser user,
UUID uuid, String... keys) {
var pointGeneration = pointFence.generation(uuid);
try {
if ("Points".equalsIgnoreCase(placeholder.getUpdateDataKey())
&& !pointFence.readable(uuid, pointGeneration)) {
if (pointFence.recoverable(uuid)) schedulePointRecovery(user);
return;
}
for (String ident : Set.copyOf(placeholder.getCache().keySet())) {
ConcurrentHashMap<UUID, String> values = placeholder.getCache().get(ident);
if (values == null) continue;
@@ -1427,7 +1571,11 @@ public class PlaceHolders {
}
} else {
String value = placeholder.placeholderRequest(user, ident);
values.put(uuid, value);
if ("Points".equalsIgnoreCase(placeholder.getUpdateDataKey())) {
pointFence.publish(uuid, pointGeneration, () -> {
if (plugin.isEnabled()) values.put(uuid, value);
});
} else values.put(uuid, value);
if (getCacheLevel().onlineOnly() && !plugin.getPlaceholderPlayerPresence().isOnline(uuid)) {
values.remove(uuid);
continue;
@@ -1436,6 +1584,9 @@ public class PlaceHolders {
+ matchingKey(placeholder, keys) + " with " + value);
}
}
} finally {
pointFence.release(uuid);
}
}
private void publishCachedValue(PlaceHolder<VotingPluginUser> placeholder, VotingPluginUser user, UUID uuid,
@@ -1460,6 +1611,52 @@ public class PlaceHolders {
return placeholder.getUpdateDataKey();
}
/** Blocks stale point results before a shared debit enters its worker. */
public void beginSharedPointDebit(UUID uuid) {
pointFence.begin(uuid, () -> clearPointResults(uuid));
}
/** Owns a queued batch without replacing its worker's mutation outcome. */
public java.util.function.Consumer<Boolean> sharedPointAdmissionCompletion(UUID uuid) {
beginSharedPointDebit(uuid);
var completed = new java.util.concurrent.atomic.AtomicBoolean();
return settled -> {
if (completed.compareAndSet(false, true)) pointFence.finishAdmission(uuid,
settled && plugin.isEnabled() && plugin.getPlaceholders() == this);
};
}
private void clearPointResults(UUID uuid) {
for (PlaceHolder<VotingPluginUser> placeholder : userDataChangeClassification.all()) {
if ("Points".equalsIgnoreCase(placeholder.getUpdateDataKey()) && placeholder.isUsesCache()) {
placeholder.clearCachePlayer(uuid);
}
}
}
/** Completes the fence only after the storage worker has reconciled its snapshot. */
public void finishSharedPointDebit(UUID uuid, boolean trustworthySnapshot) {
finishSharedPointDebit(uuid, trustworthySnapshot, trustworthySnapshot);
}
public void finishSharedPointDebit(UUID uuid, boolean knownOutcome, boolean trustworthySnapshot) {
pointFence.finish(uuid, knownOutcome, trustworthySnapshot);
}
/** Captures a worker refill generation without granting permission to retry a mutation. */
public java.util.function.Consumer<Boolean> sharedPointRefillCompletion(UUID uuid) {
var stamp = pointFence.beginRefill(uuid, () -> clearPointResults(uuid));
var completed = new java.util.concurrent.atomic.AtomicBoolean();
return verified -> {
if (!completed.compareAndSet(false, true)) return;
try {
pointFence.finishRefill(uuid, stamp, verified && plugin.isEnabled() && plugin.getPlaceholders() == this);
} finally {
pointFence.release(uuid);
}
};
}
/**
* Handle player logout.
* @param user the voting plugin user
@@ -1505,11 +1702,12 @@ public class PlaceHolders {
/**
* Update placeholders for specific user.
* @param user the voting plugin user
* @param login whether this is a login update
* @param login whether to include uncached entries, such as a login or worker warmup
*/
public void onUpdate(VotingPluginUser user, boolean login) {
if (user == null) return;
UUID uuid = user.getJavaUUID();
if (pointFence.recoverable(uuid)) schedulePointRecovery(user);
Player owner = plugin.getPlaceholderPlayerPresence().schedulerOwner(uuid);
PlaceholderClassification classification = userDataChangeClassification;
List<PlaceHolder<VotingPluginUser>> platformUpdates = new ArrayList<>();
@@ -1551,6 +1749,8 @@ public class PlaceHolders {
* Reload placeholders.
*/
public void reload() {
pointFence.invalidateLifecycle();
pointRecoveryWorkers.clear();
platformUpdateGenerations.clear();
plugin.refreshPlaceholderPlayerPresence();
cacheLevel = plugin.getConfigFile().getPlaceholderCacheLevel();
@@ -1584,14 +1784,47 @@ public class PlaceHolders {
* Schedule placeholder check for user.
* @param user the voting plugin user
*/
public void schedulePlaceholderCheck(VotingPluginUser user) {
plugin.getTimer().execute(new Runnable() {
@Override
public void run() {
checkNonCachedPlaceholders();
onUpdate(user, plugin.getPlaceholderPlayerPresence().isOnline(user.getJavaUUID()));
}
});
}
public void schedulePlaceholderCheck(VotingPluginUser user) {
if (!plugin.isEnabled() || plugin.getPlaceholders() != this) return;
UUID uuid = user.getJavaUUID();
Object token = new Object();
long lifecycle = pointFence.lifecycle();
// Common warming and direct point recovery share queued and executing admission.
if (pointRecoveryWorkers.putIfAbsent(uuid, token) != null) return;
try {
plugin.getTimer().execute(() -> {
boolean warmed = false;
try {
if (!plugin.isEnabled() || plugin.getPlaceholders() != this || lifecycle != pointFence.lifecycle()) return;
var observed = pointFence.generation(uuid);
try {
// Invalid data in a complete published row is not a missing snapshot.
// Pending/unknown writes cannot authorize a competing point refill.
if (pointFence.recoverable(uuid)
|| (pointFence.readable(uuid, observed)
&& com.bencodez.advancedcore.api.user.UserStorage.MYSQL.equals(plugin.getStorageType())
&& publishedPointSnapshot(user) == null)) {
com.bencodez.votingplugin.user.SharedMysqlCacheReconciler.invalidateAndRefreshOnWorker(
plugin, user.getUUID(), user.getPointsPath());
}
} finally { pointFence.release(uuid); }
if (!plugin.isEnabled() || plugin.getPlaceholders() != this || lifecycle != pointFence.lifecycle()) return;
checkNonCachedPlaceholders();
// Preserve each cache level's existing offline-entry admission policy.
onUpdate(user, !getCacheLevel().onlineOnly() || plugin.getPlaceholderPlayerPresence().isOnline(uuid));
warmed = true;
} finally {
boolean retired = pointRecoveryWorkers.remove(uuid, token);
// A new identifier may have arrived after this worker's discovery pass.
if (retired && warmed && !placeholdersToSetCacheOn.isEmpty() && plugin.isEnabled()
&& plugin.getPlaceholders() == this && lifecycle == pointFence.lifecycle()) {
schedulePlaceholderCheck(user);
}
}
});
} catch (RuntimeException rejected) {
pointRecoveryWorkers.remove(uuid, token);
plugin.debug(rejected);
}
}
}
@@ -7,6 +7,8 @@ import java.util.Map;
import java.util.UUID;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Function;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Supplier;
import org.bukkit.entity.Player;
@@ -19,6 +21,97 @@ import org.bukkit.entity.Player;
public final class PlaceholderPlayerPresence {
private final AtomicReference<Map<UUID, Player>> onlinePlayers = new AtomicReference<>(Map.of());
private final Object lifecycleLock = new Object();
private final Map<Player, LiveIdentity> identities = new IdentityHashMap<>();
private final Map<Player, Object> refreshReservations = new IdentityHashMap<>();
/** Immutable identity; lookup callers never need to access its Bukkit owner. */
public record LiveIdentity(UUID serverUuid, String playerName, UUID storageUuid) { }
/** Capture only on this player's owning thread (join or entity scheduler). */
public void captureOnline(UUID storageUuid, Player player) {
if (storageUuid == null || player == null) return;
LiveIdentity identity = new LiveIdentity(player.getUniqueId(), player.getName(), storageUuid);
synchronized (lifecycleLock) {
playerOnline(storageUuid, player);
identities.put(player, identity);
}
}
/** Rekey only the current owner. Delayed login cannot resurrect a retired session. */
public boolean updateStorageUuid(UUID uuid, Player player) {
if (uuid == null || player == null) return false;
synchronized (lifecycleLock) {
if (storageUuid(player) == null) return false;
Player currentOwner = onlinePlayers.get().get(uuid);
if (currentOwner != null && currentOwner != player) return false;
LiveIdentity identity = identities.get(player);
playerOnline(uuid, player);
if (identity != null) identities.put(player,
new LiveIdentity(identity.serverUuid(), identity.playerName(), uuid));
return true;
}
}
/** Snapshot-only lookup, with exact storage identities taking precedence over aliases. */
public LiveIdentity liveIdentity(UUID uuid) {
if (uuid == null) return null;
synchronized (lifecycleLock) {
Player exact = onlinePlayers.get().get(uuid);
if (exact != null) return identities.get(exact);
LiveIdentity found = null;
for (LiveIdentity identity : identities.values()) {
if (!uuid.equals(identity.serverUuid())) continue;
if (found != null) return null; // Uncertain or ambiguous: preserve the supplied UUID.
found = identity;
}
return found;
}
}
/**
* Refresh membership without reading another region's players. Each scheduled
* capture is fenced by its reservation; quit, join, another refresh and clear
* invalidate it before it can publish stale identity data. The capture consumer
* must run on that player's owning thread.
*/
public void refresh(Supplier<? extends Collection<? extends Player>> playersSupplier,
BiConsumer<Player, Consumer<UUID>> scheduleCapture) {
Map<Player, Object> reservations = new IdentityHashMap<>();
synchronized (lifecycleLock) {
Collection<? extends Player> players = playersSupplier.get();
Map<Player, Boolean> members = new IdentityHashMap<>();
if (players != null) for (Player player : players) {
if (player != null) members.put(player, Boolean.TRUE);
}
Map<UUID, Player> retained = new HashMap<>(onlinePlayers.get());
retained.entrySet().removeIf(entry -> !members.containsKey(entry.getValue()));
onlinePlayers.set(Map.copyOf(retained));
retainCurrentIdentities();
refreshReservations.clear();
members.keySet().forEach(player -> {
Object reservation = new Object();
refreshReservations.put(player, reservation);
reservations.put(player, reservation);
});
}
reservations.forEach((player, reservation) -> scheduleCapture.accept(player, storageUuid -> {
synchronized (lifecycleLock) {
if (refreshReservations.get(player) != reservation) return;
refreshReservations.remove(player);
if (storageUuid == null || !player.isOnline()) return;
Player currentOwner = onlinePlayers.get().get(storageUuid);
if (currentOwner != null && currentOwner != player) return;
UUID serverUuid = player.getUniqueId();
if (identities.entrySet().stream().anyMatch(entry -> entry.getKey() != player
&& serverUuid.equals(entry.getValue().serverUuid()))) return;
captureOnline(storageUuid, player);
}
}));
}
private void retainCurrentIdentities() {
identities.entrySet().removeIf(entry -> onlinePlayers.get().get(entry.getValue().storageUuid()) != entry.getKey());
}
public boolean isOnline(UUID uuid) {
return uuid != null && onlinePlayers.get().containsKey(uuid);
@@ -46,24 +139,31 @@ public final class PlaceholderPlayerPresence {
public void playerOnline(UUID uuid, Player player) {
if (uuid == null || player == null) return;
synchronized (lifecycleLock) {
refreshReservations.remove(player);
Player displacedOwner = onlinePlayers.get().get(uuid);
if (displacedOwner != null && displacedOwner != player) refreshReservations.remove(displacedOwner);
update(current -> {
Map<UUID, Player> next = new HashMap<>(current);
next.entrySet().removeIf(entry -> entry.getValue() == player && !entry.getKey().equals(uuid));
next.put(uuid, player);
return Map.copyOf(next);
});
retainCurrentIdentities();
}
}
public void playerOffline(UUID uuid) {
if (uuid == null) return;
synchronized (lifecycleLock) {
Player owner = onlinePlayers.get().get(uuid);
if (owner != null) refreshReservations.remove(owner);
update(current -> {
if (!current.containsKey(uuid)) return current;
Map<UUID, Player> next = new HashMap<>(current);
next.remove(uuid);
return Map.copyOf(next);
});
retainCurrentIdentities();
}
}
@@ -71,11 +171,13 @@ public final class PlaceholderPlayerPresence {
public boolean playerOffline(UUID uuid, Player expectedOwner) {
if (uuid == null || expectedOwner == null) return false;
synchronized (lifecycleLock) {
refreshReservations.remove(expectedOwner);
Map<UUID, Player> current = onlinePlayers.get();
if (current.get(uuid) != expectedOwner) return false;
Map<UUID, Player> next = new HashMap<>(current);
next.remove(uuid);
onlinePlayers.set(Map.copyOf(next));
retainCurrentIdentities();
return true;
}
}
@@ -113,6 +215,8 @@ public final class PlaceholderPlayerPresence {
}
}
onlinePlayers.set(Map.copyOf(next));
refreshReservations.clear();
retainCurrentIdentities();
}
}
@@ -122,11 +226,11 @@ public final class PlaceholderPlayerPresence {
if (players != null) players.forEach((uuid, player) -> {
if (uuid != null && player != null) next.put(uuid, player);
});
synchronized (lifecycleLock) { onlinePlayers.set(Map.copyOf(next)); }
synchronized (lifecycleLock) { onlinePlayers.set(Map.copyOf(next)); refreshReservations.clear(); retainCurrentIdentities(); }
}
public void clear() {
synchronized (lifecycleLock) { onlinePlayers.set(Map.of()); }
synchronized (lifecycleLock) { onlinePlayers.set(Map.of()); identities.clear(); refreshReservations.clear(); }
}
/** Publish an offline-only result atomically with player lifecycle capture. */
@@ -0,0 +1,107 @@
package com.bencodez.votingplugin.placeholders;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
/** Coordinates point rendering with in-flight shared-storage mutations. */
final class PointPlaceholderFence {
private static final class State {
long generation;
int pending;
int readers;
int refills;
boolean uncertain;
boolean snapshotUnavailable;
}
private final Map<UUID, State> states = new HashMap<>();
private long generation;
private long lifecycle;
record Stamp(long lifecycle, long generation) { }
synchronized Stamp generation(UUID uuid) {
State state = states.computeIfAbsent(uuid, ignored -> {
State created = new State();
created.generation = ++generation;
return created;
});
state.readers++;
return new Stamp(lifecycle, state.generation);
}
synchronized boolean readable(UUID uuid, Stamp observed) {
if (lifecycle != observed.lifecycle()) return false;
State state = states.get(uuid);
return state != null && state.generation == observed.generation()
&& state.pending == 0 && state.refills == 0 && !state.uncertain && !state.snapshotUnavailable;
}
synchronized void release(UUID uuid) {
State state = states.get(uuid);
if (state == null || state.readers == 0) throw new IllegalStateException("Unbalanced point reader");
state.readers--;
retireIfSafe(uuid, state);
}
private void retireIfSafe(UUID uuid, State state) {
if (state.readers == 0 && state.pending == 0 && state.refills == 0 && !state.uncertain && !state.snapshotUnavailable) states.remove(uuid);
}
synchronized void invalidateLifecycle() { lifecycle++; }
synchronized long lifecycle() { return lifecycle; }
synchronized boolean recoverable(UUID uuid) {
State state = states.get(uuid);
return state != null && state.snapshotUnavailable && !state.uncertain && state.pending == 0 && state.refills == 0;
}
synchronized Stamp beginRefill(UUID uuid, Runnable invalidate) {
State state = states.computeIfAbsent(uuid, ignored -> new State());
state.generation = ++generation;
state.snapshotUnavailable = true;
state.refills++;
state.readers++;
invalidate.run();
return new Stamp(lifecycle, state.generation);
}
synchronized void begin(UUID uuid, Runnable invalidate) {
State state = states.computeIfAbsent(uuid, ignored -> new State());
state.generation = ++generation;
state.pending++;
invalidate.run();
}
synchronized void finish(UUID uuid, boolean knownOutcome, boolean trustworthy) {
State state = states.get(uuid);
if (state == null || state.pending == 0) throw new IllegalStateException("Unbalanced point mutation");
state.uncertain |= !knownOutcome;
state.snapshotUnavailable = !trustworthy || state.refills != 0;
state.pending--;
state.generation = ++generation;
retireIfSafe(uuid, state);
}
synchronized void finishAdmission(UUID uuid, boolean workerSettled) {
State state = states.get(uuid);
if (state == null || state.pending == 0) throw new IllegalStateException("Unbalanced point admission");
state.pending--;
state.snapshotUnavailable |= !workerSettled;
state.generation = ++generation;
retireIfSafe(uuid, state);
}
synchronized void finishRefill(UUID uuid, Stamp observed, boolean verified) {
State state = states.get(uuid);
if (state == null || state.refills == 0) throw new IllegalStateException("Unbalanced point refill");
boolean current = lifecycle == observed.lifecycle() && state.generation == observed.generation();
state.refills--;
state.snapshotUnavailable = !(verified && current && state.pending == 0 && state.refills == 0 && !state.uncertain);
// Even an obsolete read completion can replace storage data: retire every older render.
state.generation = ++generation;
}
synchronized void publish(UUID uuid, Stamp observed, Runnable publication) {
if (readable(uuid, observed)) publication.run();
}
}
@@ -40,6 +40,19 @@ public class OfflineBungeeVote {
@Getter
@Setter
private String text;
public long getCanonicalOccurrenceTime() {
Long original = VoteOccurrenceMetadata.read(text);
return original == null ? 0L : original;
}
public void setCanonicalOccurrenceTime(long occurredAt) {
text = VoteOccurrenceMetadata.store(text, occurredAt);
}
public void setText(String updated) {
text = VoteOccurrenceMetadata.preserve(text, updated);
}
@Getter
private long time;
@Getter
@@ -0,0 +1,46 @@
package com.bencodez.votingplugin.proxy;
/** Optional occurrence metadata in existing opaque cache payloads, separate from cooldown time. */
public final class VoteOccurrenceMetadata {
private static final String MARKER = "//vp-occurrence-time:";
private VoteOccurrenceMetadata() { }
/** Null means an older payload without metadata; -1 means explicitly invalid metadata. */
public static Long read(String payload) {
if (payload == null) return null;
int marker = payload.lastIndexOf(MARKER);
if (marker < 0) return null;
if (marker != payload.indexOf(MARKER)) return -1L;
return parse(payload.substring(marker + MARKER.length(),
Math.min(payload.length(), marker + MARKER.length() + 21)));
}
public static long parse(String raw) {
if (raw == null || raw.isEmpty() || raw.length() > 20) return -1L;
try {
long time = Long.parseLong(raw);
return time > 0 ? time : -1L;
} catch (NumberFormatException invalid) {
return -1L;
}
}
/** Existing v1/v2 totals parsers ignore this tagged trailing token. */
public static String store(String payload, long occurredAt) {
String text = payload == null ? "" : payload;
int marker = text.indexOf(MARKER);
if (marker >= 0) text = text.substring(0, marker);
return text + MARKER + (occurredAt > 0 ? occurredAt : -1L);
}
/** An occurrence tag alone does not represent a processed totals snapshot. */
public static boolean hasPayload(String payload) {
return payload != null && !payload.isEmpty() && !payload.startsWith(MARKER);
}
public static String preserve(String oldPayload, String updatedPayload) {
Long original = read(oldPayload);
return original == null ? updatedPayload : store(updatedPayload, original);
}
}
@@ -181,6 +181,7 @@ public abstract class VotingPluginProxy {
private String service;
private String uuid;
private long time;
private long canonicalOccurrenceTime;
private boolean realVote;
private boolean playerOnline;
private boolean delayValidated;
@@ -200,6 +201,7 @@ public abstract class VotingPluginProxy {
private final boolean realVote;
private final boolean timeQueue;
private final long queueTime;
private final long canonicalOccurrenceTime;
private final VoteTotalsSnapshot totals;
private final String uuid;
private final UUID voteId;
@@ -212,7 +214,8 @@ public abstract class VotingPluginProxy {
private MultiProxyVoteRetry(String player, String service, boolean realVote, boolean timeQueue, long queueTime,
VoteTotalsSnapshot totals, String uuid, UUID voteId, String origin, boolean delayValidated,
boolean delayValidationKnown) {
boolean delayValidationKnown, long canonicalOccurrenceTime) {
this.canonicalOccurrenceTime = canonicalOccurrenceTime;
this.player = player;
this.service = service;
this.realVote = realVote;
@@ -2895,7 +2898,8 @@ public abstract class VotingPluginProxy {
@Override
public void triggerVote(String player, String service, boolean realVote, boolean timeQueue, long queueTime,
VoteTotalsSnapshot text, String uuid) {
vote(player, service, realVote, timeQueue, queueTime, text, uuid);
// Origin-less forwarding cannot establish an original canonical occurrence.
vote(player, service, realVote, timeQueue, queueTime, text, uuid, null, null, false, false, -1L);
}
@Override
@@ -2918,6 +2922,14 @@ public abstract class VotingPluginProxy {
delayValidated, delayValidationKnown);
}
@Override
public void triggerVote(String player, String service, boolean realVote, boolean timeQueue, long queueTime,
VoteTotalsSnapshot text, String uuid, UUID voteId, String origin, boolean delayValidated,
boolean delayValidationKnown, long canonicalOccurrenceTime) {
receiveMultiProxyVote(player, service, realVote, timeQueue, queueTime, text, uuid, voteId, origin,
delayValidated, delayValidationKnown, canonicalOccurrenceTime);
}
@Override
public void onMultiProxyVoteAcknowledged(UUID voteId, String recipient) {
handleMultiProxyVoteAcknowledgement(voteId, recipient);
@@ -2954,6 +2966,13 @@ public abstract class VotingPluginProxy {
protected synchronized void receiveMultiProxyVote(String player, String service, boolean realVote,
boolean timeQueue, long queueTime, VoteTotalsSnapshot totals, String uuid, UUID wireVoteId, String origin,
boolean delayValidated, boolean delayValidationKnown) {
receiveMultiProxyVote(player, service, realVote, timeQueue, queueTime, totals, uuid, wireVoteId, origin,
delayValidated, delayValidationKnown, queueTime);
}
protected synchronized void receiveMultiProxyVote(String player, String service, boolean realVote,
boolean timeQueue, long queueTime, VoteTotalsSnapshot totals, String uuid, UUID wireVoteId, String origin,
boolean delayValidated, boolean delayValidationKnown, long canonicalOccurrenceTime) {
UUID voteId = wireVoteId == null ? UUID.randomUUID() : wireVoteId;
if (completedMultiProxyVotes.containsKey(voteId)) {
acknowledgeCompletedMultiProxyVote(voteId, origin);
@@ -2972,7 +2991,7 @@ public abstract class VotingPluginProxy {
// this process heap and is loaded again after a restart. It also lets the
// normal queue processor drain the spill as retry slots become available.
if (retainForwardedVoteOverflow(player, service, realVote, totals, uuid, voteId, queueTime, origin,
delayValidated, delayValidationKnown)) {
delayValidated, delayValidationKnown, canonicalOccurrenceTime)) {
scheduleTimeVoteRetry();
return;
}
@@ -2980,7 +2999,7 @@ public abstract class VotingPluginProxy {
return;
}
retry = new MultiProxyVoteRetry(player, service, realVote, timeQueue, queueTime, totals, uuid, voteId, origin,
delayValidated, delayValidationKnown);
delayValidated, delayValidationKnown, canonicalOccurrenceTime);
multiProxyVoteRetries.put(voteId, retry);
}
if (!retry.scheduled) attemptMultiProxyVote(retry);
@@ -2989,7 +3008,7 @@ public abstract class VotingPluginProxy {
/** Durably spills an over-capacity forwarded vote into the normal replay queue. */
private boolean retainForwardedVoteOverflow(String player, String service, boolean realVote,
VoteTotalsSnapshot totals, String uuid, UUID voteId, long queueTime, String origin, boolean delayValidated,
boolean delayValidationKnown) {
boolean delayValidationKnown, long canonicalOccurrenceTime) {
if (voteId == null || player == null || service == null || uuid == null) return false;
for (VoteTimeQueue queued : getVoteCacheHandler().getTimeChangeQueue()) {
if (voteId.equals(queued.getVoteId())) return true;
@@ -2997,6 +3016,7 @@ public abstract class VotingPluginProxy {
long time = queueTime == 0L ? System.currentTimeMillis() : queueTime;
VoteTimeQueue queued = new VoteTimeQueue(voteId, player, service, time, false,
Collections.emptySet(), Collections.emptySet(), totals == null ? "" : totals.toString(), false, uuid);
queued.setCanonicalOccurrenceTime(canonicalOccurrenceTime);
queued.setRealVote(realVote);
queued.setMultiProxyOrigin(origin == null ? "" : origin);
if (delayValidationKnown) queued.setDelayValidated(delayValidated);
@@ -3074,6 +3094,7 @@ public abstract class VotingPluginProxy {
private boolean persistDeferredMultiProxyReceipt(MultiProxyVoteRetry retry) {
VoteTimeQueue queued = findUnprocessedQueuedVote(retry.voteId);
if (queued == null) return false;
queued.setCanonicalOccurrenceTime(retry.canonicalOccurrenceTime);
queued.setMultiProxyOrigin(retry.origin);
queued.setRealVote(retry.realVote);
if (retry.delayValidationKnown) queued.setDelayValidated(retry.delayValidated);
@@ -3620,6 +3641,7 @@ public abstract class VotingPluginProxy {
// completion fence: its origin is persisted by PERSIST_DEFERRED_RECEIPT.
if (!queued.isProcessed()) return false;
queued.setProcessed(true);
queued.setCanonicalOccurrenceTime(retry.canonicalOccurrenceTime);
queued.setRealVote(retry.realVote);
queued.setMultiProxyOrigin(retry.origin);
if (retry.delayValidationKnown) queued.setDelayValidated(retry.delayValidated);
@@ -3631,6 +3653,7 @@ public abstract class VotingPluginProxy {
retry.queueTime == 0L ? System.currentTimeMillis() : retry.queueTime, false,
Collections.emptySet(), Collections.emptySet(), retry.totals == null ? "" : retry.totals.toString(), true,
retry.uuid);
quarantine.setCanonicalOccurrenceTime(retry.canonicalOccurrenceTime);
quarantine.setRealVote(retry.realVote);
quarantine.setMultiProxyOrigin(retry.origin);
if (retry.delayValidationKnown) quarantine.setDelayValidated(retry.delayValidated);
@@ -4062,7 +4085,7 @@ public abstract class VotingPluginProxy {
vote.setRealVote(queuedRealVote);
vote.setDeliveryStateDirty(true);
}
VoteTotalsSnapshot queuedTotals = forwardedTotals[1].isEmpty() ? null
VoteTotalsSnapshot queuedTotals = !VoteOccurrenceMetadata.hasPayload(forwardedTotals[1]) ? null
: VoteTotalsSnapshot.parseStorage(forwardedTotals[1]);
QueuedVoteResult result = replayQueuedVote(vote, queuedTotals, queuedRealVote);
if (result == QueuedVoteResult.RETRY || result == QueuedVoteResult.RETRY_NONBLOCKING) {
@@ -6051,6 +6074,9 @@ public abstract class VotingPluginProxy {
private JsonEnvelope cachedVoteEnvelope(OfflineBungeeVote vote, boolean online, boolean broadcast,
int num, int numberOfVotes) {
// Older cache rows may have been timestamped by an intermediate receiver.
// Preserve their normal time, but do not invent date occurrence provenance.
String payload = VoteOccurrenceMetadata.store(vote.getText(), vote.getCanonicalOccurrenceTime());
if (vote.hasCachedVoteBatch()) {
num = vote.getCachedBatchNumber();
numberOfVotes = vote.getCachedBatchSize();
@@ -6059,18 +6085,18 @@ public abstract class VotingPluginProxy {
if (vote.isDelayValidationKnown()) {
envelope = online
? VotingPluginWire.voteOnline(vote.getPlayerName(), vote.getUuid(), vote.getService(), vote.getTime(),
resolveCachedWasOnline(vote), vote.isRealVote(), vote.getText(), vote.getVoteId(),
resolveCachedWasOnline(vote), vote.isRealVote(), payload, vote.getVoteId(),
getConfig().getBungeeManageTotals(), broadcast, num, numberOfVotes, vote.isDelayValidated())
: VotingPluginWire.vote(vote.getPlayerName(), vote.getUuid(), vote.getService(), vote.getTime(),
resolveCachedWasOnline(vote), vote.isRealVote(), vote.getText(), vote.getVoteId(),
resolveCachedWasOnline(vote), vote.isRealVote(), payload, vote.getVoteId(),
getConfig().getBungeeManageTotals(), broadcast, num, numberOfVotes, vote.isDelayValidated());
} else {
envelope = online
? VotingPluginWire.voteOnline(vote.getPlayerName(), vote.getUuid(), vote.getService(), vote.getTime(),
resolveCachedWasOnline(vote), vote.isRealVote(), vote.getText(), vote.getVoteId(),
resolveCachedWasOnline(vote), vote.isRealVote(), payload, vote.getVoteId(),
getConfig().getBungeeManageTotals(), broadcast, num, numberOfVotes)
: VotingPluginWire.vote(vote.getPlayerName(), vote.getUuid(), vote.getService(), vote.getTime(),
resolveCachedWasOnline(vote), vote.isRealVote(), vote.getText(), vote.getVoteId(),
resolveCachedWasOnline(vote), vote.isRealVote(), payload, vote.getVoteId(),
getConfig().getBungeeManageTotals(), broadcast, num, numberOfVotes);
}
// A cache entry is only known to have passed the proxy's delay gate when
@@ -6221,6 +6247,16 @@ public abstract class VotingPluginProxy {
}
}
/** Preserves captured receipt time independently of ordinary processing/cooldown time. */
public synchronized void vote(String player, String service, boolean realVote, boolean timeQueue, long queueTime,
VoteTotalsSnapshot text, String uuid, UUID voteId, long occurredAt) {
VoteTimeQueue retained = findQueuedVote(voteId);
if (vote(player, service, realVote, timeQueue, queueTime, text, uuid, retained, voteId,
false, false, occurredAt) == QueuedVoteResult.RETRY) {
throw new VoteRetryException();
}
}
/** Releases retry-only state after the bounded event-listener retries are exhausted. */
public synchronized void abandonLiveVoteRetry(UUID voteId) {
if (voteId != null) liveVoteRetries.remove(voteId);
@@ -6245,6 +6281,7 @@ public abstract class VotingPluginProxy {
public synchronized VoteTimeQueue snapshotIncomingVoteForRestart(PendingIncomingVote pending) {
VoteTimeQueue queued = new VoteTimeQueue(pending.getVoteId(), pending.getPlayer(), pending.getService(),
pending.getAcceptedAt());
queued.setCanonicalOccurrenceTime(pending.getAcceptedAt());
LiveVoteRetryState retry = liveVoteRetries.get(pending.getVoteId());
if (retry != null) {
queued.setUuid(retry.uuid == null ? "" : retry.uuid);
@@ -6275,6 +6312,7 @@ public abstract class VotingPluginProxy {
queued.setMultiProxyForwardingHandled(retry.multiProxyForwardingHandled);
if (retry.delayValidationKnown) queued.setDelayValidated(retry.delayValidated);
if (retry.totals != null) queued.setTotals(retry.totals.toString());
if (retry.canonicalOccurrenceTime != 0L) queued.setCanonicalOccurrenceTime(retry.canonicalOccurrenceTime);
}
return queued;
}
@@ -6299,7 +6337,7 @@ public abstract class VotingPluginProxy {
if (retry == null && !recovery.isVotePartyApplied() && !recovery.isTotalsApplied()
&& recovery.isRealVote() && !recovery.isWasOnlineKnown()
&& (recovery.getUuid() == null || recovery.getUuid().isEmpty())
&& (recovery.getTotals() == null || recovery.getTotals().isEmpty())) return true;
&& !VoteOccurrenceMetadata.hasPayload(recovery.getTotals())) return true;
VoteTimeQueue state = retry == null ? recovery
: snapshotIncomingVoteForRestart(new PendingIncomingVote(recovery.getVoteId(), recovery.getName(),
recovery.getService(), recovery.getTime()));
@@ -6347,6 +6385,13 @@ public abstract class VotingPluginProxy {
private synchronized QueuedVoteResult vote(String player, String service, boolean realVote, boolean timeQueue,
long queueTime, VoteTotalsSnapshot text, String uuid, VoteTimeQueue queuedVote, UUID requestedVoteId,
boolean upstreamDelayValidated, boolean upstreamDelayValidationKnown) {
return vote(player, service, realVote, timeQueue, queueTime, text, uuid, queuedVote, requestedVoteId,
upstreamDelayValidated, upstreamDelayValidationKnown, 0L);
}
private synchronized QueuedVoteResult vote(String player, String service, boolean realVote, boolean timeQueue,
long queueTime, VoteTotalsSnapshot text, String uuid, VoteTimeQueue queuedVote, UUID requestedVoteId,
boolean upstreamDelayValidated, boolean upstreamDelayValidationKnown, long upstreamOccurrenceTime) {
try {
String requestPlayer = player;
if (!ServiceSiteValidator.isValid(service)) {
@@ -6470,6 +6515,13 @@ public abstract class VotingPluginProxy {
: (queueTime != 0 ? queueTime
: LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
MultiProxyVoteRetry forwardedOccurrence = multiProxyVoteRetries.get(voteId);
long canonicalOccurrenceTime = retryState != null ? retryState.canonicalOccurrenceTime
: upstreamOccurrenceTime != 0L ? upstreamOccurrenceTime
: forwardedOccurrence != null ? forwardedOccurrence.canonicalOccurrenceTime
: queuedVote == null ? time
: queuedVote.getCanonicalOccurrenceTime() == 0L ? -1L : queuedVote.getCanonicalOccurrenceTime();
Set<String> broadcastTargets = queuedVote == null ? new LinkedHashSet<>()
: new LinkedHashSet<>(queuedVote.getBroadcastTargets());
Set<String> broadcastForwardedServers = queuedVote == null ? new LinkedHashSet<>()
@@ -6539,6 +6591,7 @@ public abstract class VotingPluginProxy {
VoteTimeQueue delayedVote = new VoteTimeQueue(voteId, player, service, time,
proxyBroadcastHandled, broadcastTargets, broadcastForwardedServers,
projectedTotals == null ? "" : projectedTotals.toString(), false, uuid);
if (canonicalOccurrenceTime != 0L) delayedVote.setCanonicalOccurrenceTime(canonicalOccurrenceTime);
delayedVote.setRealVote(realVote);
delayedVote.setWasOnline(playerOnline);
if (authoritativeDelayValidationKnown) {
@@ -6579,12 +6632,14 @@ public abstract class VotingPluginProxy {
}
retryState.totalsInput = data;
if (queuedVote != null && queuedVote.isTotalsApplied()) {
retryState.totals = text != null ? text : VoteTotalsSnapshot.parseStorage(queuedVote.getTotals());
retryState.totals = text != null ? text : VoteOccurrenceMetadata.hasPayload(queuedVote.getTotals())
? VoteTotalsSnapshot.parseStorage(queuedVote.getTotals()) : null;
}
retryState.player = requestPlayer;
retryState.service = service;
retryState.uuid = uuid;
retryState.time = time;
retryState.canonicalOccurrenceTime = canonicalOccurrenceTime;
retryState.realVote = realVote;
retryState.playerOnline = playerOnline;
retryState.delayValidated = authoritativeDelayValidated;
@@ -6693,6 +6748,9 @@ public abstract class VotingPluginProxy {
text = new VoteTotalsSnapshot(0, 0, 0, 0, 0, votePartyVotes, currentVotePartyVotesRequired, 0);
}
String votePayload = canonicalOccurrenceTime == 0L ? text.toString()
: VoteOccurrenceMetadata.store(text.toString(), canonicalOccurrenceTime);
VoteLogStatus voteStatus = VoteLogStatus.IMMEDIATE;
boolean standaloneProxyBroadcast = canValidateStandaloneBroadcast && (proxyBroadcastHandled
|| proxyBroadcastDecider.usesImmediateForwarding(playerOnline));
@@ -6727,7 +6785,7 @@ public abstract class VotingPluginProxy {
}
if (standaloneBroadcastState == null) {
standaloneBroadcastState = new OfflineBungeeVote(voteId, player, uuid, service, time, realVote,
text == null ? "" : text.toString(), false, true, proxyBroadcastTargets,
text == null ? "" : votePayload, false, true, proxyBroadcastTargets,
broadcastForwardedServers, !sendVotesToAllServers, Collections.emptyMap(), queuedVote == null
? Collections.emptyMap() : queuedVote.getHttpBroadcastDeliveryIds());
standaloneBroadcastState.setWasOnline(playerOnline);
@@ -6775,7 +6833,7 @@ public abstract class VotingPluginProxy {
if (method == BungeeMethod.PLUGINMESSAGING || retryState.pluginMessageRouting)
rewardJournalOwner = findCachedBroadcastOwner(uuid, voteId);
if (rewardJournalOwner == null) rewardJournalOwner = createCachedRewardVote(voteId, player, uuid, service, time, realVote,
text.toString(), false, playerOnline);
votePayload, false, playerOnline);
if (retryState.delayValidationKnown) rewardJournalOwner.setDelayValidated(authoritativeDelayValidated);
markPendingRewardJournalTargets(rewardJournalOwner, rewardServers, retryState.deliveredRewardServers);
retryState.rewardJournalOwner = rewardJournalOwner;
@@ -6793,7 +6851,7 @@ public abstract class VotingPluginProxy {
OfflineBungeeVote rewardState = retryState.rewardStates.get(server.toLowerCase(Locale.ROOT));
if (rewardState == null) {
rewardState = createCachedRewardVote(voteId, player, uuid, service, time,
realVote, text.toString(), standaloneProxyBroadcast, playerOnline);
realVote, votePayload, standaloneProxyBroadcast, playerOnline);
if (retryState.delayValidationKnown) rewardState.setDelayValidated(authoritativeDelayValidated);
retryState.rewardStates.put(server.toLowerCase(Locale.ROOT), rewardState);
}
@@ -6846,10 +6904,10 @@ public abstract class VotingPluginProxy {
OfflineBungeeVote pendingVote = retryState.rewardStates.get(s.toLowerCase(Locale.ROOT));
JsonEnvelope rewardEnvelope = retryState.delayValidationKnown
? VotingPluginWire.vote(player, uuid, service, time, playerOnline, realVote, text.toString(),
? VotingPluginWire.vote(player, uuid, service, time, playerOnline, realVote, votePayload,
voteId, getConfig().getBungeeManageTotals(), broadcastHere, 1, 1,
authoritativeDelayValidated)
: VotingPluginWire.vote(player, uuid, service, time, playerOnline, realVote, text.toString(),
: VotingPluginWire.vote(player, uuid, service, time, playerOnline, realVote, votePayload,
voteId, getConfig().getBungeeManageTotals(), broadcastHere, 1, 1);
boolean rewardAccepted = sendVoteEnvelopeAccepted(s, 2, rewardEnvelope, pendingVote);
if (!rewardAccepted) {
@@ -6894,10 +6952,10 @@ public abstract class VotingPluginProxy {
}
if (pendingVote == null) {
pendingVote = standaloneProxyBroadcast
? new OfflineBungeeVote(voteId, player, uuid, service, time, realVote, text.toString(), false,
? new OfflineBungeeVote(voteId, player, uuid, service, time, realVote, votePayload, false,
true, proxyBroadcastTargets, broadcastForwardedServers, false, Collections.emptyMap(),
standaloneBroadcastState.getHttpBroadcastDeliveryIds())
: createCachedRewardVote(voteId, player, uuid, service, time, realVote, text.toString(), false, playerOnline);
: createCachedRewardVote(voteId, player, uuid, service, time, realVote, votePayload, false, playerOnline);
retryState.rewardStates.put(server.toLowerCase(Locale.ROOT), pendingVote);
}
pendingVote.setWasOnline(playerOnline);
@@ -6906,10 +6964,10 @@ public abstract class VotingPluginProxy {
if (!rewardAccepted) {
JsonEnvelope rewardEnvelope = retryState.delayValidationKnown
? VotingPluginWire.voteOnline(player, uuid, service, time, playerOnline, realVote,
text.toString(), voteId, getConfig().getBungeeManageTotals(), broadcastHere, 1, 1,
votePayload, voteId, getConfig().getBungeeManageTotals(), broadcastHere, 1, 1,
authoritativeDelayValidated)
: VotingPluginWire.voteOnline(player, uuid, service, time, playerOnline, realVote,
text.toString(), voteId, getConfig().getBungeeManageTotals(), broadcastHere, 1, 1);
votePayload, voteId, getConfig().getBungeeManageTotals(), broadcastHere, 1, 1);
rewardAccepted = sendVoteEnvelopeAccepted(server, 1, rewardEnvelope, pendingVote);
if (rewardAccepted) {
retryState.deliveredRewardServers.add(server);
@@ -6970,7 +7028,7 @@ public abstract class VotingPluginProxy {
}
if (standaloneBroadcastState == null) {
standaloneBroadcastState = new OfflineBungeeVote(voteId, player, uuid, service, time,
realVote, text.toString(), false, true, targets, broadcastForwardedServers,
realVote, votePayload, false, true, targets, broadcastForwardedServers,
true, Collections.emptyMap(), Collections.emptyMap());
standaloneBroadcastState.setWasOnline(true);
retryState.standaloneBroadcastState = standaloneBroadcastState;
@@ -6996,7 +7054,7 @@ public abstract class VotingPluginProxy {
}
JsonEnvelope broadcast = VotingPluginWire.voteBroadcast(uuid, player, service, time,
text == null ? "" : text.toString(), true);
text == null ? "" : votePayload, true);
if (method == BungeeMethod.HTTP) {
boolean forwarded = sendStableHttpEnvelope(targetServer,
stableLiveHttpBroadcastDeliveryId(voteId, targetServer), broadcast);
@@ -7028,10 +7086,10 @@ public abstract class VotingPluginProxy {
}
}
OfflineBungeeVote cachedReward = standaloneProxyBroadcast
? new OfflineBungeeVote(voteId, player, uuid, service, time, realVote, text.toString(), false,
? new OfflineBungeeVote(voteId, player, uuid, service, time, realVote, votePayload, false,
true, proxyBroadcastTargets, broadcastForwardedServers, false, Collections.emptyMap(),
standaloneBroadcastState.getHttpBroadcastDeliveryIds())
: createCachedRewardVote(voteId, player, uuid, service, time, realVote, text.toString(), false, playerOnline);
: createCachedRewardVote(voteId, player, uuid, service, time, realVote, votePayload, false, playerOnline);
cachedReward.setWasOnline(playerOnline);
if (retryState.delayValidationKnown) cachedReward.setDelayValidated(authoritativeDelayValidated);
retryState.pendingOnlineRewardState = cachedReward;
@@ -7209,6 +7267,10 @@ public abstract class VotingPluginProxy {
String uuid, String service, long time, boolean realVote, VoteTotalsSnapshot totals,
boolean delayValidated, boolean delayValidationKnown) {
if (multiProxyHandler == null) return false;
String forwardingTotals = VoteOccurrenceMetadata.store(totals == null ? "" : totals.toString(),
retryState != null && retryState.canonicalOccurrenceTime != 0
? retryState.canonicalOccurrenceTime : queuedVote == null ? time
: queuedVote.getCanonicalOccurrenceTime());
// A corrupt or unpersistable peer-classification file cannot safely identify
// which targets are legacy. Stop before creating an ACK outbox that a legacy
// peer could never complete; the handler emits the operator recovery message.
@@ -7258,12 +7320,12 @@ public abstract class VotingPluginProxy {
// Older peers do not understand acknowledgements. Preserve their historical
// fire-and-forget route instead of creating an outbox they can never ACK.
return multiProxyHandler.sendMultiProxyEnvelopeAccepted(VotingPluginWire.vote(player, uuid, service, time,
false, realVote, totals == null ? "" : totals.toString(), findLiveVoteId(retryState), false, false,
false, realVote, forwardingTotals, findLiveVoteId(retryState), false, false,
1, 1), legacyRecipients);
}
if (outbox == null) {
outbox = new VoteTimeQueue(null, player, service, time, false, Collections.emptySet(),
Collections.emptySet(), totals == null ? "" : totals.toString(), true, uuid);
Collections.emptySet(), forwardingTotals, true, uuid);
// The live retry key is the stable vote ID; copy it from the enclosing state
// by locating its identity rather than creating a new duplicate record.
outbox.setVoteId(findLiveVoteId(retryState));
@@ -7318,7 +7380,7 @@ public abstract class VotingPluginProxy {
outbox.setDeliveryStateDirty(true);
if (!persistTimeVoteDelivery(outbox)) return false;
if (!multiProxyHandler.sendMultiProxyEnvelopeAccepted(VotingPluginWire.vote(player, uuid, service, time,
false, realVote, totals == null ? "" : totals.toString(), outbox.getVoteId(), false, false, 1, 1),
false, realVote, forwardingTotals, outbox.getVoteId(), false, false, 1, 1),
legacyPending)) {
outbox.setMultiProxyLegacyPendingRecipients(legacyPending);
outbox.setDeliveryStateDirty(true);
@@ -7348,10 +7410,14 @@ public abstract class VotingPluginProxy {
private VoteTimeQueue admitMultiProxyDiscoveryOutbox(LiveVoteRetryState retryState, VoteTimeQueue queuedVote,
String player, String uuid, String service, long time, boolean realVote, VoteTotalsSnapshot totals,
boolean delayValidated, boolean delayValidationKnown) {
String forwardingTotals = VoteOccurrenceMetadata.store(totals == null ? "" : totals.toString(),
retryState != null && retryState.canonicalOccurrenceTime != 0
? retryState.canonicalOccurrenceTime : queuedVote == null ? time
: queuedVote.getCanonicalOccurrenceTime());
VoteTimeQueue outbox = queuedVote;
if (outbox == null) {
outbox = new VoteTimeQueue(null, player, service, time, false, Collections.emptySet(),
Collections.emptySet(), totals == null ? "" : totals.toString(), true, uuid);
Collections.emptySet(), forwardingTotals, true, uuid);
outbox.setVoteId(findLiveVoteId(retryState));
if (outbox.getVoteId() == null) return null;
retryState.queuedVote = outbox;
@@ -34,6 +34,7 @@ public final class VotingPluginWire {
}
public static final int SCHEMA_VERSION = 1;
public static final String K_CANONICAL_OCCURRENCE_TIME = "canonicalOccurrenceTime";
// =========================
// Subchannels (canonical)
@@ -182,13 +183,16 @@ public final class VotingPluginWire {
private static JsonEnvelope.Builder voteBuilder(String subChannel, String player, String uuid, String service,
long time, boolean wasOnline, boolean realVote, String totals, UUID voteId, boolean manageTotals,
boolean bungeeBroadcast, int num, int numberOfVotes) {
return base(subChannel).put(K_PLAYER, safe(player)).put(K_UUID, safe(uuid)).put(K_SERVICE, safe(service))
JsonEnvelope.Builder builder = base(subChannel).put(K_PLAYER, safe(player)).put(K_UUID, safe(uuid)).put(K_SERVICE, safe(service))
.put(K_TIME, time).put(K_WAS_ONLINE, wasOnline).put(K_WAS_ONLINE_KNOWN, true)
.put(K_REAL_VOTE, realVote).put(K_TOTALS, safe(totals))
.put(K_VOTE_ID, voteId == null ? "" : voteId.toString()).put(K_SET_TOTALS, true)
.put(K_MANAGE_TOTALS, manageTotals).put(K_QUEUED_DELIVERY, false)
.put(K_BUNGEE_BROADCAST, bungeeBroadcast).put(K_NUM, num)
.put(K_NUMBER_OF_VOTES, numberOfVotes);
Long occurrence = VoteOccurrenceMetadata.read(totals);
builder.put(K_CANONICAL_OCCURRENCE_TIME, occurrence == null ? time : occurrence);
return builder;
}
/**
@@ -214,12 +218,15 @@ public final class VotingPluginWire {
private static JsonEnvelope.Builder multiProxyVoteBuilder(String subChannel, String player, String uuid,
String service, long time, boolean wasOnline, boolean realVote, String totals, UUID voteId,
boolean manageTotals, boolean bungeeBroadcast, int num, int numberOfVotes, String origin) {
return base(subChannel).put(K_PLAYER, safe(player)).put(K_UUID, safe(uuid)).put(K_SERVICE, safe(service))
JsonEnvelope.Builder builder = base(subChannel).put(K_PLAYER, safe(player)).put(K_UUID, safe(uuid)).put(K_SERVICE, safe(service))
.put(K_TIME, time).put(K_WAS_ONLINE, wasOnline).put(K_WAS_ONLINE_KNOWN, true).put(K_REAL_VOTE, realVote).put(K_TOTALS, safe(totals))
.put(K_VOTE_ID, voteId == null ? "" : voteId.toString()).put(K_SET_TOTALS, true)
.put(K_MANAGE_TOTALS, manageTotals).put(K_QUEUED_DELIVERY, false)
.put(K_BUNGEE_BROADCAST, bungeeBroadcast).put(K_NUM, num)
.put(K_NUMBER_OF_VOTES, numberOfVotes).put(K_MULTI_PROXY_ORIGIN, safe(origin));
Long occurrence = VoteOccurrenceMetadata.read(totals);
builder.put(K_CANONICAL_OCCURRENCE_TIME, occurrence == null ? time : occurrence);
return builder;
}
/** Reliable multi-proxy variant of {@link #voteOnline}. */
@@ -638,6 +645,7 @@ public final class VotingPluginWire {
public final String uuid;
public final String service;
public final long time;
public final long canonicalOccurrenceTime;
public final boolean wasOnline;
public final boolean wasOnlineKnown;
@@ -659,12 +667,13 @@ public final class VotingPluginWire {
boolean wasOnlineKnown, boolean realVote, String totals, UUID voteId, boolean setTotals,
boolean manageTotals, boolean delayValidated, boolean delayValidationKnown, boolean queuedDelivery,
boolean queuedDeliveryKnown,
boolean broadcast, int num, int numberOfVotes) {
boolean broadcast, int num, int numberOfVotes, long canonicalOccurrenceTime) {
this.subChannel = subChannel;
this.player = player;
this.uuid = uuid;
this.service = service;
this.time = time;
this.canonicalOccurrenceTime = canonicalOccurrenceTime;
this.wasOnline = wasOnline;
this.wasOnlineKnown = wasOnlineKnown;
this.realVote = realVote;
@@ -695,6 +704,13 @@ public final class VotingPluginWire {
final boolean wasOnlineKnown = readBool(f, K_WAS_ONLINE_KNOWN, false);
final boolean realVote = readBool(f, K_REAL_VOTE, false);
final String totals = safe(f.get(K_TOTALS));
Long cachedOccurrence = VoteOccurrenceMetadata.read(totals);
// Missing or malformed provenance excludes only date accounting. An older
// intermediate proxy may have replaced ordinary time with its receipt time.
long occurrence = f.containsKey(K_CANONICAL_OCCURRENCE_TIME)
? VoteOccurrenceMetadata.parse(f.get(K_CANONICAL_OCCURRENCE_TIME))
: cachedOccurrence == null ? -1L : cachedOccurrence;
if (cachedOccurrence != null && (cachedOccurrence <= 0 || cachedOccurrence != occurrence)) occurrence = -1L;
final UUID voteId = readUuid(f, K_VOTE_ID);
final boolean setTotals = readBool(f, K_SET_TOTALS, true);
@@ -711,7 +727,7 @@ public final class VotingPluginWire {
return new Vote(sub, player, uuid, service, time, wasOnline, wasOnlineKnown, realVote, totals, voteId,
setTotals, manageTotals, delayValidated, delayValidationKnown, queuedDelivery, queuedDeliveryKnown,
broadcast, num, numberOfVotes);
broadcast, num, numberOfVotes, occurrence);
}
public static final class VoteDelayRejected {
@@ -614,6 +614,18 @@ public class VotingPluginBungee extends Plugin implements Listener {
}
}
/** Captured ingress survives scheduler/reload/identity-resolution delays. */
public IncomingVoteRuntimeResult processIncomingVote(String player, String service, UUID voteId, long occurredAt) {
if (reloading) return IncomingVoteRuntimeResult.RETRY_AFTER_RELOAD;
synchronized (reloadLock) {
if (reloading) return IncomingVoteRuntimeResult.RETRY_AFTER_RELOAD;
VotingPluginProxy runtime = votingPluginProxy;
if (!runtimeOperational || runtime == null) return IncomingVoteRuntimeResult.RUNTIME_UNAVAILABLE;
runtime.vote(player, service, true, true, 0, null, null, voteId, occurredAt);
return IncomingVoteRuntimeResult.PROCESSED;
}
}
/** Owns a Votifier event before any fallible scheduler handoff. */
public void acceptIncomingVote(String player, String service) {
PendingIncomingVote pending = pendingIncomingVotes.admit(player, service);
@@ -672,7 +684,7 @@ public class VotingPluginBungee extends Plugin implements Listener {
try {
IncomingVoteRuntimeResult result;
synchronized (reloadLock) {
result = processIncomingVote(pending.getPlayer(), pending.getService(), pending.getVoteId());
result = processIncomingVote(pending.getPlayer(), pending.getService(), pending.getVoteId(), pending.getAcceptedAt());
if (result == IncomingVoteRuntimeResult.PROCESSED) pendingIncomingVotes.complete(pending);
}
if (result == IncomingVoteRuntimeResult.PROCESSED) {
@@ -132,6 +132,8 @@ public abstract class ProxyOnlineVoteCacheTable extends AbstractSqlTable {
return;
}
newText = com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.preserve(vote.getText(), newText);
String sql = "UPDATE " + qi(getTableName()) + " SET " + qi("text") + " = ?" + " WHERE " + qi("uuid")
+ " = ? AND " + qi("service") + " = ? AND " + qi("time") + " = ?;";
@@ -97,6 +97,8 @@ public abstract class ProxyVoteCacheTable extends AbstractSqlTable {
return;
}
newText = com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.preserve(vote.getText(), newText);
String sql = "UPDATE " + qi(getTableName()) + " SET " + qi("text") + " = ?" + " WHERE " + qi("uuid")
+ " = ? AND " + qi("service") + " = ? AND " + qi("time") + " = ? AND " + qi("server") + " = ?;";
@@ -444,6 +444,14 @@ public abstract class MultiProxyHandler {
triggerVote(player, service, realVote, timeQueue, queueTime, text, uuid, voteId, origin);
}
/** Additive occurrence metadata; queueTime remains the normal receiver clock convention. */
public void triggerVote(String player, String service, boolean realVote, boolean timeQueue, long queueTime,
VoteTotalsSnapshot text, String uuid, UUID voteId, String origin, boolean delayValidated,
boolean delayValidationKnown, long canonicalOccurrenceTime) {
triggerVote(player, service, realVote, timeQueue, queueTime, text, uuid, voteId, origin,
delayValidated, delayValidationKnown);
}
/** Called when a receiver acknowledges this proxy's stable vote ID. */
public void onMultiProxyVoteAcknowledged(UUID voteId, String recipient) {
// Optional for legacy implementations.
@@ -1276,8 +1284,14 @@ public abstract class MultiProxyHandler {
if (origin.isBlank()) {
triggerVote(player, service, realVote, true, 0L, VoteTotalsSnapshot.parseStorage(totals), uuid);
} else {
// Older reliable origin envelopes still carry the sender's original
// time. Keep it separate from receiver-local cooldown processing.
long occurrenceTime = !f.containsKey(VotingPluginWire.K_CANONICAL_OCCURRENCE_TIME)
&& com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.read(totals) == null
? wireVote.time : wireVote.canonicalOccurrenceTime;
triggerVote(player, service, realVote, true, 0L, VoteTotalsSnapshot.parseStorage(totals), uuid,
wireVote.voteId, origin, wireVote.delayValidated, wireVote.delayValidationKnown);
wireVote.voteId, origin, wireVote.delayValidated, wireVote.delayValidationKnown,
occurrenceTime);
}
}
return;
@@ -509,6 +509,18 @@ public class VotingPluginVelocity {
}
}
/** Captured ingress survives scheduler/reload/identity-resolution delays. */
public IncomingVoteRuntimeResult processIncomingVote(String player, String service, UUID voteId, long occurredAt) {
if (reloading) return IncomingVoteRuntimeResult.RETRY_AFTER_RELOAD;
synchronized (reloadLock) {
if (reloading) return IncomingVoteRuntimeResult.RETRY_AFTER_RELOAD;
VotingPluginProxy runtime = votingPluginProxy;
if (!runtimeOperational || runtime == null) return IncomingVoteRuntimeResult.RUNTIME_UNAVAILABLE;
runtime.vote(player, service, true, false, 0, null, null, voteId, occurredAt);
return IncomingVoteRuntimeResult.PROCESSED;
}
}
/** Owns a Votifier event before any fallible executor handoff. */
public void acceptIncomingVote(String player, String service) {
PendingIncomingVote pending = pendingIncomingVotes.admit(player, service);
@@ -558,7 +570,7 @@ public class VotingPluginVelocity {
try {
IncomingVoteRuntimeResult result;
synchronized (reloadLock) {
result = processIncomingVote(pending.getPlayer(), pending.getService(), pending.getVoteId());
result = processIncomingVote(pending.getPlayer(), pending.getService(), pending.getVoteId(), pending.getAcceptedAt());
if (result == IncomingVoteRuntimeResult.PROCESSED) pendingIncomingVotes.complete(pending);
}
if (result == IncomingVoteRuntimeResult.PROCESSED) {
@@ -123,8 +123,7 @@ public class ServiceSiteHandler {
public void saveToServerData() {
List<String> out = toListFormat(sitesRef.get());
plugin.getServerData().getData().set(SERVERDATA_PATH, out);
plugin.getServerData().saveData();
plugin.getServerData().setStringList(SERVERDATA_PATH, out);
}
public void refreshFromWebOnce(boolean logMore) {
@@ -12,7 +12,6 @@ import org.bukkit.block.Skull;
import org.bukkit.block.data.Directional;
import org.bukkit.inventory.meta.SkullMeta;
import com.bencodez.advancedcore.api.misc.MiscUtils;
import com.bencodez.simpleapi.array.ArrayUtils;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.topvoter.TopVoter;
@@ -25,14 +24,14 @@ public class SignHandler {
@Getter
@Setter
private String data;
private volatile String data;
/** The lines. */
private ArrayList<String> lines;
@Getter
@Setter
private Location location;
private volatile Location location;
private String playerName;
@@ -48,7 +47,7 @@ public class SignHandler {
@Getter
@Setter
private Location skullLocation;
private volatile Location skullLocation;
@Getter
@Setter
@@ -56,6 +55,88 @@ public class SignHandler {
private int votes;
private record Render(ArrayList<String> lines, String name, UUID identity, int votes) { }
private record DisplayUpdate(long generation, Location location, String data) { }
private DisplayUpdate preparing;
private long skullSequence;
private static final int MAX_DISCOVERED_SKULLS = 28;
private final java.util.Set<Location> displayedSkulls = new java.util.LinkedHashSet<>();
private SkullFrame lastSkullFrame;
private record SkullFrame(long sequence, long generation, Location origin, Location selected, String data,
String name, UUID identity) { }
private synchronized SkullFrame skullFrame(String name, UUID identity) {
var frame = new SkullFrame(++skullSequence, plugin.getTopVoterDisplayGeneration(), location.clone(),
skullLocation == null ? null : skullLocation.clone(), data, name, identity);
if (lastSkullFrame == null || lastSkullFrame.generation() != frame.generation()
|| !java.util.Objects.equals(lastSkullFrame.origin(), frame.origin())
|| !java.util.Objects.equals(lastSkullFrame.selected(), frame.selected())
|| !java.util.Objects.equals(lastSkullFrame.data(), frame.data())) displayedSkulls.clear();
lastSkullFrame = frame;
return frame;
}
/** Remember successful automatic publications, never arbitrary neighboring skulls. */
private synchronized void rememberSkull(SkullFrame frame, Location target) {
if (lastSkullFrame == frame && frame.selected() == null && displayedSkulls.size() < MAX_DISCOVERED_SKULLS)
displayedSkulls.add(target.clone());
}
private synchronized void forgetSkull(SkullFrame frame, Location target) {
if (lastSkullFrame == frame) displayedSkulls.remove(target);
}
private synchronized boolean assignedSkull(SkullFrame frame, Location target) {
return lastSkullFrame == frame && (java.util.Objects.equals(frame.selected(), target)
|| displayedSkulls.contains(target));
}
private synchronized ArrayList<Location> assignedSkulls(SkullFrame frame) {
if (lastSkullFrame != frame) return new ArrayList<>();
return new ArrayList<>(frame.selected() == null ? displayedSkulls : java.util.List.of(frame.selected()));
}
private boolean current(SkullFrame frame) {
if (!plugin.isEnabled() || plugin.getTopVoterDisplayGeneration() != frame.generation()) return false;
synchronized (this) {
return skullSequence == frame.sequence() && java.util.Objects.equals(location, frame.origin())
&& java.util.Objects.equals(skullLocation, frame.selected())
&& java.util.Objects.equals(data, frame.data());
}
}
/** Only coordinates cross regions; every block access occurs inside its own location task. */
private void onOwner(SkullFrame frame, Location target, Runnable action) {
try {
plugin.getBukkitScheduler().runTask(plugin, () -> {
if (current(frame)) action.run();
}, target);
} catch (RuntimeException rejected) { plugin.debug("Unable to schedule skull display"); }
}
private void updateSkull(SkullFrame frame, Location target, Runnable absent) {
onOwner(frame, target, () -> {
Block block = target.getBlock();
if (!(block.getState() instanceof Skull)) {
forgetSkull(frame, target);
if (absent != null) absent.run();
return;
}
String name = frame.name(); UUID identity = frame.identity();
// Queued region work may outlive the evidence used by the sign render.
TopVoter period = displayPeriod();
if (period != null && position > 0 && plugin.getConfigFile().isHideTopVoterIfNotPlayedBefore()) {
var rows = new ArrayList<>(plugin.getTopVoterDisplay(period).keySet());
if (rows.size() >= position) {
name = rows.get(position - 1).getPlayerName(); identity = rows.get(position - 1).getUuid();
} else { name = "No Player"; identity = null; }
}
if (!current(frame)) return;
if (!checkSkull(block, target, name, identity, frame) && absent != null) absent.run();
});
}
/**
* Constructs a new SignHandler.
*
@@ -81,19 +162,28 @@ public class SignHandler {
}
@SuppressWarnings("deprecation")
private boolean checkSkull(Block block) {
if (block.getState() instanceof Skull) {
if (!playerName.equals("No Player")) {
Skull skull = (Skull) block.getState();
private boolean checkSkull(Block block, Location target, String name, UUID identity, SkullFrame frame) {
if (block.getState() instanceof Skull skull) {
if (name.isEmpty() || name.equalsIgnoreCase("No Player")) {
if (plugin.getConfigFile().isHideTopVoterIfNotPlayedBefore()) {
if (!current(frame) || !assignedSkull(frame, target)) return true;
skull.setOwnerProfile(null);
if (current(frame) && skull.update(true, false)) forgetSkull(frame, target);
}
return true;
}
if (!name.equals("No Player")) {
try {
SkullMeta meta = (SkullMeta) plugin.getSkullCacheHandler().getSkull(uuid, playerName).getItemMeta();
skull.setOwnerProfile(meta.getOwnerProfile());
skull.update(true, false);
SkullMeta meta = (SkullMeta) plugin.getSkullCacheHandler().getSkull(identity, name).getItemMeta();
var profile = java.util.Objects.requireNonNull(meta.getOwnerProfile(), "Skull profile unavailable");
if (!current(frame)) return true;
skull.setOwnerProfile(profile);
if (current(frame) && skull.update(true, false)) rememberSkull(frame, target);
} catch (Exception e) {
plugin.debug("Failed to set skull for " + playerName);
plugin.debug("Failed to set skull for " + name);
plugin.debug(e);
skull.setOwner(playerName);
skull.update(true, false);
if (!current(frame)) return true;
if (skull.setOwner(name) && current(frame) && skull.update(true, false)) rememberSkull(frame, target);
}
}
@@ -106,18 +196,24 @@ public class SignHandler {
* Check skulls.
*/
public void checkSkulls() {
if (noNameAvailable()) {
return;
}
if (skullLocation != null) {
checkSkull(skullLocation.getBlock());
return;
}
Render rendered = currentRender();
checkSkulls(rendered.name(), rendered.identity());
}
Location loc = location;
private void checkSkulls(String name, UUID identity) {
if ((name.equalsIgnoreCase("No Player") || name.isEmpty())
&& !plugin.getConfigFile().isHideTopVoterIfNotPlayedBefore()) {
return;
}
SkullFrame frame = skullFrame(name, identity);
if (frame.selected() != null) {
updateSkull(frame, frame.selected(), null);
return;
}
Location loc = frame.origin();
Location loc1 = new Location(loc.getWorld(), loc.getBlockX() - 1, loc.getBlockY() - 1, loc.getBlockZ() - 1);
Location loc2 = new Location(loc.getWorld(), loc.getBlockX() + 1, loc.getBlockY() + 1, loc.getBlockZ() + 1);
updateSkulls(loc1, loc2);
updateSkulls(loc1, loc2, frame);
}
/**
@@ -190,6 +286,12 @@ public class SignHandler {
/**
* Store sign.
*/
/** Capture platform state on the caller before shutdown transfers publication ownership. */
public com.bencodez.votingplugin.data.ServerData.SignSnapshot captureShutdownSnapshot() {
return com.bencodez.votingplugin.data.ServerData.captureSignSnapshot(
sign, location, skullLocation, data, position);
}
public void storeSign() {
plugin.getServerData().setSign(sign, location, skullLocation, data, position);
}
@@ -198,95 +300,131 @@ public class SignHandler {
* Update lines.
*/
public void updateLines() {
lines = new ArrayList<>();
checkValidSign();
if (position != 0) {
String line1 = plugin.getConfigFile().getFormatSignTopVoterSignLine1();
String line2 = plugin.getConfigFile().getFormatSignTopVoterSignLine2();
String line3 = plugin.getConfigFile().getFormatSignTopVoterSignLine3();
String line4 = plugin.getConfigFile().getFormatSignTopVoterSignLine4();
lines.add(line1);
lines.add(line2);
lines.add(line3);
lines.add(line4);
ArrayList<TopVoterPlayer> users = null;
if (data.equalsIgnoreCase("all")) {
users = new ArrayList<>(plugin.getTopVoter(TopVoter.AllTime).keySet());
} else if (data.equalsIgnoreCase("monthly")) {
users = new ArrayList<>(plugin.getTopVoter(TopVoter.Monthly).keySet());
} else if (data.equalsIgnoreCase("weekly")) {
users = new ArrayList<>(plugin.getTopVoter(TopVoter.Weekly).keySet());
} else if (data.equalsIgnoreCase("daily")) {
users = new ArrayList<>(plugin.getTopVoter(TopVoter.Daily).keySet());
}
if (users != null && users.size() >= position) {
TopVoterPlayer user = users.get(position - 1);
playerName = user.getPlayerName();
uuid = user.getUuid();
votes = 0;
if (data.equalsIgnoreCase("all")) {
votes = plugin.getTopVoter(TopVoter.AllTime).get(user);
} else if (data.equalsIgnoreCase("monthly")) {
votes = plugin.getTopVoter(TopVoter.Monthly).get(user);
} else if (data.equalsIgnoreCase("weekly")) {
votes = plugin.getTopVoter(TopVoter.Weekly).get(user);
} else if (data.equalsIgnoreCase("daily")) {
votes = plugin.getTopVoter(TopVoter.Daily).get(user);
}
for (int j = 0; j < lines.size(); j++) {
lines.set(j, lines.get(j).replace("%votes%", "" + votes).replace("%player%", playerName));
}
} else {
playerName = "No Player";
votes = 0;
for (int j = 0; j < lines.size(); j++) {
lines.set(j, lines.get(j).replace("%votes%", "" + votes).replace("%player%", playerName));
}
}
for (int j = 0; j < lines.size(); j++) {
lines.set(j, lines.get(j).replace("%SiteName%", data).replace("%position%", "" + position));
}
lines = ArrayUtils.colorize(lines);
}
Render rendered = renderLines();
synchronized (this) { applyRender(rendered); }
}
/**
* Update sign.
*
* @param delay the delay
*/
private TopVoter displayPeriod() {
if ("all".equalsIgnoreCase(data)) return TopVoter.AllTime;
if ("monthly".equalsIgnoreCase(data)) return TopVoter.Monthly;
if ("weekly".equalsIgnoreCase(data)) return TopVoter.Weekly;
if ("daily".equalsIgnoreCase(data)) return TopVoter.Daily;
return null;
}
private Render renderLines() {
var rendered = new ArrayList<String>();
checkValidSign();
if (position == 0) {
synchronized (this) { return new Render(rendered, playerName, uuid, votes); }
}
rendered.add(plugin.getConfigFile().getFormatSignTopVoterSignLine1());
rendered.add(plugin.getConfigFile().getFormatSignTopVoterSignLine2());
rendered.add(plugin.getConfigFile().getFormatSignTopVoterSignLine3());
rendered.add(plugin.getConfigFile().getFormatSignTopVoterSignLine4());
TopVoter period = displayPeriod();
java.util.Map<TopVoterPlayer, Integer> board = period == null ? java.util.Map.of()
: plugin.getTopVoterDisplay(period);
var users = new ArrayList<>(board.keySet());
String name = "No Player";
UUID identity = null;
int amount = 0;
if (users.size() >= position) {
TopVoterPlayer row = users.get(position - 1);
name = row.getPlayerName(); identity = row.getUuid(); amount = board.get(row);
}
for (int index = 0; index < rendered.size(); index++) {
rendered.set(index, rendered.get(index).replace("%votes%", Integer.toString(amount))
.replace("%player%", name).replace("%SiteName%", data)
.replace("%position%", Integer.toString(position)));
}
return new Render(ArrayUtils.colorize(rendered), name, identity, amount);
}
/** Called under this monitor; never call storage/provider APIs from this scope. */
private void applyRender(Render rendered) {
lines = rendered.lines(); playerName = rendered.name(); uuid = rendered.identity(); votes = rendered.votes();
}
private Render currentRender() {
synchronized (this) { return new Render(new ArrayList<>(lines), playerName, uuid, votes); }
}
/** Update the sign on its owning scheduler, waiting once for admitted presence evidence when enabled. */
public void updateSign(int delay) {
plugin.getBukkitScheduler().runTaskLater(plugin, new Runnable() {
TopVoter period = displayPeriod();
if (position != 0 && period != null && plugin.getConfigFile() != null
&& plugin.getConfigFile().isHideTopVoterIfNotPlayedBefore()) {
prepareDisplay(period, delay);
return;
}
plugin.getBukkitScheduler().runTaskLater(plugin, () -> writeSign(currentRender(), getLocation()),
delay, getLocation());
}
@SuppressWarnings("deprecation")
@Override
public void run() {
private void prepareDisplay(TopVoter period, int delay) {
long generation = plugin.getTopVoterDisplayGeneration();
Location target = getLocation().clone();
DisplayUpdate update;
synchronized (this) {
if (preparing != null && preparing.generation() == generation
&& preparing.location().equals(target) && java.util.Objects.equals(preparing.data(), data)) return;
update = new DisplayUpdate(generation, target, data);
preparing = update;
}
try {
var ready = plugin.getTopVoterDisplayAsync(period);
if (ready == null) schedulePreparedDisplay(update, delay);
else ready.whenComplete((ignored, failure) -> schedulePreparedDisplay(update, delay));
} catch (RuntimeException unavailable) {
schedulePreparedDisplay(update, delay);
}
}
private boolean current(DisplayUpdate update) {
return plugin.isEnabled() && plugin.getTopVoterDisplayGeneration() == update.generation()
&& java.util.Objects.equals(update.location(), getLocation())
&& java.util.Objects.equals(update.data(), data);
}
private void schedulePreparedDisplay(DisplayUpdate update, int delay) {
synchronized (this) { if (preparing != update) return; }
try {
plugin.getBukkitScheduler().runTaskLater(plugin, () -> {
try {
BlockState state = getLocation().getBlock().getState();
if (state instanceof Sign) {
Sign s = (Sign) state;
for (int j = 0; j < lines.size() && j < 4; j++) {
s.setLine(j, lines.get(j));
}
s.update();
checkSkulls();
synchronized (SignHandler.this) { if (preparing != update) return; }
if (!current(update)) return;
// Resolve current evidence outside the sign monitor. Completion may reenter from the SDK worker.
Render rendered = renderLines();
if (!current(update)) return;
synchronized (SignHandler.this) {
if (preparing != update) return;
applyRender(rendered);
}
} catch (Exception ex) {
plugin.debug("Failed to update sign at " + getLocation().toString());
VotingPluginMain.plugin.debug(ex);
writeSign(rendered, update.location());
} finally {
synchronized (SignHandler.this) { if (preparing == update) preparing = null; }
}
}, delay, update.location());
} catch (RuntimeException rejected) {
synchronized (this) { if (preparing == update) preparing = null; }
}
}
@SuppressWarnings("deprecation")
private void writeSign(Render rendered, Location target) {
try {
BlockState state = target.getBlock().getState();
if (state instanceof Sign signState) {
for (int index = 0; index < rendered.lines().size() && index < 4; index++)
signState.setLine(index, rendered.lines().get(index));
signState.update();
checkSkulls(rendered.name(), rendered.identity());
}
}, delay, getLocation());
} catch (Exception failure) {
plugin.debug("Failed to update sign display");
plugin.debug(failure);
}
}
/**
@@ -296,19 +434,38 @@ public class SignHandler {
* @param loc2 the second location
*/
public void updateSkulls(Location loc1, Location loc2) {
BlockState state = getLocation().getBlock().getState();
if (state instanceof Sign && state.getBlockData() instanceof Directional) {
Directional s = (Directional) state.getBlockData();
Block b = location.getBlock().getRelative(s.getFacing());
Block above = b.getRelative(BlockFace.UP);
if (checkSkull(above)) {
return;
}
Render rendered = currentRender();
updateSkulls(loc1, loc2, rendered.name(), rendered.identity());
}
}
private void updateSkulls(Location loc1, Location loc2, String name, UUID identity) {
updateSkulls(loc1, loc2, skullFrame(name, identity));
}
for (Block block : MiscUtils.getInstance().getRegionBlocks(location.getWorld(), loc1, loc2)) {
checkSkull(block);
private void updateSkulls(Location loc1, Location loc2, SkullFrame frame) {
if (frame.name().isEmpty() || frame.name().equalsIgnoreCase("No Player")) {
if (plugin.getConfigFile().isHideTopVoterIfNotPlayedBefore())
for (Location target : assignedSkulls(frame)) updateSkull(frame, target, null);
return;
}
Runnable nearby = () -> {
for (int x = Math.min(loc1.getBlockX(), loc2.getBlockX()); x <= Math.max(loc1.getBlockX(), loc2.getBlockX()); x++)
for (int y = Math.min(loc1.getBlockY(), loc2.getBlockY()); y <= Math.max(loc1.getBlockY(), loc2.getBlockY()); y++)
for (int z = Math.min(loc1.getBlockZ(), loc2.getBlockZ()); z <= Math.max(loc1.getBlockZ(), loc2.getBlockZ()); z++) {
if (!current(frame)) return;
updateSkull(frame, new Location(frame.origin().getWorld(), x, y, z), null);
}
};
onOwner(frame, frame.origin(), () -> {
BlockState state = frame.origin().getBlock().getState();
if (state instanceof Sign && state.getBlockData() instanceof Directional direction) {
BlockFace facing = direction.getFacing();
Location preferred = new Location(frame.origin().getWorld(),
frame.origin().getBlockX() + facing.getModX(),
frame.origin().getBlockY() + facing.getModY() + 1,
frame.origin().getBlockZ() + facing.getModZ());
updateSkull(frame, preferred, nearby);
} else nearby.run();
});
}
}
@@ -64,6 +64,69 @@ public class Signs {
}
}
private final Object shutdownLock = new Object();
private ShutdownSigns shutdownSigns;
private java.util.concurrent.CompletableFuture<Void> shutdownAttempt;
private record ShutdownSigns(com.bencodez.votingplugin.data.ServerData data,
java.util.List<com.bencodez.votingplugin.data.ServerData.SignSnapshot> snapshot,
com.bencodez.votingplugin.util.ServerDataPublicationFence.Lease lease) { }
/** No YAML lock or disk wait on the lifecycle caller; failures retain the original payload. */
public java.util.concurrent.CompletionStage<Void> storeSignsForShutdown() {
synchronized (shutdownLock) {
if (shutdownAttempt != null && !shutdownAttempt.isCompletedExceptionally())
return shutdownAttempt.minimalCompletionStage();
if (shutdownSigns == null) {
var snapshot = new java.util.ArrayList<com.bencodez.votingplugin.data.ServerData.SignSnapshot>();
for (var sign : java.util.List.copyOf(getSigns())) snapshot.add(sign.captureShutdownSnapshot());
if (snapshot.isEmpty()) {
shutdownAttempt = java.util.concurrent.CompletableFuture.completedFuture(null);
return shutdownAttempt.minimalCompletionStage();
}
var data = java.util.Objects.requireNonNull(plugin.getServerData());
var fence = java.util.Objects.requireNonNull(plugin.getServerDataPublicationFence());
shutdownSigns = new ShutdownSigns(data, java.util.List.copyOf(snapshot), fence.acquire());
}
var publication = shutdownSigns;
var attempt = new java.util.concurrent.CompletableFuture<Void>();
shutdownAttempt = attempt;
try {
startShutdownWorker(() -> {
try {
java.util.Objects.requireNonNull(publication.data().publishShutdownSigns(publication.snapshot()))
.whenComplete((ignored, failure) -> finishShutdownSigns(publication, attempt, failure));
} catch (Throwable failure) { finishShutdownSigns(publication, attempt, failure); }
});
} catch (RuntimeException | Error failure) {
finishShutdownSigns(publication, attempt, failure);
throw failure;
}
return attempt.minimalCompletionStage();
}
}
private void finishShutdownSigns(ShutdownSigns publication,
java.util.concurrent.CompletableFuture<Void> attempt, Throwable failure) {
if (failure == null) {
try { publication.lease().close(); attempt.complete(null); }
catch (Throwable releaseFailure) { attempt.completeExceptionally(releaseFailure); }
} else {
// Neither rejected admission nor failed I/O proves durability or writer drain.
// Keep the same detached payload and lease for an explicit repeated-unload attempt.
try { plugin.getLogger().warning("Sign shutdown persistence failed; its payload remains owned. Recovery is not confirmed."); }
catch (RuntimeException | Error ignored) { }
attempt.completeExceptionally(failure);
}
}
/** Admission seam for deterministic rejection/cancellation tests. */
protected void startShutdownWorker(Runnable task) {
var worker = new Thread(task, "VotingPlugin-sign-shutdown");
worker.setDaemon(true);
worker.start();
}
/**
* Update signs.
*/
@@ -0,0 +1,294 @@
package com.bencodez.votingplugin.specialrewards.datemilestones;
import com.bencodez.votingplugin.core.datemilestones.DateVoteEvent;
import com.bencodez.votingplugin.util.DurableFiles;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.channels.FileChannel;
import java.nio.channels.FileLock;
import java.nio.channels.OverlappingFileLockException;
import java.nio.file.StandardOpenOption;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Properties;
import java.util.Set;
import java.util.UUID;
/** Single local accounting owner. All entry points must run on a persistence worker. */
public final class DateVoteLedger {
public record Progress(int votes, Set<Integer> reservedAwards, Set<Integer> submittedAwards, Set<Integer> deferredAwards) { }
private static final int MAX_RECORDS = 100_000;
private final Path directory;
private final int recordCapacity;
public DateVoteLedger(Path directory) { this(directory, MAX_RECORDS); }
// Smaller limits keep boundary regression fixtures bounded; production uses MAX_RECORDS.
DateVoteLedger(Path directory, int recordCapacity) {
if (recordCapacity < 1 || recordCapacity > MAX_RECORDS) throw new IllegalArgumentException("Invalid milestone record capacity");
this.directory = directory.toAbsolutePath().normalize();
this.recordCapacity = recordCapacity;
}
public synchronized List<Integer> record(DateVoteEvent event, UUID player, UUID occurrence) throws IOException {
return record(event, player, occurrence, true);
}
public synchronized List<Integer> record(DateVoteEvent event, UUID player, UUID occurrence, boolean processRewards) throws IOException {
return withLedgerLock(() -> recordLocked(event, player, occurrence, processRewards));
}
private List<Integer> recordLocked(DateVoteEvent event, UUID player, UUID occurrence, boolean processRewards) throws IOException {
seal(event);
Path file = playerFile(event, player);
Properties state = read(file);
String fingerprint = state.getProperty("fingerprint");
if (fingerprint != null && !fingerprint.equals(event.fingerprint())) throw new IOException("Event accounting changed; use a new event ID");
validateFingerprint(event, state);
Set<UUID> seen = occurrences(state);
boolean changed = !seen.contains(occurrence);
if (changed && (seen.size() >= 4096 || votes(state) >= 4096))
throw new IOException("Event occurrence capacity reached (4096); progress retained");
seen.add(occurrence);
state.setProperty("fingerprint", event.fingerprint());
state.setProperty("seen", String.join(",", seen.stream().map(UUID::toString).sorted().toList()));
int votes = votes(state);
List<Integer> awards = new ArrayList<>();
for (int threshold : event.thresholds()) {
String key = "award." + threshold;
if (votes >= threshold && !state.containsKey(key)) {
state.setProperty(key, "DEFERRED");
changed = true;
}
if (processRewards && votes >= threshold && "DEFERRED".equals(state.getProperty(key))) awards.add(threshold);
}
// Persist counts and known unattempted awards; each submission claims only its own threshold.
if (changed) write(file, state);
return List.copyOf(awards);
}
/** Explicit administrative adjustment; retains receipt IDs and all prior reward fences. */
public synchronized Progress setVotes(DateVoteEvent event, UUID player, int value) throws IOException {
if (value < 0 || value > 4096) throw new IllegalArgumentException("Votes must be between 0 and 4096");
return withLedgerLock(() -> {
seal(event);
Path file = playerFile(event, player);
Properties state = read(file);
validateFingerprint(event, state);
state.setProperty("fingerprint", event.fingerprint());
state.putIfAbsent("seen", "");
state.setProperty("adjustment", Integer.toString(value - occurrences(state).size()));
for (int threshold : event.thresholds()) if (value >= threshold)
state.putIfAbsent("award." + threshold, "DEFERRED");
write(file, state);
return progressLocked(event, player);
});
}
/** Force skips the count requirement; even an explicit repeat cannot erase an uncertain reservation. */
public synchronized boolean reserveForced(DateVoteEvent event, UUID player, int threshold,
boolean ignoreLimits) throws IOException {
if (!event.thresholds().contains(threshold)) throw new IllegalArgumentException("Unknown milestone threshold");
return withLedgerLock(() -> {
seal(event);
Path file = playerFile(event, player);
Properties state = read(file);
validateFingerprint(event, state);
String previous = state.getProperty("award." + threshold);
if ("RESERVED".equals(previous) || !ignoreLimits && "SUBMITTED".equals(previous)) return false;
state.setProperty("fingerprint", event.fingerprint());
state.putIfAbsent("seen", "");
state.putIfAbsent("adjustment", "0");
state.setProperty("award." + threshold, "RESERVED");
write(file, state);
return true;
});
}
/** Atomically admit one known unattempted threshold immediately before its external submission. */
public synchronized boolean reserve(DateVoteEvent event, UUID player, int threshold) throws IOException {
return withLedgerLock(() -> reserveLocked(event, player, threshold));
}
private boolean reserveLocked(DateVoteEvent event, UUID player, int threshold) throws IOException {
Path file = playerFile(event, player);
Properties state = read(file);
validateFingerprint(event, state);
if (!event.thresholds().contains(threshold) || votes(state) < threshold
|| !"DEFERRED".equals(state.getProperty("award." + threshold))) return false;
state.setProperty("award." + threshold, "RESERVED");
write(file, state);
return true;
}
public synchronized void submitted(DateVoteEvent event, UUID player, int threshold) throws IOException {
withLedgerLock(() -> { submittedLocked(event, player, threshold); return null; });
}
private void submittedLocked(DateVoteEvent event, UUID player, int threshold) throws IOException {
Path file = playerFile(event, player);
Properties state = read(file);
validateFingerprint(event, state);
if (!"RESERVED".equals(state.getProperty("award." + threshold))) return;
state.setProperty("award." + threshold, "SUBMITTED");
write(file, state);
}
public synchronized Progress progress(DateVoteEvent event, UUID player) throws IOException {
// An absent ledger is a valid empty snapshot. A read must not initialize
// accounting storage, including for legacy votes with no event progress.
// Unknown/unreadable paths still enter the checked ownership path.
if (Files.notExists(directory, LinkOption.NOFOLLOW_LINKS))
return new Progress(0, Set.of(), Set.of(), Set.of());
return withLedgerLock(() -> progressLocked(event, player));
}
private Progress progressLocked(DateVoteEvent event, UUID player) throws IOException {
Properties definitions = readSealedDefinitions(event);
String sealed = definitions.getProperty(event.id());
if (sealed != null && !sealed.equals(event.fingerprint())) throw new IOException("Event accounting changed; use a new ID");
Properties state = read(playerFile(event, player));
validateFingerprint(event, state);
Set<Integer> reserved = new HashSet<>(), submitted = new HashSet<>(), deferred = new HashSet<>();
for (String key : state.stringPropertyNames()) {
if (key.startsWith("award.")) {
int threshold;
try { threshold = Integer.parseInt(key.substring(6)); }
catch (NumberFormatException invalid) { throw new IOException("Invalid award state", invalid); }
if ("RESERVED".equals(state.getProperty(key))) reserved.add(threshold);
else if ("SUBMITTED".equals(state.getProperty(key))) submitted.add(threshold);
else if ("DEFERRED".equals(state.getProperty(key))) deferred.add(threshold);
else throw new IOException("Unknown award state");
}
}
return new Progress(votes(state), Set.copyOf(reserved), Set.copyOf(submitted), Set.copyOf(deferred));
}
@FunctionalInterface
private interface LedgerAction<T> { T run() throws IOException; }
private <T> T withLedgerLock(LedgerAction<T> action) throws IOException {
if (Files.isSymbolicLink(directory)) throw new IOException("Unsafe milestone directory");
Files.createDirectories(directory);
if (Files.isSymbolicLink(directory)) throw new IOException("Unsafe milestone directory");
// Interning shares this monitor across plugin classloaders without retaining a static registry.
// On Unix, closing any descriptor for a file can release another channel's process-owned lock.
String monitor = ("com.bencodez.votingplugin.DateVoteLedger:" + directory.toRealPath()).intern();
if (Thread.holdsLock(monitor)) throw new IOException("Date milestone ledger is busy");
synchronized (monitor) {
Path lockPath = directory.resolve(".ledger.lock");
if (Files.isSymbolicLink(lockPath) || (Files.exists(lockPath, LinkOption.NOFOLLOW_LINKS)
&& !Files.isRegularFile(lockPath, LinkOption.NOFOLLOW_LINKS)))
throw new IOException("Unsafe milestone lock path");
try (FileChannel channel = FileChannel.open(lockPath, StandardOpenOption.CREATE, StandardOpenOption.WRITE,
LinkOption.NOFOLLOW_LINKS)) {
FileLock lock;
try { lock = channel.tryLock(); }
catch (OverlappingFileLockException busy) { throw new IOException("Date milestone ledger is busy", busy); }
if (lock == null) throw new IOException("Date milestone ledger is busy");
try (lock) { return action.run(); }
}
}
}
private void validateFingerprint(DateVoteEvent event, Properties state) throws IOException {
if (state.isEmpty()) return;
if (!event.fingerprint().equals(state.getProperty("fingerprint")))
throw new IOException("Event accounting changed or state invalid; use a new ID");
int votes = votes(state);
for (int threshold : event.thresholds()) if (votes >= threshold && !state.containsKey("award." + threshold))
throw new IOException("Missing reached milestone award state; progress retained for review");
for (String key : state.stringPropertyNames()) if (key.startsWith("award.")
&& !event.thresholds().contains(Integer.parseInt(key.substring(6))))
throw new IOException("Award is outside configured milestone contract");
}
private void seal(DateVoteEvent event) throws IOException {
Properties definitions = readSealedDefinitions(event);
String old = definitions.getProperty(event.id());
if (old != null && !old.equals(event.fingerprint())) throw new IOException("DateVoteMilestones event " + event.id() + " changed accounting; use a new ID");
if (old == null) {
if (definitions.size() >= 1024) throw new IOException("Event definition capacity reached");
definitions.setProperty(event.id(), event.fingerprint());
write(directory.resolve("definitions.properties"), definitions);
}
}
/** Missing metadata cannot turn surviving player history into a fresh event. */
private Properties readSealedDefinitions(DateVoteEvent event) throws IOException {
if (Files.isSymbolicLink(directory)) throw new IOException("Unsafe milestone directory");
Properties definitions = read(directory.resolve("definitions.properties"));
if (!definitions.containsKey(event.id()) && Files.exists(directory, LinkOption.NOFOLLOW_LINKS)) {
// Bounded accounting directory; this lookup is exclusively on the I/O owner.
try (var history = Files.newDirectoryStream(directory, event.fileId() + "-*.properties")) {
if (history.iterator().hasNext())
throw new IOException("Missing historical event seal; preserve state and repair metadata before accounting");
}
}
return definitions;
}
private Path playerFile(DateVoteEvent event, UUID player) {
return directory.resolve(event.fileId() + "-" + player + ".properties");
}
private Set<UUID> occurrences(Properties state) throws IOException {
Set<UUID> ids = new HashSet<>();
String raw = state.getProperty("seen", "");
if (!raw.isEmpty()) for (String id : raw.split(",", -1)) {
try { if (!ids.add(UUID.fromString(id))) throw new IOException("Duplicate stored occurrence"); }
catch (IllegalArgumentException invalid) { throw new IOException("Invalid stored occurrence", invalid); }
if (ids.size() > 4096) throw new IOException("Oversized event state");
}
return ids;
}
private int votes(Properties state) throws IOException {
String adjustment = state.getProperty("adjustment", "0");
if (!adjustment.matches("-?(0|[1-9][0-9]{0,3})")) throw new IOException("Invalid progress adjustment");
int offset = Integer.parseInt(adjustment);
int result = occurrences(state).size() + offset;
if (offset < -4096 || offset > 4096 || result < 0 || result > 4096)
throw new IOException("Invalid adjusted progress");
return result;
}
private Properties read(Path file) throws IOException {
Properties state = new Properties() {
@Override public synchronized Object put(Object key, Object value) {
if (containsKey(key)) throw new IllegalArgumentException("Duplicate stored field");
return super.put(key, value);
}
};
if (Files.notExists(file, LinkOption.NOFOLLOW_LINKS)) return new Properties();
if (Files.isSymbolicLink(directory)) throw new IOException("Unsafe milestone directory");
if (Files.isSymbolicLink(file) || !Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS) || Files.size(file) > 256 * 1024)
throw new IOException("Unsafe/oversized date milestone state");
try { state.load(new StringReader(Files.readString(file))); }
catch (IllegalArgumentException invalid) { throw new IOException("Malformed milestone state", invalid); }
if (file.getFileName().toString().equals("definitions.properties")) {
if (state.isEmpty() || state.size() > 1024) throw new IOException("Empty/oversized definitions; existing seals must not be reset");
for (String key : state.stringPropertyNames()) if (!key.matches("[A-Za-z0-9_-]{1,64}")
|| !state.getProperty(key).matches("[a-f0-9]{64}")) throw new IOException("Invalid definition state");
} else {
if (!state.containsKey("fingerprint") || !state.getProperty("fingerprint").matches("[a-f0-9]{64}")
|| !state.containsKey("seen") || state.size() > 67) throw new IOException("Incomplete milestone state");
Set<UUID> seen = occurrences(state);
votes(state);
for (String key : state.stringPropertyNames()) if (!key.equals("fingerprint") && !key.equals("seen")
&& !key.equals("adjustment")) {
if (!key.matches("award\\.[1-9][0-9]{0,3}")) throw new IOException("Unknown milestone state field");
int threshold = Integer.parseInt(key.substring(6));
if (threshold > 4096 || threshold > seen.size() && !state.containsKey("adjustment")
|| !(state.getProperty(key).equals("RESERVED") || state.getProperty(key).equals("SUBMITTED") || state.getProperty(key).equals("DEFERRED")))
throw new IOException("Invalid award state");
}
}
Properties mutable = new Properties(); mutable.putAll(state);
return mutable;
}
protected void write(Path file, Properties state) throws IOException {
if (Files.isSymbolicLink(directory)) throw new IOException("Unsafe milestone directory");
Files.createDirectories(directory);
if (Files.isSymbolicLink(directory) || Files.isSymbolicLink(file)) throw new IOException("Unsafe milestone state path");
boolean newRecord = !file.getFileName().toString().equals("definitions.properties") && Files.notExists(file, LinkOption.NOFOLLOW_LINKS);
if (newRecord) {
int recordCount = 0;
try (var files = Files.newDirectoryStream(directory, "*.properties")) {
for (Path existing : files) if (!existing.getFileName().toString().equals("definitions.properties")) {
if (++recordCount >= recordCapacity) throw new IOException("Milestone record capacity reached; existing progress retained");
}
}
}
StringWriter writer = new StringWriter(); state.store(writer, "DateVoteMilestones v1");
String text = writer.toString();
if (text.length() > 256 * 1024) throw new IOException("Oversized milestone state");
Path staged = Files.createTempFile(directory, "milestone-", ".tmp");
try { Files.writeString(staged, text); DurableFiles.publishStagedFile(staged, file); }
finally { Files.deleteIfExists(staged); }
}
}
@@ -0,0 +1,94 @@
package com.bencodez.votingplugin.specialrewards.datemilestones;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeSet;
import java.util.regex.Pattern;
import org.bukkit.configuration.ConfigurationSection;
/** Bounded owner configuration; persistent award identities remain the numeric thresholds. */
final class DateVoteMilestoneConfig {
record Reward(String key, boolean enabled) { }
private static final Pattern RANGE = Pattern.compile("(\\d+)\\s*\\.\\.\\s*(\\d+)(?:\\s+step\\s+(\\d+))?");
private DateVoteMilestoneConfig() { }
static Map<Integer, Reward> read(ConfigurationSection event) {
var section = event.getConfigurationSection("Milestones");
if (section == null || section.getKeys(false).isEmpty() || section.getKeys(false).size() > 64)
throw new IllegalArgumentException("Milestones requires 1–64 entries");
Map<Integer, Reward> result = new LinkedHashMap<>();
for (String key : section.getKeys(false)) {
var milestone = section.getConfigurationSection(key);
for (var entry : entry(key, milestone).entrySet()) {
if (result.putIfAbsent(entry.getKey(), entry.getValue()) != null)
throw new IllegalArgumentException("Milestone thresholds must not overlap between entries");
if (result.size() > 64) throw new IllegalArgumentException("At most 64 thresholds per event");
}
}
return result;
}
static Map<Integer, Reward> entry(String key, ConfigurationSection section) {
if (!key.matches("[A-Za-z0-9_-]{1,64}") || section == null
|| section.getConfigurationSection("Rewards") == null)
throw new IllegalArgumentException("Each milestone requires an ID and Rewards section");
if (section.contains("Enabled") && !(section.get("Enabled") instanceof Boolean))
throw new IllegalArgumentException("Milestone Enabled must be a boolean");
for (String unsupported : List.of("Total", "Group", "Limit")) {
if (section.contains(unsupported))
throw new IllegalArgumentException(unsupported + " is not supported for date milestones");
}
TreeSet<Integer> thresholds = new TreeSet<>();
if (!section.contains("At") && !section.contains("Every")) {
int value = integer(key, false);
if (!key.equals(Integer.toString(value))) throw new IllegalArgumentException("Legacy threshold must be canonical");
thresholds.add(value);
} else {
if (section.contains("At")) {
Object raw = section.get("At");
List<?> values = raw instanceof List<?> list ? list : java.util.Collections.singletonList(raw);
if (values.isEmpty() || values.size() > 64) throw new IllegalArgumentException("At requires 1–64 values");
for (Object value : values) addAt(thresholds, value);
}
if (section.contains("Every")) {
int every = integer(section.get("Every"), false);
for (int value = every; value <= 4096; value += every) add(thresholds, value);
}
}
Map<Integer, Reward> result = new LinkedHashMap<>();
for (int value : thresholds) result.put(value, new Reward(key, section.getBoolean("Enabled", true)));
return result;
}
private static void addAt(TreeSet<Integer> values, Object raw) {
if (raw instanceof String text) {
var range = RANGE.matcher(text.trim());
if (range.matches()) {
int start = integer(range.group(1), true), end = integer(range.group(2), true);
int step = range.group(3) == null ? 1 : integer(range.group(3), false);
int first = Math.min(start, end), last = Math.max(start, end);
for (int value = first; value <= last; value += step) add(values, value == 0 ? 1 : value);
return;
}
}
int value = integer(raw, true);
add(values, value == 0 ? 1 : value);
}
private static void add(TreeSet<Integer> values, int value) {
values.add(value);
if (values.size() > 64) throw new IllegalArgumentException("At most 64 thresholds per event");
}
private static int integer(Object raw, boolean zero) {
// Avoid Number.intValue truncation and YAML's boolean/string-list coercions.
if (!(raw instanceof Byte || raw instanceof Short || raw instanceof Integer || raw instanceof Long || raw instanceof String))
throw new IllegalArgumentException("Threshold must be an integer");
String text = raw.toString().trim();
if (!text.matches("\\d{1,4}")) throw new IllegalArgumentException("Threshold must be an integer from 1 to 4096");
int value = Integer.parseInt(text);
if (value < (zero ? 0 : 1) || value > 4096) throw new IllegalArgumentException("Threshold out of range");
return value;
}
}
@@ -0,0 +1,548 @@
package com.bencodez.votingplugin.specialrewards.datemilestones;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.RejectedExecutionException;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.configuration.file.YamlConfiguration;
import org.bukkit.entity.Player;
import org.bukkit.command.CommandSender;
import com.bencodez.advancedcore.api.rewards.RewardOptions;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.core.datemilestones.DateVoteEvent;
import com.bencodez.votingplugin.core.datemilestones.DateVoteProgressSnapshot;
import com.bencodez.advancedcore.api.rewards.DirectlyDefinedReward;
import com.bencodez.votingplugin.user.VotingPluginUser;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
/** Owner-defined windows, independently accounted on one backend using original occurrence IDs. */
public final class DateVoteMilestones {
private record Definition(DateVoteEvent event, YamlConfiguration rewards, java.util.Set<Integer> enabledThresholds,
java.util.Map<Integer, DateVoteMilestoneConfig.Reward> milestones, boolean countFakeVotes) { }
private final VotingPluginMain plugin;
private volatile List<Definition> definitions = List.of();
private final java.util.Set<UUID> pendingProgress = new java.util.HashSet<>();
private final java.util.concurrent.atomic.AtomicInteger deferredAccounting = new java.util.concurrent.atomic.AtomicInteger();
private final java.util.concurrent.atomic.AtomicInteger pendingAdministration = new java.util.concurrent.atomic.AtomicInteger();
private record PlaceholderIdentity(UUID player, boolean resolveName) { }
private final java.util.Map<PlaceholderIdentity, CachedProgress> placeholderCache = new java.util.LinkedHashMap<>(256, 0.75f, true);
private static final class ProgressRequest {
boolean invalidated;
UUID resolvedStorageId;
}
private final java.util.Map<PlaceholderIdentity, ProgressRequest> placeholderRequests = new java.util.HashMap<>();
private record CachedProgress(Object generation, long expires, UUID storageId, java.util.Map<String, DateVoteLedger.Progress> events) { }
private volatile Object generation = new Object();
private DateVoteLedger ledger;
public DateVoteMilestones(VotingPluginMain plugin) { this.plugin = plugin; }
private synchronized DateVoteLedger ledger() {
if (ledger == null) ledger = new DateVoteLedger(plugin.getDataFolder().toPath().resolve("date-vote-milestones"));
return ledger;
}
/** Configuration is already loaded; this method performs no disk access. */
public void reload() {
generation = null;
synchronized (placeholderCache) {
placeholderCache.clear();
// Queued/running refreshes still own their admission until their existing finally/rejection path releases it.
placeholderRequests.values().forEach(request -> request.invalidated = true);
}
List<Definition> loaded = new ArrayList<>();
YamlConfiguration rewards = new YamlConfiguration();
var root = plugin.getSpecialRewardsConfig().getData().getConfigurationSection("DateVoteMilestones");
if (root != null && !root.getKeys(false).isEmpty()) {
try { rewards.loadFromString(plugin.getSpecialRewardsConfig().getData().saveToString()); }
catch (org.bukkit.configuration.InvalidConfigurationException invalid) {
definitions = List.of(); generation = new Object();
plugin.getLogger().warning("DateVoteMilestones configuration snapshot invalid"); return;
}
}
int considered = 0;
if (root != null) for (String id : root.getKeys(false)) {
if (++considered > 64) { plugin.getLogger().warning("DateVoteMilestones supports at most 64 configured events"); break; }
try {
ConfigurationSection section = root.getConfigurationSection(id);
if (section == null) throw new IllegalArgumentException("Expected an event section");
registerRewardHandles(id, section, rewards);
DateVoteEvent event = parse(id, section);
if (plugin.getBungeeSettings().isUseBungeecoord() && event.accountingServer().isBlank())
throw new IllegalArgumentException("Proxy events require one explicit AccountingServer and all-server identified delivery");
var configured = DateVoteMilestoneConfig.read(section);
var enabledThresholds = configured.entrySet().stream().filter(entry -> entry.getValue().enabled())
.map(java.util.Map.Entry::getKey).collect(java.util.stream.Collectors.toUnmodifiableSet());
loaded.add(new Definition(event, rewards, enabledThresholds, java.util.Map.copyOf(configured),
section.getBoolean("CountFakeVotes", true)));
} catch (Exception invalid) {
plugin.getLogger().warning("DateVoteMilestones " + id + " disabled: " + invalid.getMessage());
}
}
definitions = List.copyOf(loaded);
generation = new Object();
}
/** Queued rewards must resolve even when an accounting-only setting is invalid. */
private void registerRewardHandles(String id, ConfigurationSection section, YamlConfiguration rewards) {
String fileId = DateVoteEvent.fileId(id);
var milestones = section.getConfigurationSection("Milestones");
if (milestones == null) return;
java.util.Map<Integer, DateVoteMilestoneConfig.Reward> configuredRewards = new java.util.LinkedHashMap<>();
java.util.Set<Integer> ambiguous = new java.util.HashSet<>();
int count = 0;
for (String key : milestones.getKeys(false)) {
if (++count > 64) break;
try {
for (var entry : DateVoteMilestoneConfig.entry(key, milestones.getConfigurationSection(key)).entrySet()) {
if (configuredRewards.size() >= 64 && !configuredRewards.containsKey(entry.getKey())) continue;
if (configuredRewards.putIfAbsent(entry.getKey(), entry.getValue()) != null) ambiguous.add(entry.getKey());
}
} catch (IllegalArgumentException invalid) { /* Keep independent valid queued reward handles. */ }
}
for (var entry : configuredRewards.entrySet()) {
int threshold = entry.getKey();
if (ambiguous.contains(threshold)) continue;
String source = "DateVoteMilestones." + id + ".Milestones." + entry.getValue().key() + ".Rewards";
var configured = rewards.getConfigurationSection(source);
if (configured == null) continue;
String alias = "DateVoteMilestonesRuntime." + fileId + ".Milestones." + threshold + ".Rewards";
rewards.createSection(alias, configured.getValues(true));
plugin.addDirectlyDefinedRewards(new DirectlyDefinedReward(alias) {
private String sourcePath(String requested) {
if (!requested.equals(alias) && !requested.startsWith(alias + "."))
throw new IllegalArgumentException("Unexpected date milestone reward path");
String current = currentRewardSource(plugin.getSpecialRewardsConfig().getData(), id, threshold);
if (current == null) throw new IllegalStateException("Date milestone reward definition is unavailable");
return current + requested.substring(alias.length());
}
@Override public ConfigurationSection getFileData() {
YamlConfiguration data = new YamlConfiguration();
var live = plugin.getSpecialRewardsConfig().getData();
String currentSource = currentRewardSource(live, id, threshold);
var current = currentSource == null ? null
: live.getConfigurationSection(currentSource);
if (current != null) data.createSection(alias, current.getValues(true));
return data;
}
@Override public void createSection(String path) { plugin.getSpecialRewardsConfig().createSection(sourcePath(path)); }
@Override public void setData(String path, Object value) { plugin.getSpecialRewardsConfig().setValue(sourcePath(path), value); }
@Override public void save() { plugin.getSpecialRewardsConfig().saveData(); }
});
}
}
/** Old registry handles can outlive YAML replacement during reload; resolve by stable threshold. */
private static String currentRewardSource(ConfigurationSection live, String id, int threshold) {
var milestones = live.getConfigurationSection("DateVoteMilestones." + id + ".Milestones");
if (milestones == null) return null;
String found = null;
int count = 0;
for (String key : milestones.getKeys(false)) {
if (++count > 64) break;
try {
if (!DateVoteMilestoneConfig.entry(key, milestones.getConfigurationSection(key)).containsKey(threshold)) continue;
if (found != null) return null;
found = "DateVoteMilestones." + id + ".Milestones." + key + ".Rewards";
} catch (IllegalArgumentException invalid) { /* An unrelated invalid entry does not hide queued rewards. */ }
}
return found;
}
public static DateVoteEvent parse(String id, ConfigurationSection section) {
if (section.contains("CountFakeVotes") && !section.isBoolean("CountFakeVotes"))
throw new IllegalArgumentException("CountFakeVotes must be a boolean");
String zone = section.getString("Timezone");
String start = section.getString("Start"), end = section.getString("End");
var milestones = section.getConfigurationSection("Milestones");
if (zone == null || start == null || end == null || milestones == null)
throw new IllegalArgumentException("Start, End, Timezone and Milestones are required");
List<Integer> thresholds = new ArrayList<>(DateVoteMilestoneConfig.read(section).keySet());
Object rawSites = section.get("VoteSites");
if (rawSites != null && (!(rawSites instanceof List<?> sites)
|| sites.stream().anyMatch(site -> !(site instanceof String))))
throw new IllegalArgumentException("VoteSites must be a list of configured site keys");
return new DateVoteEvent(id, section.getString("DisplayName", id), section.getBoolean("Enabled", false),
DateVoteEvent.timestamp(start, zone), DateVoteEvent.timestamp(end, zone), zone, thresholds,
new java.util.HashSet<>(section.getStringList("VoteSites")), section.getString("AccountingServer", ""));
}
static String path(DateVoteEvent event, int threshold) {
return "DateVoteMilestonesRuntime." + event.fileId() + ".Milestones." + threshold + ".Rewards";
}
/** Owner-thread extension events use the existing ordered storage worker without waiting on gameplay. */
public boolean deferAccepted(VotingPluginUser user, String site, UUID occurrence, long occurredAt,
boolean real, boolean proxy, boolean canonicalProxy, boolean targeted, boolean forceProxyRouting) {
if (plugin.getBungeeSettings().isUseBungeecoord() && !proxy) return true;
if (occurrence == null || occurredAt <= 0 || proxy && (!canonicalProxy || targeted)) return true;
List<Definition> snapshot = definitions;
if (snapshot.stream().noneMatch(definition -> definition.event().matches(occurredAt, site,
real || definition.countFakeVotes(), proxy,
plugin.getBungeeSettings().getServer()))) return true;
int pending;
do {
pending = deferredAccounting.get();
if (pending >= 64) {
plugin.getLogger().warning("DateVoteMilestones deferred accounting is busy; occurrence remains unconfirmed.");
return false;
}
} while (!deferredAccounting.compareAndSet(pending, pending + 1));
try {
plugin.getUserManager().getDataManager().getTimer().execute(() -> {
try {
if (!plugin.isEnabled() || snapshot != definitions) return;
accepted(user, site, occurrence, occurredAt, real, proxy, canonicalProxy, targeted, forceProxyRouting);
} finally { deferredAccounting.decrementAndGet(); }
});
} catch (RejectedExecutionException rejected) {
deferredAccounting.decrementAndGet();
plugin.getLogger().warning("DateVoteMilestones deferred accounting was rejected; occurrence remains unconfirmed.");
}
return false;
}
/** Called only from the asynchronous accepted-vote pipeline; never from navigation. */
public boolean accepted(VotingPluginUser user, String site, UUID occurrence, long occurredAt,
boolean real, boolean proxy, boolean canonicalProxy, boolean targeted, boolean forceProxyRouting) {
if (plugin.getBungeeSettings().isUseBungeecoord() && !proxy) return true;
if (occurrence == null || occurredAt <= 0 || proxy && (!canonicalProxy || targeted)) return true;
boolean recorded = true;
for (Definition definition : definitions) {
DateVoteEvent event = definition.event();
if (!event.matches(occurredAt, site, real || definition.countFakeVotes(), proxy,
plugin.getBungeeSettings().getServer())) continue;
List<Integer> reached;
try {
reached = ledger().record(event, user.getJavaUUID(), occurrence, plugin.getOptions().isProcessRewards());
invalidateProgress(user.getJavaUUID());
} catch (IOException | RuntimeException failure) {
recorded = false;
plugin.getLogger().warning("DateVoteMilestones " + event.id() + " occurrence was not confirmed; proxy delivery must remain quarantined for accounting reconciliation: " + failure.getMessage());
continue;
}
try {
for (int threshold : reached) {
if (!plugin.getOptions().isProcessRewards()) break;
if (!definition.enabledThresholds().contains(threshold)) continue;
var placeholders = new HashMap<String, String>();
placeholders.put("DateVoteEvent", event.displayName());
placeholders.put("DateVoteThreshold", Integer.toString(threshold));
if (!ledger().reserve(event, user.getJavaUUID(), threshold)) continue;
plugin.getRewardHandler().giveReward(user, definition.rewards(), path(event, threshold),
new RewardOptions().setPrefix("DateVoteMilestones-" + event.id() + "-" + threshold)
.setServer(forceProxyRouting).setPlaceholders(placeholders));
// Submission is not a transactional guarantee of arbitrary command execution.
ledger().submitted(event, user.getJavaUUID(), threshold);
}
} catch (IOException | RuntimeException failure) {
plugin.getLogger().warning("DateVoteMilestones " + event.id() + " accounting/reward submission failed; progress retained for review: " + failure.getMessage());
}
}
return recorded;
}
public enum AdminAction { Status, Preview, SetVotes, Force, ForceNoLimits }
/** Admission is not success: all identity/storage/reward work runs on the ordered worker. */
public void administer(CommandSender sender, AdminAction action, String player, String eventId, String argument) {
Object epoch = generation;
dispatchAdmin(sender, action, () -> {
if (!current(epoch) || !adminAllowed(sender, action)) return;
if (!validPlayer(player) || eventId == null || !eventId.matches("[A-Za-z0-9_-]{1,64}")) {
sender.sendMessage("Invalid exact player or event ID."); return;
}
int count;
do { count = pendingAdministration.get();
if (count >= 64) { sender.sendMessage("Date milestone administration is busy. Try again shortly."); return; }
} while (!pendingAdministration.compareAndSet(count, count + 1));
try {
plugin.getUserManager().getDataManager().getTimer().execute(() -> {
try {
if (!current(epoch)) return;
List<String> result = administerOnWorker(action, player, eventId, argument, epoch);
dispatchAdmin(sender, action, () -> {
if (current(epoch) && adminAllowed(sender, action)) result.forEach(sender::sendMessage);
});
} catch (IOException | RuntimeException failure) {
dispatchAdmin(sender, action, () -> {
if (current(epoch) && adminAllowed(sender, action))
sender.sendMessage("Date milestone operation failed; inspect retained progress before retrying rewards.");
});
} finally { pendingAdministration.decrementAndGet(); }
});
} catch (RejectedExecutionException unavailable) {
pendingAdministration.decrementAndGet();
sender.sendMessage("Date milestone storage is unavailable; nothing was submitted.");
}
});
}
private boolean current(Object epoch) {
return epoch != null && epoch == generation && plugin.isEnabled() && plugin.getDateVoteMilestones() == this;
}
private static boolean validPlayer(String player) {
return player != null && (player.matches("[A-Za-z0-9_]{1,16}")
|| player.matches("[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"));
}
private boolean adminAllowed(CommandSender sender, AdminAction action) {
return (!(sender instanceof Player p) || p.isOnline()) && (sender.hasPermission("VotingPlugin.Admin")
|| sender.hasPermission("VotingPlugin.Commands.AdminVote.DateVoteMilestone." + action.name()));
}
private void dispatchAdmin(CommandSender sender, AdminAction action, Runnable effect) {
Player player = sender instanceof Player p ? p : null;
Runnable checked = () -> { if (plugin.isEnabled() && adminAllowed(sender, action)) effect.run(); };
BukkitCompletionScheduler.run(plugin, player, checked, player == null ? checked : () -> { }, () -> { });
}
private List<String> administerOnWorker(AdminAction action, String player, String eventId, String argument,
Object epoch) throws IOException {
Definition definition = definitions.stream().filter(d -> d.event().id().equals(eventId)).findFirst().orElse(null);
if (definition == null) return List.of("Unknown or invalid date event ID.");
DateVoteEvent event = definition.event();
boolean network = plugin.getBungeeSettings().isUseBungeecoord();
if (network && !event.accountingServer().equals(plugin.getBungeeSettings().getServer()))
return List.of("Progress is remote; run this command on the configured AccountingServer.");
Integer value = null;
List<Integer> selected = List.of();
if (action == AdminAction.SetVotes) {
if (argument == null || !argument.matches("0|[1-9][0-9]{0,3}") || Integer.parseInt(argument) > 4096)
return List.of("Votes must be an integer from 0 to 4096.");
value = Integer.parseInt(argument);
} else if (action == AdminAction.Force || action == AdminAction.ForceNoLimits) {
if (!event.enabled() || !plugin.getOptions().isProcessRewards())
return List.of("Event or reward processing is disabled; no reward was submitted.");
if (argument == null || !argument.matches("[A-Za-z0-9_-]{1,64}")) return List.of("Invalid milestone ID or threshold.");
String selector = argument;
// A named At/Every entry can expand into several independently fenced thresholds.
selected = event.thresholds().stream().filter(n -> definition.milestones().get(n).key().equals(selector)).toList();
if (selected.isEmpty()) selected = event.thresholds().stream().filter(n -> Integer.toString(n).equals(selector)).toList();
if (selected.isEmpty()) return List.of("Unknown milestone ID or threshold.");
}
VotingPluginUser user = player.length() == 36
? plugin.getVotingPluginUserManager().getVotingPluginUser(UUID.fromString(player), false)
: plugin.getVotingPluginUserManager().getVotingPluginUser(player);
UUID storageId = user.getJavaUUID();
if (!current(epoch)) return List.of();
if (action == AdminAction.SetVotes) {
var result = ledger().setVotes(event, storageId, value);
invalidateProgress(storageId);
return List.of("Date event " + eventId + " votes set to " + result.votes()
+ "; receipt IDs and reward fences retained. No rewards were submitted.");
}
if (action == AdminAction.Force || action == AdminAction.ForceNoLimits) {
int submitted = 0;
for (int threshold : selected) {
if (!current(epoch) || !plugin.getOptions().isProcessRewards()) break;
if (!definition.enabledThresholds().contains(threshold)) continue;
if (!ledger().reserveForced(event, storageId, threshold, action == AdminAction.ForceNoLimits)) continue;
invalidateProgress(storageId);
var placeholders = new HashMap<String, String>();
placeholders.put("DateVoteEvent", event.displayName());
placeholders.put("DateVoteThreshold", Integer.toString(threshold));
plugin.getRewardHandler().giveReward(user, definition.rewards(), path(event, threshold),
new RewardOptions().setPrefix("DateVoteMilestones-" + event.id() + "-" + threshold)
.setServer(network).setPlaceholders(placeholders));
ledger().submitted(event, storageId, threshold);
submitted++;
}
return List.of("Date event " + eventId + ": submitted " + submitted + " of " + selected.size()
+ " selected thresholds; disabled or fenced thresholds skipped. Vote count unchanged.");
}
var progress = ledger().progress(event, storageId);
List<String> lines = new ArrayList<>();
lines.add("Date event " + eventId + ": votes=" + progress.votes() + ", CountFakeVotes=" + definition.countFakeVotes()
+ ", status=" + (!event.enabled() ? "disabled" : System.currentTimeMillis() < event.start() ? "upcoming"
: System.currentTimeMillis() >= event.end() ? "ended" : "active")
+ ". Stored in date-vote-milestones/<event-file-id>-<player-uuid>.properties.");
for (int threshold : event.thresholds()) lines.add("Milestone " + definition.milestones().get(threshold).key()
+ " at " + threshold + ": " + (progress.reservedAwards().contains(threshold) ? "pending review"
: progress.submittedAwards().contains(threshold) ? "submitted"
: progress.deferredAwards().contains(threshold) ? "deferred" : "not reached")
+ (definition.enabledThresholds().contains(threshold) ? "" : " (disabled)"));
return List.copyOf(lines);
}
private void invalidateProgress(UUID player) {
synchronized (placeholderCache) {
placeholderCache.entrySet().removeIf(entry -> player.equals(entry.getValue().storageId()));
// Unresolved names have not read the ledger yet; their later read
// will observe this mutation. Once resolved, fence matching reads.
placeholderRequests.values().forEach(request -> {
if (player.equals(request.resolvedStorageId)) request.invalidated = true;
});
}
}
/** Nonblocking projection using a previously captured storage identity. */
public String placeholder(UUID player, String request) {
return placeholder(player, null, request);
}
/** Named offline identity is resolved only on the persistence worker. */
public String placeholder(UUID player, java.util.function.Supplier<String> offlineName, String request) {
if (player == null || request == null || request.length() > 100 || !plugin.isEnabled()) return "unavailable";
PlaceholderIdentity identity = new PlaceholderIdentity(player, offlineName != null);
int split = request.indexOf('_');
if (split < 1) return "invalid";
String metric = request.substring(0, split).toLowerCase(java.util.Locale.ROOT);
String id = request.substring(split + 1);
int threshold = -1;
if (metric.equals("award")) {
split = id.indexOf('_');
if (split < 1 || !id.substring(0, split).matches("[1-9][0-9]{0,3}")) return "invalid";
threshold = Integer.parseInt(id.substring(0, split)); id = id.substring(split + 1);
} else if (!List.of("votes", "next", "status").contains(metric)) return "invalid";
String eventId = id;
Definition definition = definitions.stream().filter(d -> d.event().id().equals(eventId)).findFirst().orElse(null);
if (definition == null) return "invalid";
DateVoteEvent event = definition.event();
if (metric.equals("status")) return !event.enabled() ? "disabled" : System.currentTimeMillis() < event.start()
? "upcoming" : System.currentTimeMillis() >= event.end() ? "ended" : "active";
if (metric.equals("award") && !event.thresholds().contains(threshold)) return "invalid";
if (plugin.getBungeeSettings().isUseBungeecoord() && !event.accountingServer().equals(plugin.getBungeeSettings().getServer()))
return "remote";
Object epoch = generation;
if (epoch == null) return "unavailable";
CachedProgress cached;
ProgressRequest launch = null;
synchronized (placeholderCache) {
cached = placeholderCache.get(identity);
if (cached == null || cached.generation() != epoch || System.nanoTime() >= cached.expires()) {
cached = null;
if (!placeholderRequests.containsKey(identity)) {
if (placeholderRequests.size() >= 64) return "unavailable";
launch = new ProgressRequest();
if (!identity.resolveName()) launch.resolvedStorageId = player;
placeholderRequests.put(identity, launch);
}
}
}
if (launch != null && !refreshPlaceholder(identity, offlineName, epoch, definitions, launch)) return "unavailable";
if (cached == null) return "loading";
var progress = cached.events().get(eventId);
if (progress == null) return "unavailable";
if (metric.equals("votes")) return Integer.toString(progress.votes());
if (metric.equals("next")) return event.thresholds().stream().filter(n -> n > progress.votes()
&& definition.enabledThresholds().contains(n)).findFirst().map(Object::toString).orElse("0");
return progress.reservedAwards().contains(threshold) ? "pending_review" : progress.submittedAwards().contains(threshold)
? "submitted" : progress.deferredAwards().contains(threshold) ? "deferred" : "not_reached";
}
private boolean refreshPlaceholder(PlaceholderIdentity identity, java.util.function.Supplier<String> offlineName, Object epoch, List<Definition> snapshot, ProgressRequest request) {
try {
plugin.getUserManager().getDataManager().getTimer().execute(() -> {
try {
if (!current(epoch)) return;
UUID storageId;
try {
String name = offlineName == null ? null : offlineName.get();
storageId = name == null || name.isBlank() ? identity.player()
: plugin.getVotingPluginUserManager().getVotingPluginUser(identity.player(), name).getJavaUUID();
if (storageId == null) throw new IllegalStateException("Missing storage identity");
synchronized (placeholderCache) {
if (!current(epoch) || request.invalidated || placeholderRequests.get(identity) != request) return;
request.resolvedStorageId = storageId;
}
} catch (RuntimeException unavailable) {
synchronized (placeholderCache) {
if (current(epoch) && !request.invalidated && placeholderRequests.get(identity) == request) {
if (placeholderCache.size() >= 256) placeholderCache.remove(placeholderCache.keySet().iterator().next());
placeholderCache.put(identity, new CachedProgress(epoch, System.nanoTime() + 1_000_000_000L, null, java.util.Map.of()));
}
}
return;
}
java.util.Map<String, DateVoteLedger.Progress> results = new HashMap<>();
for (Definition definition : snapshot) {
var event = definition.event();
if (plugin.getBungeeSettings().isUseBungeecoord()
&& !event.accountingServer().equals(plugin.getBungeeSettings().getServer())) continue;
try { results.put(event.id(), ledger().progress(event, storageId)); }
catch (IOException | RuntimeException unavailable) { /* Missing entry means unavailable, never zero. */ }
}
synchronized (placeholderCache) {
if (!current(epoch) || request.invalidated || placeholderRequests.get(identity) != request) return;
if (placeholderCache.size() >= 256) placeholderCache.remove(placeholderCache.keySet().iterator().next());
placeholderCache.put(identity, new CachedProgress(epoch, System.nanoTime() + 5_000_000_000L, storageId, java.util.Map.copyOf(results)));
}
} finally { synchronized (placeholderCache) { placeholderRequests.remove(identity, request); } }
});
return true;
} catch (RuntimeException unavailable) {
synchronized (placeholderCache) {
if (current(epoch) && placeholderRequests.get(identity) == request) {
if (placeholderCache.size() >= 256) placeholderCache.remove(placeholderCache.keySet().iterator().next());
placeholderCache.put(identity, new CachedProgress(epoch, System.nanoTime() + 1_000_000_000L, null, java.util.Map.of()));
}
placeholderRequests.remove(identity, request);
}
return false;
}
}
public void progress(Player player) {
progress(player, (view, current) -> com.bencodez.votingplugin.commands.gui.player.DateVoteEventsMenu.open(plugin, player, view, current));
}
/** Display is an entity-owned effect; identity resolution and ledger reads stay on the storage worker. */
void progress(Player player, java.util.function.BiConsumer<DateVoteProgressSnapshot, java.util.function.BooleanSupplier> display) {
BukkitCompletionScheduler.run(plugin, player, () -> {
UUID uuid = player.getUniqueId();
String playerName = player.getName();
if (!canView(player)) return;
synchronized (pendingProgress) {
if (pendingProgress.contains(uuid) || pendingProgress.size() >= 64) {
player.sendMessage("Date voting progress is already being checked or busy. Try again shortly."); return;
}
pendingProgress.add(uuid);
}
List<Definition> snapshot = definitions;
try {
plugin.getUserManager().getDataManager().getTimer().execute(() -> {
try {
if (snapshot != definitions || !plugin.isEnabled()) return;
boolean proxyBackend = plugin.getBungeeSettings().isUseBungeecoord();
String server = plugin.getBungeeSettings().getServer();
boolean localProgress = snapshot.stream().anyMatch(d -> !proxyBackend || d.event().accountingServer().equals(server));
UUID storageId = !localProgress ? uuid
: plugin.getVotingPluginUserManager().getVotingPluginUser(uuid, playerName).getJavaUUID();
List<DateVoteProgressSnapshot.Event> events = new ArrayList<>();
long now = System.currentTimeMillis();
for (Definition definition : snapshot) {
var event = definition.event();
var milestones = event.thresholds().stream().map(threshold -> {
var configured = definition.milestones().get(threshold);
var rewards = definition.rewards().getConfigurationSection(path(event, threshold));
var types = rewards == null ? List.<String>of() : rewards.getKeys(false).stream()
.filter(key -> key.length() <= 64).limit(16).toList();
return new DateVoteProgressSnapshot.Milestone(threshold, configured.key(), configured.enabled(), types);
}).toList();
if (proxyBackend && !event.accountingServer().equals(server)) {
events.add(view(event, DateVoteProgressSnapshot.Availability.REMOTE, null, milestones)); continue;
}
try {
var progress = ledger().progress(event, storageId);
events.add(view(event, DateVoteProgressSnapshot.Availability.OWNED, progress, milestones));
} catch (IOException failure) {
events.add(view(event, DateVoteProgressSnapshot.Availability.UNAVAILABLE, null, milestones));
}
}
var result = new DateVoteProgressSnapshot(now, events);
java.util.function.BooleanSupplier current = () -> canView(player) && snapshot == definitions
&& plugin.getDateVoteMilestones() == this;
BukkitCompletionScheduler.run(plugin, player, () -> {
if (current.getAsBoolean()) display.accept(result, current);
}, () -> { }, () -> { });
} catch (RuntimeException unavailable) {
BukkitCompletionScheduler.run(plugin, player, () -> {
if (canView(player) && snapshot == definitions)
player.sendMessage("Date voting progress is temporarily unavailable.");
}, () -> { }, () -> { });
} finally { synchronized (pendingProgress) { pendingProgress.remove(uuid); } }
});
} catch (RejectedExecutionException unavailable) {
synchronized (pendingProgress) { pendingProgress.remove(uuid); }
player.sendMessage("Date voting progress is temporarily unavailable.");
}
}, () -> { }, () -> { });
}
private boolean canView(Player player) {
return plugin.isEnabled() && player.isOnline()
&& (player.hasPermission("VotingPlugin.Commands.Vote.DateEvents") || player.hasPermission("VotingPlugin.Player"));
}
private static DateVoteProgressSnapshot.Event view(DateVoteEvent event, DateVoteProgressSnapshot.Availability availability,
DateVoteLedger.Progress progress, List<DateVoteProgressSnapshot.Milestone> milestones) {
return new DateVoteProgressSnapshot.Event(event, availability, progress == null ? 0 : progress.votes(),
progress == null ? java.util.Set.of() : progress.submittedAwards(),
progress == null ? java.util.Set.of() : progress.deferredAwards(),
progress == null ? java.util.Set.of() : progress.reservedAwards(), milestones);
}
}
@@ -146,8 +146,9 @@ public class VoteParty implements Listener {
public void commandVoteParty(CommandSender sender) {
if (plugin.getSpecialRewardsConfig().isVotePartyEnabled()) {
ArrayList<String> msg = plugin.getConfigFile().getFormatCommandsVoteParty();
int votesRequired = getVotesRequired();
int votes = getTotalVotes();
var display = plugin.getServerData().getVotePartyDisplay();
int votesRequired = display.required(plugin.getSpecialRewardsConfig().getVotePartyVotesRequired());
int votes = display.total();
int neededVotes = votesRequired - votes;
HashMap<String, String> placeholders = new HashMap<>();
placeholders.put("votesrequired", "" + votesRequired);
@@ -243,7 +244,16 @@ public class VoteParty implements Listener {
*/
public void giveRewards(VotingPluginUser orgUser, boolean forceBungee) {
rewardHandler.giveRewards(orgUser, forceBungee);
reset(false);
// Clear this party's recipient list immediately, as before. Delaying it
// would risk wiping voters recorded for the next party.
setVotedUsers(new ArrayList<>());
// Shared-MySQL recipients capture eligibility on AdvancedCore's ordered
// storage worker. Only the persisted per-user counter wipe must run
// behind those reads; it must not overtake deferred eligibility checks.
com.bencodez.advancedcore.api.user.usercache.UserDataManager manager =
plugin.getUserManager().getDataManager();
if (manager != null && manager.deferSharedStorageWork(this::resetVotePartyCount)) return;
resetVotePartyCount();
}
/**
@@ -3,6 +3,8 @@ package com.bencodez.votingplugin.specialrewards.voteparty;
import java.util.ArrayList;
import java.util.UUID;
import java.util.concurrent.ThreadLocalRandom;
import java.util.function.Consumer;
import java.util.function.Supplier;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
@@ -11,6 +13,7 @@ import com.bencodez.advancedcore.api.messages.PlaceholderUtils;
import com.bencodez.advancedcore.api.misc.MiscUtils;
import com.bencodez.advancedcore.api.rewards.RewardBuilder;
import com.bencodez.advancedcore.api.user.UserDataFetchMode;
import com.bencodez.advancedcore.api.user.usercache.UserDataManager;
import com.bencodez.simpleapi.array.ArrayUtils;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.user.VotingPluginUser;
@@ -37,10 +40,15 @@ public final class VotePartyRewardHandler {
}
public void giveReward(VotingPluginUser user, boolean online, boolean useBungee) {
givePreparedReward(user, online, useBungee, !plugin.getServerData().isLastVotePartySameDay());
}
private void givePreparedReward(VotingPluginUser user, boolean online, boolean useBungee,
boolean firstVotePartyToday) {
new RewardBuilder(plugin.getSpecialRewardsConfig().getData(),
plugin.getSpecialRewardsConfig().getVotePartyRewardsPath()).setOnline(online)
.withPlaceHolder("VotesRequired", "" + plugin.getSpecialRewardsConfig().getVotePartyVotesRequired())
.withPlaceHolder("FirstVotePartyToday", "" + !plugin.getServerData().isLastVotePartySameDay())
.withPlaceHolder("FirstVotePartyToday", "" + firstVotePartyToday)
.setServer(useBungee).send(user);
}
@@ -82,13 +90,14 @@ public final class VotePartyRewardHandler {
}
}
/** Dispatch to every eligible user, preserving each online player's scheduler owner. */
private void giveAllPlayers(VotingPluginUser triggeringUser, boolean forceBungee) {
plugin.debug("Trying to give all players vote party");
ArrayList<String> alreadyGiven = new ArrayList<>();
for (Player player : Bukkit.getOnlinePlayers()) {
VotingPluginUser user = resolveUser(triggeringUser, player.getUniqueId(), player);
if (!plugin.getSpecialRewardsConfig().isVotePartyGiveOnlinePlayersOnly() || user.isOnline()) {
voteParty.giveReward(user, forceBungee);
giveRewardWhenLoaded(user, forceBungee, player);
}
alreadyGiven.add(player.getUniqueId().toString());
}
@@ -99,30 +108,115 @@ public final class VotePartyRewardHandler {
}
VotingPluginUser user = resolveUser(triggeringUser, UUID.fromString(uuid), null);
if (!plugin.getSpecialRewardsConfig().isVotePartyGiveOnlinePlayersOnly() || user.isOnline()) {
voteParty.giveReward(user, forceBungee);
giveRewardWhenLoaded(user, forceBungee, null);
}
}
}
/** Dispatch to users recorded for this party before its voter list is reset. */
private void giveVotedPlayers(VotingPluginUser triggeringUser, boolean forceBungee) {
plugin.debug("Trying to give all voted players vote party");
plugin.debug(ArrayUtils.makeStringList(voteParty.getVotedUsers()));
for (String uuid : voteParty.getVotedUsers()) {
VotingPluginUser user = resolveUser(triggeringUser, UUID.fromString(uuid), null);
if (!plugin.getSpecialRewardsConfig().isVotePartyGiveOnlinePlayersOnly() || user.isOnline()) {
voteParty.giveReward(user, forceBungee);
// Capture a live player only on a platform-owned thread. The vote path
// can also originate from a storage worker, where Bukkit lookups are unsafe.
UserDataManager manager = sharedDataManager();
Player owner = manager != null && manager.isPlatformOwnedThread()
? Bukkit.getPlayer(user.getJavaUUID()) : null;
giveRewardWhenLoaded(user, forceBungee, owner);
}
}
}
/** Resolve a recipient without forcing an uncached SQL read for shared storage. */
private VotingPluginUser resolveUser(VotingPluginUser triggeringUser, UUID uuid, Player onlinePlayer) {
if (triggeringUser != null && triggeringUser.getJavaUUID().equals(uuid)) {
return triggeringUser;
VotingPluginUser user = triggeringUser != null && triggeringUser.getJavaUUID().equals(uuid)
? triggeringUser
: onlinePlayer == null
? plugin.getVotingPluginUserManager().getVotingPluginUser(uuid, true)
: plugin.getVotingPluginUserManager().getVotingPluginUser(onlinePlayer);
if (sharedDataManager() != null) {
// Reward placeholders need the published shared cache, including for the triggering user.
user.userDataFetechMode(UserDataFetchMode.DEFAULT);
} else if (user != triggeringUser) {
// Preserve direct reads for file/SQLite storage.
user.userDataFetechMode(UserDataFetchMode.NO_CACHE);
}
VotingPluginUser user = onlinePlayer == null
? plugin.getVotingPluginUserManager().getVotingPluginUser(uuid)
: plugin.getVotingPluginUserManager().getVotingPluginUser(onlinePlayer);
user.userDataFetechMode(UserDataFetchMode.NO_CACHE);
return user;
}
/** Returns the active shared SQL manager or null for nonshared storage. */
private UserDataManager sharedDataManager() {
UserDataManager manager = plugin.getUserManager().getDataManager();
return manager != null && manager.hasSharedSqlBackend() ? manager : null;
}
/**
* Capture shared SQL reward eligibility on AdvancedCore's storage worker.
* This must finish before the VoteParty counter wipe is enqueued on that worker.
* A caller running on a platform thread must not check even a published cache
* directly because checking publication takes the cache's synchronized monitor.
*/
private void giveRewardWhenLoaded(VotingPluginUser user, boolean forceBungee, Player callbackOwner) {
UserDataManager manager = sharedDataManager();
if (manager == null) {
voteParty.giveReward(user, forceBungee);
return;
}
UUID uuid = user.getJavaUUID();
// VoteParty clears per-user counters and updates the last-party timestamp
// after dispatch. Capture these decisions before that reset, not when the
// deferred reward finally runs on the player scheduler.
final boolean firstPartyToday = !plugin.getServerData().isLastVotePartySameDay();
final int userVotesRequired = plugin.getSpecialRewardsConfig().getVotePartyUserVotesRequired();
// A mapped cache entry can still be an *unpublished* placeholder, so
// cacheUserIfNeeded() alone would not make reward placeholders safe to read.
Supplier<Integer> populate = () -> {
if (manager.getPublishedCache(uuid) == null) manager.cacheUser(uuid, null);
if (manager.getPublishedCache(uuid) == null) return null;
// Read eligibility on the storage worker, before VoteParty resets counters.
return userVotesRequired > 0 ? user.getVotePartyVotes() : 0;
};
Consumer<Integer> success = votes -> {
if (votes == null) {
plugin.getLogger().warning("VoteParty reward not sent: shared user data is unavailable for " + uuid);
return;
}
if (votes < userVotesRequired) return;
// Eligibility was captured on the storage worker before reset. Do not
// re-read the cache on a platform thread or re-check reset counters.
Runnable deliver = () -> givePreparedReward(user, user.isOnline(), forceBungee, firstPartyToday);
if (callbackOwner != null) {
deliver.run();
} else {
// A worker-originated vote has no captured Player. Its completion is
// on the global platform scheduler; discover a live owner there.
Player online = Bukkit.getPlayer(uuid);
if (online == null) deliver.run();
else plugin.getBukkitScheduler().runTask(plugin, deliver, online);
}
};
Consumer<Throwable> failure = error -> plugin.getLogger()
.warning("Failed to load shared user data for VoteParty reward " + uuid + ": " + error);
try {
if (manager.deferSharedStorageResult(populate, success, failure, callbackOwner)) return;
// Called from a non-platform worker: storage reads are safe here, but reward
// effects still need the Bukkit/Folia scheduler.
Integer ready = populate.get();
if (callbackOwner != null) {
plugin.getBukkitScheduler().runTask(plugin, () -> success.accept(ready), callbackOwner);
} else {
plugin.getBukkitScheduler().runTask(plugin, () -> success.accept(ready));
}
} catch (RuntimeException | Error error) {
failure.accept(error);
}
}
}
@@ -24,8 +24,7 @@ public final class VotePartyState {
}
public void setTotalVotes(int value) {
plugin.getServerData().getData().set(TOTAL_PATH, value);
plugin.getServerData().saveData();
plugin.getServerData().setInt(TOTAL_PATH, value);
}
public List<String> getVotedUsers() {
@@ -34,8 +33,7 @@ public final class VotePartyState {
}
public void setVotedUsers(List<String> users) {
plugin.getServerData().getData().set(VOTED_PATH, users);
plugin.getServerData().saveData();
plugin.getServerData().setStringList(VOTED_PATH, users);
}
public int getVotesRequired() {
@@ -40,6 +40,7 @@ public class VoteStreakHandler {
private final Map<String, VoteStreakDefinition> byId = new LinkedHashMap<>();
private final Map<String, VoteStreakDefinition> byProgressGroup = new LinkedHashMap<>();
private final List<VoteStreakDefinition> ordered = new ArrayList<>();
private volatile List<VoteStreakDefinition> displayDefinitions = List.of();
public VoteStreakHandler(VotingPluginMain plugin) {
this.plugin = plugin;
@@ -56,6 +57,26 @@ public class VoteStreakHandler {
// VoteStreak definitions live in specialrewards.yml now (Option B)
ConfigurationSection root = plugin.getSpecialRewardsConfig().getData();
new VoteStreakConfigLoader().load(root);
displayDefinitions = ordered.stream().filter(VoteStreakDefinition::isEnabled).toList();
}
/** Worker-only, observational view. Does not advance periods, save state or execute rewards. */
public com.bencodez.votingplugin.streaks.VoteStreaksSnapshot snapshotForDisplay(VotingPluginUser user) {
var definitions = displayDefinitions;
var periods = List.of(
new com.bencodez.votingplugin.streaks.VoteStreaksSnapshot.Period(VoteStreakType.DAILY, user.getDayVoteStreak(), user.getBestDayVoteStreak()),
new com.bencodez.votingplugin.streaks.VoteStreaksSnapshot.Period(VoteStreakType.WEEKLY, user.getWeekVoteStreak(), user.getBestWeekVoteStreak()),
new com.bencodez.votingplugin.streaks.VoteStreaksSnapshot.Period(VoteStreakType.MONTHLY, user.getMonthVoteStreak(), user.getBestMonthVoteStreak()));
var states = new LinkedHashMap<String, StreakState>();
var rows = new ArrayList<com.bencodez.votingplugin.streaks.VoteStreaksSnapshot.Milestone>();
for (var definition : definitions) {
if (rows.size() >= com.bencodez.votingplugin.streaks.VoteStreaksSnapshot.MAX_MILESTONES) break;
var state = states.computeIfAbsent(getColumnName(definition), ignored -> readState(user, definition));
String label = definition.getId().codePoints().limit(80).collect(StringBuilder::new, StringBuilder::appendCodePoint, StringBuilder::append).toString();
rows.add(new com.bencodez.votingplugin.streaks.VoteStreaksSnapshot.Milestone(label, definition.getType(), state.streakCount,
state.bestStreakCount, definition.getRequiredAmount(), definition.getVotesRequired(), definition.isRecurring()));
}
return new com.bencodez.votingplugin.streaks.VoteStreaksSnapshot(periods, rows, definitions.size() > rows.size());
}
public List<VoteStreakDefinition> getDefinitions() {
@@ -0,0 +1,20 @@
package com.bencodez.votingplugin.streaks;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import com.bencodez.advancedcore.api.command.CommandHandler;
import com.bencodez.votingplugin.VotingPluginMain;
public final class VoteStreaksCommand {
private VoteStreaksCommand() { }
public static void register(VotingPluginMain plugin) {
plugin.getVoteCommand().add(new CommandHandler(plugin, new String[] { "Streaks" },
VoteStreaksMenu.PERMISSION + "|VotingPlugin.Player", "View your vote streak progression", false) {
@Override public void execute(CommandSender sender, String[] args) {
if (sender instanceof Player player && plugin.getVoteStreaksMenu() != null) {
plugin.getVoteStreaksMenu().open(player);
}
}
});
}
}
@@ -0,0 +1,277 @@
package com.bencodez.votingplugin.streaks;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;
import java.util.function.BiFunction;
import org.bukkit.Bukkit;
import org.bukkit.Material;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener;
import org.bukkit.event.entity.PlayerDeathEvent;
import org.bukkit.event.inventory.InventoryClickEvent;
import org.bukkit.event.inventory.InventoryCloseEvent;
import org.bukkit.event.inventory.InventoryDragEvent;
import org.bukkit.event.inventory.InventoryOpenEvent;
import org.bukkit.event.player.PlayerChangedWorldEvent;
import org.bukkit.event.player.PlayerQuitEvent;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.InventoryHolder;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.meta.ItemMeta;
import com.bencodez.simpleapi.messages.MessageAPI;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
/** One isolated native inventory view; no registrations in existing production GUI managers. */
public final class VoteStreaksMenu implements Listener, AutoCloseable {
public static final String PERMISSION = "VotingPlugin.Commands.Vote.Streaks";
private static final int MAX_SESSIONS = 128, MAX_LOADS = 16;
private final VotingPluginMain plugin;
private final Consumer<Runnable> worker;
private final BiFunction<UUID, String, VoteStreaksSnapshot> snapshot;
private final Map<UUID, Session> sessions = new ConcurrentHashMap<>();
private final AtomicInteger loading = new AtomicInteger();
private final AtomicInteger reloadDepth = new AtomicInteger();
private volatile boolean closed;
public VoteStreaksMenu(VotingPluginMain plugin) {
this(plugin, task -> plugin.getUserManager().getDataManager().getTimer().execute(task), (uuid, name) ->
plugin.getVoteStreakHandler().snapshotForDisplay(plugin.getVotingPluginUserManager().getVotingPluginUser(uuid, name)));
}
VoteStreaksMenu(VotingPluginMain plugin, Consumer<Runnable> worker, BiFunction<UUID, String, VoteStreaksSnapshot> snapshot) {
this.plugin = plugin; this.worker = worker; this.snapshot = snapshot;
}
private static final class Session {
final Player player;
final UUID owner;
final String name;
final Inventory previous;
final boolean ownsPrevious;
final long created = System.nanoTime();
volatile Holder view;
Session(Player player, VoteStreaksMenu manager) {
this.player = player; owner = player.getUniqueId(); name = player.getName();
previous = player.getOpenInventory().getTopInventory();
Holder holder = manager.holder(previous);
ownsPrevious = holder != null && holder.session.owner.equals(owner);
}
}
static final class Holder implements InventoryHolder {
final VoteStreaksMenu manager;
final Session session;
final VoteStreaksSnapshot snapshot;
final int page;
Inventory inventory;
Holder(VoteStreaksMenu manager, Session session, VoteStreaksSnapshot snapshot, int page) {
this.manager = manager; this.session = session; this.snapshot = snapshot; this.page = snapshot.clampPage(page);
}
@Override public Inventory getInventory() { return inventory; }
}
private static boolean permitted(Player player) {
return player.isOnline() && (player.hasPermission(PERMISSION) || player.hasPermission("VotingPlugin.Player"));
}
private void onPlayer(Player player, Runnable work, Runnable rejected) {
BukkitCompletionScheduler.run(plugin, player, work, rejected, rejected);
}
public void open(Player player) {
onPlayer(player, () -> begin(player), () -> { });
}
private void begin(Player player) {
if (closed || reloadDepth.get() != 0 || !permitted(player)) return;
if (loading.incrementAndGet() > MAX_LOADS) {
loading.decrementAndGet(); player.sendMessage("Vote streaks are busy. Please try again shortly."); return;
}
Session session;
synchronized (sessions) {
if (closed || reloadDepth.get() != 0 || (sessions.size() >= MAX_SESSIONS && !sessions.containsKey(player.getUniqueId()))) {
loading.decrementAndGet(); player.sendMessage("Vote streaks are unavailable. Please try again shortly."); return;
}
session = new Session(player, this); sessions.put(session.owner, session);
}
try {
worker.accept(() -> {
try {
if (!current(session)) return;
VoteStreaksSnapshot data = snapshot.apply(session.owner, session.name);
onPlayer(player, () -> {
if (!current(session)) return;
if (!permitted(player) || System.nanoTime() - session.created > 30_000_000_000L
|| player.getOpenInventory().getTopInventory() != session.previous) {
retire(session); return;
}
renderSafely(session, data, 0);
}, () -> retire(session));
} catch (RuntimeException failure) {
onPlayer(player, () -> {
if (retire(session) && player.isOnline())
player.sendMessage("Unable to read vote streaks. Please try again later.");
}, () -> retire(session));
} finally { loading.decrementAndGet(); }
});
} catch (RuntimeException rejected) {
loading.decrementAndGet(); retire(session);
player.sendMessage("Vote streaks are unavailable. Please try again later.");
}
}
private boolean current(Session session) { return !closed && sessions.get(session.owner) == session; }
private Holder holder(Inventory inventory) {
return inventory != null && inventory.getHolder() instanceof Holder holder && holder.manager == this ? holder : null;
}
private void renderSafely(Session session, VoteStreaksSnapshot data, int page) {
try { render(session, data, page); }
catch (RuntimeException failure) {
if (sessions.remove(session.owner, session)) {
closeView(session);
if (session.player.isOnline()) session.player.sendMessage("Unable to open vote streaks. Please try again later.");
}
}
}
private void navigate(Holder holder, int page) {
onPlayer(holder.session.player, () -> {
if (current(holder.session) && holder.session.view == holder
&& holder.session.player.getOpenInventory().getTopInventory() == holder.inventory)
renderSafely(holder.session, holder.snapshot, page);
}, () -> sessions.remove(holder.session.owner, holder.session));
}
private void render(Session session, VoteStreaksSnapshot data, int page) {
if (!current(session) || !permitted(session.player)) return;
Holder holder = new Holder(this, session, data, page);
String title = plugin.getGui().getChestVoteStreaksName();
holder.inventory = Bukkit.createInventory(holder, 54, MessageAPI.colorize(title));
for (int i = 0; i < data.periods().size(); i++) {
var period = data.periods().get(i); String unit = VoteStreaksSnapshot.unit(period.type());
holder.inventory.setItem(11 + i * 2, item(Material.CLOCK, "&6" + period.type() + " streak",
List.of("&7Current: &e" + period.current() + " " + unit, "&7Best: &e" + period.best() + " " + unit)));
}
List<VoteStreaksSnapshot.Milestone> milestones = data.page(holder.page);
for (int i = 0; i < milestones.size(); i++) {
var milestone = milestones.get(i); String unit = VoteStreaksSnapshot.unit(milestone.type());
var lore = new ArrayList<String>();
lore.add("&7Current: &e" + milestone.current() + " " + unit);
lore.add("&7Best: &e" + milestone.best() + " " + unit);
lore.add("&7Milestone: &e" + milestone.threshold() + " " + unit);
lore.add("&7Votes per period: &e" + milestone.votesRequired());
lore.add(milestone.recurring() ? "&7Repeats every " + milestone.threshold() + " " + unit + "; next: " + milestone.nextThreshold()
: milestone.current() >= milestone.threshold() ? "&aCurrent streak meets this milestone" : "&7Upcoming milestone");
lore.add("&7Progress only; this does not claim rewards.");
holder.inventory.setItem(20 + i, item(Material.PAPER, "&e" + milestone.id(), lore));
}
if (milestones.isEmpty()) holder.inventory.setItem(22, item(Material.PAPER, "&7No enabled streak milestones",
List.of("&7Configure VoteStreaks in SpecialRewards.yml.")));
holder.inventory.setItem(45, item(Material.ARROW, "&ePrevious", List.of()));
holder.inventory.setItem(49, item(Material.BARRIER, "&cClose", List.of()));
holder.inventory.setItem(50, item(Material.CLOCK, "&eRefresh", List.of("&7Read current streaks again.")));
holder.inventory.setItem(53, item(Material.ARROW, "&eNext", List.of("&7Page " + (holder.page + 1) + "/" + data.pages(),
data.truncated() ? "&7Showing the first 512 enabled milestones." : "&7Read-only streak progression.")));
session.view = holder;
if (!current(session) || !permitted(session.player)) return;
session.player.openInventory(holder.inventory);
if (!current(session) && session.player.getOpenInventory().getTopInventory() == holder.inventory)
session.player.closeInventory();
if (session.player.getOpenInventory().getTopInventory() != holder.inventory) sessions.remove(session.owner, session);
}
private static ItemStack item(Material material, String name, List<String> lore) {
ItemStack item = new ItemStack(material); ItemMeta meta = item.getItemMeta();
if (meta != null) {
meta.setDisplayName(MessageAPI.colorize(name));
meta.setLore(lore.stream().map(MessageAPI::colorize).toList()); item.setItemMeta(meta);
}
return item;
}
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void inventoryOpen(InventoryOpenEvent event) {
if (!(event.getPlayer() instanceof Player player)) return;
Holder holder = holder(event.getInventory());
if (holder == null) return;
if (holder.session.player != player || !current(holder.session) || holder.session.view != holder || !permitted(player)) {
event.setCancelled(true); return;
}
if (event.isCancelled()) sessions.remove(holder.session.owner, holder.session);
}
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
public void unrelatedInventoryOpen(InventoryOpenEvent event) {
if (!event.isCancelled() && holder(event.getInventory()) == null && event.getPlayer() instanceof Player player)
sessions.remove(player.getUniqueId());
}
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void click(InventoryClickEvent event) {
Holder holder = holder(event.getView().getTopInventory());
if (holder == null) return;
boolean cancelled = event.isCancelled(); event.setCancelled(true);
if (cancelled || event.getWhoClicked() != holder.session.player || !current(holder.session)
|| holder.session.view != holder || !permitted(holder.session.player)) return;
// Only ordinary top-inventory clicks navigate; shift/number/drop actions cannot move previews.
if (event.getRawSlot() < 0 || event.getRawSlot() >= 54 || !event.isLeftClick() || event.isShiftClick()) return;
switch (event.getRawSlot()) {
case 45 -> navigate(holder, holder.page - 1);
case 53 -> navigate(holder, holder.page + 1);
case 49 -> { sessions.remove(holder.session.owner, holder.session); closeView(holder.session); }
case 50 -> begin(holder.session.player);
default -> { }
}
}
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = false)
public void drag(InventoryDragEvent event) {
if (holder(event.getView().getTopInventory()) != null) event.setCancelled(true);
}
@EventHandler public void inventoryClose(InventoryCloseEvent event) {
Holder holder = holder(event.getInventory());
if (holder != null && holder.session.view == holder) sessions.remove(holder.session.owner, holder.session);
else if (event.getPlayer() instanceof Player player) {
Session pending = sessions.get(player.getUniqueId());
if (pending != null && pending.view == null && pending.previous == event.getInventory()) sessions.remove(pending.owner, pending);
}
}
@EventHandler public void quit(PlayerQuitEvent event) { sessions.remove(event.getPlayer().getUniqueId()); }
@EventHandler public void worldChange(PlayerChangedWorldEvent event) { end(event.getPlayer()); }
@EventHandler public void death(PlayerDeathEvent event) { end(event.getEntity()); }
private void end(Player player) { Session session = sessions.remove(player.getUniqueId()); if (session != null) closeView(session); }
private boolean retire(Session session) {
if (!sessions.remove(session.owner, session)) return false;
closeView(session); return true;
}
private void closeView(Session session) {
if (session.view == null && !session.ownsPrevious) return;
Runnable cleanup = () -> {
// A queued cleanup must never close an inventory adopted by a newer request.
Session replacement = sessions.get(session.owner);
if (replacement != null && replacement != session) return;
Inventory top = session.player.getOpenInventory().getTopInventory();
if ((session.view != null && top == session.view.inventory)
|| (session.ownsPrevious && top == session.previous)) session.player.closeInventory();
};
// Bukkit rejects scheduling after disable. Its primary thread already owns this interaction.
if (closed && ownsForShutdown(Bukkit.class, session.player)) cleanup.run();
else onPlayer(session.player, cleanup, () -> { });
}
/** Public Folia ownership also recognizes its stopped-region shutdown owner. */
static boolean ownsForShutdown(Class<?> platform, Player player) {
try {
return Boolean.TRUE.equals(platform.getMethod("isOwnedByCurrentRegion", org.bukkit.entity.Entity.class).invoke(null, player));
} catch (NoSuchMethodException legacy) {
try {
Class.forName("io.papermc.paper.threadedregions.RegionizedServer", false, VoteStreaksMenu.class.getClassLoader());
return false; // A regional server without its ownership API must fail closed.
} catch (ClassNotFoundException ordinaryServer) { return Bukkit.isPrimaryThread(); }
catch (LinkageError unavailable) { return false; }
} catch (ReflectiveOperationException | LinkageError unavailable) { return false; }
}
public void suspend() { reloadDepth.incrementAndGet(); reset(); }
public void resume() { reloadDepth.updateAndGet(value -> Math.max(0, value - 1)); }
public void reset() {
List<Session> old;
synchronized (sessions) { old = List.copyOf(sessions.values()); sessions.clear(); }
old.forEach(this::closeView);
}
@Override public void close() { synchronized (sessions) { closed = true; } reset(); }
int sessionCount() { return sessions.size(); }
}
@@ -0,0 +1,37 @@
package com.bencodez.votingplugin.streaks;
import java.util.List;
import com.bencodez.votingplugin.specialrewards.votestreak.VoteStreakType;
/** Read-only observations of existing state; never evidence that a reward was delivered. */
public record VoteStreaksSnapshot(List<Period> periods, List<Milestone> milestones, boolean truncated) {
public static final int MAX_MILESTONES = 512;
public static final int PAGE_SIZE = 5;
public VoteStreaksSnapshot {
periods = List.copyOf(periods);
milestones = List.copyOf(milestones);
if (periods.size() != 3 || milestones.size() > MAX_MILESTONES) throw new IllegalArgumentException("Invalid streak snapshot size");
}
public record Period(VoteStreakType type, int current, int best) {
public Period { current = Math.max(0, current); best = Math.max(current, best); }
}
public record Milestone(String id, VoteStreakType type, int current, int best,
int threshold, int votesRequired, boolean recurring) {
public Milestone {
current = Math.max(0, current); best = Math.max(current, best);
threshold = Math.max(1, threshold); votesRequired = Math.max(1, votesRequired);
}
public long nextThreshold() {
return recurring ? ((long) current / threshold + 1L) * threshold : threshold;
}
}
public int pages() { return Math.max(1, (milestones.size() + PAGE_SIZE - 1) / PAGE_SIZE); }
public int clampPage(int page) { return Math.max(0, Math.min(page, pages() - 1)); }
public List<Milestone> page(int page) {
int start = clampPage(page) * PAGE_SIZE;
return milestones.subList(start, Math.min(start + PAGE_SIZE, milestones.size()));
}
public static String unit(VoteStreakType type) {
return switch (type) { case DAILY -> "days"; case WEEKLY -> "weeks"; case MONTHLY -> "months"; };
}
}
@@ -3,10 +3,15 @@ package com.bencodez.votingplugin.timequeue;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Queue;
import java.util.UUID;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.FutureTask;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.event.EventHandler;
@@ -24,11 +29,24 @@ import lombok.Getter;
* The TimeQueueHandler class manages time-based vote queue processing.
*/
public class TimeQueueHandler implements Listener {
private static final long TICKS_PER_SECOND = 20L;
@Getter
private Queue<VoteTimeQueue> timeChangeQueue = new ConcurrentLinkedQueue<>();
private VotingPluginMain plugin;
private final Object persistenceLock = new Object();
private volatile boolean stopping;
private final AtomicReference<FutureTask<Void>> shutdownSave = new AtomicReference<>();
// A failed task is retryable, but cannot release its unsaved suffix to a successor.
private final AtomicReference<ShutdownPublication> shutdownPublicationOwner = new AtomicReference<>();
private record ShutdownPublication(com.bencodez.votingplugin.util.ServerDataPublicationFence.Lease lease,
java.util.concurrent.ScheduledExecutorService producers,
java.util.concurrent.ScheduledExecutorService[] coreWriters) { }
private final AtomicBoolean processing = new AtomicBoolean();
private VoteTimeQueue dispatchingVote;
private UUID dispatchId;
private boolean dispatchEnded;
private boolean dispatchStarted;
private int persistedShutdownVotes;
private final AtomicBoolean retryPending = new AtomicBoolean();
private final AtomicInteger retryAttempts = new AtomicInteger();
@@ -48,10 +66,23 @@ public class TimeQueueHandler implements Listener {
* @param voteUsername the voter username
* @param voteSiteName the vote site name
*/
public void addVote(String voteUsername, String voteSiteName) {
timeChangeQueue.add(new VoteTimeQueue(voteUsername, voteSiteName,
LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli()));
}
public void addVote(String voteUsername, String voteSiteName) { addVote(voteUsername, voteSiteName, 0L); }
public void addVote(String voteUsername, String voteSiteName, long occurredAt) {
addVote(voteUsername, voteSiteName, occurredAt, UUID.randomUUID());
}
public void addVote(String voteUsername, String voteSiteName, long occurredAt, UUID localOccurrenceId) {
java.util.Objects.requireNonNull(localOccurrenceId, "localOccurrenceId");
VoteTimeQueue queued = new VoteTimeQueue(voteUsername, voteSiteName,
LocalDateTime.now().atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
queued.setLocalOccurrenceId(localOccurrenceId);
if (occurredAt > 0) queued.setCanonicalOccurrenceTime(occurredAt);
synchronized (persistenceLock) {
timeChangeQueue.add(queued);
if (stopping) persistPendingVotes();
}
}
/**
* Loads cached votes from server data and schedules queue processing.
@@ -59,8 +90,29 @@ public class TimeQueueHandler implements Listener {
public void load() {
for (String str : plugin.getServerData().getTimedVoteCacheKeys()) {
ConfigurationSection data = plugin.getServerData().getTimedVoteCacheSection(str);
timeChangeQueue
.add(new VoteTimeQueue(data.getString("Name"), data.getString("Service"), data.getLong("Time")));
VoteTimeQueue queued = new VoteTimeQueue(data.getString("Name"), data.getString("Service"), data.getLong("Time"));
UUID localOccurrenceId;
if (!data.contains("LocalOccurrenceId")) {
// The existing ServerData saver can defer publication. Derive only
// legacy migration IDs from their persisted row identity so a crash
// before that save completes cannot reroll the same legacy row.
String identity = "legacy-local-timed-vote\u0000" + str + "\u0000" + queued.getName()
+ "\u0000" + queued.getService() + "\u0000" + queued.getTime();
localOccurrenceId = UUID.nameUUIDFromBytes(identity.getBytes(java.nio.charset.StandardCharsets.UTF_8));
plugin.getServerData().setTimedVoteLocalOccurrenceId(str, localOccurrenceId);
} else {
String rawId = data.getString("LocalOccurrenceId");
try {
localOccurrenceId = UUID.fromString(rawId);
if (!localOccurrenceId.toString().equalsIgnoreCase(rawId)) throw new IllegalArgumentException();
} catch (IllegalArgumentException | NullPointerException malformed) {
plugin.getLogger().warning("Invalid local occurrence ID in timed vote cache; row withheld");
continue;
}
}
queued.setLocalOccurrenceId(localOccurrenceId);
if (data.contains("CanonicalOccurrenceTime")) queued.setCanonicalOccurrenceTime(data.getLong("CanonicalOccurrenceTime", -1L));
timeChangeQueue.add(queued);
}
scheduleQueueProcessing(120, TimeUnit.SECONDS);
}
@@ -76,17 +128,11 @@ public class TimeQueueHandler implements Listener {
}
private void scheduleQueueProcessing(long delay, TimeUnit unit) {
boolean admitted = VoteTaskAdmission.trySchedule(plugin.getVoteTimer(), () -> {
// Clear only after the bounded executor has admitted the task. If it is
// rejected, shutdown persistence can still recover the in-memory queue.
plugin.getServerData().clearTimedVoteCache();
processQueue();
}, delay, unit);
synchronized (persistenceLock) { if (stopping) return; }
boolean admitted = VoteTaskAdmission.trySchedule(plugin.getVoteTimer(), this::processQueue, delay, unit);
if (!admitted) {
plugin.getLogger().warning("Unable to schedule time-queue processing because vote processing is busy; queued votes were retained.");
scheduleRetry();
} else {
retryAttempts.set(0);
}
}
@@ -94,15 +140,14 @@ public class TimeQueueHandler implements Listener {
if (timeChangeQueue.isEmpty() || !retryPending.compareAndSet(false, true)) return;
int attempt = Math.min(6, retryAttempts.getAndIncrement());
long delaySeconds = Math.min(60L, 1L << attempt);
long delayTicks = delaySeconds * TICKS_PER_SECOND;
try {
plugin.getBukkitScheduler().runTaskLaterAsynchronously(plugin, () -> {
retryPending.set(false);
if (!timeChangeQueue.isEmpty()) scheduleQueueProcessing(0, TimeUnit.SECONDS);
}, delayTicks);
}, delaySeconds);
} catch (RuntimeException rejected) {
retryPending.set(false);
plugin.getLogger().warning("Unable to queue a time-queue retry; pending votes remain persisted for recovery.");
plugin.getLogger().warning("Unable to queue a time-queue retry; pending votes remain owned for recovery.");
}
}
@@ -110,32 +155,241 @@ public class TimeQueueHandler implements Listener {
* Processes all votes in the queue.
*/
public void processQueue() {
while (getTimeChangeQueue().size() > 0) {
VoteTimeQueue vote = getTimeChangeQueue().remove();
PlayerVoteEvent voteEvent = new PlayerVoteEvent(
plugin.getVoteSiteManager().getVoteSite(plugin.getVoteSiteManager().getVoteSiteName(true, vote.getService()), true), vote.getName(),
vote.getService(), true);
voteEvent.setTime(vote.getTime());
plugin.getServer().getPluginManager().callEvent(voteEvent);
if (voteEvent.isCancelled()) {
plugin.debug("Vote cancelled");
continue;
if (!processing.compareAndSet(false, true)) return;
boolean retry = false;
try {
synchronized (persistenceLock) {
if (stopping) return;
if (dispatchingVote != null) {
if (!dispatchEnded) return;
retainUncertainDispatch();
clearDispatch();
}
persistedShutdownVotes = 0;
}
while (true) {
VoteTimeQueue vote;
synchronized (persistenceLock) {
if (stopping || dispatchingVote != null) return;
vote = timeChangeQueue.peek();
}
if (vote == null) return;
PlayerVoteEvent voteEvent = new PlayerVoteEvent(
plugin.getVoteSiteManager().getVoteSite(plugin.getVoteSiteManager().getVoteSiteName(true, vote.getService()), true), vote.getName(),
vote.getService(), true);
voteEvent.setTime(vote.getTime());
voteEvent.setLocalOccurrenceId(vote.getLocalOccurrenceId());
if (vote.getCanonicalOccurrenceTime() != 0L) voteEvent.setCanonicalOccurrenceTime(vote.getCanonicalOccurrenceTime());
synchronized (persistenceLock) {
if (stopping) return;
if (timeChangeQueue.peek() != vote) continue;
dispatchingVote = vote;
if (vote.getVoteId() == null) vote.setVoteId(UUID.randomUUID());
dispatchId = vote.getVoteId();
dispatchEnded = false;
try {
plugin.getServerData().prepareTimedVoteDispatch(dispatchId, vote,
timeChangeQueue.stream().filter(pending -> pending != vote).toList());
} catch (RuntimeException | Error failure) {
clearDispatch();
throw failure;
}
// A preparation resumed after stop is still eligible for normal recovery.
if (stopping) return;
dispatchStarted = true;
}
try {
plugin.getServer().getPluginManager().callEvent(voteEvent);
} catch (RuntimeException | Error failure) {
synchronized (persistenceLock) {
dispatchEnded = true;
try {
retainUncertainDispatch();
clearDispatch();
if (!stopping) checkpointPendingVotes();
} catch (RuntimeException | Error persistenceFailure) {
if (failure != persistenceFailure) failure.addSuppressed(persistenceFailure);
}
}
throw failure;
}
synchronized (persistenceLock) {
dispatchEnded = true;
if (!stopping) plugin.getServerData().completeTimedVoteDispatch(dispatchId);
timeChangeQueue.remove(vote);
clearDispatch();
if (voteEvent.isCancelled() && !stopping) checkpointPendingVotes();
}
if (voteEvent.isCancelled()) {
plugin.debug("Vote cancelled");
continue;
}
}
} catch (RuntimeException | Error failure) {
retry = !stopping;
throw failure;
} finally {
processing.set(false);
if (retry) scheduleRetry();
else retryAttempts.set(0);
}
}
private void clearDispatch() {
dispatchingVote = null;
dispatchId = null;
dispatchEnded = false;
dispatchStarted = false;
}
private void checkpointPendingVotes() {
plugin.getServerData().replaceTimedVoteCache(
timeChangeQueue.stream().filter(vote -> vote != dispatchingVote).toList());
persistedShutdownVotes = 0;
}
/** Uncertain event delivery is retained for review, never automatically replayed. */
private void retainUncertainDispatch() {
if (dispatchingVote == null || !timeChangeQueue.contains(dispatchingVote)) return;
plugin.getServerData().addUncertainTimedVote(dispatchId, dispatchingVote);
timeChangeQueue.remove(dispatchingVote);
plugin.getLogger().warning("Timed vote event delivery is uncertain; retained in ServerData.yml VotingPlugin.UncertainTimedVotes for manual review.");
}
/**
* Saves pending votes to server data.
*/
public void save() {
if (!timeChangeQueue.isEmpty()) {
int num = 0;
for (VoteTimeQueue vote : timeChangeQueue) {
plugin.getServerData().addTimeVoted(num, vote);
num++;
if (stopping) {
saveForShutdown();
return;
}
synchronized (persistenceLock) {
if (stopping) persistPendingVotes();
else checkpointPendingVotes();
}
}
/** Seal processing and retain one persistence owner without an unbounded lifecycle wait. */
public void saveForShutdown() {
stopping = true;
FutureTask<Void> save;
while (true) {
save = shutdownSave.get();
if (save != null) {
if (!save.isDone()) break;
shutdownSave.compareAndSet(save, null);
continue;
}
FutureTask<Void> candidate = new FutureTask<Void>(() -> {
try {
var publication = java.util.Objects.requireNonNull(shutdownPublicationOwner.get());
try { synchronized (persistenceLock) { persistPendingVotes(); } }
finally {
// Publication failure does not terminate previously admitted producers.
awaitRetiringProducers(publication.producers());
if (publication.coreWriters() != null)
for (var writer : publication.coreWriters()) awaitWriterTermination(writer);
}
synchronized (persistenceLock) { persistPendingVotes(); }
if (publication.lease() != null) publication.lease().close();
shutdownPublicationOwner.compareAndSet(publication, null);
} catch (RuntimeException | Error failure) {
try {
plugin.getLogger().warning("Timed vote shutdown persistence failed; pending votes remain owned for retry. Recovery is not confirmed.");
} catch (RuntimeException | Error ignored) { }
throw failure;
}
return null;
}) {
@Override protected void done() {
// Late admission failures must be retryable after this owner completes.
shutdownSave.compareAndSet(this, null);
}
};
FutureTask<Void> existing = shutdownSave.compareAndExchange(null, candidate);
if (existing == null) {
save = candidate;
try {
if (shutdownPublicationOwner.get() == null) {
// Unload can clear these fields even while their original work survives.
// Keep the snapshot with its lease through every rejected or failed attempt.
var producers = plugin.getVoteTimer();
var coreWriters = plugin.getServerDataWriterExecutors();
var retainedWriters = coreWriters == null ? null : coreWriters.clone();
var fence = plugin.getServerDataPublicationFence();
shutdownPublicationOwner.set(new ShutdownPublication(
fence == null ? null : fence.acquire(), producers, retainedWriters));
}
startShutdownWorker(candidate);
}
catch (RuntimeException | Error failure) {
// Even a rejected worker retains the queue owner for an explicit retry.
candidate.cancel(false);
shutdownSave.compareAndSet(candidate, null);
throw failure;
}
break;
}
}
try {
save.get(1, TimeUnit.SECONDS);
shutdownSave.compareAndSet(save, null);
} catch (TimeoutException pending) {
plugin.getLogger().warning("Timed vote shutdown persistence is still pending; its worker retains ownership. Recovery is not yet confirmed.");
} catch (InterruptedException interrupted) {
Thread.currentThread().interrupt();
plugin.getLogger().warning("Timed vote shutdown persistence wait was interrupted; its worker retains ownership.");
} catch (ExecutionException failure) {
shutdownSave.compareAndSet(save, null);
Throwable cause = failure.getCause();
if (cause instanceof Error error) throw error;
if (cause instanceof RuntimeException runtime) throw runtime;
throw new IllegalStateException("Timed vote shutdown persistence failed", cause);
}
}
/** Kept separate so worker-admission failure can be exercised without replacing persistence. */
protected void startShutdownWorker(Runnable task) {
Thread worker = new Thread(task, "VotingPlugin-timed-vote-shutdown");
worker.setDaemon(true);
worker.start();
}
private void awaitRetiringProducers(java.util.concurrent.ScheduledExecutorService producers) {
if (producers == null || !producers.isShutdown()) return;
awaitWriterTermination(producers);
}
private void awaitWriterTermination(java.util.concurrent.ScheduledExecutorService producers) {
if (producers == null) return;
boolean interrupted = false;
try {
while (!producers.isTerminated()) {
try { producers.awaitTermination(100, TimeUnit.MILLISECONDS); }
catch (InterruptedException ignored) { interrupted = true; }
}
} finally { if (interrupted) Thread.currentThread().interrupt(); }
}
/** Remove only a successfully saved prefix; failures retain the same next slot for retry. */
private void persistPendingVotes() {
VoteTimeQueue vote;
while ((vote = timeChangeQueue.peek()) != null) {
if (vote == dispatchingVote) {
if (dispatchStarted) retainUncertainDispatch();
else {
var pending = timeChangeQueue.stream().toList();
plugin.getServerData().abortTimedVoteDispatch(dispatchId, pending);
timeChangeQueue.removeAll(pending);
persistedShutdownVotes = pending.size();
clearDispatch();
}
} else {
plugin.getServerData().addTimeVoted(persistedShutdownVotes, vote);
persistedShutdownVotes++;
timeChangeQueue.remove(vote);
}
}
timeChangeQueue.clear();
}
}
@@ -30,6 +30,10 @@ public class VoteTimeQueue {
@Getter
@Setter
private UUID voteId;
/** Local Bukkit receipt identity; never used as a proxy transport vote ID. */
@Getter
@Setter
private UUID localOccurrenceId;
/** SQL primary key for a legacy timed-cache row, or {@code -1} when not SQL-backed. */
@Getter
@Setter
@@ -47,6 +51,19 @@ public class VoteTimeQueue {
@Getter
@Setter
private String totals;
public long getCanonicalOccurrenceTime() {
Long original = com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.read(totals);
return original == null ? 0L : original;
}
public void setCanonicalOccurrenceTime(long time) {
totals = com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.store(totals, time);
}
public void setTotals(String updated) {
totals = com.bencodez.votingplugin.proxy.VoteOccurrenceMetadata.preserve(totals, updated);
}
@Getter
@Setter
private boolean processed;
@@ -0,0 +1,269 @@
package com.bencodez.votingplugin.topvoter;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Set;
import java.util.Map;
import java.util.Objects;
import java.util.UUID;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import java.util.function.BiFunction;
import java.util.function.LongSupplier;
import com.bencodez.advancedcore.api.user.presence.PlayerPresence;
import org.bukkit.event.Listener;
import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.player.PlayerJoinEvent;
/** Bounded display snapshots only; raw rankings and award inputs stay untouched. */
public final class TopVoterDisplayFilter implements AutoCloseable, Listener {
private static final int MAX_PENDING = 128;
private static final int MAX_CACHED = 8192;
private static final long MAX_AGE = java.util.concurrent.TimeUnit.SECONDS.toNanos(30);
private record Identity(UUID uuid, String name) { }
private static final class Evidence {
private PlayerPresence value = PlayerPresence.UNKNOWN;
private long completed;
private boolean pending = true;
private Set<UUID> identities = Set.of();
private long joinGeneration;
private TopVoterPlayer snapshot;
private List<UUID> aliases;
private final CompletableFuture<Void> settled = new CompletableFuture<>();
}
private final Function<TopVoterPlayer, List<UUID>> identities;
private final BiFunction<TopVoterPlayer, List<UUID>, CompletionStage<PlayerPresence>> lookup;
private final LongSupplier clock;
private final LongSupplier rankingRowBudget;
private volatile int cacheLimit = MAX_CACHED;
private final LinkedHashMap<Identity, Evidence> cache = new LinkedHashMap<>(16, 0.75f, true);
private int pending;
private boolean closed;
private long joinGeneration;
public TopVoterDisplayFilter(Function<TopVoterPlayer, CompletionStage<PlayerPresence>> lookup) {
this(lookup, System::nanoTime);
}
public TopVoterDisplayFilter(Function<TopVoterPlayer, CompletionStage<PlayerPresence>> lookup, LongSupplier clock) {
this(player -> List.of(player.getUuid()), (player, aliases) -> lookup.apply(player), clock);
Objects.requireNonNull(lookup);
}
/** Check the captured cache-only scope asynchronously; revalidate it before using negative evidence. */
public TopVoterDisplayFilter(Function<TopVoterPlayer, List<UUID>> identities,
BiFunction<TopVoterPlayer, List<UUID>, CompletionStage<PlayerPresence>> lookup) {
this(identities, lookup, System::nanoTime);
}
public TopVoterDisplayFilter(Function<TopVoterPlayer, List<UUID>> identities,
BiFunction<TopVoterPlayer, List<UUID>, CompletionStage<PlayerPresence>> lookup, LongSupplier clock) {
this(identities, lookup, clock, () -> 0L);
}
/** The owner supplies the row count already retained in current and historical ranking maps. */
public TopVoterDisplayFilter(Function<TopVoterPlayer, List<UUID>> identities,
BiFunction<TopVoterPlayer, List<UUID>, CompletionStage<PlayerPresence>> lookup, LongSupplier clock,
LongSupplier rankingRowBudget) {
this.identities = Objects.requireNonNull(identities);
this.lookup = Objects.requireNonNull(lookup);
this.clock = Objects.requireNonNull(clock);
this.rankingRowBudget = Objects.requireNonNull(rankingRowBudget);
}
/** Pending, failed, missing or stale evidence remains visible until a checked result arrives. */
public LinkedHashMap<TopVoterPlayer, Integer> project(Map<TopVoterPlayer, Integer> rankings, boolean enabled) {
if (enabled) reserveRankingRows(rankings.size());
var visible = new LinkedHashMap<TopVoterPlayer, Integer>();
for (var entry : rankings.entrySet()) {
if (!enabled || evidence(entry.getKey()) != PlayerPresence.NEVER_JOINED)
visible.put(entry.getKey(), entry.getValue());
}
return visible;
}
private void reserveRankingRows(int rows) {
long requested = rows;
// Read owner state outside the evidence monitor. A racing replacement may leave
// a temporary unknown budget; keep the previous bound until the next refresh.
try { requested = Math.max(requested, rankingRowBudget.getAsLong()); }
catch (RuntimeException unavailable) { requested = Math.max(requested, cacheLimit); }
synchronized (cache) {
cacheLimit = (int) Math.min(Integer.MAX_VALUE, Math.max(MAX_CACHED, requested));
trimCompletedEvidence(cacheLimit);
}
}
/** Called under cache; in-flight requests retain their bounded admission until completion. */
private void trimCompletedEvidence(int limit) {
var oldest = cache.entrySet().iterator();
while (cache.size() > limit && oldest.hasNext()) {
if (!oldest.next().getValue().pending) oldest.remove();
}
}
/** Await admitted checks without blocking their worker; unavailable rows stay visible. */
public CompletionStage<LinkedHashMap<TopVoterPlayer, Integer>> projectAsync(
Map<TopVoterPlayer, Integer> rankings, boolean enabled) {
var snapshot = new LinkedHashMap<>(rankings);
if (!enabled) return CompletableFuture.completedFuture(snapshot);
project(snapshot, true);
var captured = new LinkedHashMap<Identity, Evidence>();
var waiting = new java.util.ArrayList<CompletableFuture<Void>>();
synchronized (cache) {
for (TopVoterPlayer player : snapshot.keySet()) {
if (player == null || player.getUuid() == null) continue;
Identity key = new Identity(player.getUuid(), player.getPlayerName());
Evidence record = cache.get(key);
if (record != null) {
captured.put(key, record);
if (record.pending) waiting.add(record.settled);
}
}
}
return CompletableFuture.allOf(waiting.toArray(CompletableFuture[]::new))
.completeOnTimeout(null, 5, java.util.concurrent.TimeUnit.SECONDS).thenApply(ignored -> {
var visible = new LinkedHashMap<TopVoterPlayer, Integer>();
for (var entry : snapshot.entrySet()) {
TopVoterPlayer player = entry.getKey();
Identity key = player == null ? null : new Identity(player.getUuid(), player.getPlayerName());
Evidence record = captured.get(key);
if (record == null || cachedValue(key, record) != PlayerPresence.NEVER_JOINED)
visible.put(player, entry.getValue());
}
return visible;
});
}
private PlayerPresence evidence(TopVoterPlayer player) {
if (player == null || player.getUuid() == null) return PlayerPresence.UNKNOWN;
Identity key = new Identity(player.getUuid(), player.getPlayerName());
Evidence record;
boolean reuse;
synchronized (cache) {
if (closed) return PlayerPresence.UNKNOWN;
record = cache.get(key);
reuse = record != null && (record.pending || clock.getAsLong() - record.completed < MAX_AGE);
if (!reuse) {
if (pending >= MAX_PENDING) return PlayerPresence.UNKNOWN;
if (record != null) cache.remove(key);
if (cache.size() >= cacheLimit) trimCompletedEvidence(cacheLimit - 1);
if (cache.size() >= cacheLimit) return PlayerPresence.UNKNOWN;
record = new Evidence(); cache.put(key, record); pending++;
record.joinGeneration = joinGeneration;
record.snapshot = new TopVoterPlayer(key.uuid(), key.name(), player.getLastVoteTime());
}
}
if (reuse) return cachedValue(key, record);
Evidence admitted = record;
try {
List<UUID> aliases = resolveScope(admitted.snapshot);
if (aliases == null) {
finish(key, admitted, PlayerPresence.UNKNOWN);
return PlayerPresence.UNKNOWN;
}
var checked = new java.util.HashSet<UUID>();
for (UUID alias : aliases) if (alias != null) checked.add(alias);
boolean valid;
synchronized (cache) {
valid = !closed && cache.get(key) == admitted && admitted.joinGeneration == joinGeneration;
if (valid) {
admitted.identities = Set.copyOf(checked);
admitted.aliases = aliases;
} else cache.remove(key, admitted);
}
if (!valid) {
finish(key, admitted, PlayerPresence.UNKNOWN);
return PlayerPresence.UNKNOWN;
}
CompletionStage<PlayerPresence> request = lookup.apply(admitted.snapshot, aliases);
if (request == null) finish(key, admitted, PlayerPresence.UNKNOWN);
else request.whenComplete((result, failure) -> finish(key, admitted,
failure == null && result != null ? result : PlayerPresence.UNKNOWN));
} catch (RuntimeException unavailable) {
finish(key, admitted, PlayerPresence.UNKNOWN);
}
return cachedValue(key, admitted);
}
private List<UUID> resolveScope(TopVoterPlayer snapshot) {
List<UUID> resolved = identities.apply(snapshot);
if (resolved == null || resolved.isEmpty() || resolved.size() > 8) return null;
// Preserve null uncertainty markers and detach the provider from mutable cache data.
return java.util.Collections.unmodifiableList(new java.util.ArrayList<>(resolved));
}
private boolean matchesScope(Evidence record) {
try {
return record.aliases != null && record.aliases.equals(resolveScope(record.snapshot));
} catch (RuntimeException unavailable) {
return false;
}
}
private PlayerPresence cachedValue(Identity key, Evidence record) {
PlayerPresence value;
synchronized (cache) {
if (closed || cache.get(key) != record || record.pending
|| clock.getAsLong() - record.completed >= MAX_AGE) return PlayerPresence.UNKNOWN;
value = record.value;
}
// The resolver is cache-only, but must never run under the evidence-cache monitor.
if (value == PlayerPresence.NEVER_JOINED && !matchesScope(record)) {
synchronized (cache) { cache.remove(key, record); }
return PlayerPresence.UNKNOWN;
}
synchronized (cache) {
return !closed && cache.get(key) == record && !record.pending
&& clock.getAsLong() - record.completed < MAX_AGE ? record.value : PlayerPresence.UNKNOWN;
}
}
private void finish(Identity key, Evidence record, PlayerPresence result) {
boolean currentScope = result != PlayerPresence.NEVER_JOINED || matchesScope(record);
synchronized (cache) {
if (!record.pending) return;
record.pending = false; pending--;
if (!closed && cache.get(key) == record) {
if (!currentScope) cache.remove(key, record);
else { record.value = result; record.completed = clock.getAsLong(); }
}
trimCompletedEvidence(cacheLimit);
}
// Completion may invoke projection callbacks, which resolve aliases outside this monitor.
record.settled.complete(null);
}
/** A newly observed join revokes matching negative snapshots and pending stale completions. */
public void joined(UUID uuid, String name) {
var invalidated = new java.util.ArrayList<Evidence>();
synchronized (cache) {
joinGeneration++;
cache.entrySet().removeIf(entry -> {
boolean matches = Objects.equals(entry.getKey().uuid(), uuid)
|| (uuid != null && entry.getValue().identities.contains(uuid))
|| (name != null && name.equalsIgnoreCase(entry.getKey().name()));
if (matches) invalidated.add(entry.getValue());
return matches;
});
}
for (Evidence record : invalidated) record.settled.complete(null);
}
@EventHandler(priority = EventPriority.LOWEST)
public void onJoin(PlayerJoinEvent event) {
joined(event.getPlayer().getUniqueId(), event.getPlayer().getName());
}
@Override public void close() {
List<Evidence> retiring;
synchronized (cache) {
closed = true;
retiring = new java.util.ArrayList<>(cache.values());
cache.clear();
}
for (Evidence record : retiring) record.settled.complete(null);
}
}
@@ -113,11 +113,12 @@ public class TopVoterHandler implements Listener {
*/
public String[] getTopVotersWeekly() {
ArrayList<String> msg = new ArrayList<>();
ArrayList<TopVoterPlayer> users = new ArrayList<>(plugin.getTopVoter(TopVoter.Weekly).keySet());
var board = plugin.getTopVoterDisplay(TopVoter.Weekly);
ArrayList<TopVoterPlayer> users = new ArrayList<>(board.keySet());
for (int i = 0; i < users.size(); i++) {
String line = plugin.getConfigFile().getFormatCommandsVoteTopLine().replace("%num%", "" + (i + 1))
.replace("%player%", users.get(i).getPlayerName())
.replace("%votes%", "" + plugin.getTopVoter(TopVoter.Weekly).get(users.get(i)));
.replace("%votes%", "" + board.get(users.get(i)));
msg.add(line);
}
msg = ArrayUtils.colorize(msg);
@@ -638,11 +639,12 @@ public class TopVoterHandler implements Listener {
* @return the string[]
*/
public String[] topVoterAllTime(int page) {
int pagesize = plugin.getConfigFile().getFormatPageSize();
page = Math.max(1, page);
int pagesize = Math.max(1, plugin.getConfigFile().getFormatPageSize());
ArrayList<String> msg = new ArrayList<>();
ArrayList<String> topVoters = new ArrayList<>();
int count = 1;
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.AllTime).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.AllTime).entrySet()) {
String line = plugin.getConfigFile().getFormatCommandsVoteTopLine();
line = line.replace("%num%", "" + count);
line = line.replace("%player%", entry.getKey().getPlayerName());
@@ -662,7 +664,8 @@ public class TopVoterHandler implements Listener {
title = title.replace("%Top%", plugin.getConfigFile().getFormatTopVoterAllTime());
msg.add(MessageAPI.colorize(title));
for (int i = (page - 1) * pagesize; (i < topVoters.size()) && (i < (((page - 1) * pagesize) + 10)); i++) {
long start = (long) (page - 1) * pagesize;
for (int i = (int) Math.min(start, topVoters.size()); i < topVoters.size() && i < start + pagesize; i++) {
msg.add(topVoters.get(i));
}
@@ -676,11 +679,12 @@ public class TopVoterHandler implements Listener {
* @return array of formatted top voter lines
*/
public String[] topVoterDaily(int page) {
int pagesize = plugin.getConfigFile().getFormatPageSize();
page = Math.max(1, page);
int pagesize = Math.max(1, plugin.getConfigFile().getFormatPageSize());
ArrayList<String> msg = new ArrayList<>();
ArrayList<String> topVoters = new ArrayList<>();
int count = 1;
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Daily).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Daily).entrySet()) {
String line = plugin.getConfigFile().getFormatCommandsVoteTopLine();
line = line.replace("%num%", "" + count);
line = line.replace("%player%", entry.getKey().getPlayerName());
@@ -700,7 +704,8 @@ public class TopVoterHandler implements Listener {
title = title.replace("%Top%", plugin.getConfigFile().getFormatTopVoterDaily());
msg.add(MessageAPI.colorize(title));
for (int i = (page - 1) * pagesize; (i < topVoters.size()) && (i < (((page - 1) * pagesize) + 10)); i++) {
long start = (long) (page - 1) * pagesize;
for (int i = (int) Math.min(start, topVoters.size()); i < topVoters.size() && i < start + pagesize; i++) {
msg.add(topVoters.get(i));
}
@@ -714,11 +719,12 @@ public class TopVoterHandler implements Listener {
* @return array of formatted top voter lines
*/
public String[] topVoterMonthly(int page) {
int pagesize = plugin.getConfigFile().getFormatPageSize();
page = Math.max(1, page);
int pagesize = Math.max(1, plugin.getConfigFile().getFormatPageSize());
ArrayList<String> msg = new ArrayList<>();
ArrayList<String> topVoters = new ArrayList<>();
int count = 1;
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Monthly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Monthly).entrySet()) {
String line = plugin.getConfigFile().getFormatCommandsVoteTopLine();
line = line.replace("%num%", "" + count);
line = line.replace("%player%", entry.getKey().getPlayerName());
@@ -738,7 +744,8 @@ public class TopVoterHandler implements Listener {
title = title.replace("%Top%", plugin.getConfigFile().getFormatTopVoterMonthly());
msg.add(MessageAPI.colorize(title));
for (int i = (page - 1) * pagesize; (i < topVoters.size()) && (i < (((page - 1) * pagesize) + 10)); i++) {
long start = (long) (page - 1) * pagesize;
for (int i = (int) Math.min(start, topVoters.size()); i < topVoters.size() && i < start + pagesize; i++) {
msg.add(topVoters.get(i));
}
@@ -752,7 +759,7 @@ public class TopVoterHandler implements Listener {
*/
public String[] topVotersAllTime() {
ArrayList<String> msg = new ArrayList<>();
List<Entry<TopVoterPlayer, Integer>> list = new LinkedList<>(plugin.getTopVoter(TopVoter.AllTime).entrySet());
List<Entry<TopVoterPlayer, Integer>> list = new LinkedList<>(plugin.getTopVoterDisplay(TopVoter.AllTime).entrySet());
int i = 0;
for (Entry<TopVoterPlayer, Integer> entry : list) {
String line = "%num%: %player%, %votes%";
@@ -778,7 +785,8 @@ public class TopVoterHandler implements Listener {
*/
public String[] topVotersDaily() {
ArrayList<String> msg = new ArrayList<>();
ArrayList<TopVoterPlayer> users = new ArrayList<>(plugin.getTopVoter(TopVoter.Daily).keySet());
var board = plugin.getTopVoterDisplay(TopVoter.Daily);
ArrayList<TopVoterPlayer> users = new ArrayList<>(board.keySet());
for (int i = 0; i < users.size(); i++) {
String line = "%num%: %player%, %votes%";
line = line.replace("%num%", "" + (i + 1));
@@ -787,7 +795,7 @@ public class TopVoterHandler implements Listener {
} catch (Exception ex) {
VotingPluginMain.plugin.debug(ex);
}
line = line.replace("%votes%", "" + plugin.getTopVoter(TopVoter.Monthly).get(users.get(i)));
line = line.replace("%votes%", "" + board.get(users.get(i)));
msg.add(line);
}
@@ -801,7 +809,7 @@ public class TopVoterHandler implements Listener {
*/
public String[] topVotersMonthly() {
ArrayList<String> msg = new ArrayList<>();
List<Entry<TopVoterPlayer, Integer>> list = new LinkedList<>(plugin.getTopVoter(TopVoter.Monthly).entrySet());
List<Entry<TopVoterPlayer, Integer>> list = new LinkedList<>(plugin.getTopVoterDisplay(TopVoter.Monthly).entrySet());
int i = 0;
for (Entry<TopVoterPlayer, Integer> entry : list) {
String line = "%num%: %player%, %votes%";
@@ -827,11 +835,12 @@ public class TopVoterHandler implements Listener {
* @return array of formatted top voter lines
*/
public String[] topVoterWeekly(int page) {
int pagesize = plugin.getConfigFile().getFormatPageSize();
page = Math.max(1, page);
int pagesize = Math.max(1, plugin.getConfigFile().getFormatPageSize());
ArrayList<String> msg = new ArrayList<>();
ArrayList<String> topVoters = new ArrayList<>();
int count = 1;
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoter(TopVoter.Weekly).entrySet()) {
for (Entry<TopVoterPlayer, Integer> entry : plugin.getTopVoterDisplay(TopVoter.Weekly).entrySet()) {
String line = plugin.getConfigFile().getFormatCommandsVoteTopLine();
line = line.replace("%num%", "" + count);
line = line.replace("%player%", entry.getKey().getPlayerName());
@@ -851,7 +860,8 @@ public class TopVoterHandler implements Listener {
title = title.replace("%Top%", plugin.getConfigFile().getFormatTopVoterWeekly());
msg.add(MessageAPI.colorize(title));
for (int i = (page - 1) * pagesize; (i < topVoters.size()) && (i < (((page - 1) * pagesize) + 10)); i++) {
long start = (long) (page - 1) * pagesize;
for (int i = (int) Math.min(start, topVoters.size()); i < topVoters.size() && i < start + pagesize; i++) {
msg.add(topVoters.get(i));
}
@@ -0,0 +1,41 @@
package com.bencodez.votingplugin.topvoter;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import java.util.function.Function;
/** UUID-only evidence scopes; never resolves a profile or loads plugin/server storage. */
public final class TopVoterPresenceIdentity {
private TopVoterPresenceIdentity() { }
/** A null alias explicitly prevents uncertain migration evidence becoming negative. */
public static List<UUID> identities(TopVoterPlayer row, boolean onlineMode, Function<String, String> cachedUuid) {
var identities = new ArrayList<UUID>();
if (row == null || row.getUuid() == null) { identities.add(null); return identities; }
identities.add(row.getUuid());
String name = row.getPlayerName();
if (name == null || name.isBlank() || name.length() > 64 || !name.equals(name.trim())) {
identities.add(null); return identities;
}
UUID offline = UUID.nameUUIDFromBytes(("OfflinePlayer:" + name).getBytes(StandardCharsets.UTF_8));
if (!identities.contains(offline)) identities.add(offline);
UUID current = null;
try {
String known = cachedUuid.apply(name);
if (known != null && !known.isBlank()) {
current = UUID.fromString(known);
if (!current.toString().equalsIgnoreCase(known)) { identities.add(null); return identities; }
}
} catch (RuntimeException unavailable) { identities.add(null); return identities; }
if (current != null && !identities.contains(current)) identities.add(current);
// This validates known aliases; online historical completeness is checked
// separately against retained server history by the asynchronous provider.
boolean resolvable = onlineMode ? row.getUuid().version() == 4 && row.getUuid().variant() == 2
&& (current == null || current.equals(row.getUuid()))
: offline.equals(row.getUuid()) || offline.equals(current);
if (!resolvable) identities.add(null);
return identities;
}
}
@@ -93,10 +93,20 @@ public final class SharedMysqlCacheReconciler {
public static void invalidateAndRefresh(VotingPluginMain plugin, String uuid, String... columns) {
invalidate(plugin, uuid, columns);
if (plugin == null || uuid == null) return;
String pointColumn = plugin.getBungeeSettings().isPerServerPoints()
? plugin.getBungeeSettings().getServerNameStorage() + "_Points" : "Points";
boolean affectsPoints = columns != null && java.util.Arrays.asList(columns).contains(pointColumn);
var placeholders = plugin.getPlaceholders();
java.util.function.Consumer<Boolean> completion = affectsPoints && placeholders != null
? placeholders.sharedPointRefillCompletion(UUID.fromString(uuid)) : null;
try {
plugin.getVotingPluginUserManager().getVotingPluginUser(UUID.fromString(uuid), false).cacheAsync();
plugin.getBukkitScheduler().runTaskAsynchronously(plugin,
() -> tryInvalidateAndRefreshOnWorker(plugin, uuid, columns));
} catch (RuntimeException refreshFailure) {
plugin.debug(refreshFailure);
} finally {
// This admission is not storage evidence. Only the actual worker can recover rendering.
if (completion != null) completion.accept(false);
}
}
@@ -106,13 +116,37 @@ public final class SharedMysqlCacheReconciler {
* A failed refill leaves the snapshot explicitly unavailable, not false zero.
*/
public static void invalidateAndRefreshOnWorker(VotingPluginMain plugin, String uuid, String... columns) {
invalidate(plugin, uuid, columns);
if (plugin == null || uuid == null) return;
tryInvalidateAndRefreshOnWorker(plugin, uuid, columns);
}
static boolean tryInvalidateAndRefreshOnWorker(VotingPluginMain plugin, String uuid, String... columns) {
if (plugin == null || uuid == null) return false;
UUID playerUuid = UUID.fromString(uuid);
String pointColumn = plugin.getBungeeSettings().isPerServerPoints()
? plugin.getBungeeSettings().getServerNameStorage() + "_Points" : "Points";
boolean affectsPoints = columns != null && java.util.Arrays.asList(columns).contains(pointColumn);
var placeholders = plugin.getPlaceholders();
java.util.function.Consumer<Boolean> completion = affectsPoints && placeholders != null
? placeholders.sharedPointRefillCompletion(playerUuid) : null;
boolean verified = false;
try {
plugin.getUserManager().getDataManager().cacheUser(UUID.fromString(uuid), null);
invalidate(plugin, uuid, columns);
var manager = plugin.getUserManager().getDataManager();
manager.cacheUser(playerUuid, null);
var cache = manager.getUserDataCache().get(playerUuid);
if (cache != null) synchronized (cache) {
// A complete published row may legitimately omit the selected points key.
// Rendering separately rejects present malformed/unsupported values.
verified = manager.getUserDataCache().get(playerUuid) == cache
&& cache.hasPublishedStorageSnapshot();
}
return true;
} catch (RuntimeException refreshFailure) {
plugin.getLogger().warning("Shared MySQL cache refresh is unavailable after mutation; stale data was not published.");
plugin.debug(refreshFailure);
return false;
} finally {
if (completion != null) completion.accept(verified);
}
}
@@ -21,6 +21,7 @@ import com.bencodez.simpleapi.sql.DataType;
import com.bencodez.simpleapi.sql.data.DataValue;
import com.bencodez.simpleapi.sql.data.DataValueInt;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.placeholders.PlaceHolders;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
/** Performs point writes that must remain atomic across shared MySQL servers. */
@@ -124,7 +125,7 @@ final class SharedMysqlPointMutator {
int previousTotal = cachedPoints(user, pointsColumn);
int predictedTotal = previousTotal + amount;
cachePredictedPoints(user, predictedTotal, pointsColumn);
if (!run(() -> update(user, amount, false, pointsColumn), true)) {
if (!runPointMutation(user, () -> update(user, amount, false, pointsColumn), true)) {
discardOptimisticPoints(user, pointsColumn);
if (failOnRejectedAdmission) throw new IllegalStateException("Point mutation storage worker is unavailable");
return previousTotal;
@@ -185,16 +186,29 @@ final class SharedMysqlPointMutator {
AddResult addCommittedToColumn(VotingPluginUser user, int amount, String operationId, String pointsColumn) {
if (operationId == null || operationId.isEmpty()) return addCommittedToColumn(user, amount, pointsColumn);
drainCache(user, pointsColumn);
var placeholders = plugin.getPlaceholders();
UUID uuid = UUID.fromString(user.getUUID());
if (placeholders != null) placeholders.beginSharedPointDebit(uuid);
boolean confirmed = false;
try {
drainCache(user, pointsColumn);
SharedPointAdditionJournal.AdditionResult result = SharedPointAdditionJournal.forTable(plugin.getMysql())
.add(operationId, user.getUUID(), pointsColumn, amount, System.currentTimeMillis());
confirmed = true;
return new AddResult(true, result.total());
} catch (SQLException failure) {
logFailure(failure);
return new AddResult(MutationOutcome.INDETERMINATE, 0);
} finally {
discardPointsCache(user, pointsColumn);
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), pointsColumn);
if (placeholders != null) {
var cache = plugin.getUserManager().getDataManager().getUserDataCache().get(uuid);
boolean available = false;
if (cache != null) synchronized (cache) {
available = refreshed && confirmed && cache.hasPublishedStorageSnapshot();
}
placeholders.finishSharedPointDebit(uuid, confirmed, available);
}
}
}
@@ -209,18 +223,36 @@ final class SharedMysqlPointMutator {
AddResult removeCommittedFromColumn(VotingPluginUser user, int amount, String operationId, String pointsColumn) {
if (operationId == null || operationId.isEmpty()) return new AddResult(false, 0);
drainCache(user, pointsColumn);
var placeholders = plugin.getPlaceholders();
UUID uuid = UUID.fromString(user.getUUID());
if (placeholders != null) placeholders.beginSharedPointDebit(uuid);
AddResult outcome = new AddResult(MutationOutcome.INDETERMINATE, 0);
boolean refreshed;
try {
drainCache(user, pointsColumn);
SharedPointAdditionJournal.AdditionResult result = SharedPointAdditionJournal.forTable(plugin.getMysql())
.subtract(operationId, user.getUUID(), pointsColumn, amount, System.currentTimeMillis());
return new AddResult(true, result.total());
outcome = new AddResult(true, result.total());
} catch (SQLException failure) {
logFailure(failure);
return new AddResult(failure instanceof SharedPointAdditionJournal.DebitRejectedException
? MutationOutcome.REJECTED : MutationOutcome.INDETERMINATE, 0);
if (failure instanceof SharedPointAdditionJournal.DebitRejectedException) {
outcome = new AddResult(MutationOutcome.REJECTED, 0);
} else {
logFailure(failure);
outcome = new AddResult(MutationOutcome.INDETERMINATE, 0);
}
} finally {
discardPointsCache(user, pointsColumn);
refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), pointsColumn);
if (placeholders != null) {
var cache = plugin.getUserManager().getDataManager().getUserDataCache().get(uuid);
boolean available = false;
if (cache != null) synchronized (cache) {
available = refreshed && outcome.outcome() != MutationOutcome.INDETERMINATE
&& cache.hasPublishedStorageSnapshot();
}
placeholders.finishSharedPointDebit(uuid, outcome.outcome() != MutationOutcome.INDETERMINATE, available);
}
}
return new AddResult(outcome.outcome(), outcome.total(), refreshed);
}
/** Looks up a completed retry before its Bukkit receive event is dispatched. */
@@ -326,7 +358,20 @@ final class SharedMysqlPointMutator {
boolean set(VotingPluginUser user, int value, boolean async) {
String pointsColumn = user.getPointsPath();
return run(() -> setAbsolute(user, value, pointsColumn), async);
var placeholders = plugin.getPlaceholders();
Consumer<Boolean> admission = placeholders == null ? null
: placeholders.sharedPointAdmissionCompletion(UUID.fromString(user.getUUID()));
boolean accepted = run(() -> {
boolean settled = false;
try {
setAbsolute(user, value, pointsColumn);
settled = true;
} finally {
if (admission != null) admission.accept(settled);
}
}, async);
if (!accepted && admission != null) admission.accept(false);
return accepted;
}
boolean setCommitted(VotingPluginUser user, int value) {
@@ -339,7 +384,7 @@ final class SharedMysqlPointMutator {
void cap(VotingPluginUser user, int maximum, boolean async) {
String pointsColumn = user.getPointsPath();
run(() -> capAt(user, maximum, pointsColumn), async);
runPointMutation(user, () -> capAt(user, maximum, pointsColumn), async);
}
/**
@@ -357,7 +402,7 @@ final class SharedMysqlPointMutator {
int predictedTotal = (int) Math.max(Integer.MIN_VALUE,
Math.min((long) previousTotal + amount, maximum));
cachePredictedPoints(user, predictedTotal, pointsColumn);
if (!run(() -> addAndCapAt(user, amount, maximum, pointsColumn), true)) {
if (!runPointMutation(user, () -> addAndCapAt(user, amount, maximum, pointsColumn), true)) {
discardOptimisticPoints(user, pointsColumn);
}
}
@@ -370,7 +415,7 @@ final class SharedMysqlPointMutator {
if (!async) return remove(user, amount);
String pointsColumn = user.getPointsPath();
boolean predictedSuccess = cachedPoints(user, pointsColumn) >= amount;
boolean submitted = run(() -> update(user, -amount, true, pointsColumn), true);
boolean submitted = runPointMutation(user, () -> update(user, -amount, true, pointsColumn), true);
// Preserve the historical asynchronous API contract: the caller receives
// the cached prediction while the conditional database debit runs later.
return submitted && predictedSuccess;
@@ -498,41 +543,40 @@ final class SharedMysqlPointMutator {
org.bukkit.entity.Player approvalPlayer = targetPlayer != null ? targetPlayer : sourcePlayer;
String sourcePoints = source.getPointsPath();
String targetPoints = target.getPointsPath();
var reservationPublication = beginPointPublication(source);
try {
plugin.getTimer().execute(() -> {
try {
drainCache(source);
drainCache(target);
} catch (RuntimeException cacheFailure) {
plugin.debug(cacheFailure);
completeOnBukkit(sourcePlayer, completion, PointTransferResult.UNAVAILABLE);
return;
}
MySQL table = plugin.getMysql();
String transferId = UUID.randomUUID().toString();
String owner = UUID.randomUUID().toString();
SharedPointTransferJournal journal;
SharedPointTransferJournal prepared = null;
boolean known = true;
boolean reserved = false;
PointTransferResult failed = PointTransferResult.UNAVAILABLE;
try {
journal = SharedPointTransferJournal.forTable(table);
recoverTransfers(plugin, journal);
if (!journal.reserve(transferId, source.getUUID(), sourcePoints, debitAmount, target.getUUID(),
debitAmount, System.currentTimeMillis())) {
completeOnBukkit(sourcePlayer, completion, PointTransferResult.INSUFFICIENT_POINTS);
return;
}
// The source cache may have been recreated while the reservation was being
// committed. Invalidate its points after the durable debit, before any later
// dump can restore the pre-debit balance.
discardPointsCache(source, sourcePoints);
drainCache(source);
drainCache(target);
prepared = SharedPointTransferJournal.forTable(table);
recoverTransfers(plugin, prepared);
known = false;
reserved = prepared.reserve(transferId, source.getUUID(), sourcePoints, debitAmount,
target.getUUID(), debitAmount, System.currentTimeMillis());
known = true;
failed = PointTransferResult.INSUFFICIENT_POINTS;
} catch (SQLException failure) {
// An acknowledgement/confirmation failure can follow a committed
// reservation debit. Never allow a cache recreated during the unknown
// outcome to flush the pre-debit source balance over it.
discardPointsCache(source, sourcePoints);
known |= failure instanceof SharedPointTransferJournal.PreparationFailure;
logFailure(failure);
completeOnBukkit(sourcePlayer, completion, PointTransferResult.UNAVAILABLE);
} catch (RuntimeException cacheFailure) {
plugin.debug(cacheFailure);
} finally {
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, source.getUUID(), sourcePoints);
finishPointPublication(reservationPublication, source, sourcePoints, known, refreshed);
}
if (!reserved) {
completeOnBukkit(sourcePlayer, completion, failed);
return;
}
SharedPointTransferJournal journal = prepared;
/*
* Do not claim the reservation until the Bukkit approval task has actually
@@ -562,6 +606,7 @@ final class SharedMysqlPointMutator {
// No reservation exists when the initial persistence task is rejected.
// Still complete the command contract on the source entity lane.
plugin.debug(schedulingFailure);
finishPointPublication(reservationPublication, source, sourcePoints, true, false);
completeOnBukkit(sourcePlayer, completion, PointTransferResult.UNAVAILABLE);
}
}
@@ -574,8 +619,7 @@ final class SharedMysqlPointMutator {
System.currentTimeMillis());
if (claim == SharedPointTransferJournal.ClaimOutcome.NOT_CLAIMED) {
try {
journal.refundReserved(transferId, source.getUUID(), sourcePoints, debitAmount);
discardPointsCache(source, sourcePoints);
refundReservedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
} catch (SQLException failure) {
logFailure(failure);
}
@@ -713,10 +757,7 @@ final class SharedMysqlPointMutator {
} catch (SQLException markerFailure) {
boolean refunded = false;
try {
refunded = journal.refundHookStarted(transferId, source.getUUID(), sourcePoints, debitAmount);
if (refunded) {
discardPointsCache(source, sourcePoints);
}
refunded = refundClaimedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
} catch (SQLException refundFailure) {
logFailure(refundFailure);
}
@@ -736,17 +777,24 @@ final class SharedMysqlPointMutator {
int debitAmount,
Consumer<PointTransferResult> completion, SharedPointTransferJournal journal, String transferId, String owner,
String sourcePoints, String targetPoints, Integer approvedAmount) {
var sourcePublication = beginPointPublication(source);
var targetPublication = beginPointPublication(target);
boolean known = false;
PointTransferResult result;
try {
// The hook may have recreated either cache while it ran on Bukkit.
drainCache(target);
SharedPointTransferJournal.SettlementOutcome outcome;
try {
drainCache(target);
outcome = journal.settleWithConfirmation(transferId, owner, source.getUUID(), sourcePoints,
target.getUUID(), targetPoints, debitAmount, approvedAmount);
known = outcome != SharedPointTransferJournal.SettlementOutcome.INDETERMINATE;
} finally {
discardPointsCache(source, sourcePoints);
discardPointsCache(target, targetPoints);
boolean sourceRefreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, source.getUUID(), sourcePoints);
boolean targetRefreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, target.getUUID(), targetPoints);
finishPointPublication(sourcePublication, source, sourcePoints, known, sourceRefreshed);
finishPointPublication(targetPublication, target, targetPoints, known, targetRefreshed);
}
result = outcome == SharedPointTransferJournal.SettlementOutcome.COMPLETED ? PointTransferResult.SUCCESS
: outcome == SharedPointTransferJournal.SettlementOutcome.REFUNDED ? PointTransferResult.CANCELLED
@@ -760,14 +808,29 @@ final class SharedMysqlPointMutator {
completeOnBukkit(sourcePlayer, completion, result);
}
private boolean refundReservedWithPublication(VotingPluginUser source, SharedPointTransferJournal journal,
String transferId, String sourcePoints, int debitAmount) throws SQLException {
var publication = beginPointPublication(source);
boolean known = false;
try {
boolean refunded = journal.refundReserved(transferId, source.getUUID(), sourcePoints, debitAmount);
known = true;
return refunded;
} catch (SQLException failure) {
known = failure instanceof SharedPointTransferJournal.PreparationFailure;
throw failure;
} finally {
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, source.getUUID(), sourcePoints);
finishPointPublication(publication, source, sourcePoints, known, refreshed);
}
}
private void refundReservedAfterSchedulingFailure(VotingPluginUser source, org.bukkit.entity.Player sourcePlayer,
Consumer<PointTransferResult> completion,
SharedPointTransferJournal journal, String transferId, String sourcePoints, int debitAmount,
RuntimeException failure) {
try {
if (journal.refundReserved(transferId, source.getUUID(), sourcePoints, debitAmount)) {
discardPointsCache(source, sourcePoints);
}
refundReservedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
} catch (SQLException refundFailure) {
logFailure(refundFailure);
}
@@ -783,24 +846,23 @@ final class SharedMysqlPointMutator {
// HOOK_STARTED is safe to compensate because the approval task has not
// been submitted yet. A RESERVED row is handled by its normal refund.
if (journal.markCompensating(transferId)) {
refunded = journal.refundHookStarted(transferId, source.getUUID(), sourcePoints, debitAmount);
refunded = refundClaimedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
} else {
refunded = journal.refundReserved(transferId, source.getUUID(), sourcePoints, debitAmount);
refunded = refundReservedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
}
} catch (SQLException markerFailure) {
// A lost marker acknowledgement may still have committed. Both refund
// operations are idempotent and cover either durable pre-hook state.
try {
refunded = journal.refundHookStarted(transferId, source.getUUID(), sourcePoints, debitAmount);
refunded = refundClaimedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
if (!refunded) {
refunded = journal.refundReserved(transferId, source.getUUID(), sourcePoints, debitAmount);
refunded = refundReservedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
}
} catch (SQLException refundFailure) {
logFailure(refundFailure);
}
logFailure(markerFailure);
}
if (refunded) discardPointsCache(source, sourcePoints);
if (!refunded) {
rememberPendingCompensationMarker(plugin, transferId);
logIndeterminateClaim(transferId);
@@ -815,19 +877,32 @@ final class SharedMysqlPointMutator {
completeOnBukkit(sourcePlayer, completion, PointTransferResult.UNAVAILABLE);
}
private boolean refundClaimedWithPublication(VotingPluginUser source, SharedPointTransferJournal journal,
String transferId, String sourcePoints, int debitAmount) throws SQLException {
var publication = beginPointPublication(source);
boolean known = false;
try {
boolean refunded = journal.refundHookStarted(transferId, source.getUUID(), sourcePoints, debitAmount);
known = true;
return refunded;
} catch (SQLException refundFailure) {
known = refundFailure instanceof SharedPointTransferJournal.PreparationFailure;
throw refundFailure;
} finally {
// A later guarded fallback or refill cannot erase an earlier ambiguous write.
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, source.getUUID(), sourcePoints);
finishPointPublication(publication, source, sourcePoints, known, refreshed);
}
}
void refundClaimedAfterSchedulingFailure(VotingPluginUser source, org.bukkit.entity.Player sourcePlayer,
Consumer<PointTransferResult> completion,
SharedPointTransferJournal journal, String transferId, String sourcePoints, int debitAmount,
RuntimeException failure) {
try {
journal.refundHookStarted(transferId, source.getUUID(), sourcePoints, debitAmount);
refundClaimedWithPublication(source, journal, transferId, sourcePoints, debitAmount);
} catch (SQLException refundFailure) {
logFailure(refundFailure);
} finally {
// The refund may have committed even when its acknowledgement and
// confirmation read both failed. Invalidate a cache recreated after the
// original debit so it cannot later overwrite either durable outcome.
discardPointsCache(source, sourcePoints);
}
plugin.debug(failure);
completeOnBukkit(sourcePlayer, completion, PointTransferResult.UNAVAILABLE);
@@ -890,6 +965,23 @@ final class SharedMysqlPointMutator {
}
}
private boolean runPointMutation(VotingPluginUser user, Runnable operation, boolean async) {
PlaceHolders placeholders = plugin.getPlaceholders();
Consumer<Boolean> admission = placeholders == null ? null
: placeholders.sharedPointAdmissionCompletion(UUID.fromString(user.getUUID()));
boolean accepted = run(() -> {
boolean settled = false;
try {
operation.run();
settled = true;
} finally {
if (admission != null) admission.accept(settled);
}
}, async);
if (!accepted && admission != null) admission.accept(false);
return accepted;
}
private boolean run(Runnable operation, boolean async) {
if (async) {
try {
@@ -910,25 +1002,34 @@ final class SharedMysqlPointMutator {
}
private boolean update(VotingPluginUser user, int delta, boolean requireNonnegative, String points) {
drainCache(user, points);
MySQL table = plugin.getMysql();
StringBuilder sql = new StringBuilder("UPDATE ").append(table.qi(table.getTableName())).append(" SET ")
.append(table.qi(points)).append(" = COALESCE(").append(table.qi(points)).append(", 0) + ? WHERE ")
.append(table.qi("uuid")).append(table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
if (requireNonnegative) {
sql.append(" AND COALESCE(").append(table.qi(points)).append(", 0) >= ?");
}
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql.toString())) {
statement.setInt(1, delta);
statement.setString(2, user.getUUID());
if (requireNonnegative) statement.setInt(3, -delta);
return statement.executeUpdate() == 1;
} catch (SQLException failure) {
logFailure(failure);
return false;
PlaceHolders publication = beginPointPublication(user);
// Classify this arithmetic statement; an earlier uncertain operation stays fenced.
boolean known = true;
try {
drainCache(user, points);
MySQL table = plugin.getMysql();
StringBuilder sql = new StringBuilder("UPDATE ").append(table.qi(table.getTableName())).append(" SET ")
.append(table.qi(points)).append(" = COALESCE(").append(table.qi(points)).append(", 0) + ? WHERE ")
.append(table.qi("uuid")).append(table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
if (requireNonnegative) {
sql.append(" AND COALESCE(").append(table.qi(points)).append(", 0) >= ?");
}
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql.toString())) {
statement.setInt(1, delta);
statement.setString(2, user.getUUID());
if (requireNonnegative) statement.setInt(3, -delta);
known = false;
int affected = statement.executeUpdate();
known = true;
return affected == 1;
} catch (SQLException failure) {
logFailure(failure);
return false;
}
} finally {
discardPointsCache(user, points);
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), points);
finishPointPublication(publication, user, points, known, refreshed);
}
}
@@ -946,53 +1047,74 @@ final class SharedMysqlPointMutator {
}
private AddResult addAndReadCommittedResult(VotingPluginUser user, int amount, String points) {
drainCache(user, points);
MySQL table = plugin.getMysql();
String uuidMatch = table.qi("uuid") + (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
String update = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points) + " = COALESCE("
+ table.qi(points) + ", 0) + ? WHERE " + uuidMatch;
String read = "SELECT " + table.qi(points) + " FROM " + table.qi(table.getTableName()) + " WHERE " + uuidMatch;
boolean updateCommitted = false;
Integer committedTotal = null;
try (Connection connection = requireConnection(table);
PreparedStatement updateStatement = connection.prepareStatement(update);
PreparedStatement readStatement = connection.prepareStatement(read)) {
updateStatement.setInt(1, amount);
updateStatement.setString(2, user.getUUID());
if (updateStatement.executeUpdate() == 1) {
// With JDBC auto-commit, executeUpdate returning one means the mutation
// completed. A later read may still fail after the points have been
// committed, so never turn that outcome into a retryable failure.
updateCommitted = true;
readStatement.setString(1, user.getUUID());
try (java.sql.ResultSet result = readStatement.executeQuery()) {
if (result.next()) committedTotal = result.getInt(1);
}
PlaceHolders publication = beginPointPublication(user);
// Classify this arithmetic statement; an earlier uncertain operation stays fenced.
boolean known = true;
boolean refreshed = false;
try {
try {
drainCache(user, points);
} catch (RuntimeException preparationFailure) {
// No arithmetic statement was submitted. Cache retirement may itself
// perform I/O; its failure is not proof this addition ran.
plugin.debug(preparationFailure);
return new AddResult(MutationOutcome.REJECTED, 0);
}
} catch (SQLException failure) {
logFailure(failure);
MySQL table = plugin.getMysql();
String uuidMatch = table.qi("uuid") + (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
String update = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points) + " = COALESCE("
+ table.qi(points) + ", 0) + ? WHERE " + uuidMatch;
String read = "SELECT " + table.qi(points) + " FROM " + table.qi(table.getTableName()) + " WHERE " + uuidMatch;
boolean updateCommitted = false;
Integer committedTotal = null;
try (Connection connection = requireConnection(table);
PreparedStatement updateStatement = connection.prepareStatement(update);
PreparedStatement readStatement = connection.prepareStatement(read)) {
updateStatement.setInt(1, amount);
updateStatement.setString(2, user.getUUID());
known = false;
int affected = updateStatement.executeUpdate();
known = true;
if (affected == 1) {
// With JDBC auto-commit, executeUpdate returning one means the mutation
// completed. A later read may still fail after the points have been
// committed, so never turn that outcome into a retryable failure.
updateCommitted = true;
readStatement.setString(1, user.getUUID());
try (java.sql.ResultSet result = readStatement.executeQuery()) {
if (result.next()) committedTotal = result.getInt(1);
}
}
} catch (SQLException failure) {
logFailure(failure);
} finally {
refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), points);
}
// Do not evaluate the fallback while the JDBC handle is still held. With a
// one-connection pool, getPoints() may need that same handle after a missing
// row or a failed follow-up read.
if (committedTotal != null) return new AddResult(true, committedTotal);
// A failed acquisition cannot support the fallback read either. Report the
// mutation failure without checking out a second connection and let callers
// complete their callback deterministically.
if (!updateCommitted) return new AddResult(known ? MutationOutcome.REJECTED : MutationOutcome.INDETERMINATE, 0);
// A live mode reload can change getPointsPath() while this queued write is
// running. Keep the fallback on the column that received the credit.
if (!points.equals(user.getPointsPath())) return new AddResult(true, user.getUserData().getInt(points));
return new AddResult(true, user.getPoints());
} finally {
discardPointsCache(user, points);
finishPointPublication(publication, user, points, known, refreshed);
}
// Do not evaluate the fallback while the JDBC handle is still held. With a
// one-connection pool, getPoints() may need that same handle after a missing
// row or a failed follow-up read.
if (committedTotal != null) return new AddResult(true, committedTotal);
// A failed acquisition cannot support the fallback read either. Report the
// mutation failure without checking out a second connection and let callers
// complete their callback deterministically.
if (!updateCommitted) return new AddResult(false, 0);
// A live mode reload can change getPointsPath() while this queued write is
// running. Keep the fallback on the column that received the credit.
if (!points.equals(user.getPointsPath())) return new AddResult(true, user.getUserData().getInt(points));
return new AddResult(true, user.getPoints());
}
enum MutationOutcome { CONFIRMED, REJECTED, INDETERMINATE }
record AddResult(MutationOutcome outcome, int total) {
record AddResult(MutationOutcome outcome, int total, boolean sourceRefreshed) {
AddResult(MutationOutcome outcome, int total) {
this(outcome, total, false);
}
AddResult(boolean success, int total) {
this(success ? MutationOutcome.CONFIRMED : MutationOutcome.INDETERMINATE, total);
this(success ? MutationOutcome.CONFIRMED : MutationOutcome.INDETERMINATE, total, false);
}
boolean success() { return outcome == MutationOutcome.CONFIRMED; }
}
@@ -1002,21 +1124,29 @@ final class SharedMysqlPointMutator {
}
private boolean setAbsolute(VotingPluginUser user, int value, String points) {
drainCache(user, points);
MySQL table = plugin.getMysql();
String sql = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points)
+ " = ? WHERE " + table.qi("uuid")
+ (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql)) {
statement.setInt(1, value);
statement.setString(2, user.getUUID());
return statement.executeUpdate() == 1;
} catch (SQLException failure) {
logFailure(failure);
return false;
var publication = beginPointPublication(user);
boolean known = true;
try {
drainCache(user, points);
MySQL table = plugin.getMysql();
String sql = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points)
+ " = ? WHERE " + table.qi("uuid")
+ (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql)) {
statement.setInt(1, value);
statement.setString(2, user.getUUID());
known = false;
int affected = statement.executeUpdate();
known = true;
return affected == 1;
} catch (SQLException failure) {
logFailure(failure);
return false;
}
} finally {
discardPointsCache(user, points);
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), points);
finishPointPublication(publication, user, points, known, refreshed);
}
}
@@ -1025,20 +1155,28 @@ final class SharedMysqlPointMutator {
}
private void capAt(VotingPluginUser user, int maximum, String points) {
drainCache(user, points);
MySQL table = plugin.getMysql();
String sql = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points) + " = LEAST(COALESCE("
+ table.qi(points) + ", 0), ?) WHERE " + table.qi("uuid")
+ (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql)) {
statement.setInt(1, maximum);
statement.setString(2, user.getUUID());
statement.executeUpdate();
} catch (SQLException failure) {
logFailure(failure);
PlaceHolders publication = beginPointPublication(user);
// Classify this arithmetic statement; an earlier uncertain operation stays fenced.
boolean known = true;
try {
drainCache(user, points);
MySQL table = plugin.getMysql();
String sql = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points) + " = LEAST(COALESCE("
+ table.qi(points) + ", 0), ?) WHERE " + table.qi("uuid")
+ (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql)) {
statement.setInt(1, maximum);
statement.setString(2, user.getUUID());
known = false;
statement.executeUpdate();
known = true;
} catch (SQLException failure) {
logFailure(failure);
}
} finally {
discardPointsCache(user, points);
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), points);
finishPointPublication(publication, user, points, known, refreshed);
}
}
@@ -1047,21 +1185,29 @@ final class SharedMysqlPointMutator {
}
private void addAndCapAt(VotingPluginUser user, int amount, int maximum, String points) {
drainCache(user, points);
MySQL table = plugin.getMysql();
String sql = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points) + " = LEAST(COALESCE("
+ table.qi(points) + ", 0) + ?, ?) WHERE " + table.qi("uuid")
+ (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql)) {
statement.setInt(1, amount);
statement.setInt(2, maximum);
statement.setString(3, user.getUUID());
statement.executeUpdate();
} catch (SQLException failure) {
logFailure(failure);
PlaceHolders publication = beginPointPublication(user);
// Classify this arithmetic statement; an earlier uncertain operation stays fenced.
boolean known = true;
try {
drainCache(user, points);
MySQL table = plugin.getMysql();
String sql = "UPDATE " + table.qi(table.getTableName()) + " SET " + table.qi(points) + " = LEAST(COALESCE("
+ table.qi(points) + ", 0) + ?, ?) WHERE " + table.qi("uuid")
+ (table.getDbType() == DbType.POSTGRESQL ? " = ?::uuid" : " = ?");
try (Connection connection = requireConnection(table);
PreparedStatement statement = connection.prepareStatement(sql)) {
statement.setInt(1, amount);
statement.setInt(2, maximum);
statement.setString(3, user.getUUID());
known = false;
statement.executeUpdate();
known = true;
} catch (SQLException failure) {
logFailure(failure);
}
} finally {
discardPointsCache(user, points);
boolean refreshed = SharedMysqlCacheReconciler.tryInvalidateAndRefreshOnWorker(plugin, user.getUUID(), points);
finishPointPublication(publication, user, points, known, refreshed);
}
}
@@ -1101,6 +1247,27 @@ final class SharedMysqlPointMutator {
* deliberately not discarded here because it is a distinct, later write and
* the generic absolute-value API cannot provide cross-server atomic semantics.
*/
private com.bencodez.votingplugin.placeholders.PlaceHolders beginPointPublication(VotingPluginUser user) {
var placeholders = plugin.getPlaceholders();
if (placeholders != null) placeholders.beginSharedPointDebit(UUID.fromString(user.getUUID()));
return placeholders;
}
private void finishPointPublication(com.bencodez.votingplugin.placeholders.PlaceHolders placeholders,
VotingPluginUser user, String column, boolean known, boolean refreshed) {
if (placeholders == null) return;
UUID uuid = UUID.fromString(user.getUUID());
var caches = plugin.getUserManager().getDataManager().getUserDataCache();
var cache = caches.get(uuid);
boolean available = false;
if (cache != null) synchronized (cache) {
available = known && refreshed && caches.get(uuid) == cache && cache.hasPublishedStorageSnapshot()
&& column.equals(user.getPointsPath())
&& plugin.isEnabled() && plugin.getPlaceholders() == placeholders;
}
placeholders.finishSharedPointDebit(uuid, known, available);
}
private void discardPointsCache(VotingPluginUser user) {
discardPointsCache(user, user.getPointsPath());
}
@@ -28,6 +28,14 @@ import com.bencodez.simpleapi.sql.mysql.DbType;
* settlement is a second short, idempotent transaction.</p>
*/
final class SharedPointTransferJournal {
/** Positive proof that this invocation did not attempt a points write. */
static final class PreparationFailure extends SQLException {
private static final long serialVersionUID = 1L;
PreparationFailure(SQLException cause) {
super(cause.getMessage(), cause.getSQLState(), cause.getErrorCode(), cause);
}
}
private static final String RESERVED = "RESERVED";
private static final String HOOK_STARTED = "HOOK_STARTED";
/*
@@ -144,51 +152,59 @@ final class SharedPointTransferJournal {
*/
boolean reserve(String transferId, String sourceUuid, String sourcePointsColumn, int debitPoints, String targetUuid,
int requestedCreditPoints, long now) throws SQLException {
TransferRow existing = find(transferId);
if (existing != null) {
return existing.matches(sourceUuid, targetUuid, debitPoints, requestedCreditPoints)
&& !REFUNDED.equals(existing.state);
}
String insert = "INSERT INTO " + qiJournal() + " (" + qi("transfer_id") + ", " + qi("source_uuid")
+ ", " + qi("source_points_column") + ", " + qi("target_uuid") + ", " + qi("debit_points")
+ ", " + qi("requested_credit_points") + ", " + qi("state") + ", " + qi("created_at")
+ ") VALUES (?, ?, ?, ?, ?, ?, ?, ?)";
String points = qi(sourcePointsColumn);
String debit = "UPDATE " + qi(table.getTableName()) + " SET " + points + " = " + points
+ " - ? WHERE " + qi("uuid") + uuidCast() + " AND " + points + " >= ?";
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement insertStatement = connection.prepareStatement(insert);
PreparedStatement debitStatement = connection.prepareStatement(debit)) {
insertStatement.setString(1, transferId);
insertStatement.setString(2, sourceUuid);
insertStatement.setString(3, sourcePointsColumn);
insertStatement.setString(4, targetUuid);
insertStatement.setInt(5, debitPoints);
insertStatement.setInt(6, requestedCreditPoints);
insertStatement.setString(7, RESERVED);
insertStatement.setLong(8, now);
insertStatement.executeUpdate();
debitStatement.setInt(1, debitPoints);
debitStatement.setString(2, sourceUuid);
debitStatement.setInt(3, debitPoints);
if (debitStatement.executeUpdate() != 1) {
connection.rollback();
return false;
}
return commitAndConfirm(connection, transferId, RESERVED);
} catch (SQLException failure) {
rollback(connection);
if (isDuplicate(failure)) {
closeQuietly(connection);
TransferRow duplicate = find(transferId);
return duplicate != null && duplicate.matches(sourceUuid, targetUuid, debitPoints,
requestedCreditPoints) && !REFUNDED.equals(duplicate.state);
}
throw failure;
boolean pointWriteAttempted = false;
try {
TransferRow existing = find(transferId);
if (existing != null) {
return existing.matches(sourceUuid, targetUuid, debitPoints, requestedCreditPoints)
&& !REFUNDED.equals(existing.state);
}
String insert = "INSERT INTO " + qiJournal() + " (" + qi("transfer_id") + ", " + qi("source_uuid")
+ ", " + qi("source_points_column") + ", " + qi("target_uuid") + ", " + qi("debit_points")
+ ", " + qi("requested_credit_points") + ", " + qi("state") + ", " + qi("created_at")
+ ") VALUES (?, ?, ?, ?, ?, ?, ?, ?)";
String points = qi(sourcePointsColumn);
String debit = "UPDATE " + qi(table.getTableName()) + " SET " + points + " = " + points
+ " - ? WHERE " + qi("uuid") + uuidCast() + " AND " + points + " >= ?";
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement insertStatement = connection.prepareStatement(insert);
PreparedStatement debitStatement = connection.prepareStatement(debit)) {
insertStatement.setString(1, transferId);
insertStatement.setString(2, sourceUuid);
insertStatement.setString(3, sourcePointsColumn);
insertStatement.setString(4, targetUuid);
insertStatement.setInt(5, debitPoints);
insertStatement.setInt(6, requestedCreditPoints);
insertStatement.setString(7, RESERVED);
insertStatement.setLong(8, now);
insertStatement.executeUpdate();
debitStatement.setInt(1, debitPoints);
debitStatement.setString(2, sourceUuid);
debitStatement.setInt(3, debitPoints);
pointWriteAttempted = true;
if (debitStatement.executeUpdate() != 1) {
connection.rollback();
return false;
}
return commitAndConfirm(connection, transferId, RESERVED);
} catch (SQLException failure) {
rollback(connection);
if (isDuplicate(failure)) {
closeQuietly(connection);
TransferRow duplicate = find(transferId);
return duplicate != null && duplicate.matches(sourceUuid, targetUuid, debitPoints,
requestedCreditPoints) && !REFUNDED.equals(duplicate.state);
}
throw failure;
}
}
} catch (SQLException failure) {
if (failure instanceof PreparationFailure) throw failure;
if (!pointWriteAttempted) throw new PreparationFailure(failure);
throw failure;
}
}
@@ -286,42 +302,50 @@ final class SharedPointTransferJournal {
*/
boolean refundReserved(String transferId, String sourceUuid, String sourcePointsColumn, int debitPoints)
throws SQLException {
if (!isSafeColumn(sourcePointsColumn)) return false;
String select = "SELECT " + qi("state") + " FROM " + qiJournal() + " WHERE " + qi("transfer_id")
+ " = ? FOR UPDATE";
String points = qi(sourcePointsColumn);
String refund = "UPDATE " + qi(table.getTableName()) + " SET " + points + " = " + points
+ " + ? WHERE " + qi("uuid") + uuidCast();
String update = "UPDATE " + qiJournal() + " SET " + qi("state") + " = ? WHERE " + qi("transfer_id")
+ " = ?";
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement selectStatement = connection.prepareStatement(select)) {
selectStatement.setString(1, transferId);
try (ResultSet result = selectStatement.executeQuery()) {
if (!result.next() || !RESERVED.equals(result.getString(1))) {
boolean pointWriteAttempted = false;
try {
if (!isSafeColumn(sourcePointsColumn)) return false;
String select = "SELECT " + qi("state") + " FROM " + qiJournal() + " WHERE " + qi("transfer_id")
+ " = ? FOR UPDATE";
String points = qi(sourcePointsColumn);
String refund = "UPDATE " + qi(table.getTableName()) + " SET " + points + " = " + points
+ " + ? WHERE " + qi("uuid") + uuidCast();
String update = "UPDATE " + qiJournal() + " SET " + qi("state") + " = ? WHERE " + qi("transfer_id")
+ " = ?";
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement selectStatement = connection.prepareStatement(select)) {
selectStatement.setString(1, transferId);
try (ResultSet result = selectStatement.executeQuery()) {
if (!result.next() || !RESERVED.equals(result.getString(1))) {
connection.rollback();
return false;
}
}
}
try (PreparedStatement refundStatement = connection.prepareStatement(refund)) {
refundStatement.setInt(1, debitPoints);
refundStatement.setString(2, sourceUuid);
pointWriteAttempted = true;
if (refundStatement.executeUpdate() != 1) {
connection.rollback();
return false;
}
}
}
try (PreparedStatement refundStatement = connection.prepareStatement(refund)) {
refundStatement.setInt(1, debitPoints);
refundStatement.setString(2, sourceUuid);
if (refundStatement.executeUpdate() != 1) {
connection.rollback();
return false;
try (PreparedStatement updateStatement = connection.prepareStatement(update)) {
updateStatement.setString(1, REFUNDED);
updateStatement.setString(2, transferId);
if (updateStatement.executeUpdate() != 1) {
connection.rollback();
return false;
}
}
return commitAndConfirm(connection, transferId, REFUNDED);
}
try (PreparedStatement updateStatement = connection.prepareStatement(update)) {
updateStatement.setString(1, REFUNDED);
updateStatement.setString(2, transferId);
if (updateStatement.executeUpdate() != 1) {
connection.rollback();
return false;
}
}
return commitAndConfirm(connection, transferId, REFUNDED);
} catch (SQLException failure) {
if (failure instanceof PreparationFailure) throw failure;
if (!pointWriteAttempted) throw new PreparationFailure(failure);
throw failure;
}
}
@@ -340,6 +364,7 @@ final class SharedPointTransferJournal {
+ " + ? WHERE " + qi("uuid") + uuidCast();
String update = "UPDATE " + qiJournal() + " SET " + qi("state") + " = ? WHERE " + qi("transfer_id")
+ " = ?";
boolean pointWriteAttempted = false;
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement selectStatement = connection.prepareStatement(select)) {
@@ -363,6 +388,7 @@ final class SharedPointTransferJournal {
try (PreparedStatement refundStatement = connection.prepareStatement(refund)) {
refundStatement.setInt(1, debitPoints);
refundStatement.setString(2, sourceUuid);
pointWriteAttempted = true;
if (refundStatement.executeUpdate() != 1) {
connection.rollback();
return false;
@@ -378,6 +404,7 @@ final class SharedPointTransferJournal {
}
return commitAndConfirm(connection, transferId, REFUNDED);
} catch (SQLException failure) {
if (!pointWriteAttempted) throw new PreparationFailure(failure);
throw failure;
}
}
@@ -2,7 +2,11 @@ package com.bencodez.votingplugin.user;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.UUID;
import java.util.UUID;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import com.bencodez.votingplugin.placeholders.PlaceholderPlayerPresence.LiveIdentity;
import org.bukkit.OfflinePlayer;
import org.bukkit.entity.Player;
@@ -22,7 +26,8 @@ import com.bencodez.votingplugin.topvoter.TopVoter;
* Manages VotingPlugin user operations and data.
*/
public class UserManager {
private VotingPluginMain plugin;
private VotingPluginMain plugin;
private final Set<UUID> warnedOfflineUuidPlayers = ConcurrentHashMap.newKeySet();
private boolean sharedPointTransferRecoveryScheduled;
/**
@@ -257,18 +262,50 @@ public class UserManager {
* Gets a VotingPluginUser by UUID.
* @param uuid the player UUID
* @return the VotingPluginUser
* @deprecated UUID-only lookups can be ambiguous in offline mode because Minecraft
* preserves name capitalization, while VotingPlugin derives its
* offline UUID from the player name lowercased with Locale.ROOT.
* Prefer {@link #getVotingPluginUser(UUID, String)} when both UUID
* and player name are available; supplying the name allows the
* existing offline UUID normalization. Use
* {@link #getVotingPluginUser(Player)} for an online player,
* {@link #getVotingPluginUser(OfflinePlayer)} when an offline
* player object with a known name is available, or
* {@link #getVotingPluginUser(String)} when only the name is known.
*/
@Deprecated
@SuppressWarnings("deprecation")
public VotingPluginUser getVotingPluginUser(UUID uuid) {
return new VotingPluginUser(plugin, uuid);
LiveIdentity identity = offlineLiveIdentity(uuid);
if (identity == null) return new VotingPluginUser(plugin, uuid);
VotingPluginUser user = new VotingPluginUser(plugin, identity.storageUuid(), false);
user.setPlayerName(identity.playerName());
warnOfflineUuidCorrection(uuid, identity);
return user;
}
/**
* Gets a VotingPluginUser by UUID with optional name loading.
* Gets a VotingPluginUser by exact storage UUID with optional name loading.
* This overload preserves the supplied key for storage iteration, recovery
* and administrative operations, even when loadName is true.
* @param uuid the player UUID
* @param loadName whether to load the player name
* @return the VotingPluginUser
* @deprecated UUID-only lookups can be ambiguous in offline mode because Minecraft
* preserves name capitalization, while VotingPlugin derives its
* offline UUID from the player name lowercased with Locale.ROOT.
* Prefer {@link #getVotingPluginUser(UUID, String)} when both UUID
* and player name are available; supplying the name allows the
* existing offline UUID normalization. Use
* {@link #getVotingPluginUser(Player)} for an online player,
* {@link #getVotingPluginUser(OfflinePlayer)} when an offline
* player object with a known name is available, or
* {@link #getVotingPluginUser(String)} when only the name is known.
* Retain this overload when the exact stored UUID and explicit
* name-loading behavior are required; name-aware alternatives
* may normalize the supplied identity in offline mode.
*/
@Deprecated
@SuppressWarnings("deprecation")
public VotingPluginUser getVotingPluginUser(UUID uuid, boolean loadName) {
return new VotingPluginUser(plugin, uuid, loadName);
@@ -285,6 +322,24 @@ public class UserManager {
return new VotingPluginUser(plugin, uuid, playerName);
}
/** Resolve only immutable live identity captured by the presence lifecycle. */
private LiveIdentity offlineLiveIdentity(UUID uuid) {
if (plugin.getOptions().isOnlineMode()) return null;
var presence = plugin.getPlaceholderPlayerPresence();
LiveIdentity identity = presence == null ? null : presence.liveIdentity(uuid);
if (identity == null || identity.serverUuid() == null || identity.storageUuid() == null
|| identity.playerName() == null || identity.playerName().isBlank()) return null;
return identity;
}
private void warnOfflineUuidCorrection(UUID uuid, LiveIdentity identity) {
if (!uuid.equals(identity.storageUuid()) && warnedOfflineUuidPlayers.add(identity.storageUuid())) {
plugin.getLogger().warning("Offline UUID compatibility workaround used for " + identity.playerName()
+ ". Server UUID: " + identity.serverUuid() + " -> VotingPlugin UUID: " + identity.storageUuid()
+ ". Applied for third-party compatibility: a plugin may be using the server UUID instead of VotingPlugin's UUID.");
}
}
/**
* Purges old players with no voting data.
*/
File diff suppressed because it is too large. Load diff
@@ -18,6 +18,19 @@ public final class BukkitCompletionScheduler {
public static boolean isSuccessfulEntityTaskResult(Object status) {
return status instanceof Enum<?> result && "SUCCESS".equals(result.name());
}
/** Event flags are not a reliable execution-context check, including Folia region threads. */
public static boolean isPlatformOwnedThread() {
try { if (org.bukkit.Bukkit.isPrimaryThread()) return true; } catch (RuntimeException ignored) { }
Object server = org.bukkit.Bukkit.getServer();
if (server != null) try {
if (Boolean.TRUE.equals(server.getClass().getMethod("isGlobalTickThread").invoke(server))) return true;
} catch (ReflectiveOperationException | RuntimeException ignored) { }
for (String name : new String[] { "ca.spottedleaf.moonrise.common.util.TickThread", "io.papermc.paper.util.TickThread" }) try {
if (Boolean.TRUE.equals(Class.forName(name).getMethod("isTickThread").invoke(null))) return true;
} catch (ReflectiveOperationException | LinkageError | RuntimeException ignored) { }
return false;
}
private BukkitCompletionScheduler() {
}
@@ -0,0 +1,217 @@
package com.bencodez.votingplugin.util;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.HexFormat;
import java.util.Locale;
import java.util.Properties;
import java.util.UUID;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
/** Memory-only admission for participating plugin generations sharing one server-data path in a JVM. */
public final class ServerDataPublicationFence {
private static final String PREFIX = "com.bencodez.votingplugin.ServerDataPublicationFence.owner.";
private static final int MAX_OWNERS = 1024;
private final Properties registry;
private final String key;
private final String generation;
private final AtomicBoolean retirementStarted = new AtomicBoolean();
private final java.util.concurrent.CompletableFuture<Void> retirementCompleted = new java.util.concurrent.CompletableFuture<>();
private final CompletableFuture<Long> processShutdownStarted = new CompletableFuture<>();
private final CompletableFuture<Void> processExitCompletion = new CompletableFuture<>();
private final AtomicBoolean processHookRemoved = new AtomicBoolean();
private volatile Runtime processRuntime;
private volatile Thread processHook;
/** Opt in during startup, before the JVM can begin invoking shutdown hooks. */
public synchronized void retainForProcessExit() {
if (processHook != null) return;
var runtime = Runtime.getRuntime();
var hook = new Thread(this::awaitProcessExit, "VotingPlugin-ServerData-Exit");
runtime.addShutdownHook(hook);
processRuntime = runtime;
processHook = hook;
processExitCompletion.whenComplete((ignored, failure) -> removeProcessHook());
}
/** The first disable entry fixes the deadline; retries cannot renew it. No caller wait. */
public void beginShutdown(long startedNanos) {
if (processShutdownStarted.complete(startedNanos) && processHook != null) {
CompletableFuture.delayedExecutor(remainingProcessWait(startedNanos), TimeUnit.NANOSECONDS)
.execute(this::removeProcessHook);
}
}
private static long remainingProcessWait(long startedNanos) {
long elapsed = Math.max(0L, System.nanoTime() - startedNanos);
return Math.max(0L, TimeUnit.SECONDS.toNanos(15) - elapsed);
}
private void awaitProcessExit() {
long exitStarted = System.nanoTime();
try {
long disableStarted = processShutdownStarted.get(remainingProcessWait(exitStarted), TimeUnit.NANOSECONDS);
long remaining = Math.min(remainingProcessWait(exitStarted), remainingProcessWait(disableStarted));
if (remaining > 0) processExitCompletion.get(remaining, TimeUnit.NANOSECONDS);
} catch (InterruptedException interrupted) {
Thread.currentThread().interrupt();
} catch (ExecutionException | TimeoutException pendingOrExpired) {
// Process exit is bounded. Timeout does not acknowledge publication or release a lease.
}
}
private void removeProcessHook() {
var hook = processHook;
if (hook == null || !processHookRemoved.compareAndSet(false, true)) return;
try { processRuntime.removeShutdownHook(hook); }
catch (IllegalStateException stopping) { /* The JVM is already invoking its hooks. */ }
}
private ServerDataPublicationFence(Properties registry, String key, String generation) {
this.registry = registry;
this.key = key;
this.generation = generation;
}
/** Runs before platform initialization and performs no filesystem operation or wait for storage. */
public static ServerDataPublicationFence beginGeneration(Path file) {
String identity = file.toAbsolutePath().normalize().toString();
if (DurableFiles.isWindowsName(System.getProperty("os.name", ""))) identity = identity.toLowerCase(Locale.ROOT);
String key;
try {
key = PREFIX + HexFormat.of().formatHex(MessageDigest.getInstance("SHA-256")
.digest(identity.getBytes(StandardCharsets.UTF_8)));
} catch (NoSuchAlgorithmException unavailable) { throw new IllegalStateException(unavailable); }
Properties registry = System.getProperties();
synchronized (registry) {
Object value = registry.get(key);
if (value != null) {
State previous = state(value);
if (previous.users != 0 || !previous.retiring)
throw new IllegalStateException("Previous server-data generation still owns storage work; replacement was not started");
} else if (registry.keySet().stream().filter(k -> k instanceof String s && s.startsWith(PREFIX)).count() >= MAX_OWNERS) {
throw new IllegalStateException("Server-data publication owner capacity is unavailable");
}
String generation = UUID.randomUUID().toString();
registry.setProperty(key, generation + ":0:false");
return new ServerDataPublicationFence(registry, key, generation);
}
}
/** Hold through the entire operation, including a blocked write or admitted shutdown handoff. */
public Lease acquire() {
synchronized (registry) {
State current = current();
if (current.users >= MAX_OWNERS) throw new IllegalStateException("Server-data publication admission is unavailable");
registry.setProperty(key, generation + ":" + (current.users + 1) + ":" + current.retiring);
return new Lease(this);
}
}
/** Existing operations/retries retain ownership; a successor requires zero outstanding leases. */
public void retire() {
boolean drained = false;
synchronized (registry) {
State current = state(registry.get(key));
if (generation.equals(current.generation)) {
registry.setProperty(key, generation + ":" + current.users + ":true");
drained = current.users == 0;
}
}
// Completion callbacks may remove a JVM hook; never run them under the registry monitor.
if (drained) processExitCompletion.complete(null);
}
/** Reserve before asynchronous admission; a failed stage never proves drain. */
public void retainUntilSuccessfulPublication(java.util.concurrent.CompletionStage<Void> publication) {
java.util.Objects.requireNonNull(publication);
Lease lease = acquire();
publication.whenComplete((ignored, failure) -> {
if (failure == null) lease.close();
});
}
/** Reserve before disable and release only after existing SDK writers actually terminate. */
public java.util.concurrent.CompletionStage<Void> retainUntilTermination(java.util.concurrent.ScheduledExecutorService[] writers) {
var snapshot = writers.clone();
if (!retirementStarted.compareAndSet(false, true)) return retirementCompleted.minimalCompletionStage();
Lease lease;
try { lease = acquire(); }
catch (RuntimeException | Error failure) { retirementStarted.set(false); throw failure; }
try {
Thread guardian = new Thread(() -> {
boolean interrupted = false;
try (lease) {
for (var writer : snapshot) {
if (writer == null) continue;
while (!writer.isTerminated()) {
try { writer.awaitTermination(100, java.util.concurrent.TimeUnit.MILLISECONDS); }
catch (InterruptedException ignored) { interrupted = true; }
}
}
} catch (RuntimeException | Error failure) {
retirementCompleted.completeExceptionally(failure);
return;
} finally { if (interrupted) Thread.currentThread().interrupt(); }
retirementCompleted.complete(null);
}, "VotingPlugin-server-data-retirement");
guardian.setDaemon(true);
guardian.start();
} catch (RuntimeException | Error failure) {
try { lease.close(); }
catch (RuntimeException | Error cleanupFailure) { if (cleanupFailure != failure) failure.addSuppressed(cleanupFailure); }
finally { retirementStarted.set(false); }
throw failure;
}
return retirementCompleted.minimalCompletionStage();
}
private State current() {
State current = state(registry.get(key));
if (registry != System.getProperties() || !generation.equals(current.generation))
throw new IllegalStateException("Server-data publication belongs to another generation");
return current;
}
private static State state(Object value) {
if (!(value instanceof String text) || text.length() > 64)
throw new IllegalStateException("Server-data publication ownership is invalid");
String[] fields = text.split(":", -1);
try {
if (fields.length != 3 || !UUID.fromString(fields[0]).toString().equals(fields[0])
|| !(fields[2].equals("true") || fields[2].equals("false"))) throw new IllegalArgumentException();
int users = Integer.parseInt(fields[1]);
if (users < 0 || users > MAX_OWNERS || !Integer.toString(users).equals(fields[1])) throw new IllegalArgumentException();
return new State(fields[0], users, Boolean.parseBoolean(fields[2]));
} catch (IllegalArgumentException invalid) {
throw new IllegalStateException("Server-data publication ownership is invalid");
}
}
private record State(String generation, int users, boolean retiring) { }
public static final class Lease implements AutoCloseable {
private final ServerDataPublicationFence owner;
private final AtomicBoolean closed = new AtomicBoolean();
private Lease(ServerDataPublicationFence owner) { this.owner = owner; }
@Override public void close() {
boolean drained;
synchronized (owner.registry) {
if (closed.get()) return;
State current = owner.current();
if (current.users <= 0) throw new IllegalStateException("Server-data publication ownership is invalid");
owner.registry.setProperty(owner.key, owner.generation + ":" + (current.users - 1) + ":" + current.retiring);
closed.set(true);
drained = current.retiring && current.users == 1;
}
if (drained) owner.processExitCompletion.complete(null);
}
}
}
@@ -13,11 +13,12 @@ public final class VoteTaskAdmission {
/**
* Attempts to submit a one-shot vote task without running it on the caller.
*
* @param executor bounded vote executor
* @param executor bounded vote executor, or null before startup/after shutdown
* @param task task to submit
* @return true when the task was admitted
*/
public static boolean trySubmit(ScheduledExecutorService executor, Runnable task) {
if (executor == null) return false;
try {
executor.submit(task);
return true;
@@ -29,13 +30,14 @@ public final class VoteTaskAdmission {
/**
* Attempts to schedule a one-shot vote task without blocking the caller.
*
* @param executor bounded vote executor
* @param executor bounded vote executor, or null before startup/after shutdown
* @param task task to schedule
* @param delay delay before execution
* @param unit delay unit
* @return true when the task was admitted
*/
public static boolean trySchedule(ScheduledExecutorService executor, Runnable task, long delay, TimeUnit unit) {
if (executor == null) return false;
try {
executor.schedule(task, delay, unit);
return true;
@@ -29,6 +29,14 @@ import com.bencodez.simpleapi.sql.mysql.DbType;
* arbitrary, non-idempotent side effects.</p>
*/
final class SharedMysqlPurchaseJournal {
/** Positive proof that this invocation did not attempt a points write. */
static final class PreparationFailure extends SQLException {
private static final long serialVersionUID = 1L;
PreparationFailure(SQLException cause) {
super(cause.getMessage(), cause.getSQLState(), cause.getErrorCode(), cause);
}
}
private static final String PENDING = "PENDING";
private static final String HOOK_STARTED = "HOOK_STARTED";
private static final String COMPENSATING = "COMPENSATING";
@@ -119,60 +127,68 @@ final class SharedMysqlPurchaseJournal {
/** Atomically records a pending purchase and conditionally charges it. */
boolean reserve(String purchaseId, String uuid, String pointsColumn, String limitColumn, int cost, int limit,
String limitGeneration, long limitGenerationExpiresAt, long now) throws SQLException {
String insert = "INSERT INTO " + qiJournal() + " (" + qi("purchase_id") + ", " + qi("player_uuid")
+ ", " + qi("points_column") + ", " + qi("limit_column") + ", " + qi("cost") + ", "
+ qi("limit_value") + ", " + qi("limit_generation") + ", "
+ qi("limit_generation_expires_at") + ", " + qi("limit_epoch") + ", " + qi("state")
+ ", " + qi("created_at") + ") VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
String points = qi(pointsColumn);
StringBuilder debit = new StringBuilder("UPDATE ").append(qi(table.getTableName())).append(" SET ")
.append(points).append(" = COALESCE(").append(points).append(", 0) - ?");
if (limitColumn != null) {
debit.append(", ").append(qi(limitColumn)).append(" = COALESCE(").append(qi(limitColumn))
.append(", 0) + 1");
}
debit.append(" WHERE ").append(qi("uuid")).append(uuidCast()).append(" AND COALESCE(").append(points)
.append(", 0) >= ?");
if (limitColumn != null) {
debit.append(" AND COALESCE(").append(qi(limitColumn)).append(", 0) < ?");
}
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try {
Long limitEpoch = limitColumn == null ? null : lockLimitEpoch(connection, limitColumn);
try (PreparedStatement insertStatement = connection.prepareStatement(insert);
PreparedStatement debitStatement = connection.prepareStatement(debit.toString())) {
insertStatement.setString(1, purchaseId);
insertStatement.setString(2, uuid);
insertStatement.setString(3, pointsColumn);
insertStatement.setString(4, limitColumn);
insertStatement.setInt(5, cost);
if (limitColumn == null) insertStatement.setNull(6, java.sql.Types.INTEGER);
else insertStatement.setInt(6, limit);
if (limitGeneration == null) insertStatement.setNull(7, java.sql.Types.VARCHAR);
else insertStatement.setString(7, limitGeneration);
if (limitGenerationExpiresAt <= 0L) insertStatement.setNull(8, java.sql.Types.BIGINT);
else insertStatement.setLong(8, limitGenerationExpiresAt);
if (limitEpoch == null) insertStatement.setNull(9, java.sql.Types.BIGINT);
else insertStatement.setLong(9, limitEpoch.longValue());
insertStatement.setString(10, PENDING);
insertStatement.setLong(11, now);
insertStatement.executeUpdate();
debitStatement.setInt(1, cost);
debitStatement.setString(2, uuid);
debitStatement.setInt(3, cost);
if (limitColumn != null) debitStatement.setInt(4, limit);
if (debitStatement.executeUpdate() != 1) {
rollback(connection);
return false;
}
return commitAndConfirm(connection, purchaseId, PENDING);
}
} catch (SQLException failure) {
rollback(connection);
throw failure;
boolean pointWriteAttempted = false;
try {
String insert = "INSERT INTO " + qiJournal() + " (" + qi("purchase_id") + ", " + qi("player_uuid")
+ ", " + qi("points_column") + ", " + qi("limit_column") + ", " + qi("cost") + ", "
+ qi("limit_value") + ", " + qi("limit_generation") + ", "
+ qi("limit_generation_expires_at") + ", " + qi("limit_epoch") + ", " + qi("state")
+ ", " + qi("created_at") + ") VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
String points = qi(pointsColumn);
StringBuilder debit = new StringBuilder("UPDATE ").append(qi(table.getTableName())).append(" SET ")
.append(points).append(" = COALESCE(").append(points).append(", 0) - ?");
if (limitColumn != null) {
debit.append(", ").append(qi(limitColumn)).append(" = COALESCE(").append(qi(limitColumn))
.append(", 0) + 1");
}
debit.append(" WHERE ").append(qi("uuid")).append(uuidCast()).append(" AND COALESCE(").append(points)
.append(", 0) >= ?");
if (limitColumn != null) {
debit.append(" AND COALESCE(").append(qi(limitColumn)).append(", 0) < ?");
}
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try {
Long limitEpoch = limitColumn == null ? null : lockLimitEpoch(connection, limitColumn);
try (PreparedStatement insertStatement = connection.prepareStatement(insert);
PreparedStatement debitStatement = connection.prepareStatement(debit.toString())) {
insertStatement.setString(1, purchaseId);
insertStatement.setString(2, uuid);
insertStatement.setString(3, pointsColumn);
insertStatement.setString(4, limitColumn);
insertStatement.setInt(5, cost);
if (limitColumn == null) insertStatement.setNull(6, java.sql.Types.INTEGER);
else insertStatement.setInt(6, limit);
if (limitGeneration == null) insertStatement.setNull(7, java.sql.Types.VARCHAR);
else insertStatement.setString(7, limitGeneration);
if (limitGenerationExpiresAt <= 0L) insertStatement.setNull(8, java.sql.Types.BIGINT);
else insertStatement.setLong(8, limitGenerationExpiresAt);
if (limitEpoch == null) insertStatement.setNull(9, java.sql.Types.BIGINT);
else insertStatement.setLong(9, limitEpoch.longValue());
insertStatement.setString(10, PENDING);
insertStatement.setLong(11, now);
insertStatement.executeUpdate();
debitStatement.setInt(1, cost);
debitStatement.setString(2, uuid);
debitStatement.setInt(3, cost);
if (limitColumn != null) debitStatement.setInt(4, limit);
pointWriteAttempted = true;
if (debitStatement.executeUpdate() != 1) {
rollback(connection);
return false;
}
return commitAndConfirm(connection, purchaseId, PENDING);
}
} catch (SQLException failure) {
rollback(connection);
throw failure;
}
}
} catch (SQLException failure) {
if (failure instanceof PreparationFailure) throw failure;
if (!pointWriteAttempted) throw new PreparationFailure(failure);
throw failure;
}
}
@@ -370,65 +386,73 @@ final class SharedMysqlPurchaseJournal {
private RefundedPurchase setTerminalDetails(String purchaseId, String terminalState, long now,
String... refundableStates)
throws SQLException {
boolean refund = REFUNDED.equals(terminalState);
String refundedUuid = null;
String refundedPointsColumn = null;
String refundedLimitColumn = null;
String select = "SELECT " + qi("state") + ", " + qi("player_uuid") + ", " + qi("points_column")
+ ", " + qi("limit_column") + ", " + qi("cost") + ", " + qi("limit_generation") + ", "
+ qi("limit_generation_expires_at") + ", " + qi("limit_epoch") + " FROM " + qiJournal() + " WHERE "
+ qi("purchase_id") + " = ? FOR UPDATE";
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement selectStatement = connection.prepareStatement(select)) {
selectStatement.setString(1, purchaseId);
try (ResultSet result = selectStatement.executeQuery()) {
if (!result.next()) {
rollback(connection);
return null;
}
String state = result.getString(1);
if (COMPLETED.equals(state) || REFUNDED.equals(state)) {
rollback(connection);
return terminalState.equals(state) ? new RefundedPurchase(null, null, null) : null;
}
if (refund && !isRefundableState(state, refundableStates)) {
rollback(connection);
return null;
}
if (!refund && !HOOK_STARTED.equals(state)) {
rollback(connection);
return null;
}
String uuid = result.getString(2);
String pointsColumn = result.getString(3);
String limitColumn = result.getString(4);
refundedUuid = uuid;
refundedPointsColumn = pointsColumn;
refundedLimitColumn = limitColumn;
int cost = result.getInt(5);
String limitGeneration = result.getString(6);
Long limitEpoch = nullableLong(result, 8);
if (refund) {
refund(connection, uuid, pointsColumn, limitColumn, cost,
shouldRefundLimit(connection, limitColumn, limitGeneration, limitEpoch));
boolean pointWriteAttempted = false;
try {
boolean refund = REFUNDED.equals(terminalState);
String refundedUuid = null;
String refundedPointsColumn = null;
String refundedLimitColumn = null;
String select = "SELECT " + qi("state") + ", " + qi("player_uuid") + ", " + qi("points_column")
+ ", " + qi("limit_column") + ", " + qi("cost") + ", " + qi("limit_generation") + ", "
+ qi("limit_generation_expires_at") + ", " + qi("limit_epoch") + " FROM " + qiJournal() + " WHERE "
+ qi("purchase_id") + " = ? FOR UPDATE";
try (Connection connection = connection()) {
connection.setAutoCommit(false);
try (PreparedStatement selectStatement = connection.prepareStatement(select)) {
selectStatement.setString(1, purchaseId);
try (ResultSet result = selectStatement.executeQuery()) {
if (!result.next()) {
rollback(connection);
return null;
}
String state = result.getString(1);
if (COMPLETED.equals(state) || REFUNDED.equals(state)) {
rollback(connection);
return terminalState.equals(state) ? new RefundedPurchase(null, null, null) : null;
}
if (refund && !isRefundableState(state, refundableStates)) {
rollback(connection);
return null;
}
if (!refund && !HOOK_STARTED.equals(state)) {
rollback(connection);
return null;
}
String uuid = result.getString(2);
String pointsColumn = result.getString(3);
String limitColumn = result.getString(4);
refundedUuid = uuid;
refundedPointsColumn = pointsColumn;
refundedLimitColumn = limitColumn;
int cost = result.getInt(5);
String limitGeneration = result.getString(6);
Long limitEpoch = nullableLong(result, 8);
if (refund) {
boolean refundLimit = shouldRefundLimit(connection, limitColumn, limitGeneration, limitEpoch);
pointWriteAttempted = true;
refund(connection, uuid, pointsColumn, limitColumn, cost, refundLimit);
}
}
}
}
String update = "UPDATE " + qiJournal() + " SET " + qi("state") + " = ? WHERE " + qi("purchase_id")
+ " = ?";
try (PreparedStatement updateStatement = connection.prepareStatement(update)) {
updateStatement.setString(1, terminalState);
updateStatement.setString(2, purchaseId);
if (updateStatement.executeUpdate() != 1) {
rollback(connection);
return null;
String update = "UPDATE " + qiJournal() + " SET " + qi("state") + " = ? WHERE " + qi("purchase_id")
+ " = ?";
try (PreparedStatement updateStatement = connection.prepareStatement(update)) {
updateStatement.setString(1, terminalState);
updateStatement.setString(2, purchaseId);
if (updateStatement.executeUpdate() != 1) {
rollback(connection);
return null;
}
}
if (!commitAndConfirm(connection, purchaseId, terminalState)) return null;
return refund ? new RefundedPurchase(refundedUuid, refundedPointsColumn, refundedLimitColumn)
: new RefundedPurchase(null, null, null);
} catch (SQLException failure) {
throw failure;
}
if (!commitAndConfirm(connection, purchaseId, terminalState)) return null;
return refund ? new RefundedPurchase(refundedUuid, refundedPointsColumn, refundedLimitColumn)
: new RefundedPurchase(null, null, null);
} catch (SQLException failure) {
if (failure instanceof PreparationFailure) throw failure;
if (!pointWriteAttempted) throw new PreparationFailure(failure);
throw failure;
}
}
@@ -442,20 +466,28 @@ final class SharedMysqlPurchaseJournal {
private void refund(Connection connection, String uuid, String pointsColumn, String limitColumn, int cost,
boolean refundLimit) throws SQLException {
if (!isSafeColumn(pointsColumn) || (limitColumn != null && !isSafeColumn(limitColumn))) {
throw new SQLException("Unsafe durable purchase column");
}
StringBuilder refund = new StringBuilder("UPDATE ").append(qi(table.getTableName())).append(" SET ")
.append(qi(pointsColumn)).append(" = ").append(qi(pointsColumn)).append(" + ?");
if (refundLimit) {
refund.append(", ").append(qi(limitColumn)).append(" = GREATEST(COALESCE(").append(qi(limitColumn))
.append(", 0) - 1, 0)");
}
refund.append(" WHERE ").append(qi("uuid")).append(uuidCast());
try (PreparedStatement statement = connection.prepareStatement(refund.toString())) {
statement.setInt(1, cost);
statement.setString(2, uuid);
if (statement.executeUpdate() != 1) throw new SQLException("Purchase refund player missing");
boolean pointWriteAttempted = false;
try {
if (!isSafeColumn(pointsColumn) || (limitColumn != null && !isSafeColumn(limitColumn))) {
throw new SQLException("Unsafe durable purchase column");
}
StringBuilder refund = new StringBuilder("UPDATE ").append(qi(table.getTableName())).append(" SET ")
.append(qi(pointsColumn)).append(" = ").append(qi(pointsColumn)).append(" + ?");
if (refundLimit) {
refund.append(", ").append(qi(limitColumn)).append(" = GREATEST(COALESCE(").append(qi(limitColumn))
.append(", 0) - 1, 0)");
}
refund.append(" WHERE ").append(qi("uuid")).append(uuidCast());
try (PreparedStatement statement = connection.prepareStatement(refund.toString())) {
statement.setInt(1, cost);
statement.setString(2, uuid);
pointWriteAttempted = true;
if (statement.executeUpdate() != 1) throw new SQLException("Purchase refund player missing");
}
} catch (SQLException failure) {
if (failure instanceof PreparationFailure) throw failure;
if (!pointWriteAttempted) throw new PreparationFailure(failure);
throw failure;
}
}
@@ -186,15 +186,24 @@ public class VoteShopPurchaseService {
// or entity task runs could pair an old debit with a newly loaded reward.
FileConfiguration shopData = plugin.getShopFile().getData();
HashMap<String, String> placeholders = purchasePlaceholders(item);
var pointPlaceholders = plugin.getPlaceholders();
Consumer<Boolean> admission = pointPlaceholders == null ? null
: pointPlaceholders.sharedPointAdmissionCompletion(UUID.fromString(user.getUUID()));
try {
plugin.getTimer().execute(() -> {
try {
SharedPurchaseDebit debit;
synchronized (purchaseLock(user.getUUID())) {
// Sample the reset window beside the conditional debit. A queued
// persistence task may otherwise cross into a new limit period.
debit = reserveSharedMysqlPurchase(user, item,
limitGeneration(item, System.currentTimeMillis()));
boolean settled = false;
try {
synchronized (purchaseLock(user.getUUID())) {
// Sample the reset window beside the conditional debit. A queued
// persistence task may otherwise cross into a new limit period.
debit = reserveSharedMysqlPurchase(user, item,
limitGeneration(item, System.currentTimeMillis()));
}
settled = true;
} finally {
if (admission != null) admission.accept(settled);
}
if (debit.result() != VoteShopPurchaseResult.SUCCESS) {
completePurchaseResult(player, completion, debit.result());
@@ -207,6 +216,7 @@ public class VoteShopPurchaseService {
}
});
} catch (RuntimeException persistenceRejected) {
if (admission != null) admission.accept(false);
plugin.debug(persistenceRejected);
completeFailedPurchase(player, completion);
}
@@ -479,20 +489,29 @@ public class VoteShopPurchaseService {
}
private void refundCompensatingMysqlDebit(VotingPluginUser user, SharedPurchaseDebit debit) {
var publication = plugin.getPlaceholders();
UUID uuid = publication == null ? null : UUID.fromString(user.getUUID());
if (publication != null) publication.beginSharedPointDebit(uuid);
boolean known = false;
try {
if (debit.journal().refundCompensatingReward(debit.purchaseId())) {
refreshPurchaseCache(user, debit.pointsColumn(), debit.limitColumn());
}
debit.journal().refundCompensatingReward(debit.purchaseId());
known = true;
} catch (SQLException failure) {
known = failure instanceof SharedMysqlPurchaseJournal.PreparationFailure;
// A commit/confirmation failure is indeterminate: the refund transaction
// may have committed even though this worker could not observe its terminal
// journal state. Drop the affected snapshots before any later cache dump so
// a stale debit cannot overwrite a durable refund. Recovery will reconcile
// the journal state if the transaction did not commit.
refreshPurchaseCache(user, debit.pointsColumn(), debit.limitColumn());
plugin.getLogger().severe("Unable to refund an incomplete vote shop purchase: "
+ failure.getClass().getSimpleName());
plugin.debug(failure);
} finally {
try {
refreshPurchaseCache(user, debit.pointsColumn(), debit.limitColumn());
} finally {
if (publication != null) publication.finishSharedPointDebit(uuid, known, false);
}
}
}
@@ -738,37 +757,50 @@ public class VoteShopPurchaseService {
private SharedPurchaseDebit reserveSharedMysqlPurchase(VotingPluginUser user, VoteShopItem item,
LimitGeneration limitGeneration) {
MySQL table = plugin.getMysql();
String pointsColumn = user.getPointsPath();
String limitColumn = item.getLimit() > 0 ? "VoteShopLimit" + item.getIdentifier() : null;
ensurePerServerPointsColumn(table, pointsColumn);
drainPurchaseCache(user, pointsColumn);
if (limitColumn != null) {
table.checkColumn(limitColumn, DataType.INTEGER);
}
var publication = plugin.getPlaceholders();
UUID pointUuid = UUID.fromString(user.getUUID());
if (publication != null) publication.beginSharedPointDebit(pointUuid);
boolean known = true;
try {
SharedMysqlPurchaseJournal journal = SharedMysqlPurchaseJournal.forTable(table);
String purchaseId = UUID.randomUUID().toString();
if (journal.reserve(purchaseId, user.getUUID(), pointsColumn, limitColumn, item.getCost(), item.getLimit(),
limitGeneration.value(), limitGeneration.expiresAt(), System.currentTimeMillis())) {
// reserve() returns only after its transaction and connection are closed;
// NO_CACHE reads must not contend with its one-connection pool handle.
refreshPurchaseCache(user, pointsColumn, limitColumn);
return new SharedPurchaseDebit(VoteShopPurchaseResult.SUCCESS, journal, purchaseId, pointsColumn,
limitColumn);
MySQL table = plugin.getMysql();
String pointsColumn = user.getPointsPath();
String limitColumn = item.getLimit() > 0 ? "VoteShopLimit" + item.getIdentifier() : null;
ensurePerServerPointsColumn(table, pointsColumn);
drainPurchaseCache(user, pointsColumn);
if (limitColumn != null) {
table.checkColumn(limitColumn, DataType.INTEGER);
}
try {
SharedMysqlPurchaseJournal journal = SharedMysqlPurchaseJournal.forTable(table);
String purchaseId = UUID.randomUUID().toString();
known = false;
boolean reserved = journal.reserve(purchaseId, user.getUUID(), pointsColumn, limitColumn, item.getCost(), item.getLimit(),
limitGeneration.value(), limitGeneration.expiresAt(), System.currentTimeMillis());
known = true;
if (reserved) {
// reserve() returns only after its transaction and connection are closed;
// NO_CACHE reads must not contend with its one-connection pool handle.
refreshPurchaseCache(user, pointsColumn, limitColumn);
return new SharedPurchaseDebit(VoteShopPurchaseResult.SUCCESS, journal, purchaseId, pointsColumn,
limitColumn);
}
} catch (SQLException failure) {
known |= failure instanceof SharedMysqlPurchaseJournal.PreparationFailure;
// reserve() can throw after its commit acknowledgement and confirmation
// both fail. The debit may therefore be durable even though this caller
// reports FAILED; drop snapshots recreated during that transaction so a
// later cache dump cannot restore the pre-reservation values.
refreshPurchaseCache(user, pointsColumn, limitColumn);
plugin.getLogger().severe("Unable to atomically debit vote shop points: "
+ failure.getClass().getSimpleName());
plugin.debug(failure);
return new SharedPurchaseDebit(VoteShopPurchaseResult.FAILED, null, null, null, null);
}
} catch (SQLException failure) {
// reserve() can throw after its commit acknowledgement and confirmation
// both fail. The debit may therefore be durable even though this caller
// reports FAILED; drop snapshots recreated during that transaction so a
// later cache dump cannot restore the pre-reservation values.
refreshPurchaseCache(user, pointsColumn, limitColumn);
plugin.getLogger().severe("Unable to atomically debit vote shop points: "
+ failure.getClass().getSimpleName());
plugin.debug(failure);
return new SharedPurchaseDebit(VoteShopPurchaseResult.FAILED, null, null, null, null);
return new SharedPurchaseDebit(sharedMysqlFailure(user, item, limitColumn), null, null, null, null);
} finally {
if (publication != null) publication.finishSharedPointDebit(pointUuid, known, false);
}
return new SharedPurchaseDebit(sharedMysqlFailure(user, item, limitColumn), null, null, null, null);
}
/** The legacy cache path created server-suffixed points columns before direct SQL used them. */
+17 -6
View File
@@ -188,6 +188,7 @@ DebugLevel: NONE
GiveDefaultPermission: true
# If true, plugin will automatically generate votesites upon getting a vote
# Disable after setup; a small periodic console reminder warns while enabled.
AutoCreateVoteSites: true
# Geyser/Bedrock player support
@@ -211,6 +212,14 @@ UseVoteGUIMainCommand: false
# Does not backup MySQL data
CreateBackups: true
# Player root command and standalone player aliases; admin commands remain available.
# These settings require a server restart; /av reload does not change registration.
VoteCommandEnabled: true
# Root label without a slash or namespace; 1-64 letters, digits, underscores or hyphens.
# Reserved/invalid names use vote. A foreign bare-name conflict uses votingplugin:<name>.
# Standalone aliases such as /votegui and /vgui keep their existing names.
VoteCommandName: vote
# Load command aliases, such as /avgui
# Requires restart to take effect
LoadCommandAliases: true
@@ -442,6 +451,14 @@ VoteLogging:
# Tracks and displays top voters by time period
###########################################
# Hide only confirmed never-joined identities from top voter displays.
# Missing, unreadable or ambiguous history stays visible. Awards are unchanged.
# Presence checks are asynchronous; pending snapshots stay visible until refreshed.
# Evidence expires after 30 seconds. GUI, chat and placeholder views can show
# previously hidden rows while fresh checks are pending; stale negatives are not reused.
# At most 128 checks run at once, so a large expired board may need several refreshes.
HideTopVoterIfNotPlayedBefore: false
# Top voter blacklist
# Hide these names from top voter lists
BlackList:
@@ -1256,9 +1273,3 @@ DisableUpdateChecking: false
# Disable checking permissions on tab complete
# Could increase performance slightly, but probably not
DisableAdvancedTab: false
# Optional public vanilla villagers opening the existing voting-site menu.
# Enable and /av reload, then /av npc create <id> [name]. No Citizens required.
# Definitions live in VotingNPCs.json; disabling keeps them but removes live NPCs.
VotingNPCs:
Enabled: false
+4
View File
@@ -294,6 +294,10 @@ CHEST:
Lore: '&c&lBest: &c%Best%'
Amount: 1
# Separate read-only /vote streaks progression menu.
VoteStreaks:
Name: '&6Vote streaks'
VoteStreak:
Name: 'VoteStreak: %player%'
BackButton: false
@@ -397,3 +397,45 @@ DailyAwards:
Rewards:
Messages:
Player: '&aYou came in second place in %TopVoter%!'
# Owner-defined dated events. This example is DISABLED by default.
# Set your own dates/rewards, then enable the event. No automatic recurring reset.
# Keep the event ID stable to retain progress; never delete its ledger and reuse it.
# After accounting starts, use a NEW ID for changes to dates, timezone, thresholds,
# VoteSites or AccountingServer. Unsafe edits are rejected, preserving progress.
# DisplayName and Enabled may change without resetting counts.
# Full configuration and durability limits: docs/date-vote-milestones.md
DateVoteMilestones:
example_event:
Enabled: false
# Count admin/test votes for this event? Existing normal vote policies are unchanged.
CountFakeVotes: true
DisplayName: 'Example voting event'
# Local ISO date-times interpreted in the explicit IANA timezone below.
Start: '2026-10-01T00:00:00' # Inclusive: occurrences at this instant count.
End: '2026-11-01T00:00:00' # Exclusive: occurrences at this instant do not count.
Timezone: 'UTC'
# Ledger owner: empty/omitted means local accounting on standalone servers.
# With UseBungeecord enabled, empty/omitted disables new date accounting.
# Proxy: set the exact, case-sensitive BungeeSettings.yml Server name of ONE
# backend, identically on every backend, with identified all-server delivery.
# Reward delivery follows the existing reward settings. Keep matching event
# IDs and milestone reward sections on backends that may resolve rewards.
AccountingServer: ''
# Configured VoteSites.yml keys (not service names); empty means all sites.
VoteSites: []
# Named milestones use At (one count, list, or bounded range) / Every.
# Existing numeric keys with Rewards remain supported; see the guide.
Milestones:
TenVotes:
Enabled: true
At: 10
Rewards:
Messages:
Player: '&aYou reached 10 votes in %DateVoteEvent%!'
TwentyFiveVotes:
Enabled: true
At: 25
Rewards:
Messages:
Player: '&aYou reached 25 votes in %DateVoteEvent%!'
+6 -5
View File
@@ -170,8 +170,6 @@ permissions:
description: Allows mod commands
VotingPlugin.Admin:
description: Allows admincommands
children:
VotingPlugin.Commands.AdminVote: true
VotingPlugin.TopVoter.Ignore:
description: Allows you to be exempt from top voter
VotingPlugin.NoRemind:
@@ -198,8 +196,11 @@ permissions:
description: Remind if player can vote on all votesites, rather than any
default: false
VotingPlugin.Commands.AdminVote.NPC:
description: Create, inspect, list and remove saved vanilla voting NPCs
VotingPlugin.Commands.Vote.DateEvents:
description: View owner-configured date event progress
default: false
VotingPlugin.Commands.Vote.Streaks:
description: View your read-only vote streak progression
default: op
children:
VotingPlugin.Commands.AdminVote: true
VotingPlugin.Commands.Vote: true
@@ -1,34 +0,0 @@
package com.bencodez.votingplugin.listeners;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.UUID;
import org.junit.jupiter.api.Test;
import com.bencodez.votingplugin.events.PlayerVoteEvent;
import com.bencodez.votingplugin.proxy.VoteTotalsSnapshot;
class PlayerVoteListenerProxyVoteIdTest {
@Test
@SuppressWarnings("deprecation")
void legacyTotalsSnapshotRetainsItsCorrelationIdentity() {
UUID legacyId = UUID.randomUUID();
PlayerVoteEvent event = new PlayerVoteEvent(null, "Ben", "Example", true);
event.setBungeeTextTotals(new VoteTotalsSnapshot(1, 2, 3, 4, 5, 6, 7, 8, legacyId));
assertEquals(legacyId, PlayerVoteListener.resolveProxyVoteId(event));
}
@Test
@SuppressWarnings("deprecation")
void explicitTransportIdentityWinsOverLegacySnapshot() {
UUID explicitId = UUID.randomUUID();
PlayerVoteEvent event = new PlayerVoteEvent(null, "Ben", "Example", true);
event.setProxyVoteId(explicitId);
event.setBungeeTextTotals(new VoteTotalsSnapshot(1, 2, 3, 4, 5, 6, 7, 8, UUID.randomUUID()));
assertEquals(explicitId, PlayerVoteListener.resolveProxyVoteId(event));
}
}
@@ -1,203 +0,0 @@
package com.bencodez.votingplugin.npc;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.LinkedBlockingQueue;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.junit.jupiter.api.Test;
import org.mockito.ArgumentCaptor;
import com.bencodez.advancedcore.api.command.CommandHandler;
import com.bencodez.simpleapi.scheduler.BukkitScheduler;
import com.bencodez.votingplugin.VotingPluginMain;
class VotingNPCCommandsTest {
private static class Fixture {
final VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
final BukkitScheduler scheduler = mock(BukkitScheduler.class);
final VotingNPCManager manager = mock(VotingNPCManager.class);
final ArrayList<CommandHandler> handlers = new ArrayList<>();
final LinkedBlockingQueue<Runnable> tasks = new LinkedBlockingQueue<>();
final LinkedBlockingQueue<Runnable> asynchronous = new LinkedBlockingQueue<>();
Fixture() {
when(plugin.getAdminVoteCommand()).thenReturn(handlers);
when(plugin.getVotingNPCManager()).thenReturn(manager);
when(plugin.getBukkitScheduler()).thenReturn(scheduler);
when(manager.available()).thenReturn(true);
doAnswer(inv -> { tasks.add(inv.getArgument(1)); return null; })
.when(scheduler).runTask(eq(plugin), any(Runnable.class), any(Entity.class));
doAnswer(inv -> { tasks.add(inv.getArgument(1)); return null; })
.when(scheduler).runTask(eq(plugin), any(Runnable.class));
doAnswer(inv -> { asynchronous.add(inv.getArgument(1)); return null; })
.when(scheduler).runTaskAsynchronously(eq(plugin), any(Runnable.class));
VotingNPCCommands.register(plugin);
}
Player player() {
Player player = mock(Player.class);
when(player.isOnline()).thenReturn(true);
when(player.hasPermission("VotingPlugin.Commands.AdminVote.NPC")).thenReturn(true);
World world = mock(World.class); when(world.getUID()).thenReturn(new UUID(1, 0));
// Location holds its world weakly; retain it as a real online player does.
when(player.getWorld()).thenReturn(world);
when(player.getLocation()).thenReturn(new Location(world, 4, 64, 4));
return player;
}
CommandHandler command(String action, int arguments) {
return handlers.stream().filter(value -> value.getArgs()[1].equals(action)
&& value.getArgs().length == arguments).findFirst().orElseThrow();
}
}
@Test void usesOnlyDedicatedNpcPatternsAndExplicitAdminPermission() {
var f = new Fixture();
assertEquals(List.of(List.of("NPC", "Create", "(string)"), List.of("NPC", "Create", "(string)", "(list)"),
List.of("NPC", "List"), List.of("NPC", "Inspect", "(npcid)"), List.of("NPC", "Remove", "(npcid)")),
f.handlers.stream().map(value -> List.of(value.getArgs())).toList());
for (var handler : f.handlers) assertEquals("VotingPlugin.Commands.AdminVote.NPC|VotingPlugin.Admin", handler.getPerm());
}
@Test void metadataGrantsTheAdminRootGateWithoutGrantingOtherAdminLeaves() throws Exception {
org.bukkit.plugin.PluginDescriptionFile description;
try (var input = getClass().getResourceAsStream("/plugin.yml")) {
assertNotNull(input); description = new org.bukkit.plugin.PluginDescriptionFile(input);
}
var permissions = description.getPermissions().stream().collect(java.util.stream.Collectors.toMap(
permission -> permission.getName().toLowerCase(java.util.Locale.ROOT), java.util.function.Function.identity()));
var plugin = mock(VotingPluginMain.class); when(plugin.isEnabled()).thenReturn(true);
var pm = mock(org.bukkit.plugin.PluginManager.class);
when(pm.getDefaultPermissions(false)).thenReturn(java.util.Set.of());
when(pm.getPermission(anyString())).thenAnswer(call -> permissions.get(((String)call.getArgument(0)).toLowerCase(java.util.Locale.ROOT)));
try (var bukkit = mockStatic(org.bukkit.Bukkit.class)) {
bukkit.when(org.bukkit.Bukkit::getPluginManager).thenReturn(pm);
var server = mock(org.bukkit.Server.class); when(server.getPluginManager()).thenReturn(pm);
bukkit.when(org.bukkit.Bukkit::getServer).thenReturn(server);
for (String grant : List.of("VotingPlugin.Commands.AdminVote.NPC", "VotingPlugin.Admin")) {
var permissible = new org.bukkit.permissions.PermissibleBase(mock(org.bukkit.permissions.ServerOperator.class));
permissible.addAttachment(plugin, grant, true);
CommandSender sender = mock(CommandSender.class);
when(sender.hasPermission(anyString())).thenAnswer(call -> permissible.hasPermission((String)call.getArgument(0)));
var root = new org.bukkit.command.Command("av") {
@Override public boolean execute(CommandSender sender, String label, String[] args) { return true; }
};
root.setPermission("VotingPlugin.Commands.AdminVote");
assertTrue(root.testPermissionSilent(sender), grant);
if (grant.endsWith(".NPC")) {
assertFalse(permissible.hasPermission("VotingPlugin.Commands.AdminVote.Edit.Config"));
assertFalse(permissible.hasPermission("VotingPlugin.Admin"));
}
}
}
}
@Test void capturesPlayerStateOnlyOnOwnerAndSuccessOnlyAfterDurableCompletion() {
var f = new Fixture(); Player player = f.player();
var completion = new CompletableFuture<VotingNPCDefinition>();
when(f.manager.create(any())).thenReturn(completion);
f.command("Create", 4).execute(player, new String[] { "NPC", "Create", "voting", "Vote", "here" });
verify(player, never()).getLocation(); verify(f.manager, never()).create(any());
f.tasks.remove().run();
var definition = ArgumentCaptor.forClass(VotingNPCDefinition.class); verify(f.manager).create(definition.capture());
assertEquals("Vote here", definition.getValue().name()); assertEquals("voting", definition.getValue().id());
verify(player, never()).sendMessage(anyString());
completion.complete(definition.getValue());
verify(player, never()).sendMessage(anyString());
f.tasks.remove().run();
verify(player).sendMessage(contains("Saved voting NPC 'voting'"));
}
@Test void delayedPermissionRevocationAndDisabledFeaturePreventMutation() {
var f = new Fixture(); Player player = f.player();
var handler = f.command("Create", 3);
handler.execute(player, new String[] { "NPC", "Create", "voting" });
when(player.hasPermission("VotingPlugin.Commands.AdminVote.NPC")).thenReturn(false);
f.tasks.remove().run(); verify(f.manager, never()).create(any());
when(player.hasPermission("VotingPlugin.Commands.AdminVote.NPC")).thenReturn(true);
when(f.manager.available()).thenReturn(false);
handler.execute(player, new String[] { "NPC", "Create", "voting" }); f.tasks.remove().run();
verify(f.manager, never()).create(any()); verify(player).sendMessage(contains("VotingNPCs.Enabled"));
}
@Test void rejectedStorageDoesNotSendSuccessAndDoesNotLeakRawFailure() {
var f = new Fixture(); Player player = f.player();
when(f.manager.remove("voting")).thenReturn(CompletableFuture.failedFuture(new IllegalStateException("Synthetic private diagnostic")));
f.command("Remove", 3).execute(player, new String[] { "NPC", "Remove", "voting" });
f.tasks.remove().run(); f.tasks.remove().run();
verify(player).sendMessage(contains("was not confirmed"));
verify(player, never()).sendMessage(contains("Synthetic private"));
verify(player, never()).sendMessage(startsWith("Removed saved"));
}
@Test void validationRejectionsHaveFixedActionableMessagesAndUnavailableStorageStaysConservative() {
for (var reason : VotingNPCRegistry.Rejection.values()) {
var f = new Fixture(); Player player = f.player();
when(f.manager.create(any())).thenReturn(CompletableFuture.failedFuture(
new java.util.concurrent.CompletionException(new VotingNPCRegistry.ValidationFailure(reason))));
f.command("Create", 3).execute(player, new String[] { "NPC", "Create", "voting" });
f.tasks.remove().run(); f.tasks.remove().run();
String expected = switch (reason) {
case DUPLICATE_ID -> "ID already exists";
case DUPLICATE_IDENTITY -> "identity already exists";
case LIMIT -> "64 voting NPC limit";
};
verify(player).sendMessage(contains(expected));
verify(player, never()).sendMessage(contains("reload before retrying"));
}
var f = new Fixture(); Player player = f.player();
var pending = new CompletableFuture<VotingNPCDefinition>();
when(f.manager.create(any())).thenReturn(pending);
f.command("Create", 3).execute(player, new String[] { "NPC", "Create", "voting" }); f.tasks.remove().run();
when(f.manager.available()).thenReturn(false);
pending.completeExceptionally(new java.util.concurrent.RejectedExecutionException("Synthetic")); f.tasks.remove().run();
verify(player).sendMessage(contains("reload before retrying"));
verify(player, never()).sendMessage(contains("busy"));
}
@Test void healthyQueueSaturationDoesNotTellTheAdministratorToReloadStorage() {
var f = new Fixture(); Player player = f.player();
when(f.manager.create(any())).thenReturn(CompletableFuture.failedFuture(
new java.util.concurrent.RejectedExecutionException("Synthetic queue rejection")));
f.command("Create", 3).execute(player, new String[] { "NPC", "Create", "voting" });
f.tasks.remove().run(); f.tasks.remove().run();
verify(player).sendMessage(contains("busy"));
verify(player, never()).sendMessage(contains("reload before retrying"));
verify(player, never()).sendMessage(contains("Synthetic"));
}
@Test void invalidDefinitionAndConsoleCreationDoNotMutate() {
var f = new Fixture(); Player player = f.player();
f.command("Create", 3).execute(player, new String[] { "NPC", "Create", "bad id" }); f.tasks.remove().run();
verify(f.manager, never()).create(any()); verify(player).sendMessage(contains("lowercase ID"));
CommandSender console = mock(CommandSender.class); when(console.hasPermission("VotingPlugin.Admin")).thenReturn(true);
f.command("Create", 3).execute(console, new String[] { "NPC", "Create", "voting" }); f.tasks.remove().run();
verify(console).sendMessage("Create a voting NPC from in game."); verify(f.manager, never()).create(any());
}
@Test void bothCreationFormsMatchRealCommandDispatchWithStandardFrameworkPlaceholders() {
var tabs = new com.bencodez.simpleapi.command.TabCompleteHandler();
// These are the standard placeholders AdvancedCore registers before commands.
tabs.addTabCompleteOption("(String)", new ArrayList<>());
tabs.addTabCompleteOption("(List)", new ArrayList<>());
try (var tabSingleton = mockStatic(com.bencodez.simpleapi.command.TabCompleteHandler.class)) {
tabSingleton.when(com.bencodez.simpleapi.command.TabCompleteHandler::getInstance).thenReturn(tabs);
var f = new Fixture(); Player player = f.player();
when(f.manager.create(any())).thenReturn(new CompletableFuture<>());
assertTrue(f.command("Create", 3).runCommand(player, new String[] { "npc", "create", "new-voting" }));
f.asynchronous.remove().run(); f.tasks.remove().run();
assertTrue(f.command("Create", 4).runCommand(player, new String[] { "npc", "create", "another", "Vote", "here" }));
f.asynchronous.remove().run(); f.tasks.remove().run();
var values = ArgumentCaptor.forClass(VotingNPCDefinition.class); verify(f.manager, times(2)).create(values.capture());
assertEquals(List.of("new-voting", "another"), values.getAllValues().stream().map(VotingNPCDefinition::id).toList());
}
}
}
@@ -1,556 +0,0 @@
package com.bencodez.votingplugin.npc;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;
import static org.mockito.AdditionalMatchers.aryEq;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.logging.Logger;
import org.bukkit.Bukkit;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.entity.Entity;
import org.bukkit.entity.Player;
import org.bukkit.entity.Villager;
import org.bukkit.event.entity.EntityDamageEvent;
import org.bukkit.event.player.PlayerInteractEntityEvent;
import org.bukkit.event.world.ChunkLoadEvent;
import org.bukkit.event.world.ChunkUnloadEvent;
import org.bukkit.event.world.WorldLoadEvent;
import org.bukkit.event.world.WorldUnloadEvent;
import org.bukkit.inventory.EquipmentSlot;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import com.bencodez.simpleapi.scheduler.BukkitScheduler;
import com.bencodez.votingplugin.VotingPluginMain;
class VotingNPCManagerTest {
@TempDir Path directory;
private static final UUID WORLD = new UUID(1, 0);
private static VotingNPCDefinition definition(int identity) {
return new VotingNPCDefinition("voting", new UUID(0, identity), WORLD, 8, 64, 8, 0, 0, "&aVote");
}
private static VotingNPCDefinition definitionAt(int identity, double x) {
return new VotingNPCDefinition("npc-" + identity, new UUID(0, identity), WORLD, x, 64, 8, 0, 0, "&aVote");
}
private static <T> T await(CompletionStage<T> stage) throws Exception {
return stage.toCompletableFuture().get(5, TimeUnit.SECONDS);
}
private static class Scheduler extends VotingNPCScheduler {
final LinkedBlockingQueue<Runnable> global = new LinkedBlockingQueue<>();
final LinkedBlockingQueue<Runnable> regions = new LinkedBlockingQueue<>();
final LinkedBlockingQueue<Runnable> entities = new LinkedBlockingQueue<>();
String owner = "none";
boolean rejectCleanup;
Scheduler(VotingPluginMain plugin) { super(plugin); }
@Override boolean owns(Location value) { return owner.equals("region"); }
@Override boolean owns(Entity value) { return owner.equals("entity"); }
@Override void global(Runnable action, Consumer<Throwable> failed) { global.add(action); }
@Override void region(Location anchor, Runnable action, Consumer<Throwable> failed) { regions.add(action); }
@Override void entity(Entity entity, Runnable action, Runnable retired, Consumer<Throwable> failed) {
if (rejectCleanup) failed.accept(new IllegalStateException("Synthetic rejection"));
else entities.add(action);
}
void runNext(LinkedBlockingQueue<Runnable> queue, String phase) throws Exception {
Runnable action = queue.poll(5, TimeUnit.SECONDS);
assertNotNull(action, "Expected scheduled " + phase + " work");
owner = phase;
try { action.run(); } finally { owner = "none"; }
}
}
@Test void duplicateChunkNotificationsDoNotReconstructAnotherEntityAndOrdinaryEntitiesAreIgnored() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin);
List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
var manager = new VotingNPCManager(plugin, scheduler, registry, player -> fail("Unexpected menu"));
try {
manager.configure(true);
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
Chunk chunk = chunk(world);
manager.chunkLoad(new ChunkLoadEvent(chunk, false));
manager.chunkLoad(new ChunkLoadEvent(chunk, false));
assertEquals(1, spawned.size()); assertEquals(1, manager.runtimeCount());
verify(spawned.getFirst()).setPersistent(false);
verify(spawned.getFirst()).setAI(false);
verify(spawned.getFirst()).setCustomName("\u00a7aVote");
Player player = mock(Player.class); when(player.getUniqueId()).thenReturn(new UUID(0, 100));
Villager unrelated = mock(Villager.class); when(unrelated.getUniqueId()).thenReturn(new UUID(0, 99));
var interact = new PlayerInteractEntityEvent(player, unrelated, EquipmentSlot.HAND);
manager.interact(interact); assertFalse(interact.isCancelled());
var damage = mock(EntityDamageEvent.class); when(damage.getEntity()).thenReturn(unrelated);
manager.damage(damage); verify(damage, never()).setCancelled(anyBoolean());
var protectedDamage = mock(EntityDamageEvent.class); when(protectedDamage.getEntity()).thenReturn(spawned.getFirst());
manager.damage(protectedDamage); verify(protectedDamage).setCancelled(true);
var hostileTarget = new org.bukkit.event.entity.EntityTargetEvent(unrelated, spawned.getFirst(),
org.bukkit.event.entity.EntityTargetEvent.TargetReason.CLOSEST_ENTITY);
manager.target(hostileTarget);
assertTrue(hostileTarget.isCancelled(), "ordinary mobs must not target a tracked NPC");
var normalTarget = new org.bukkit.event.entity.EntityTargetEvent(unrelated, player,
org.bukkit.event.entity.EntityTargetEvent.TargetReason.CLOSEST_ENTITY);
manager.target(normalTarget); assertFalse(normalTarget.isCancelled());
var clearedTarget = new org.bukkit.event.entity.EntityTargetEvent(unrelated, null,
org.bukkit.event.entity.EntityTargetEvent.TargetReason.FORGOT_TARGET);
manager.target(clearedTarget); assertFalse(clearedTarget.isCancelled());
var witch = mock(org.bukkit.entity.Witch.class);
var transform = new org.bukkit.event.entity.EntityTransformEvent(spawned.getFirst(), List.of(witch),
org.bukkit.event.entity.EntityTransformEvent.TransformReason.LIGHTNING);
var unrelatedTransform = new org.bukkit.event.entity.EntityTransformEvent(unrelated, List.of(witch),
org.bukkit.event.entity.EntityTransformEvent.TransformReason.LIGHTNING);
// Discover actual listener methods, as event registration does;
// absence of a transformation handler must fail this regression.
for (var method : VotingNPCManager.class.getDeclaredMethods()) {
if (method.isAnnotationPresent(org.bukkit.event.EventHandler.class) && method.getParameterCount() == 1
&& method.getParameterTypes()[0].isInstance(transform)) {
method.invoke(manager, transform); method.invoke(manager, unrelatedTransform);
}
}
assertTrue(transform.isCancelled(), "lightning must not replace a tracked villager with an untracked entity");
assertFalse(unrelatedTransform.isCancelled());
} finally {
manager.close(); scheduler.runNext(scheduler.entities, "entity");
assertEquals(0, manager.runtimeCount()); assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
@Test void freedFullCapacityWakesOnePendingDifferentId() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("capacity.json")); await(registry.initialLoad());
for (int i = 1; i <= VotingNPCStore.MAX_NPCS; i++) await(registry.create(definitionAt(i, i * 2)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global");
for (int i = 0; i < VotingNPCStore.MAX_NPCS; i++) scheduler.runNext(scheduler.regions, "region");
assertEquals(VotingNPCStore.MAX_NPCS, manager.runtimeCount());
await(manager.remove("npc-1")); await(manager.create(definitionAt(1000, 2000)));
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.global, "global");
scheduler.runNext(scheduler.entities, "entity");
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
assertEquals(VotingNPCStore.MAX_NPCS, manager.runtimeCount());
assertEquals(VotingNPCStore.MAX_NPCS + 1, spawned.size());
} finally {
manager.close(); while (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
@Test void unloadedCurrentReservationWakesDifferentPendingIdWithoutRetryingItself() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("unloaded-current-capacity.json")); await(registry.initialLoad());
for (int i = 1; i < VotingNPCStore.MAX_NPCS; i++) await(registry.create(definitionAt(i, i * 2)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global");
for (int i = 1; i < VotingNPCStore.MAX_NPCS; i++) scheduler.runNext(scheduler.regions, "region");
await(manager.create(definitionAt(64, 128)));
scheduler.runNext(scheduler.global, "global");
assertEquals(64, manager.runtimeCount()); assertEquals(1, scheduler.regions.size());
await(manager.remove("npc-1")); await(manager.create(definitionAt(1000, 2000)));
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.global, "global");
assertEquals(1, scheduler.entities.size()); assertTrue(scheduler.global.isEmpty());
assertEquals(1, scheduler.regions.size());
// The existing queued reservation is now unloaded; the new target remains loaded.
when(world.isChunkLoaded(anyInt(), anyInt())).thenAnswer(call -> (Integer) call.getArgument(0) != 8);
scheduler.runNext(scheduler.regions, "region");
assertEquals(63, manager.runtimeCount());
assertEquals(1, scheduler.global.size(), "Released capacity must wake the different waiting ID");
scheduler.runNext(scheduler.global, "global");
assertEquals(1, scheduler.regions.size(), "Only the pending ID may retry, not the unloaded reservation");
scheduler.runNext(scheduler.regions, "region");
assertEquals(64, spawned.size()); assertEquals(64, manager.runtimeCount());
assertTrue(scheduler.global.isEmpty()); assertTrue(scheduler.regions.isEmpty());
verify(world).spawn(argThat(anchor -> anchor.getX() == 2000), eq(Villager.class), any(Consumer.class));
} finally {
manager.close(); while (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
@Test void successorWaitsForExactPredecessorCleanupAndCleanupRejectionRetainsOwnership() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
scheduler.rejectCleanup = true;
assertTrue(await(manager.remove("voting")));
await(manager.create(definition(2)));
// Process both durable mutation notifications while old removal is rejected.
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.global, "global");
assertEquals(1, spawned.size()); assertEquals(1, manager.runtimeCount());
verify(spawned.getFirst(), never()).remove();
// A rejected cleanup keeps ownership; repeated load notifications may
// request a retry, but must never create a successor or duplicate task.
manager.chunkLoad(new ChunkLoadEvent(chunk(world), false));
manager.chunkLoad(new ChunkLoadEvent(chunk(world), false));
assertEquals(1, spawned.size()); assertEquals(1, manager.runtimeCount());
scheduler.rejectCleanup = false;
manager.chunkLoad(new ChunkLoadEvent(chunk(world), false));
scheduler.runNext(scheduler.entities, "entity");
verify(spawned.getFirst()).remove();
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
assertEquals(2, spawned.size()); assertEquals(1, manager.runtimeCount());
} finally {
scheduler.rejectCleanup = false; manager.close();
if (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
@Test void transientUnloadCleanupRetriesAtLoadAndCoalescesUntilRemovalFinishes() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
Chunk chunk = chunk(world); scheduler.rejectCleanup = true;
manager.chunkUnload(new ChunkUnloadEvent(chunk));
assertEquals(1, manager.runtimeCount()); assertTrue(scheduler.global.isEmpty());
assertTrue(scheduler.entities.isEmpty(), "rejection must not create an autonomous retry loop");
scheduler.rejectCleanup = false;
manager.chunkLoad(new ChunkLoadEvent(chunk, false));
manager.chunkLoad(new ChunkLoadEvent(chunk, false));
assertEquals(1, scheduler.entities.size(), "a queued exact predecessor cleanup must coalesce");
assertEquals(1, spawned.size());
scheduler.runNext(scheduler.entities, "entity"); verify(spawned.getFirst()).remove();
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
assertEquals(2, spawned.size()); assertEquals(1, manager.runtimeCount());
assertTrue(scheduler.entities.isEmpty()); assertTrue(scheduler.global.isEmpty());
} finally {
scheduler.rejectCleanup = false; manager.close();
if (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
@Test void queuedRemovedReservationWakesPendingCapacityWithoutEntity() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("queued-capacity.json")); await(registry.initialLoad());
for (int i = 1; i <= VotingNPCStore.MAX_NPCS; i++) await(registry.create(definitionAt(i, i * 2)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global");
await(manager.remove("npc-1")); await(manager.create(definitionAt(1000, 2000)));
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.global, "global");
for (int i = 0; i <= VotingNPCStore.MAX_NPCS; i++) scheduler.runNext(scheduler.regions, "region");
assertTrue(scheduler.regions.isEmpty()); assertTrue(scheduler.global.isEmpty());
assertEquals(VotingNPCStore.MAX_NPCS, manager.runtimeCount());
assertEquals(VotingNPCStore.MAX_NPCS, spawned.size());
} finally {
manager.close(); while (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
@Test void unloadedQueuedReservationWithPendingCapacityDoesNotRetry() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(false);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("unloaded-capacity.json")); await(registry.initialLoad());
for (int i = 1; i <= VotingNPCStore.MAX_NPCS; i++) await(registry.create(definitionAt(i, i * 2)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global");
await(manager.remove("npc-1")); await(manager.create(definitionAt(1000, 2000)));
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.global, "global");
for (int i = 0; i <= VotingNPCStore.MAX_NPCS; i++) scheduler.runNext(scheduler.regions, "region");
assertEquals(0, spawned.size()); assertTrue(scheduler.global.isEmpty());
assertTrue(scheduler.regions.isEmpty()); assertEquals(0, manager.runtimeCount());
} finally { manager.close(); assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS)); }
}
}
@Test void unloadedChunksNeverSpawnOrLoadAndLaterLoadReconstructsOnce() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
assertTrue(spawned.isEmpty()); assertEquals(0, manager.runtimeCount());
verify(world, never()).getChunkAt(anyInt(), anyInt()); verify(world, never()).loadChunk(anyInt(), anyInt());
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
manager.chunkLoad(new ChunkLoadEvent(chunk(world), false)); scheduler.runNext(scheduler.regions, "region");
assertEquals(1, spawned.size());
manager.chunkUnload(new ChunkUnloadEvent(chunk(world))); scheduler.runNext(scheduler.entities, "entity");
assertTrue(scheduler.global.isEmpty(), "unload must not immediately retry reconstruction");
assertTrue(scheduler.regions.isEmpty());
manager.chunkLoad(new ChunkLoadEvent(chunk(world), false)); scheduler.runNext(scheduler.regions, "region");
assertEquals(2, spawned.size());
} finally { manager.close(); scheduler.runNext(scheduler.entities, "entity"); assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS)); }
}
}
@Test void partialSpawnFailureRemovesOnlyTheCapturedEntityAndCloseInvalidatesQueuedSpawns() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global");
// Close before a deferred creation runs: no entity may be created.
manager.configure(false); scheduler.runNext(scheduler.regions, "region");
assertTrue(spawned.isEmpty()); assertEquals(0, manager.runtimeCount());
manager.configure(true); scheduler.runNext(scheduler.global, "global");
doAnswer(invocation -> {
Villager entity = mock(Villager.class); when(entity.getUniqueId()).thenReturn(new UUID(0, 17));
doThrow(new IllegalStateException("Synthetic entity property failure")).when(entity).setAI(false);
spawned.add(entity);
Consumer<Villager> initializer = invocation.getArgument(2); initializer.accept(entity); return entity;
}).when(world).spawn(any(Location.class), eq(Villager.class), any(Consumer.class));
scheduler.runNext(scheduler.regions, "region");
assertEquals(1, manager.runtimeCount());
scheduler.runNext(scheduler.entities, "entity");
verify(spawned.getFirst()).remove(); assertEquals(0, manager.runtimeCount());
assertTrue(scheduler.global.isEmpty(), "failed spawn must not cause an automatic retry loop");
} finally { manager.close(); assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS)); }
}
}
@Test void occupiedNeighbourUnloadRetiresAndReloadReconstructsOnceAtBothCoordinateSigns() throws Exception {
for (double position : new double[] {15.75, -.25}) {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("boundary-" + (position > 0) + ".json"));
await(registry.initialLoad());
var definition = new VotingNPCDefinition("voting", new UUID(0, 1), WORLD, position, 64, position, 0, 0, "Vote");
await(registry.create(definition));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
manager.chunkUnload(new ChunkUnloadEvent(atChunk(world, 7, 7)));
assertTrue(scheduler.entities.isEmpty(), "unrelated chunk unload must leave NPC alone");
int neighbour = definition.chunkX() + 1;
manager.chunkUnload(new ChunkUnloadEvent(atChunk(world, neighbour, neighbour)));
assertEquals(1, scheduler.entities.size(), "occupied adjacent chunk must trigger entity-owned cleanup");
// Bukkit may still report the unloading chunk as loaded during its event.
manager.chunkLoad(new ChunkLoadEvent(atChunk(world, definition.chunkX(), definition.chunkZ()), false));
scheduler.runNext(scheduler.entities, "entity");
assertEquals(0, manager.runtimeCount()); assertTrue(scheduler.regions.isEmpty());
manager.chunkLoad(new ChunkLoadEvent(atChunk(world, neighbour, neighbour), false));
manager.chunkLoad(new ChunkLoadEvent(atChunk(world, neighbour, neighbour), false));
scheduler.runNext(scheduler.regions, "region");
assertEquals(2, spawned.size()); assertEquals(1, manager.runtimeCount());
verify(world, never()).getChunkAt(anyInt(), anyInt()); verify(world, never()).loadChunk(anyInt(), anyInt());
} finally {
manager.close(); if (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
}
@Test void neighbourUnloadFenceSurvivesReconciliationAndBlocksDeferredCreation() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("pending-boundary.json")); await(registry.initialLoad());
await(registry.create(new VotingNPCDefinition("voting", new UUID(0, 1), WORLD, 15.75, 64, 15.75, 0, 0, "Vote")));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global");
manager.chunkUnload(new ChunkUnloadEvent(atChunk(world, 1, 1)));
scheduler.runNext(scheduler.regions, "region");
assertTrue(spawned.isEmpty(), "a deferred creation cannot cross an occupied chunk unload");
assertEquals(0, manager.runtimeCount());
await(manager.create(new VotingNPCDefinition("other", new UUID(0, 2), WORLD, 40, 64, 40, 0, 0, "Vote")));
scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
assertEquals(1, spawned.size(), "unrelated mutation must not erase the first NPC's occupied-chunk fence");
assertTrue(scheduler.regions.isEmpty());
} finally {
manager.close(); while (!scheduler.entities.isEmpty()) scheduler.runNext(scheduler.entities, "entity");
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
}
}
private static Chunk atChunk(World world, int x, int z) {
Chunk chunk = mock(Chunk.class); when(chunk.getWorld()).thenReturn(world);
when(chunk.getX()).thenReturn(x); when(chunk.getZ()).thenReturn(z); return chunk;
}
@Test void disabledFeatureDoesNotReadStorageOrRegisterAnyRuntimeWork() {
var plugin = mock(VotingPluginMain.class);
var scheduler = new Scheduler(plugin);
var manager = new VotingNPCManager(plugin, scheduler, null, ignored -> fail("Disabled menu"));
manager.configure(false);
assertFalse(manager.available()); assertEquals(0, manager.runtimeCount());
assertTrue(scheduler.global.isEmpty()); assertTrue(scheduler.regions.isEmpty());
verify(plugin, never()).getDataFolder();
manager.close(); manager.close();
}
@Test void worldUnloadPreservesDefinitionsAndAWorldLoadAfterCleanupRecreatesOnce() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
var manager = new VotingNPCManager(plugin, scheduler, registry, ignored -> { });
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
manager.worldUnload(new WorldUnloadEvent(world));
// A load before delayed cleanup must record demand, not spawn a duplicate.
manager.worldLoad(new WorldLoadEvent(world)); scheduler.runNext(scheduler.global, "global");
assertEquals(1, spawned.size());
scheduler.runNext(scheduler.entities, "entity"); scheduler.runNext(scheduler.global, "global");
scheduler.runNext(scheduler.regions, "region");
assertEquals(2, spawned.size()); assertEquals(List.of(definition(1)), manager.definitions());
} finally { manager.close(); scheduler.runNext(scheduler.entities, "entity"); assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS)); }
}
}
@Test void cancelledAndOffhandClicksDoNotOpenAndRemovalInvalidatesAQueuedPlayerCallback() throws Exception {
var plugin = mock(VotingPluginMain.class); when(plugin.getLogger()).thenReturn(Logger.getAnonymousLogger());
var bukkitScheduler = mock(BukkitScheduler.class); when(plugin.getBukkitScheduler()).thenReturn(bukkitScheduler);
var playerCallbacks = new LinkedBlockingQueue<Runnable>();
doAnswer(invocation -> { playerCallbacks.add(invocation.getArgument(1)); return null; })
.when(bukkitScheduler).runTask(eq(plugin), any(Runnable.class), any(Entity.class));
try (var bukkit = mockStatic(Bukkit.class)) {
World world = mock(World.class); when(world.getUID()).thenReturn(WORLD);
bukkit.when(() -> Bukkit.getWorld(WORLD)).thenReturn(world);
when(world.isChunkLoaded(anyInt(), anyInt())).thenReturn(true);
var scheduler = new Scheduler(plugin); List<Villager> spawned = installSpawner(world, scheduler);
var registry = new VotingNPCRegistry(directory.resolve("npcs.json")); await(registry.initialLoad());
await(registry.create(definition(1)));
List<Player> opened = new ArrayList<>();
var manager = new VotingNPCManager(plugin, scheduler, registry, opened::add);
try {
manager.configure(true); scheduler.runNext(scheduler.global, "global"); scheduler.runNext(scheduler.regions, "region");
Player player = mock(Player.class); when(player.getUniqueId()).thenReturn(new UUID(0, 50));
when(player.isOnline()).thenReturn(true); when(player.getWorld()).thenReturn(world);
when(player.getLocation()).thenReturn(new Location(world, 8, 64, 9));
var cancelled = new PlayerInteractEntityEvent(player, spawned.getFirst(), EquipmentSlot.HAND); cancelled.setCancelled(true);
manager.interact(cancelled);
manager.interact(new PlayerInteractEntityEvent(player, spawned.getFirst(), EquipmentSlot.OFF_HAND));
assertTrue(playerCallbacks.isEmpty());
var click = new PlayerInteractEntityEvent(player, spawned.getFirst(), EquipmentSlot.HAND);
manager.interact(click); assertTrue(click.isCancelled());
assertEquals(1, playerCallbacks.size());
playerCallbacks.remove().run();
assertEquals(List.of(player), opened, "healthy main-hand selection opens on the player callback");
Player second = mock(Player.class); when(second.getUniqueId()).thenReturn(new UUID(0, 51));
when(second.isOnline()).thenReturn(true); when(second.getWorld()).thenReturn(world);
when(second.getLocation()).thenReturn(new Location(world, 8, 64, 9));
manager.interact(new PlayerInteractEntityEvent(second, spawned.getFirst(), EquipmentSlot.HAND));
playerCallbacks.remove().run();
assertEquals(List.of(player, second), opened, "one player's selection must not block another player");
Player third = mock(Player.class); when(third.getUniqueId()).thenReturn(new UUID(0, 52));
when(third.isOnline()).thenReturn(true); when(third.getWorld()).thenReturn(world);
when(third.getLocation()).thenReturn(new Location(world, 8, 64, 9));
manager.interact(new PlayerInteractEntityEvent(third, spawned.getFirst(), EquipmentSlot.HAND));
await(manager.remove("voting"));
playerCallbacks.remove().run(); assertEquals(List.of(player, second), opened);
} finally { manager.close(); scheduler.runNext(scheduler.entities, "entity"); assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS)); }
}
}
@Test void productionMenuEntryDelegatesToTheExistingUrlCommandRatherThanAnotherMenuOrRewardPath() {
var plugin = mock(VotingPluginMain.class);
var unrelated = mock(com.bencodez.advancedcore.api.command.CommandHandler.class);
var url = mock(com.bencodez.advancedcore.api.command.CommandHandler.class);
var later = mock(com.bencodez.advancedcore.api.command.CommandHandler.class);
var player = mock(Player.class);
when(plugin.getVoteCommand()).thenReturn(new ArrayList<>(List.of(unrelated, url, later)));
when(url.runCommand(eq(player), aryEq(new String[] { "URL" }))).thenReturn(true);
VotingNPCManager.openVotingSites(plugin, player);
verify(unrelated).runCommand(eq(player), aryEq(new String[] { "URL" }));
verify(url).runCommand(eq(player), aryEq(new String[] { "URL" }));
verifyNoInteractions(later);
verify(player, never()).performCommand(anyString());
}
private static Chunk chunk(World world) {
Chunk chunk = mock(Chunk.class); when(chunk.getWorld()).thenReturn(world); when(chunk.getX()).thenReturn(0); when(chunk.getZ()).thenReturn(0); return chunk;
}
@SuppressWarnings("unchecked")
private static List<Villager> installSpawner(World world, Scheduler scheduler) {
List<Villager> spawned = new ArrayList<>();
doAnswer(invocation -> {
assertEquals("region", scheduler.owner);
Villager entity = mock(Villager.class); when(entity.getUniqueId()).thenReturn(new UUID(2, spawned.size() + 1));
when(entity.isValid()).thenReturn(true);
Consumer<Villager> initializer = invocation.getArgument(2); initializer.accept(entity);
doAnswer(removal -> { assertEquals("entity", scheduler.owner); return null; }).when(entity).remove();
spawned.add(entity); return entity;
}).when(world).spawn(any(Location.class), eq(Villager.class), any(Consumer.class));
return spawned;
}
}
@@ -1,237 +0,0 @@
package com.bencodez.votingplugin.npc;
import static org.junit.jupiter.api.Assertions.*;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
class VotingNPCRegistryTest {
@TempDir Path directory;
private VotingNPCDefinition definition(int id) {
return new VotingNPCDefinition("npc-" + id, new UUID(0, id), new UUID(1, 0),
0.5, 64, 0.5, 0, 0, "Vote");
}
private static <T> T await(CompletionStage<T> stage) throws Exception {
return stage.toCompletableFuture().get(5, TimeUnit.SECONDS);
}
private static void close(VotingNPCRegistry registry) throws InterruptedException {
registry.close();
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
}
private static void waitOn(CountDownLatch latch) throws IOException {
try {
if (!latch.await(5, TimeUnit.SECONDS)) throw new IOException("Synthetic worker latch timed out");
} catch (InterruptedException interrupted) {
Thread.currentThread().interrupt();
throw new IOException("Synthetic worker interrupted", interrupted);
}
}
@Test void linkedDirectoryAliasesShareTheSameExclusiveOwnerAndLeafLockLinksAreRejected() throws Exception {
Path real = Files.createDirectory(directory.resolve("real"));
Path linked = Files.createSymbolicLink(directory.resolve("linked"), real);
Path file = linked.resolve("npcs.json");
var first = new VotingNPCRegistry(file);
try {
await(first.initialLoad()); await(first.create(definition(1)));
var alias = new VotingNPCRegistry(real.resolve("npcs.json"));
try { assertThrows(ExecutionException.class, () -> await(alias.initialLoad())); }
finally { close(alias); }
} finally { close(first); }
var recovered = new VotingNPCRegistry(file);
try { assertEquals(List.of(definition(1)), await(recovered.initialLoad())); }
finally { close(recovered); }
Path lock = linked.resolve("other.json.lock");
Path unrelated = real.resolve("unrelated"); Files.writeString(unrelated, "unchanged");
Files.createSymbolicLink(lock, unrelated);
var rejected = new VotingNPCRegistry(linked.resolve("other.json"));
try { assertThrows(ExecutionException.class, () -> await(rejected.initialLoad())); }
finally { close(rejected); }
assertEquals("unchanged", Files.readString(unrelated));
}
@Test void orderedDefinitionsAreDurableAndDuplicateRequestsDoNotOverwrite() throws Exception {
Path file = directory.resolve("npcs.json");
var registry = new VotingNPCRegistry(file);
try {
assertEquals(List.of(), await(registry.initialLoad()));
var first = registry.create(definition(1));
var duplicate = registry.create(definition(1));
var second = registry.create(definition(2));
assertEquals(definition(1), await(first));
assertInstanceOf(IllegalArgumentException.class,
assertThrows(ExecutionException.class, () -> await(duplicate)).getCause());
await(second);
assertEquals(List.of(definition(1), definition(2)), new VotingNPCStore(file).load());
assertTrue(await(registry.remove("npc-1")));
assertFalse(await(registry.remove("npc-1")));
} finally { close(registry); }
var restarted = new VotingNPCRegistry(file);
try { assertEquals(List.of(definition(2)), await(restarted.initialLoad())); }
finally { close(restarted); }
}
@Test void failedReloadRetainsLastSnapshotButCannotPublishUntilRepaired() throws Exception {
Path file = directory.resolve("npcs.json");
var registry = new VotingNPCRegistry(file);
try {
await(registry.initialLoad()); await(registry.create(definition(1)));
byte[] healthy = Files.readAllBytes(file);
Files.writeString(file, "{invalid");
assertThrows(ExecutionException.class, () -> await(registry.reload()));
assertFalse(registry.available());
assertEquals(List.of(definition(1)), registry.snapshot());
assertThrows(ExecutionException.class, () -> await(registry.create(definition(2))));
assertEquals("{invalid", Files.readString(file));
Files.write(file, healthy);
assertEquals(List.of(definition(1)), await(registry.reload()));
await(registry.create(definition(2)));
} finally { close(registry); }
}
@Test void invalidInitialFileDoesNotAppearReadyOrGetReplaced() throws Exception {
Path file = directory.resolve("npcs.json"); Files.writeString(file, "{invalid");
var registry = new VotingNPCRegistry(file);
try {
assertThrows(ExecutionException.class, () -> await(registry.initialLoad()));
assertFalse(registry.available());
assertThrows(ExecutionException.class, () -> await(registry.create(definition(1))));
assertEquals("{invalid", Files.readString(file));
} finally { close(registry); }
}
@Test void closeReturnsWhileAcceptedWriteDrainsAndKeepsExclusiveFileOwnership() throws Exception {
Path file = directory.resolve("npcs.json");
CountDownLatch entered = new CountDownLatch(1), release = new CountDownLatch(1);
var store = new VotingNPCStore(file) {
@Override synchronized void save(List<VotingNPCDefinition> values) throws IOException {
entered.countDown(); waitOn(release); super.save(values);
}
};
var first = new VotingNPCRegistry(file, store);
VotingNPCRegistry replacement = null;
try {
await(first.initialLoad());
var writing = first.create(definition(1));
assertTrue(entered.await(5, TimeUnit.SECONDS));
first.close(); first.close();
assertFalse(first.awaitClosed(0, TimeUnit.SECONDS));
assertThrows(ExecutionException.class, () -> await(first.remove("npc-1")));
replacement = new VotingNPCRegistry(file);
var next = replacement;
assertThrows(ExecutionException.class, () -> await(next.initialLoad()));
assertFalse(replacement.available());
release.countDown(); await(writing);
assertTrue(first.awaitClosed(5, TimeUnit.SECONDS));
assertEquals(List.of(definition(1)), await(replacement.reload()));
} finally {
release.countDown(); close(first);
if (replacement != null) close(replacement);
}
}
@Test void saturatedReloadIsRejectedWithoutDisablingTheHealthyOwner() throws Exception {
Path file = directory.resolve("npcs.json");
CountDownLatch entered = new CountDownLatch(1), release = new CountDownLatch(1);
var store = new VotingNPCStore(file) {
@Override synchronized void save(List<VotingNPCDefinition> values) throws IOException {
entered.countDown(); waitOn(release); super.save(values);
}
};
var registry = new VotingNPCRegistry(file, store);
try {
await(registry.initialLoad());
var writing = registry.create(definition(1));
assertTrue(entered.await(5, TimeUnit.SECONDS));
var queued = new java.util.ArrayList<CompletionStage<Boolean>>();
for (int i = 0; i < 128; i++) queued.add(registry.remove("missing"));
assertThrows(ExecutionException.class, () -> await(registry.reload()));
assertTrue(registry.available(), "rejected reload must leave existing readiness intact");
release.countDown(); await(writing);
for (var entry : queued) assertFalse(await(entry));
await(registry.create(definition(2)));
} finally { release.countDown(); close(registry); }
}
@Test void failedWriteFencesAlreadyQueuedMutationsUntilCheckedReload() throws Exception {
Path file = directory.resolve("npcs.json");
CountDownLatch entered = new CountDownLatch(1), release = new CountDownLatch(1);
AtomicBoolean fail = new AtomicBoolean(true);
var store = new VotingNPCStore(file) {
@Override synchronized void save(List<VotingNPCDefinition> values) throws IOException {
if (fail.getAndSet(false)) {
entered.countDown(); waitOn(release);
super.save(values);
throw new IOException("Synthetic failure after visible write");
}
super.save(values);
}
};
var registry = new VotingNPCRegistry(file, store);
try {
await(registry.initialLoad());
var first = registry.create(definition(1));
assertTrue(entered.await(5, TimeUnit.SECONDS));
var second = registry.create(definition(2));
release.countDown();
assertThrows(ExecutionException.class, () -> await(first));
assertThrows(ExecutionException.class, () -> await(second));
assertFalse(registry.available());
assertEquals(List.of(), registry.snapshot());
assertEquals(List.of(definition(1)), new VotingNPCStore(file).load());
assertEquals(List.of(definition(1)), await(registry.reload()));
await(registry.create(definition(2)));
assertEquals(List.of(definition(1), definition(2)), registry.snapshot());
} finally { release.countDown(); close(registry); }
}
@Test void completionCallbackMayCloseWithoutDeadlockingOrInterruptingCommittedWork() throws Exception {
var registry = new VotingNPCRegistry(directory.resolve("npcs.json"));
try {
await(registry.initialLoad());
CompletableFuture<Void> callback = registry.create(definition(1)).thenAccept(value -> registry.close())
.toCompletableFuture();
await(callback);
assertTrue(registry.awaitClosed(5, TimeUnit.SECONDS));
assertEquals(List.of(definition(1)), new VotingNPCStore(directory.resolve("npcs.json")).load());
} finally { close(registry); }
}
@Test void capacityAndIdentityRejectionsLeaveHealthyStorageAvailable() throws Exception {
Path file = directory.resolve("npcs.json");
var seed = new VotingNPCStore(file); seed.load();
seed.save(java.util.stream.IntStream.rangeClosed(1, 63).mapToObj(this::definition).toList());
var registry = new VotingNPCRegistry(file);
try {
await(registry.initialLoad());
byte[] original = Files.readAllBytes(file);
var duplicateIdentity = new VotingNPCDefinition("another", definition(1).identity(), definition(1).world(),
0, 64, 0, 0, 0, "Vote");
assertThrows(ExecutionException.class, () -> await(registry.create(duplicateIdentity)));
assertTrue(registry.available(), "invalid new identity must not disable existing NPC storage");
assertArrayEquals(original, Files.readAllBytes(file));
await(registry.create(definition(64)));
byte[] atLimit = Files.readAllBytes(file);
assertThrows(ExecutionException.class, () -> await(registry.create(definition(65))));
assertTrue(registry.available(), "one extra creation must not disable 64 existing NPCs");
assertEquals(64, registry.snapshot().size());
assertArrayEquals(atLimit, Files.readAllBytes(file));
} finally { close(registry); }
}
}
@@ -1,78 +0,0 @@
package com.bencodez.votingplugin.npc;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.entity.Entity;
import org.junit.jupiter.api.Test;
import com.bencodez.votingplugin.VotingPluginMain;
class VotingNPCSchedulerTest {
@Test void alreadyOwnedCleanupRunsInlineEvenDuringDisable() {
var plugin = mock(VotingPluginMain.class);
try (var bukkit = mockStatic(Bukkit.class)) {
bukkit.when(Bukkit::isPrimaryThread).thenReturn(true);
var scheduler = new VotingNPCScheduler(plugin); var ran = new AtomicInteger();
scheduler.entity(mock(Entity.class), ran::incrementAndGet, () -> fail("retired"), error -> fail(error));
assertEquals(1, ran.get()); verify(plugin, never()).getBukkitScheduler();
}
}
@Test void deferredRegionActionUsesTheLocationSchedulerAndReportsFailure() {
var plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
try (var bukkit = mockStatic(Bukkit.class)) {
var scheduler = new VotingNPCScheduler(plugin); Location anchor = mock(Location.class);
var completion = new CompletableFuture<Void>();
var callback = new AtomicReference<Runnable>();
when(plugin.getBukkitScheduler().getFoliaLib().getImpl().runAtLocation(eq(anchor), any()))
.thenAnswer(inv -> { Consumer<?> action = inv.getArgument(1); callback.set(() -> action.accept(null)); return completion; });
var ran = new AtomicInteger(); List<Throwable> failures = new ArrayList<>();
scheduler.region(anchor, ran::incrementAndGet, failures::add);
assertEquals(0, ran.get()); callback.get().run(); assertEquals(1, ran.get());
completion.completeExceptionally(new IllegalStateException("Synthetic scheduler failure"));
assertEquals(1, failures.size());
}
}
@Test @SuppressWarnings({"unchecked", "rawtypes"})
void schedulerRetirementDoesNotPretendThatAnEntityWasRemoved() throws Exception {
var plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
try (var bukkit = mockStatic(Bukkit.class)) {
var scheduler = new VotingNPCScheduler(plugin); Entity entity = mock(Entity.class);
CompletableFuture completion = new CompletableFuture();
when(plugin.getBukkitScheduler().getFoliaLib().getImpl().runAtEntityWithFallback(eq(entity), any(), any()))
.thenReturn(completion);
var ran = new AtomicInteger(); var retired = new AtomicInteger(); List<Throwable> failures = new ArrayList<>();
scheduler.entity(entity, ran::incrementAndGet, retired::incrementAndGet, failures::add);
completion.complete(Enum.valueOf((Class) Class.forName("com.bencodez.simpleapi.folialib.enums.EntityTaskResult"), "SCHEDULER_RETIRED"));
assertEquals(0, ran.get()); assertEquals(0, retired.get()); assertEquals(1, failures.size());
}
}
@Test @SuppressWarnings({"unchecked", "rawtypes"})
void entityRetirementFallbackAndFutureCompletionAreHandledOnce() throws Exception {
var plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
try (var bukkit = mockStatic(Bukkit.class)) {
var scheduler = new VotingNPCScheduler(plugin); Entity entity = mock(Entity.class);
CompletableFuture completion = new CompletableFuture(); var fallback = new AtomicReference<Runnable>();
when(plugin.getBukkitScheduler().getFoliaLib().getImpl().runAtEntityWithFallback(eq(entity), any(), any()))
.thenAnswer(inv -> { fallback.set(inv.getArgument(2)); return completion; });
var retired = new AtomicInteger();
scheduler.entity(entity, () -> fail("Entity already retired"), retired::incrementAndGet, error -> fail(error));
fallback.get().run();
completion.complete(Enum.valueOf((Class) Class.forName("com.bencodez.simpleapi.folialib.enums.EntityTaskResult"), "ENTITY_RETIRED"));
assertEquals(1, retired.get());
}
}
}
@@ -1,158 +0,0 @@
package com.bencodez.votingplugin.npc;
import static org.junit.jupiter.api.Assertions.*;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.stream.IntStream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
class VotingNPCStoreTest {
@TempDir Path directory;
private VotingNPCDefinition definition(int id) {
return new VotingNPCDefinition("npc-" + id, new UUID(0, id), new UUID(1, 0),
-0.5, 64, 16.5, 90, 0, "Vote");
}
@Test void roundTripPreservesStableIdentitiesAndPositionAcrossRestart() throws Exception {
Path file = directory.resolve("npcs.json");
var store = new VotingNPCStore(file);
assertEquals(List.of(), store.load());
store.save(List.of(definition(1), definition(2)));
assertEquals(List.of(definition(1), definition(2)), new VotingNPCStore(file).load());
assertEquals(-1, definition(1).chunkX());
assertEquals(1, definition(1).chunkZ());
}
@Test void missingInitialReadDoesNotCreateFilesAndUninitializedStoreCannotOverwrite() throws Exception {
Path file = directory.resolve("npcs.json");
var store = new VotingNPCStore(file);
assertThrows(IOException.class, () -> store.save(List.of(definition(1))));
assertFalse(Files.exists(file));
assertTrue(store.load().isEmpty());
assertFalse(Files.exists(file));
}
@Test void invalidLoadKeepsOriginalBytesAndBlocksMutations() throws Exception {
Path file = directory.resolve("npcs.json");
byte[] original = "{ damaged definitions".getBytes(StandardCharsets.UTF_8);
Files.write(file, original);
var store = new VotingNPCStore(file);
assertThrows(IOException.class, store::load);
assertThrows(IOException.class, () -> store.save(List.of()));
assertArrayEquals(original, Files.readAllBytes(file));
}
@Test void duplicateIdentitiesAndCapacityRejectionDoNotChangeDurableDefinitions() throws Exception {
Path file = directory.resolve("npcs.json");
var store = new VotingNPCStore(file); store.load(); store.save(List.of(definition(1)));
byte[] before = Files.readAllBytes(file);
assertThrows(IOException.class, () -> store.save(List.of(definition(1), definition(1))));
var sameIdentity = new VotingNPCDefinition("another", definition(1).identity(), definition(1).world(),
0, 64, 0, 0, 0, "Vote");
assertThrows(IOException.class, () -> store.save(List.of(definition(1), sameIdentity)));
assertThrows(IOException.class, () -> store.save(IntStream.rangeClosed(1, 65).mapToObj(this::definition).toList()));
assertArrayEquals(before, Files.readAllBytes(file));
}
@Test void publicationFailureFencesOldStateUntilCheckedReload() throws Exception {
Path file = directory.resolve("npcs.json");
AtomicBoolean fail = new AtomicBoolean();
var store = new VotingNPCStore(file) {
@Override void forceDirectory(Path parent) throws IOException {
if (fail.get()) throw new IOException("Synthetic directory sync failure");
super.forceDirectory(parent);
}
};
store.load(); store.save(List.of(definition(1)));
fail.set(true);
assertThrows(IOException.class, () -> store.save(List.of(definition(1), definition(2))));
byte[] uncertain = Files.readAllBytes(file);
fail.set(false);
assertThrows(IOException.class, () -> store.save(List.of(definition(1))));
assertArrayEquals(uncertain, Files.readAllBytes(file));
assertEquals(List.of(definition(1), definition(2)), store.load());
store.save(List.of(definition(2)));
assertEquals(List.of(definition(2)), new VotingNPCStore(file).load());
}
@Test void missingUncertainFileDoesNotBecomeAnEmptySuccessfulRecovery() throws Exception {
Path file = directory.resolve("npcs.json");
var store = new VotingNPCStore(file) {
@Override void forceDirectory(Path ignored) throws IOException { throw new IOException("Synthetic failure"); }
};
store.load(); assertThrows(IOException.class, () -> store.save(List.of(definition(1))));
Files.delete(file);
assertThrows(IOException.class, store::load);
assertThrows(IOException.class, () -> store.save(List.of()));
assertFalse(Files.exists(file));
}
@Test void strictFieldsAndTypesRejectMalformedDocumentsIndividually() throws Exception {
Path file = directory.resolve("npcs.json");
var store = new VotingNPCStore(file); store.load(); store.save(List.of(definition(1)));
String healthy = Files.readString(file);
for (String damaged : List.of(
healthy.replace("\"version\": 1", "\"version\": 1, \"version\": 1"),
healthy.replace("\"version\": 1", "\"version\": \"1\""),
healthy.replace("\"version\": 1", "\"version\": 1.0"),
healthy.replace("\"id\": \"npc-1\"", "\"id\": \"npc-1\", \"id\": \"other\""),
healthy.replace("\"x\": -0.5", "\"x\": \"-0.5\""),
healthy.replace("\"name\": \"Vote\"", "\"unknown\": \"Vote\""),
healthy.replace("\"name\": \"Vote\"", "\"name\": null"),
healthy.replace("\"yaw\": 90.0", "\"yaw\": 1e100"),
healthy + "{}")) {
Files.writeString(file, damaged);
assertThrows(IOException.class, () -> new VotingNPCStore(file).load(), damaged);
assertEquals(damaged, Files.readString(file));
}
}
@Test void invalidUtf8OversizeAndSymlinkCannotBeLoadedOrOverwritten() throws Exception {
Path file = directory.resolve("npcs.json");
Files.write(file, new byte[] {(byte) 0xc3, (byte) 0x28});
assertThrows(IOException.class, () -> new VotingNPCStore(file).load());
Files.write(file, new byte[128 * 1024 + 1]);
assertThrows(IOException.class, () -> new VotingNPCStore(file).load());
Files.delete(file);
Path target = directory.resolve("unrelated.json");
Files.writeString(target, "unrelated");
Files.createSymbolicLink(file, target);
assertThrows(IOException.class, () -> new VotingNPCStore(file).load());
assertEquals("unrelated", Files.readString(target));
}
@Test void linkedDirectoriesAllowDurableDefinitionsButLeafLinksStayRejected() throws Exception {
Path real = Files.createDirectory(directory.resolve("real"));
Path linked = Files.createSymbolicLink(directory.resolve("linked"), real);
Path nested = Files.createDirectory(real.resolve("data"));
for (Path parent : List.of(linked, linked.resolve("data"))) {
Path file = parent.resolve("npcs.json");
var store = new VotingNPCStore(file);
assertTrue(store.load().isEmpty());
store.save(List.of(definition(1)));
assertEquals(List.of(definition(1)), new VotingNPCStore(file).load());
}
Path leaf = linked.resolve("alias.json");
Files.createSymbolicLink(leaf, nested.resolve("npcs.json"));
assertThrows(IOException.class, () -> new VotingNPCStore(leaf).load());
assertEquals(List.of(definition(1)), new VotingNPCStore(nested.resolve("npcs.json")).load());
}
@Test void invalidDefinitionsAreRejectedBeforePublication() {
assertThrows(IllegalArgumentException.class, () -> new VotingNPCDefinition("bad id", new UUID(0, 1),
new UUID(1, 0), 0, 64, 0, 0, 0, "Vote"));
assertThrows(IllegalArgumentException.class, () -> new VotingNPCDefinition("valid", new UUID(0, 1),
new UUID(1, 0), Double.NaN, 64, 0, 0, 0, "Vote"));
assertThrows(IllegalArgumentException.class, () -> new VotingNPCDefinition("valid", new UUID(0, 1),
new UUID(1, 0), 0, 64, 0, 0, 0, "Vote\nNew line"));
}
}
@@ -0,0 +1,70 @@
package com.bencodez.votingplugin.tests;
import com.bencodez.votingplugin.tests.support.ReflectiveAccess;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.Mockito.CALLS_REAL_METHODS;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import java.io.InputStreamReader;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.TimeUnit;
import org.bukkit.configuration.file.YamlConfiguration;
import org.junit.jupiter.api.Test;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.config.Config;
import com.bencodez.votingplugin.maintenance.AutoCreateVoteSitesReminderService.Settings;
class AutoCreateVoteSitesReminderConfigTest {
@Test
void bundledConfigHasOnlyExistingAutoCreateSetting() throws Exception {
var resource = VotingPluginMain.class.getClassLoader().getResourceAsStream("Config.yml");
assertNotNull(resource);
try (var reader = new InputStreamReader(resource, StandardCharsets.UTF_8)) {
YamlConfiguration config = YamlConfiguration.loadConfiguration(reader);
assertTrue(config.getBoolean("AutoCreateVoteSites"));
assertFalse(config.contains("AutoCreateVoteSitesReminder"));
}
}
@Test
void enabledAutoCreationGetsStartupAndTwoDayNagWithoutExtraSettings() throws Exception {
Config config = mock(Config.class);
when(config.isAutoCreateVoteSites()).thenReturn(true);
Settings settings = settings(config);
assertTrue(settings.enabled());
assertTrue(settings.autoCreateEnabled());
assertEquals(0, settings.afterMillis());
assertEquals(TimeUnit.HOURS.toMillis(48), settings.repeatMillis());
verify(config, never()).getData();
}
@Test
void disablingExistingAutoCreateSettingStopsNag() throws Exception {
Config config = mock(Config.class);
when(config.isAutoCreateVoteSites()).thenReturn(false);
assertFalse(settings(config).autoCreateEnabled());
verify(config, never()).getData();
}
private static Settings settings(Config config) throws Exception {
VotingPluginMain plugin = mock(VotingPluginMain.class, CALLS_REAL_METHODS);
Field field = VotingPluginMain.class.getDeclaredField("configFile");
field.setAccessible(true);
ReflectiveAccess.set(field, plugin, config);
Method method = VotingPluginMain.class.getDeclaredMethod("autoCreateVoteSitesReminderSettings");
method.setAccessible(true);
return (Settings) ReflectiveAccess.invoke(method, plugin, new Object[]{});
}
}
@@ -0,0 +1,270 @@
package com.bencodez.votingplugin.tests;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.util.concurrent.TimeUnit;
import org.junit.jupiter.api.Test;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState.Candidate;
import com.bencodez.votingplugin.core.maintenance.AutoCreateVoteSitesReminderState.Snapshot;
class AutoCreateVoteSitesReminderStateTest {
@Test
void firstReminderUsesStartupThresholdAndFortyEightHourRepeatDefault() {
long threshold = AutoCreateVoteSitesReminderState.DEFAULT_THRESHOLD_MILLIS;
assertEquals(0, threshold);
assertEquals(TimeUnit.HOURS.toMillis(48), AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS);
AutoCreateVoteSitesReminderState state = fresh(0);
Candidate first = state.propose(0, true, true, threshold,
AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS);
assertTrue(first.reminderDue());
assertEquals(new Snapshot(0, 0), first.snapshot());
state.commit(first);
Candidate boundary = state.propose(nanos(AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS), true, true,
threshold, AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS);
assertTrue(boundary.reminderDue());
assertEquals(new Snapshot(AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS,
AutoCreateVoteSitesReminderState.DEFAULT_REPEAT_MILLIS), boundary.snapshot());
}
@Test
void disabledFlagsSuppressOnlyReminderAndKeepAccruingRuntime() {
boolean[][] disabled = { { false, false }, { false, true }, { true, false } };
for (boolean[] flags : disabled) {
AutoCreateVoteSitesReminderState state = fresh(0);
Candidate candidate = state.propose(nanos(1500), flags[0], flags[1], 1000, 500);
assertFalse(candidate.reminderDue());
assertEquals(new Snapshot(1500, -1), candidate.snapshot());
state.commit(candidate);
Candidate enabled = state.propose(nanos(1500), true, true, 1000, 500);
assertTrue(enabled.reminderDue());
assertEquals(new Snapshot(1500, 1500), enabled.snapshot());
}
}
@Test
void restartLoadsCumulativeRuntimeAndExcludesOfflineTime() {
AutoCreateVoteSitesReminderState previous = fresh(0);
previous.commit(previous.propose(nanos(900), false, false, 1000, 500));
long restartClock = nanos(TimeUnit.DAYS.toMillis(30));
AutoCreateVoteSitesReminderState restarted = new AutoCreateVoteSitesReminderState(previous.snapshot(),
restartClock);
assertFalse(restarted.propose(restartClock, true, true, 1000, 500).reminderDue());
Candidate before = restarted.propose(restartClock + nanos(99), true, true, 1000, 500);
assertEquals(new Snapshot(999, -1), before.snapshot());
assertFalse(before.reminderDue());
restarted.commit(before);
Candidate boundary = restarted.propose(restartClock + nanos(100), true, true, 1000, 500);
assertEquals(new Snapshot(1000, 1000), boundary.snapshot());
assertTrue(boundary.reminderDue());
}
@Test
void restartPreservesReminderCooldownWithFreshClockAnchor() {
AutoCreateVoteSitesReminderState state = new AutoCreateVoteSitesReminderState(new Snapshot(1000, 1000),
-nanos(5000));
assertFalse(state.propose(-nanos(4501), true, true, 1000, 500).reminderDue());
assertTrue(state.propose(-nanos(4500), true, true, 1000, 500).reminderDue());
}
@Test
void repeatBoundaryIsInclusiveAndAdvancesOnlyAfterCommit() {
AutoCreateVoteSitesReminderState state = new AutoCreateVoteSitesReminderState(new Snapshot(1000, 1000), 0);
Candidate before = state.propose(nanos(499), true, true, 1000, 500);
assertFalse(before.reminderDue());
state.commit(before);
Candidate boundary = state.propose(nanos(500), true, true, 1000, 500);
assertTrue(boundary.reminderDue());
assertEquals(new Snapshot(1499, 1000), state.snapshot());
state.commit(boundary);
assertEquals(new Snapshot(1500, 1500), state.snapshot());
assertFalse(state.propose(nanos(999), true, true, 1000, 500).reminderDue());
assertTrue(state.propose(nanos(1000), true, true, 1000, 500).reminderDue());
}
@Test
void failedPersistenceLeavesUptimeAndReminderRetryableWithoutDoubleCounting() {
AutoCreateVoteSitesReminderState state = fresh(0);
Candidate failedWrite = state.propose(nanos(1000), true, true, 1000, 500);
assertTrue(failedWrite.reminderDue());
// The storage owner must omit commit when its write fails.
assertEquals(new Snapshot(0, -1), state.snapshot());
Candidate sameClockRetry = state.propose(nanos(1000), true, true, 1000, 500);
assertEquals(failedWrite.snapshot(), sameClockRetry.snapshot());
Candidate laterRetry = state.propose(nanos(1200), true, true, 1000, 500);
assertTrue(laterRetry.reminderDue());
assertEquals(new Snapshot(1200, 1200), laterRetry.snapshot());
state.commit(laterRetry);
assertThrows(IllegalArgumentException.class, () -> state.commit(failedWrite));
assertThrows(IllegalArgumentException.class, () -> state.commit(sameClockRetry));
Candidate next = state.propose(nanos(1300), true, true, 1000, 500);
assertEquals(new Snapshot(1300, 1200), next.snapshot());
assertFalse(next.reminderDue());
}
@Test
void failedNonReminderCheckpointDoesNotMintRuntimeOnRetry() {
AutoCreateVoteSitesReminderState state = fresh(0);
state.propose(nanos(300), false, false, 1000, 500);
Candidate retry = state.propose(nanos(400), false, false, 1000, 500);
assertEquals(new Snapshot(400, -1), retry.snapshot());
state.commit(retry);
assertEquals(new Snapshot(500, -1), state.propose(nanos(500), false, false, 1000, 500).snapshot());
}
@Test
void staleAndDuplicateCommitsAreRejectedWithoutPublishingProgress() {
AutoCreateVoteSitesReminderState state = fresh(0);
Candidate first = state.propose(nanos(100), false, false, 1000, 500);
Candidate sibling = state.propose(nanos(200), false, false, 1000, 500);
state.commit(first);
assertThrows(IllegalArgumentException.class, () -> state.commit(first));
assertThrows(IllegalArgumentException.class, () -> state.commit(sibling));
assertEquals(new Snapshot(100, -1), state.snapshot());
Candidate retry = state.propose(nanos(200), false, false, 1000, 500);
state.commit(retry);
assertEquals(new Snapshot(200, -1), state.snapshot());
}
@Test
void candidateFromAnotherStateIsRejectedEvenWithIdenticalSnapshots() {
AutoCreateVoteSitesReminderState state = fresh(0);
AutoCreateVoteSitesReminderState other = fresh(0);
Candidate foreign = other.propose(nanos(1000), true, true, 1000, 500);
assertThrows(IllegalArgumentException.class, () -> state.commit(foreign));
assertEquals(new Snapshot(0, -1), state.snapshot());
other.commit(foreign);
assertEquals(new Snapshot(1000, 1000), other.snapshot());
}
@Test
void changingThresholdAndRepeatKeepsExistingRuntimeAndReminderMarker() {
AutoCreateVoteSitesReminderState state = fresh(0);
state.commit(state.propose(nanos(1500), true, true, 2000, 1000));
Candidate loweredThreshold = state.propose(nanos(1500), true, true, 1000, 1000);
assertTrue(loweredThreshold.reminderDue());
state.commit(loweredThreshold);
assertFalse(state.propose(nanos(2000), true, true, 3000, 100).reminderDue());
assertFalse(state.propose(nanos(2000), true, true, 1000, 1000).reminderDue());
Candidate loweredRepeat = state.propose(nanos(2000), true, true, 1000, 500);
assertTrue(loweredRepeat.reminderDue());
assertEquals(new Snapshot(2000, 2000), loweredRepeat.snapshot());
}
@Test
void disablingAfterReminderDoesNotClearItsMarker() {
AutoCreateVoteSitesReminderState state = new AutoCreateVoteSitesReminderState(new Snapshot(1000, 1000), 0);
Candidate disabled = state.propose(nanos(600), false, false, 1000, 500);
state.commit(disabled);
assertEquals(new Snapshot(1600, 1000), state.snapshot());
assertFalse(disabled.reminderDue());
assertTrue(state.propose(nanos(600), true, true, 1000, 500).reminderDue());
}
@Test
void negativeNanoReadingsAccruePositiveElapsedRuntime() {
AutoCreateVoteSitesReminderState state = fresh(-nanos(1000));
Candidate candidate = state.propose(-nanos(900), false, false, 1000, 500);
assertEquals(new Snapshot(100, -1), candidate.snapshot());
state.commit(candidate);
assertEquals(new Snapshot(200, -1), state.propose(-nanos(800), false, false, 1000, 500).snapshot());
}
@Test
void signedNanoClockWrapAccruesElapsedTime() {
AutoCreateVoteSitesReminderState state = fresh(Long.MAX_VALUE - 500_000);
Candidate wrapped = state.propose(Long.MIN_VALUE + 499_999, true, true, 1, 1);
assertTrue(wrapped.reminderDue());
assertEquals(new Snapshot(1, 1), wrapped.snapshot());
state.commit(wrapped);
assertEquals(new Snapshot(2, 2), state.propose(Long.MIN_VALUE + 1_499_999, true, true, 1, 1).snapshot());
}
@Test
void backwardClockDoesNotMoveAnchorOrMintElapsedRuntime() {
AutoCreateVoteSitesReminderState state = fresh(nanos(1000));
Candidate backward = state.propose(nanos(900), true, true, 1000, 500);
assertEquals(new Snapshot(0, -1), backward.snapshot());
state.commit(backward);
assertEquals(new Snapshot(100, -1), state.propose(nanos(1100), false, false, 1000, 500).snapshot());
}
@Test
void subMillisecondCheckpointsRetainRemainderAndNeverDoubleCount() {
AutoCreateVoteSitesReminderState state = fresh(0);
for (long clock : new long[] { 400_000, 800_000, 1_200_000, 1_600_000, 2_000_000 }) {
state.commit(state.propose(clock, false, false, 1000, 500));
}
assertEquals(new Snapshot(2, -1), state.snapshot());
state.commit(state.propose(2_000_000, false, false, 1000, 500));
assertEquals(new Snapshot(2, -1), state.snapshot());
}
@Test
void runtimeSaturatesWithoutOverflowAndReminderMarkerRemainsValid() {
AutoCreateVoteSitesReminderState state = new AutoCreateVoteSitesReminderState(new Snapshot(Long.MAX_VALUE - 2, -1), 0);
Candidate candidate = state.propose(nanos(10), true, true, 1000, 500);
assertTrue(candidate.reminderDue());
assertEquals(new Snapshot(Long.MAX_VALUE, Long.MAX_VALUE), candidate.snapshot());
state.commit(candidate);
Candidate later = state.propose(nanos(20), true, true, 1000, 500);
assertEquals(new Snapshot(Long.MAX_VALUE, Long.MAX_VALUE), later.snapshot());
assertFalse(later.reminderDue());
}
@Test
void saturationDoesNotOverflowRepeatElapsedComparison() {
AutoCreateVoteSitesReminderState state = new AutoCreateVoteSitesReminderState(new Snapshot(Long.MAX_VALUE - 1, 0), 0);
Candidate candidate = state.propose(nanos(100), true, true,
AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS, AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS);
assertTrue(candidate.reminderDue());
assertEquals(Long.MAX_VALUE, candidate.snapshot().totalRuntimeMillis());
}
@Test
void snapshotsRejectNegativeRuntimeInvalidSentinelAndFutureReminderMarker() {
assertThrows(IllegalArgumentException.class, () -> new Snapshot(-1, -1));
assertThrows(IllegalArgumentException.class, () -> new Snapshot(0, -2));
assertThrows(IllegalArgumentException.class, () -> new Snapshot(0, 1));
assertThrows(IllegalArgumentException.class, () -> new Snapshot(Long.MAX_VALUE - 1, Long.MAX_VALUE));
assertEquals(new Snapshot(0, -1), fresh(0).snapshot());
assertEquals(0, new Snapshot(0, 0).lastReminderRuntimeMillis());
assertEquals(Long.MAX_VALUE, new Snapshot(Long.MAX_VALUE, Long.MAX_VALUE).totalRuntimeMillis());
}
@Test
void intervalsAllowStartupThresholdButRequirePositiveBoundedRepeatsEvenWhileDisabled() {
AutoCreateVoteSitesReminderState state = fresh(0);
for (long invalid : new long[] { -1, AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS + 1, Long.MAX_VALUE }) {
assertThrows(IllegalArgumentException.class, () -> state.propose(0, false, false, invalid, 1));
assertThrows(IllegalArgumentException.class, () -> state.propose(0, false, false, 1, invalid));
}
assertThrows(IllegalArgumentException.class, () -> state.propose(0, false, false, 0, 0));
assertFalse(state.propose(0, false, false, 0, 1).reminderDue());
assertEquals(new Snapshot(0, -1), state.snapshot());
assertFalse(state.propose(0, true, true, AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS,
AutoCreateVoteSitesReminderState.MAX_INTERVAL_MILLIS).reminderDue());
}
@Test
void nullSnapshotAndNullCandidateAreRejected() {
assertThrows(NullPointerException.class, () -> new AutoCreateVoteSitesReminderState(null, 0));
AutoCreateVoteSitesReminderState state = fresh(0);
assertThrows(NullPointerException.class, () -> state.commit(null));
assertEquals(new Snapshot(0, -1), state.snapshot());
}
private static AutoCreateVoteSitesReminderState fresh(long nowNanos) {
return new AutoCreateVoteSitesReminderState(new Snapshot(0, AutoCreateVoteSitesReminderState.NEVER_REMINDED), nowNanos);
}
private static long nanos(long millis) {
return Math.multiplyExact(millis, 1_000_000);
}
}
@@ -1,5 +1,7 @@
package com.bencodez.votingplugin.tests;
import com.bencodez.votingplugin.tests.support.ReflectiveAccess;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;
@@ -1418,7 +1420,7 @@ class CachedVoteBatchDurabilityTest {
for (var pair : List.of(new Object[] {"useMySQL", true}, new Object[] {"voteCacheTable", serverTable},
new Object[] {"onlineVoteCacheTable", onlineTable}, new Object[] {"timedVoteCacheTable", timedTable})) {
Field field = VoteCacheHandler.class.getDeclaredField((String) pair[0]);
field.setAccessible(true); field.set(handler, pair[1]);
field.setAccessible(true); ReflectiveAccess.set(field, handler, pair[1]);
}
return handler;
}
@@ -0,0 +1,58 @@
package com.bencodez.votingplugin.tests;
import com.bencodez.votingplugin.*;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;
import static org.mockito.ArgumentMatchers.*;
import com.bencodez.votingplugin.placeholders.PlaceholderPlayerPresence;
import com.bencodez.votingplugin.signs.Signs;
import com.bencodez.votingplugin.streaks.VoteStreaksMenu;
import com.bencodez.votingplugin.util.BukkitCompletionScheduler;
import java.util.HashSet;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import org.bukkit.event.HandlerList;
import org.bukkit.entity.Player;
import org.junit.jupiter.api.Test;
class DateEventUnloadIntegrationTest {
private void field(Object target, String name, Object value) throws Exception {
var field = VotingPluginMain.class.getDeclaredField(name); field.setAccessible(true); field.set(target, value);
}
private ScheduledExecutorService stoppedExecutor() throws Exception {
var executor = mock(ScheduledExecutorService.class);
when(executor.awaitTermination(anyLong(), any(TimeUnit.class))).thenReturn(true);
return executor;
}
@Test void unloadClosesDateIngressAndRejectsLaterStreakMenuOpens() throws Exception {
var plugin = mock(VotingPluginMain.class, CALLS_REAL_METHODS);
doReturn(true).when(plugin).isEnabled();
field(plugin, "unloadInProgress", new java.util.concurrent.atomic.AtomicBoolean());
var listener = mock(com.bencodez.votingplugin.listeners.VotiferEvent.class);
field(plugin, "localVotifierListener", listener);
field(plugin, "localVotifierIngressReady", true);
field(plugin, "placeholderPlayerPresence", new PlaceholderPlayerPresence());
field(plugin, "backendHostedControlLifecycle", stoppedExecutor());
field(plugin, "backendHostedControlManagers", new HashSet<>());
field(plugin, "backendControlConnectorLifecycle", stoppedExecutor());
field(plugin, "voteTimer", stoppedExecutor());
var signs = mock(Signs.class);
when(signs.storeSignsForShutdown()).thenReturn(java.util.concurrent.CompletableFuture.completedFuture(null));
field(plugin, "signs", signs);
var menu = new VoteStreaksMenu(plugin); field(plugin, "voteStreaksMenu", menu);
var player = mock(Player.class);
try (var handlers = mockStatic(HandlerList.class); var scheduler = mockStatic(BukkitCompletionScheduler.class)) {
scheduler.when(() -> BukkitCompletionScheduler.run(eq(plugin), eq(player), any(Runnable.class), any(Runnable.class), any(Runnable.class)))
.thenAnswer(call -> { call.getArgument(2, Runnable.class).run(); return null; });
plugin.onUnLoad();
verify(listener).stop();
var proxy = mock(Runnable.class);
assertThrows(IllegalStateException.class, () -> DateVoteIngressAccess.initializeDateVoteIngress(plugin, proxy));
verifyNoInteractions(proxy);
menu.open(player);
verifyNoInteractions(player);
verify(signs).storeSignsForShutdown();
}
}
}
@@ -0,0 +1,24 @@
package com.bencodez.votingplugin.tests;
import com.bencodez.votingplugin.VotingPluginMain;
import com.bencodez.votingplugin.tests.support.ReflectiveAccess;
import org.mockito.Mockito;
/** Narrow test-only access to the real startup ingress lifecycle. */
public final class DateVoteIngressAccess {
private DateVoteIngressAccess() { }
public static void initializeDateVoteIngress(VotingPluginMain target, Runnable opening) {
ReflectiveAccess.call("com.bencodez.votingplugin.VotingPluginMain", target,
"initializeDateVoteIngress", new String[]{"Runnable"}, new Object[]{opening});
}
public static void registerEarlyVotifierIngress(VotingPluginMain target) {
ReflectiveAccess.call("com.bencodez.votingplugin.VotingPluginMain", target,
"registerEarlyVotifierIngress", new String[]{}, new Object[]{});
}
public static void callRealInitialization(VotingPluginMain target) {
initializeDateVoteIngress(Mockito.doCallRealMethod().when(target), Mockito.any());
}
public static void callRealRegistration(VotingPluginMain target) {
registerEarlyVotifierIngress(Mockito.doCallRealMethod().when(target));
}
}
@@ -0,0 +1,173 @@
package com.bencodez.votingplugin.tests;
import com.bencodez.votingplugin.*;
import static org.mockito.Mockito.*;
import static org.junit.jupiter.api.Assertions.*;
import java.nio.file.Path;
import java.util.UUID;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.bukkit.configuration.file.YamlConfiguration;
import com.bencodez.votingplugin.specialrewards.datemilestones.DateVoteMilestones;
import com.bencodez.votingplugin.user.VotingPluginUser;
class DateVoteIngressOrderingTest {
@TempDir Path root;
@Test void firstTransportDeliveryFindsDefinitionsAndRewardHandlesAlreadyPublished() throws Exception {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
YamlConfiguration config = new YamlConfiguration();
String prefix = "DateVoteMilestones.startup.";
config.set(prefix + "Enabled", true); config.set(prefix + "Timezone", "UTC");
config.set(prefix + "Start", "2020-01-01T00:00:00"); config.set(prefix + "End", "2099-01-01T00:00:00");
config.set(prefix + "AccountingServer", "backend");
config.set(prefix + "Milestones.1.Rewards.Messages.Player", "Thanks");
when(plugin.getSpecialRewardsConfig().getData()).thenReturn(config);
when(plugin.getDataFolder()).thenReturn(root.toFile());
when(plugin.getOptions().isProcessRewards()).thenReturn(true);
when(plugin.getBungeeSettings().isUseBungeecoord()).thenReturn(true);
when(plugin.getBungeeSettings().getServer()).thenReturn("backend");
DateVoteMilestones events = new DateVoteMilestones(plugin);
when(plugin.getDateVoteMilestones()).thenReturn(events);
VotingPluginUser user = mock(VotingPluginUser.class); when(user.getJavaUUID()).thenReturn(UUID.randomUUID());
Runnable ingress = () -> {
verify(plugin).addDirectlyDefinedRewards(any());
events.accepted(user, "a", UUID.randomUUID(), System.currentTimeMillis(), true, true, true, false, false);
};
ready(plugin);
DateVoteIngressAccess.callRealInitialization(plugin);
DateVoteIngressAccess.initializeDateVoteIngress(plugin, ingress);
verify(plugin.getRewardHandler()).giveReward(eq(user), any(), startsWith("DateVoteMilestonesRuntime."), any());
assertTrue(java.nio.file.Files.exists(root.resolve("date-vote-milestones")));
}
private static final String[] HANDLERS = {"voteMilestonesManager", "voteStreakHandler", "voteParty", "specialRewards", "topVoterHandler", "voteShopManager", "placeholders"};
private static void ready(VotingPluginMain plugin) throws Exception {
for (String name : HANDLERS) {
var field = VotingPluginMain.class.getDeclaredField(name); field.setAccessible(true); field.set(plugin, mock(field.getType()));
}
}
@Test void eachMissingDownstreamHandlerKeepsIngressClosed() throws Exception {
for (String name : HANDLERS) {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS); ready(plugin);
var field = VotingPluginMain.class.getDeclaredField(name); field.setAccessible(true); field.set(plugin, null);
DateVoteIngressAccess.callRealInitialization(plugin); Runnable ingress = mock(Runnable.class);
assertThrows(IllegalStateException.class, () -> DateVoteIngressAccess.initializeDateVoteIngress(plugin, ingress)); verify(ingress, never()).run();
verify(plugin.getDateVoteMilestones(), never()).reload();
verify(plugin.getServer().getPluginManager(), never()).registerEvents(any(), eq(plugin));
}
}
@Test void earlyCaptureIsRegisteredOnceAndConsumersOpenOnlyAfterDefinitionsAndHandlers() throws Exception {
for (boolean proxyEnabled : new boolean[] {false, true}) {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
when(plugin.isVotifierLoaded()).thenReturn(true);
when(plugin.getBungeeSettings().isUseBungeecoord()).thenReturn(proxyEnabled);
var timer = mock(java.util.concurrent.ScheduledExecutorService.class);
when(plugin.getVoteTimer()).thenReturn(timer);
var registered = new java.util.ArrayList<org.bukkit.event.Listener>();
var manager = plugin.getServer().getPluginManager();
doAnswer(call -> { registered.add(call.getArgument(0)); return null; }).when(manager).registerEvents(any(), eq(plugin));
DateVoteIngressAccess.callRealRegistration(plugin);
DateVoteIngressAccess.callRealInitialization(plugin);
try (var queues = mockConstruction(com.bencodez.votingplugin.listeners.VotifierVoteOverflowQueue.class)) {
DateVoteIngressAccess.registerEarlyVotifierIngress(plugin); DateVoteIngressAccess.registerEarlyVotifierIngress(plugin);
assertEquals(1, registered.size());
assertInstanceOf(com.bencodez.votingplugin.listeners.VotiferEvent.class, registered.getFirst());
verify(plugin.getDateVoteMilestones(), never()).reload();
assertEquals(1, queues.constructed().size(), "capture publishes its independent queue owner immediately");
var queueField = VotingPluginMain.class.getDeclaredField("votifierVoteOverflowQueue");
queueField.setAccessible(true);
assertSame(queues.constructed().getFirst(), queueField.get(plugin));
verifyNoInteractions(timer); // Loading cannot be lost with vote-executor cancellation.
verify(queues.constructed().getFirst(), never()).start();
ready(plugin);
Runnable proxy = () -> {
verify(plugin.getDateVoteMilestones()).reload();
assertEquals(3, registered.size());
assertInstanceOf(com.bencodez.votingplugin.listeners.PlayerVoteListener.class, registered.get(1));
assertInstanceOf(com.bencodez.votingplugin.timequeue.TimeQueueHandler.class, registered.get(2));
};
DateVoteIngressAccess.initializeDateVoteIngress(plugin, proxy); DateVoteIngressAccess.initializeDateVoteIngress(plugin, proxy);
assertEquals(3, registered.size());
verify(plugin.getDateVoteMilestones()).reload(); verify(queues.constructed().getFirst()).start();
}
}
}
@Test void persistedReplayProducerIsConstructedOnlyAfterItsAcceptedVoteConsumer() throws Exception {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS); ready(plugin);
DateVoteIngressAccess.callRealInitialization(plugin);
var manager = plugin.getServer().getPluginManager();
var registered = new java.util.ArrayList<org.bukkit.event.Listener>();
doAnswer(call -> { registered.add(call.getArgument(0)); return null; }).when(manager).registerEvents(any(), eq(plugin));
try (var producers = mockConstruction(com.bencodez.votingplugin.timequeue.TimeQueueHandler.class, (handler, context) -> {
// The real constructor schedules replay immediately; this hook runs at that boundary.
assertEquals(1, registered.size()); assertInstanceOf(com.bencodez.votingplugin.listeners.PlayerVoteListener.class, registered.getFirst());
verify(plugin.getDateVoteMilestones()).reload();
})) {
DateVoteIngressAccess.initializeDateVoteIngress(plugin, () -> fail("Local startup does not open proxy ingress"));
assertEquals(1, producers.constructed().size()); assertSame(producers.constructed().getFirst(), registered.get(1));
var field = VotingPluginMain.class.getDeclaredField("timeQueueHandler"); field.setAccessible(true);
assertSame(producers.constructed().getFirst(), field.get(plugin));
}
}
@Test void failedProxyOpeningRetriesWithoutDuplicatingAcceptedConsumers() throws Exception {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
ready(plugin); when(plugin.getBungeeSettings().isUseBungeecoord()).thenReturn(true);
DateVoteIngressAccess.callRealInitialization(plugin);
var registered = new java.util.ArrayList<org.bukkit.event.Listener>();
var eventManager = plugin.getServer().getPluginManager();
doAnswer(call -> { registered.add(call.getArgument(0)); return null; })
.when(eventManager).registerEvents(any(), eq(plugin));
assertThrows(IllegalStateException.class, () -> DateVoteIngressAccess.initializeDateVoteIngress(plugin, () -> { throw new IllegalStateException("transport unavailable"); }));
assertEquals(2, registered.size());
DateVoteIngressAccess.initializeDateVoteIngress(plugin, () -> { }); DateVoteIngressAccess.initializeDateVoteIngress(plugin, () -> fail("Already ready"));
assertEquals(2, registered.size()); verify(plugin.getDateVoteMilestones(), times(2)).reload();
}
@Test void reenableCreatesNewIngressAndFencesOldReadiness() throws Exception {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
when(plugin.isVotifierLoaded()).thenReturn(true);
when(plugin.getBungeeSettings().isUseBungeecoord()).thenReturn(true);
when(plugin.getBungeeSettings().isGloblalDataEnabled()).thenReturn(true);
DateVoteIngressAccess.callRealRegistration(plugin);
DateVoteIngressAccess.callRealInitialization(plugin);
var listenerField = VotingPluginMain.class.getDeclaredField("localVotifierListener");
listenerField.setAccessible(true);
var readyField = com.bencodez.votingplugin.listeners.VotiferEvent.class.getDeclaredField("ready");
readyField.setAccessible(true);
var closedField = VotingPluginMain.class.getDeclaredField("localVotifierIngressClosed");
closedField.setAccessible(true);
var steps = VotingPluginMain.class.getDeclaredField("completedUnloadSteps"); steps.setAccessible(true);
var reset = VotingPluginMain.class.getDeclaredMethod("resetDateVoteIngressForEnable"); reset.setAccessible(true);
try (var queues = mockConstruction(com.bencodez.votingplugin.listeners.VotifierVoteOverflowQueue.class)) {
DateVoteIngressAccess.registerEarlyVotifierIngress(plugin);
Object first = listenerField.get(plugin);
var oldReady = (java.util.function.BooleanSupplier) readyField.get(first);
closedField.setBoolean(plugin, true);
steps.set(plugin, new java.util.HashSet<>(java.util.Set.of("local Votifier ingress", "event handlers")));
reset.invoke(plugin);
assertFalse(oldReady.getAsBoolean());
DateVoteIngressAccess.registerEarlyVotifierIngress(plugin);
Object second = listenerField.get(plugin);
assertNotSame(first, second);
ready(plugin);
DateVoteIngressAccess.initializeDateVoteIngress(plugin, () -> { });
assertTrue(((java.util.function.BooleanSupplier) readyField.get(second)).getAsBoolean());
assertFalse(oldReady.getAsBoolean(), "a retired generation must not become ready again");
verify(plugin.getServer().getPluginManager(), times(3)).registerEvents(any(), eq(plugin));
}
}
@Test void reenableRejectsIncompletePriorIngressRetirement() throws Exception {
VotingPluginMain plugin = mock(VotingPluginMain.class, RETURNS_DEEP_STUBS);
var listener = VotingPluginMain.class.getDeclaredField("localVotifierListener"); listener.setAccessible(true);
listener.set(plugin, mock(com.bencodez.votingplugin.listeners.VotiferEvent.class));
var steps = VotingPluginMain.class.getDeclaredField("completedUnloadSteps"); steps.setAccessible(true);
steps.set(plugin, new java.util.HashSet<>(java.util.Set.of("event handlers")));
var reset = VotingPluginMain.class.getDeclaredMethod("resetDateVoteIngressForEnable"); reset.setAccessible(true);
var failure = assertThrows(java.lang.reflect.InvocationTargetException.class, () -> reset.invoke(plugin));
assertInstanceOf(IllegalStateException.class, failure.getCause());
assertNotNull(listener.get(plugin));
}
}
Loaded 100 of 390 files, more files were not shown because too many files have changed in this diff. Show more