Add Rotations

src/main/i18n/templates/pgm/PGMMessages.properties

@@ -23,6 +23,7 @@ command.admin.pgm = Configuration successfully reloaded.
 
 # {0} = map title and version
 command.map.next.success = Next map: {0}
+command.map.next.noNextMap = No next map
 
 command.map.update.running = Not updated, map modified by active match
 

src/main/i18n/templates/pgm/PGMUI.properties

@@ -16,9 +16,17 @@ command.map.mapInfo.proto = Proto
 command.map.mapInfo.source = Source
 command.map.mapInfo.folder = Folder
 
-command.map.currentRotation.title = Current Rotation
+command.rotation.noRotationMatch = No rotations matched query.
+command.rotation.noRotation = No rotation currently in use.
+command.rotation.noRotations = No loaded rotations.
+command.rotation.currentRotation.title = Rotation
+command.rotation.rotationsDisabled = Rotations are currently disabled.
 
-command.map.rotationList.title = Loaded Rotations
+command.rotation.rotationList.title = Loaded Rotations
+command.rotation.skip.message = Skipped a total of {0} positions.
+command.rotation.skip.noNegative = You may not skip negative positions!
+
+rotations.rotationChange = Rotation has been set to {0} in order to better adjust to the current player count.
 
 map.genre.objectives = Objectives
 map.genre.deathmatch = Deathmatch

src/main/java/tc/oc/pgm/Config.java

@@ -33,6 +33,16 @@ public static boolean reloadWhenError() {
     }
   }
 
+  public static class Rotations {
+    public static boolean areEnabled() {
+      return getConfiguration().getBoolean("rotations.enabled");
+    }
+
+    public static String getPath() {
+      return getConfiguration().getString("rotations.path");
+    }
+  }
+
   public static class AutoRestart {
     private final Configuration config;
 

src/main/java/tc/oc/pgm/PGMImpl.java

@@ -45,6 +45,7 @@
 import tc.oc.pgm.commands.MapDevelopmentCommands;
 import tc.oc.pgm.commands.MatchCommands;
 import tc.oc.pgm.commands.ModeCommands;
+import tc.oc.pgm.commands.RotationCommands;
 import tc.oc.pgm.commands.StartCommands;
 import tc.oc.pgm.commands.TeamCommands;
 import tc.oc.pgm.commands.TimeLimitCommands;
@@ -113,6 +114,8 @@
 import tc.oc.pgm.regions.RegionModule;
 import tc.oc.pgm.renewable.RenewableModule;
 import tc.oc.pgm.restart.RestartManager;
+import tc.oc.pgm.rotation.FixedPGMMapOrderManager;
+import tc.oc.pgm.rotation.RandomPGMMapOrder;
 import tc.oc.pgm.score.ScoreModule;
 import tc.oc.pgm.scoreboard.ScoreboardModule;
 import tc.oc.pgm.scoreboard.SidebarModule;
@@ -231,6 +234,15 @@ public void onEnable() {
 
     try {
       matchManager = new MatchManagerImpl(server, mapLibrary, mapLoader);
+
+      if (Config.Rotations.areEnabled()) {
+        matchManager.setMapOrder(
+            new FixedPGMMapOrderManager(
+                matchManager, logger, new File(getDataFolder(), Config.Rotations.getPath())));
+      } else {
+        matchManager.setMapOrder(new RandomPGMMapOrder(matchManager));
+      }
+
     } catch (MapNotFoundException e) {
       logger.log(Level.SEVERE, "PGM could not load any maps, server will shut down", e);
       server.shutdown();
@@ -263,8 +275,10 @@ public Identity getIdentity(UUID playerId, String username, @Nullable String nic
         .scheduleSyncDelayedTask(
             this,
             () -> {
-              if (!matchManager.cycleMatch(null, MapCommands.popNextMap(), true).isPresent()) {
-                logger.severe("PGM could not load the initial match, server will shut down");
+              if (!matchManager
+                  .cycleMatch(null, matchManager.getMapOrder().popNextMap(), true)
+                  .isPresent()) {
+                logger.severe("PGM could not load an initial match, server will shut down");
                 server.shutdown();
               }
             });
@@ -404,6 +418,7 @@ private void registerCommands() {
     node.registerCommands(new MatchCommands());
     node.registerNode("mode", "modes").registerCommands(new ModeCommands());
     node.registerCommands(new TimeLimitCommands());
+    node.registerCommands(new RotationCommands());
 
     new BukkitIntake(this, graph).register();
   }

src/main/java/tc/oc/pgm/api/match/MatchManager.java

@@ -11,6 +11,7 @@
 import tc.oc.pgm.api.chat.Audience;
 import tc.oc.pgm.map.MapNotFoundException;
 import tc.oc.pgm.map.PGMMap;
+import tc.oc.pgm.rotation.PGMMapOrder;
 
 /** A manager that creates, loads, unloads, and cycles {@link Match}es. */
 public interface MatchManager extends MatchPlayerResolver, Audience {
@@ -89,4 +90,8 @@ default Match getMatch(@Nullable CommandSender sender) {
   // TODO: Move to either MapLibrary or MapLoader, this is an orthogonal concern
   @Deprecated
   Collection<PGMMap> loadNewMaps() throws MapNotFoundException;
+
+  void setMapOrder(PGMMapOrder pgmMapOrder);
+
+  PGMMapOrder getMapOrder();
 }

src/main/java/tc/oc/pgm/commands/AdminCommands.java

@@ -127,7 +127,8 @@ public static void end(CommandSender sender, Match match, @Nullable @Text String
       usage = "[map name]",
       flags = "f",
       perms = Permissions.SETNEXT)
-  public static void setNext(CommandSender sender, @Switch('f') boolean force, @Text PGMMap map)
+  public static void setNext(
+      CommandSender sender, @Switch('f') boolean force, @Text PGMMap map, MatchManager matchManager)
       throws CommandException {
     MatchManager mm = PGM.get().getMatchManager();
     boolean restartQueued = RestartManager.get().isRestartRequested();
@@ -137,7 +138,7 @@ public static void setNext(CommandSender sender, @Switch('f') boolean force, @Te
           AllTranslations.get().translate("command.admin.setNext.restartQueued", sender));
     }
 
-    MapCommands.setNextMap(map);
+    matchManager.getMapOrder().setNextMap(map);
 
     if (restartQueued) {
       RestartManager.get().cancelRestart();

src/main/java/tc/oc/pgm/commands/CycleCommands.java

@@ -9,6 +9,7 @@
 import tc.oc.pgm.AllTranslations;
 import tc.oc.pgm.api.Permissions;
 import tc.oc.pgm.api.match.Match;
+import tc.oc.pgm.api.match.MatchManager;
 import tc.oc.pgm.commands.annotations.Text;
 import tc.oc.pgm.cycle.CycleMatchModule;
 import tc.oc.pgm.map.PGMMap;
@@ -24,6 +25,7 @@ public class CycleCommands {
   public static void cycle(
       CommandSender sender,
       Match match,
+      MatchManager matchManager,
       Duration countdown,
       @Switch('f') boolean force,
       @Default("next") @Text PGMMap map)
@@ -36,6 +38,7 @@ public static void cycle(
     }
 
     if (map != null) {
+      matchManager.getMapOrder().setNextMap(map);
       cmm.startCountdown(countdown, map);
     } else {
       cmm.startCountdown(countdown);
@@ -49,8 +52,12 @@ public static void cycle(
       flags = "f",
       perms = Permissions.START)
   public static void recycle(
-      CommandSender sender, Match match, Duration duration, @Switch('f') boolean force)
+      CommandSender sender,
+      Match match,
+      MatchManager matchManager,
+      Duration duration,
+      @Switch('f') boolean force)
       throws CommandException {
-    cycle(sender, match, duration, force, match.getMap());
+    cycle(sender, match, matchManager, duration, force, match.getMap());
   }
 }

src/main/java/tc/oc/pgm/commands/MapCommands.java

@@ -18,10 +18,8 @@
 import tc.oc.named.NameStyle;
 import tc.oc.named.NicknameRenderer;
 import tc.oc.pgm.AllTranslations;
-import tc.oc.pgm.api.PGM;
 import tc.oc.pgm.api.Permissions;
 import tc.oc.pgm.api.chat.Audience;
-import tc.oc.pgm.api.match.Match;
 import tc.oc.pgm.api.match.MatchManager;
 import tc.oc.pgm.commands.annotations.Text;
 import tc.oc.pgm.map.Contributor;
@@ -33,38 +31,6 @@
 
 public class MapCommands {
 
-  // FIXME: This is temporary until a new rotation/vote system is determined.
-  private static PGMMap nextMap;
-
-  public static PGMMap peekNextMap() {
-    if (nextMap != null) {
-      return nextMap;
-    }
-
-    Iterator<Match> iterator = PGM.get().getMatchManager().getMatches().iterator();
-    PGMMap current = iterator.hasNext() ? iterator.next().getMap() : null;
-
-    List<PGMMap> maps = new ArrayList<>(PGM.get().getMapLibrary().getMaps());
-    PGMMap next;
-    do {
-      Collections.shuffle(maps);
-      next = maps.get(0);
-    } while (maps.size() > 1 && Objects.equals(current, next));
-
-    setNextMap(next);
-    return next;
-  }
-
-  public static void setNextMap(PGMMap map) {
-    nextMap = map;
-  }
-
-  public static PGMMap popNextMap() {
-    PGMMap peek = peekNextMap();
-    nextMap = null;
-    return peek;
-  }
-
   @Command(
       aliases = {"maplist", "maps", "ml"},
       desc = "Shows the maps that are currently loaded",
@@ -205,7 +171,14 @@ public void map(Audience audience, CommandSender sender, @Text PGMMap map) {
       aliases = {"mapnext", "mn", "nextmap", "nm", "next"},
       desc = "Shows which map is coming up next")
   public void next(Audience audience, CommandSender sender, MatchManager matchManager) {
-    final PGMMap next = peekNextMap();
+    final PGMMap next = matchManager.getMapOrder().getNextMap();
+
+    if (next == null) {
+      sender.sendMessage(
+          ChatColor.RED + AllTranslations.get().translate("command.map.next.noNextMap", sender));
+      return;
+    }
+
     audience.sendMessage(
         ChatColor.DARK_PURPLE
             + AllTranslations.get()