Feature/auto whitelist

pom.xml

@@ -21,14 +21,14 @@
 
     <groupId>voidpointer.spigot</groupId>
     <artifactId>voidwhitelist</artifactId>
-    <version>0.9.5</version>
+    <version>1.0.0</version>
     <packaging>jar</packaging>
 
     <name>VoidWhitelist</name>
 
     <description>UUID based temporal whitelist. Supports JSON, H2, MySQL and PostrgreSQL storage.</description>
     <properties>
-        <version.stability>stable</version.stability>
+        <version.stability>unstable</version.stability>
         <java.version>1.8</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>

src/main/java/voidpointer/spigot/voidwhitelist/TimesAutoWhitelisted.java

@@ -0,0 +1,28 @@
+package voidpointer.spigot.voidwhitelist;
+
+import java.util.UUID;
+
+public interface TimesAutoWhitelisted {
+    static TimesAutoWhitelisted zero(final UUID uniqueId) {
+        return of(uniqueId, 0);
+    }
+
+    static TimesAutoWhitelisted of(final UUID uniqueId, final int timesAutoWhitelisted) {
+        return new TimesAutoWhitelisted() {
+            @Override public UUID getUniqueId() {
+                return uniqueId;
+            }
+            @Override public int get() {
+                return timesAutoWhitelisted;
+            }
+        };
+    }
+
+    UUID getUniqueId();
+
+    int get();
+
+    default boolean isExceeded(final int limit) {
+        return (limit >= 0) && (get() >= limit);
+    }
+}

src/main/java/voidpointer/spigot/voidwhitelist/VoidWhitelistPlugin.java

@@ -25,7 +25,8 @@
 import voidpointer.spigot.framework.localemodule.annotation.LocaleAnnotationResolver;
 import voidpointer.spigot.framework.localemodule.annotation.PluginLocale;
 import voidpointer.spigot.framework.localemodule.config.TranslatedLocaleFile;
-import voidpointer.spigot.voidwhitelist.command.WhitelistCommand;
+import voidpointer.spigot.voidwhitelist.command.autowhitelist.AutoWhitelistCommand;
+import voidpointer.spigot.voidwhitelist.command.whitelist.WhitelistCommand;
 import voidpointer.spigot.voidwhitelist.config.GuiConfig;
 import voidpointer.spigot.voidwhitelist.config.WhitelistConfig;
 import voidpointer.spigot.voidwhitelist.event.EventManager;
@@ -41,6 +42,7 @@
 import voidpointer.spigot.voidwhitelist.message.WhitelistMessage;
 import voidpointer.spigot.voidwhitelist.papi.PapiLocale;
 import voidpointer.spigot.voidwhitelist.papi.TimeLeftExpansion;
+import voidpointer.spigot.voidwhitelist.storage.AutoWhitelistService;
 import voidpointer.spigot.voidwhitelist.storage.StorageFactory;
 import voidpointer.spigot.voidwhitelist.storage.WhitelistService;
 import voidpointer.spigot.voidwhitelist.task.KickTaskScheduler;
@@ -54,7 +56,8 @@ public final class VoidWhitelistPlugin extends JavaPlugin {
     private static TranslatedLocaleFile locale;
     @Dependency private static WhitelistConfig whitelistConfig;
     @Dependency private static LocaleLog guiLocale;
-    @Dependency private static WhitelistService whitelistService;
+    @Dependency(id="whitelistService")
+    private static AutoWhitelistService whitelistService;
     @Dependency private static EventManager eventManager;
     @Dependency private static StorageFactory storageFactory;
     @Dependency private static KickTaskScheduler kickTaskScheduler;
@@ -70,6 +73,7 @@ public final class VoidWhitelistPlugin extends JavaPlugin {
     @Override public void onLoad() {
         instance = this;
         whitelistConfig = new WhitelistConfig(this);
+        whitelistConfig.runMigrations();
         guiLocale = new GuiConfig(this, whitelistConfig).getLocaleLog();
         papiLocale = new PapiLocale(this);
         eventManager = new EventManager(this);
@@ -86,6 +90,7 @@ public final class VoidWhitelistPlugin extends JavaPlugin {
         kickTaskScheduler = new KickTaskScheduler();
         Injector.inject(this);
         new WhitelistCommand().register(this);
+        new AutoWhitelistCommand().register(this);
         registerListeners();
         hookPapi();
 
@@ -95,11 +100,12 @@ public final class VoidWhitelistPlugin extends JavaPlugin {
     }
 
     @Override public void onDisable() {
-        whitelistService.shutdown();
+        if (whitelistService != null)
+            whitelistService.shutdown();
     }
 
     /** Changes the {@link WhitelistService}, but doesn't inject it. */
-    public void changeWhitelistService(final @NonNull WhitelistService whitelistService) {
+    public void changeWhitelistService(final @NonNull AutoWhitelistService whitelistService) {
         VoidWhitelistPlugin.whitelistService = whitelistService;
     }
 

src/main/java/voidpointer/spigot/voidwhitelist/Whitelistable.java

@@ -48,8 +48,10 @@ public interface Whitelistable {
      */
     boolean isAssociatedWith(final Player player);
 
-    /** @return {@code true} if the entity has an "expires at" date
-     * and {@code false} otherwise. */
+    /**
+     * @return {@code true} if the given {@link Date} can expire.
+     * @see #NEVER_EXPIRES
+     */
     static boolean isDateExpirable(final Date date) {
         return NEVER_EXPIRES != date;
     }

src/main/java/voidpointer/spigot/voidwhitelist/command/Command.java

@@ -39,6 +39,7 @@
 
 import static java.util.Collections.emptyList;
 import static lombok.AccessLevel.PROTECTED;
+import static lombok.AccessLevel.PUBLIC;
 
 @Getter
 @RequiredArgsConstructor
@@ -49,7 +50,7 @@ public abstract class Command implements CommandExecutor, TabCompleter {
     private static final List<String> EMPTY_ALIASES = emptyList();
     @AutowiredLocale private static LocaleLog localeLog;
 
-    @Setter(PROTECTED)
+    @Setter(PUBLIC)
     private @NonNull String permission = EMPTY_PERMISSION;
 
     private final String name;

src/main/java/voidpointer/spigot/voidwhitelist/command/CommandManager.java

@@ -14,6 +14,8 @@
  */
 package voidpointer.spigot.voidwhitelist.command;
 
+import lombok.AccessLevel;
+import lombok.Getter;
 import voidpointer.spigot.framework.localemodule.LocaleLog;
 import voidpointer.spigot.framework.localemodule.annotation.AutowiredLocale;
 import voidpointer.spigot.voidwhitelist.command.arg.Args;
@@ -28,6 +30,8 @@
 
 public final class CommandManager {
     @AutowiredLocale private static LocaleLog log;
+
+    @Getter(AccessLevel.PUBLIC)
     private final Map<String, Command> commands = new HashMap<>();
 
     public void addCommand(final Command command) {

src/main/java/voidpointer/spigot/voidwhitelist/command/autowhitelist/AutoWhitelistCommand.java

@@ -0,0 +1,61 @@
+package voidpointer.spigot.voidwhitelist.command.autowhitelist;
+
+import org.bukkit.command.CommandSender;
+import voidpointer.spigot.framework.localemodule.Locale;
+import voidpointer.spigot.framework.localemodule.annotation.AutowiredLocale;
+import voidpointer.spigot.voidwhitelist.command.Command;
+import voidpointer.spigot.voidwhitelist.command.CommandManager;
+import voidpointer.spigot.voidwhitelist.command.arg.Args;
+
+import java.util.List;
+
+import static voidpointer.spigot.voidwhitelist.message.WhitelistMessage.*;
+
+public final class AutoWhitelistCommand extends Command {
+    public static final String NAME = "auto-whitelist";
+
+    @AutowiredLocale private static Locale locale;
+
+    private final CommandManager autoWhitelistCommands = new CommandManager();
+
+    public AutoWhitelistCommand() {
+        super(NAME);
+
+        super.setPermission("voidwhitelist.auto-whitelist");
+        super.setRequiredArgsNumber(1);
+
+        autoWhitelistCommands.addCommand(new HelpCommand());
+        /* general commands */
+        autoWhitelistCommands.addCommand(new EnableCommand());
+        autoWhitelistCommands.addCommand(new DisableCommand());
+        autoWhitelistCommands.addCommand(new IsOnCommand());
+        /* configuration related commands */
+        autoWhitelistCommands.addCommand(new GetDurationCommand());
+        autoWhitelistCommands.addCommand(new SetDurationCommand());
+        autoWhitelistCommands.addCommand(new GetLimitCommand());
+        autoWhitelistCommands.addCommand(new SetLimitCommand());
+        autoWhitelistCommands.addCommand(new GetStrategyCommand());
+        autoWhitelistCommands.addCommand(new SetStrategyCommand());
+        /* player related commands */
+        autoWhitelistCommands.addCommand(new InfoCommand());
+        autoWhitelistCommands.addCommand(new ResetCommand());
+        autoWhitelistCommands.addCommand(new SetCommand());
+        /* set appropriate permissions for sub commands */
+        autoWhitelistCommands.getCommands().values()
+                .forEach(cmd -> cmd.setPermission(getPermission() + '.' + cmd.getName()));
+    }
+
+    @Override public void execute(final Args args) {
+        final String subCommandName = args.removeFirst();
+        if (!autoWhitelistCommands.executeCommand(subCommandName, args))
+            locale.localize(AUTO_WHITELIST_UNKNOWN_COMMAND).send(args.getSender());
+    }
+
+    @Override public List<String> tabComplete(final Args args) {
+        return autoWhitelistCommands.tabComplete(args);
+    }
+
+    @Override protected void onNotEnoughArgs(final CommandSender sender, final Args args) {
+        locale.localize(AUTO_WHITELIST_NOT_ENOUGH_ARGS).send(sender);
+    }
+}

src/main/java/voidpointer/spigot/voidwhitelist/command/autowhitelist/DisableCommand.java

@@ -0,0 +1,23 @@
+package voidpointer.spigot.voidwhitelist.command.autowhitelist;
+
+import voidpointer.spigot.framework.di.Autowired;
+import voidpointer.spigot.framework.localemodule.Locale;
+import voidpointer.spigot.framework.localemodule.annotation.AutowiredLocale;
+import voidpointer.spigot.voidwhitelist.command.Command;
+import voidpointer.spigot.voidwhitelist.command.arg.Args;
+import voidpointer.spigot.voidwhitelist.config.WhitelistConfig;
+import voidpointer.spigot.voidwhitelist.message.WhitelistMessage;
+
+final class DisableCommand extends Command {
+    @AutowiredLocale private static Locale locale;
+    @Autowired private static WhitelistConfig whitelistConfig;
+
+    DisableCommand() {
+        super("off");
+    }
+
+    @Override public void execute(final Args args) {
+        whitelistConfig.disableAutoWhitelist();
+        locale.localize(WhitelistMessage.AUTO_WHITELIST_DISABLED).send(args.getSender());
+    }
+}

src/main/java/voidpointer/spigot/voidwhitelist/command/autowhitelist/EnableCommand.java

@@ -0,0 +1,24 @@
+package voidpointer.spigot.voidwhitelist.command.autowhitelist;
+
+import voidpointer.spigot.framework.di.Autowired;
+import voidpointer.spigot.framework.localemodule.Locale;
+import voidpointer.spigot.framework.localemodule.annotation.AutowiredLocale;
+import voidpointer.spigot.voidwhitelist.command.Command;
+import voidpointer.spigot.voidwhitelist.command.arg.Args;
+import voidpointer.spigot.voidwhitelist.config.WhitelistConfig;
+
+import static voidpointer.spigot.voidwhitelist.message.WhitelistMessage.*;
+
+final class EnableCommand extends Command {
+    @AutowiredLocale private static Locale locale;
+    @Autowired private static WhitelistConfig whitelistConfig;
+
+    EnableCommand() {
+        super("on");
+    }
+
+    @Override public void execute(final Args args) {
+        whitelistConfig.enableAutoWhitelist();
+        locale.localize(AUTO_WHITELIST_ENABLED).send(args.getSender());
+    }
+}

src/main/java/voidpointer/spigot/voidwhitelist/command/autowhitelist/GetDurationCommand.java

@@ -0,0 +1,27 @@
+package voidpointer.spigot.voidwhitelist.command.autowhitelist;
+
+import voidpointer.spigot.framework.di.Autowired;
+import voidpointer.spigot.framework.localemodule.Locale;
+import voidpointer.spigot.framework.localemodule.annotation.AutowiredLocale;
+import voidpointer.spigot.voidwhitelist.command.Command;
+import voidpointer.spigot.voidwhitelist.command.arg.Args;
+import voidpointer.spigot.voidwhitelist.config.WhitelistConfig;
+import voidpointer.spigot.voidwhitelist.date.Duration;
+
+import static voidpointer.spigot.voidwhitelist.message.WhitelistMessage.*;
+
+final class GetDurationCommand extends Command {
+    @AutowiredLocale private static Locale locale;
+    @Autowired private static WhitelistConfig whitelistConfig;
+
+    GetDurationCommand() {
+        super("get-duration");
+    }
+
+    @Override public void execute(final Args args) {
+        final String rawDuration = whitelistConfig.getRawAutoDuration();
+        locale.localize(AUTO_WHITELIST_GET_DURATION)
+                .set("duration", rawDuration).set("exact", Duration.exactMillis(rawDuration).orElse(-1L))
+                .send(args.getSender());
+    }
+}

src/main/java/voidpointer/spigot/voidwhitelist/command/autowhitelist/GetLimitCommand.java

@@ -0,0 +1,23 @@
+package voidpointer.spigot.voidwhitelist.command.autowhitelist;
+
+import voidpointer.spigot.framework.di.Autowired;
+import voidpointer.spigot.framework.localemodule.Locale;
+import voidpointer.spigot.framework.localemodule.annotation.AutowiredLocale;
+import voidpointer.spigot.voidwhitelist.command.Command;
+import voidpointer.spigot.voidwhitelist.command.arg.Args;
+import voidpointer.spigot.voidwhitelist.config.WhitelistConfig;
+
+import static voidpointer.spigot.voidwhitelist.message.WhitelistMessage.*;
+
+final class GetLimitCommand extends Command {
+    @AutowiredLocale private static Locale locale;
+    @Autowired private static WhitelistConfig whitelistConfig;
+
+    GetLimitCommand() {
+        super("get-limit");
+    }
+
+    @Override public void execute(final Args args) {
+        locale.localize(AUTO_WHITELIST_GET_LIMIT).set("limit", whitelistConfig.getAutoLimit()).send(args.getSender());
+    }
+}