Merge pull request #26 from Innectic/feature/permission-profile

Permission Profile

Author: Innectic

API/src/main/java/me/innectic/permissify/api/PermissifyAPI.java

@@ -28,6 +28,7 @@
 import me.innectic.permissify.api.database.ConnectionInformation;
 import me.innectic.permissify.api.database.DatabaseHandler;
 import me.innectic.permissify.api.database.handlers.HandlerType;
+import me.innectic.permissify.api.profile.ProfileSerializer;
 import me.innectic.permissify.api.util.DisplayUtil;
 
 import java.lang.reflect.InvocationTargetException;
@@ -44,13 +45,15 @@ public class PermissifyAPI {
 
     @Getter private Optional<DatabaseHandler> databaseHandler;
     @Getter private DisplayUtil displayUtil;
+    @Getter private ProfileSerializer serializer;
 
     /**
      * Initialize Permissify's API
      */
     public void initialize(HandlerType type, Optional<ConnectionInformation> connectionInformation, DisplayUtil displayUtil) throws Exception {
         instance = Optional.of(this);
         this.displayUtil = displayUtil;
+        serializer = new ProfileSerializer();
 
         try {
             databaseHandler = Optional.of(type.getHandler().getConstructor(ConnectionInformation.class).newInstance(connectionInformation.orElse(null)));
@@ -60,7 +63,7 @@ public void initialize(HandlerType type, Optional<ConnectionInformation> connect
         if (!databaseHandler.isPresent()) throw new Exception("No data handler present.");
         databaseHandler.ifPresent(handler -> {
             handler.initialize();
-            handler.clear(new ArrayList<>());
+            handler.reload(new ArrayList<>());
             boolean connected = handler.connect();
             if (connected) System.out.println("Connected to the database.");
             else System.out.println("Unable to connect to the database.");

API/src/main/java/me/innectic/permissify/api/PermissifyConstants.java

@@ -59,6 +59,7 @@ public class PermissifyConstants {
     public static final String PERMISSIFY_FORMAT = "permissify.format";
     public static final String PERMISSIFY_CACHE = "permissify.cache";
     public static final String PERMISSIFY_ADMIN = "permissify.admin";
+    public static final String PERMISSIFY_PROFILE = "permissify.profile";
 
     public static final String INSUFFICIENT_PERMISSIONS = PERMISSIFY_PREFIX + "&c&lInsufficient permissions!";
 
@@ -99,10 +100,17 @@ public class PermissifyConstants {
     public static final String NOT_ENOUGH_ARGUMENTS_PLAYER_LIST_GROUP = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify player listgroup [player]";
     public static final String NOT_ENOUGH_ARGUMENTS_SET_FORMAT = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify format [whisper|chat|disable|enable] [format?...]";
     public static final String NOT_ENOUGH_ARGUMENTS_SET_MAIN_GROUP = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify player setmain [player] [group]";
+    public static final String NOT_ENOUGH_ARGUMENTS_PROFILE = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify profile [save|load] [profile]";
+    public static final String NOT_ENOUGH_ARGUMENTS_PROFILE_SAVE = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify profile save [fileName]";
+    public static final String NOT_ENOUGH_ARGUMENTS_PROFILE_LOAD = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify profile load [source]";
+
+    public static final String PROFILE_SAVED = PERMISSIFY_PREFIX + "&e&lSaved profile '<PROFILE>'.";
+    public static final String PROFILE_NOT_SAVED = PERMISSIFY_PREFIX + "&c&lUnable to save profile '<PROFILE>'";
+    public static final String PROFILE_LOADED = PERMISSIFY_PREFIX + "&e&lLoaded profile '<PROFILE>' in <TIME> ms.";
+    public static final String PROFILE_NOT_LOADED = PERMISSIFY_PREFIX + "&c&lUnable to load profile '<PROFILE>'";
 
     public static final String INVALID_CHATCOLOR = PERMISSIFY_PREFIX + "&c&lInvalid chat color <COLOR>";
     public static final String INVALID_GROUP = PERMISSIFY_PREFIX + "&c&lInvalid group '<GROUP>'!";
-    public static final String CONSOLE_INVALID_COMMAND = PERMISSIFY_PREFIX + "&c&lOnly one console command available: /permissify superadmin [username]";
     public static final String INVALID_PLAYER = PERMISSIFY_PREFIX + "&c&lInvalid player!";
     public static final String INVALID_ARGUMENT = PERMISSIFY_PREFIX + "&c&lInvalid argument: <ARGUMENT>";
 

API/src/main/java/me/innectic/permissify/api/database/DatabaseHandler.java

@@ -28,6 +28,7 @@
 import lombok.Setter;
 import me.innectic.permissify.api.permission.Permission;
 import me.innectic.permissify.api.permission.PermissionGroup;
+import me.innectic.permissify.api.profile.PermissifyProfile;
 
 import java.util.*;
 
@@ -43,7 +44,7 @@ public abstract class DatabaseHandler {
     @Getter protected List<PermissionGroup> cachedGroups = new ArrayList<>();
     @Getter protected Optional<PermissionGroup> defaultGroup = Optional.empty();
     @Getter protected final Optional<ConnectionInformation> connectionInformation;
-    protected List<UUID> superAdmins = new ArrayList<>();
+    @Getter protected List<UUID> superAdmins = new ArrayList<>();
     protected String chatFormat = "{group} {username}: {message}";
     protected String whisperFormat = "{senderGroup} {username} > {receiverGroup} {to}: {message}";
 
@@ -68,7 +69,19 @@ public DatabaseHandler(ConnectionInformation connectionInformation) {
      *
      * @param onlinePlayers the current players online who will need permissions.
      */
-    public abstract void clear(List<UUID> onlinePlayers);
+    public abstract void reload(List<UUID> onlinePlayers);
+
+    /**
+     * Drop all values from the handler.
+     */
+    public abstract void drop();
+
+    /**
+     * Load a profile into the handler.
+     *
+     * @param profile the profile to load
+     */
+    public abstract void loadProfile(PermissifyProfile profile);
 
     /**
      * Add a permission to a player

API/src/main/java/me/innectic/permissify/api/database/handlers/SQLHandler.java

@@ -30,6 +30,7 @@
 import me.innectic.permissify.api.permission.Permission;
 import me.innectic.permissify.api.database.ConnectionInformation;
 import me.innectic.permissify.api.permission.PermissionGroup;
+import me.innectic.permissify.api.profile.PermissifyProfile;
 import me.innectic.permissify.api.util.FormatterType;
 
 import java.sql.*;
@@ -156,7 +157,7 @@ public boolean connect() {
     }
 
     @Override
-    public void clear(List<UUID> onlinePlayers) {
+    public void reload(List<UUID> onlinePlayers) {
         cachedGroups = new ArrayList<>();
         cachedPermissions = new HashMap<>();
         superAdmins = new ArrayList<>();
@@ -214,6 +215,45 @@ public void clear(List<UUID> onlinePlayers) {
         onlinePlayers.forEach(this::getPermissions);
     }
 
+    @Override
+    public void drop() {
+        cachedGroups = new ArrayList<>();
+        cachedPermissions = new HashMap<>();
+        superAdmins = new ArrayList<>();
+        chatFormat = "";
+        whisperFormat = "";
+    }
+
+    @Override
+    public void loadProfile(PermissifyProfile profile) {
+        // Load player permissions
+        profile.getPlayerPermissions().forEach((uuid, permissions) -> permissions.forEach(permission -> {
+            if (!permission.isGranted()) addPermission(uuid, permission.getPermission());
+            else removePermission(uuid, permission.getPermission());
+        }));
+        // Create groups
+        profile.getGroups().forEach(group -> {
+            createGroup(group.getName(), group.getPrefix(), group.getSuffix(), group.getChatColor());
+            Optional<PermissionGroup> created = getGroup(group.getName());
+            if (!created.isPresent()) {
+                System.out.println("Profile group was never created?");
+                return;
+            }
+            // Add permissions to the group
+            group.getPermissions().forEach(permission -> {
+                if (permission.isGranted()) created.get().addPermission(permission.getPermission());
+                else created.get().removePermission(permission.getPermission());
+            });
+            // Add the players to the group
+            group.getPlayers().forEach(created.get()::addPlayer);
+        });
+        // Set the other misc things.
+        chatFormat = profile.getChatFormat();
+        whisperFormat = profile.getWhisperFormat();
+        superAdmins = profile.getSuperAdmins();
+        defaultGroup = Optional.ofNullable(profile.getDefaultGroup());
+    }
+
     @Override
     public void addPermission(UUID uuid, String... permissions) {
         // Put the permissions into the cache

API/src/main/java/me/innectic/permissify/api/permission/Permission.java

@@ -28,12 +28,14 @@
 import lombok.Getter;
 import lombok.Setter;
 
+import java.io.Serializable;
+
 /**
  * @author Innectic
  * @since 6/8/2017
  */
 @AllArgsConstructor
-public class Permission {
+public class Permission implements Serializable {
     @Getter private String permission;
     @Getter @Setter private boolean granted;
 }

API/src/main/java/me/innectic/permissify/api/permission/PermissionGroup.java

@@ -28,14 +28,15 @@
 import lombok.RequiredArgsConstructor;
 import lombok.Setter;
 
+import java.io.Serializable;
 import java.util.*;
 
 /**
  * @author Innectic
  * @since 6/14/2017
  */
 @RequiredArgsConstructor
-public class PermissionGroup {
+public class PermissionGroup implements Serializable {
     @Getter private final String name;
     @Getter private final String chatColor;
     @Getter private final String prefix;
@@ -51,7 +52,6 @@ public class PermissionGroup {
     public void removePermission(String permission) {
         Optional<Permission> perm = permissions.stream().filter(groupPermission -> groupPermission.getPermission().equals(permission)).findFirst();
         perm.ifPresent(groupPermission -> groupPermission.setGranted(false));
-        // TODO: Remove permissions from the player
     }
 
     /**
@@ -63,7 +63,6 @@ public void addPermission(String permission) {
         Optional<Permission> perm = permissions.stream().filter(groupPermission -> groupPermission.getPermission().equals(permission)).findFirst();
         if (perm.isPresent()) perm.get().setGranted(true);
         else permissions.add(new Permission(permission, true));
-        // TODO: Add permissions to the player
     }
 
     public boolean hasPermission(String permission) {

API/src/main/java/me/innectic/permissify/api/profile/PermissifyProfile.java

@@ -0,0 +1,49 @@
+/*
+*
+* This file is part of Permissify, licensed under the MIT License (MIT).
+* Copyright (c) Innectic
+* Copyright (c) contributors
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all
+* copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+* SOFTWARE.
+ */
+package me.innectic.permissify.api.profile;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import me.innectic.permissify.api.permission.Permission;
+import me.innectic.permissify.api.permission.PermissionGroup;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+
+/**
+ * @author Innectic
+ * @since 8/26/2017
+ */
+@AllArgsConstructor
+public class PermissifyProfile implements Serializable {
+    @Getter private final List<PermissionGroup> groups;
+    @Getter private Map<UUID, List<Permission>> playerPermissions;
+    @Getter private PermissionGroup defaultGroup;
+    @Getter private String chatFormat;
+    @Getter private String whisperFormat;
+    @Getter private List<UUID> superAdmins;
+}

API/src/main/java/me/innectic/permissify/api/profile/ProfileSerializer.java

@@ -0,0 +1,76 @@
+/*
+*
+* This file is part of Permissify, licensed under the MIT License (MIT).
+* Copyright (c) Innectic
+* Copyright (c) contributors
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all
+* copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+* SOFTWARE.
+ */
+package me.innectic.permissify.api.profile;
+
+import java.io.*;
+import java.util.Optional;
+
+/**
+ * @author Innectic
+ * @since 8/26/2017
+ */
+public class ProfileSerializer {
+
+    /**
+     * Serialize a permissify profile into a permissify profile file
+     *
+     * @param profile       the profile to serialize
+     * @param baseDirectory the base of the directory to store the profiles in
+     * @param profileName   the name of the profile
+     * @return              if the profile was successfully stored
+     */
+    public boolean serialize(PermissifyProfile profile, String baseDirectory, String profileName) {
+        try {
+            FileOutputStream outputStream = new FileOutputStream(baseDirectory + "/profiles/" + profileName + ".permissify");
+            ObjectOutputStream out = new ObjectOutputStream(outputStream);
+            out.writeObject(profile);
+            out.close();
+            outputStream.close();
+        } catch (IOException e) {
+            e.printStackTrace();
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Deserialize a permissify profile file into a real permissify profile
+     *
+     * @param profile       the profile file
+     * @param baseDirectory the base directory that files are located in
+     * @return              the profile, fulfilled if done, empty otherwise.
+     */
+    public Optional<PermissifyProfile> deserialize(String profile, String baseDirectory) {
+        Optional<PermissifyProfile> deserialized = Optional.empty();
+        try {
+            FileInputStream inputStream = new FileInputStream(baseDirectory + "/profiles/" + profile + ".permissify");
+            ObjectInputStream input = new ObjectInputStream(inputStream);
+            deserialized = Optional.of((PermissifyProfile) input.readObject());
+        } catch (IOException | ClassNotFoundException e) {
+            e.printStackTrace();
+        }
+        return deserialized;
+    }
+}

README.md

@@ -7,7 +7,7 @@ and most importantly, *no errors caused by the plugin*.
 
 # Builds
 
-// TODO: Get this plugin to a state where builds can actually happen
+You can download the latest version of Permissify from the [releases](https://github.com/Innectic/Permissify/releases) page.
 
 # Contributing
 

Spigot/src/main/java/me/innectic/permissify/spigot/PermissifyMain.java

@@ -27,14 +27,11 @@
 import lombok.Getter;
 import lombok.Setter;
 import me.innectic.permissify.spigot.commands.PermissifyCommand;
-import me.innectic.permissify.spigot.commands.permissify.CacheCommand;
-import me.innectic.permissify.spigot.commands.permissify.FormatCommand;
+import me.innectic.permissify.spigot.commands.permissify.*;
 import me.innectic.permissify.spigot.events.PlayerChat;
 import me.innectic.permissify.spigot.events.PlayerJoin;
 import me.innectic.permissify.api.PermissifyAPI;
 import me.innectic.permissify.api.database.handlers.FullHandler;
-import me.innectic.permissify.spigot.commands.permissify.GroupCommand;
-import me.innectic.permissify.spigot.commands.permissify.PlayerCommand;
 import me.innectic.permissify.spigot.events.PreProcess;
 import me.innectic.permissify.spigot.utils.ConfigVerifier;
 import me.innectic.permissify.spigot.utils.DisplayUtil;
@@ -59,6 +56,7 @@ public class PermissifyMain extends JavaPlugin {
     @Getter private PlayerCommand playerCommand;
     @Getter private FormatCommand formatCommand;
     @Getter private CacheCommand cacheCommand;
+    @Getter private ProfileCommand profileCommand;
 
     @Getter @Setter private boolean handleChat = false;
 
@@ -121,6 +119,7 @@ private void registerCommands() {
         playerCommand = new PlayerCommand();
         formatCommand = new FormatCommand();
         cacheCommand = new CacheCommand();
+        profileCommand = new ProfileCommand();
 
         getCommand("permissify").setExecutor(new PermissifyCommand());
     }