Skip to content

Commit 3a07730

Browse files
committed
Permission profile loading and saving
1 parent 811333e commit 3a07730

File tree

12 files changed

+241
-24
lines changed

12 files changed

+241
-24
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import me.innectic.permissify.api.database.ConnectionInformation;
2929
import me.innectic.permissify.api.database.DatabaseHandler;
3030
import me.innectic.permissify.api.database.handlers.HandlerType;
31+
import me.innectic.permissify.api.profile.ProfileSerializer;
3132
import me.innectic.permissify.api.util.DisplayUtil;
3233

3334
import java.lang.reflect.InvocationTargetException;
@@ -44,13 +45,15 @@ public class PermissifyAPI {
4445

4546
@Getter private Optional<DatabaseHandler> databaseHandler;
4647
@Getter private DisplayUtil displayUtil;
48+
@Getter private ProfileSerializer serializer;
4749

4850
/**
4951
* Initialize Permissify's API
5052
*/
5153
public void initialize(HandlerType type, Optional<ConnectionInformation> connectionInformation, DisplayUtil displayUtil) throws Exception {
5254
instance = Optional.of(this);
5355
this.displayUtil = displayUtil;
56+
serializer = new ProfileSerializer();
5457

5558
try {
5659
databaseHandler = Optional.of(type.getHandler().getConstructor(ConnectionInformation.class).newInstance(connectionInformation.orElse(null)));
@@ -60,7 +63,7 @@ public void initialize(HandlerType type, Optional<ConnectionInformation> connect
6063
if (!databaseHandler.isPresent()) throw new Exception("No data handler present.");
6164
databaseHandler.ifPresent(handler -> {
6265
handler.initialize();
63-
handler.clear(new ArrayList<>());
66+
handler.reload(new ArrayList<>());
6467
boolean connected = handler.connect();
6568
if (connected) System.out.println("Connected to the database.");
6669
else System.out.println("Unable to connect to the database.");

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ public class PermissifyConstants {
5959
public static final String PERMISSIFY_FORMAT = "permissify.format";
6060
public static final String PERMISSIFY_CACHE = "permissify.cache";
6161
public static final String PERMISSIFY_ADMIN = "permissify.admin";
62+
public static final String PERMISSIFY_PROFILE = "permissify.profile";
6263

6364
public static final String INSUFFICIENT_PERMISSIONS = PERMISSIFY_PREFIX + "&c&lInsufficient permissions!";
6465

@@ -99,10 +100,17 @@ public class PermissifyConstants {
99100
public static final String NOT_ENOUGH_ARGUMENTS_PLAYER_LIST_GROUP = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify player listgroup [player]";
100101
public static final String NOT_ENOUGH_ARGUMENTS_SET_FORMAT = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify format [whisper|chat|disable|enable] [format?...]";
101102
public static final String NOT_ENOUGH_ARGUMENTS_SET_MAIN_GROUP = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify player setmain [player] [group]";
103+
public static final String NOT_ENOUGH_ARGUMENTS_PROFILE = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify profile [save|load] [profile]";
104+
public static final String NOT_ENOUGH_ARGUMENTS_PROFILE_SAVE = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify profile save [fileName]";
105+
public static final String NOT_ENOUGH_ARGUMENTS_PROFILE_LOAD = PERMISSIFY_PREFIX + "&c&lNot enough arguments! &e&l/permissify profile load [source]";
106+
107+
public static final String PROFILE_SAVED = PERMISSIFY_PREFIX + "&e&lSaved profile '<PROFILE>'.";
108+
public static final String PROFILE_NOT_SAVED = PERMISSIFY_PREFIX + "&c&lUnable to save profile '<PROFILE>'";
109+
public static final String PROFILE_LOADED = PERMISSIFY_PREFIX + "&e&lLoaded profile '<PROFILE>' in <TIME> ms.";
110+
public static final String PROFILE_NOT_LOADED = PERMISSIFY_PREFIX + "&c&lUnable to load profile '<PROFILE>'";
102111

103112
public static final String INVALID_CHATCOLOR = PERMISSIFY_PREFIX + "&c&lInvalid chat color <COLOR>";
104113
public static final String INVALID_GROUP = PERMISSIFY_PREFIX + "&c&lInvalid group '<GROUP>'!";
105-
public static final String CONSOLE_INVALID_COMMAND = PERMISSIFY_PREFIX + "&c&lOnly one console command available: /permissify superadmin [username]";
106114
public static final String INVALID_PLAYER = PERMISSIFY_PREFIX + "&c&lInvalid player!";
107115
public static final String INVALID_ARGUMENT = PERMISSIFY_PREFIX + "&c&lInvalid argument: <ARGUMENT>";
108116

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

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import lombok.Setter;
2929
import me.innectic.permissify.api.permission.Permission;
3030
import me.innectic.permissify.api.permission.PermissionGroup;
31+
import me.innectic.permissify.api.profile.PermissifyProfile;
3132

3233
import java.util.*;
3334

@@ -43,7 +44,7 @@ public abstract class DatabaseHandler {
4344
@Getter protected List<PermissionGroup> cachedGroups = new ArrayList<>();
4445
@Getter protected Optional<PermissionGroup> defaultGroup = Optional.empty();
4546
@Getter protected final Optional<ConnectionInformation> connectionInformation;
46-
protected List<UUID> superAdmins = new ArrayList<>();
47+
@Getter protected List<UUID> superAdmins = new ArrayList<>();
4748
protected String chatFormat = "{group} {username}: {message}";
4849
protected String whisperFormat = "{senderGroup} {username} > {receiverGroup} {to}: {message}";
4950

@@ -68,7 +69,19 @@ public DatabaseHandler(ConnectionInformation connectionInformation) {
6869
*
6970
* @param onlinePlayers the current players online who will need permissions.
7071
*/
71-
public abstract void clear(List<UUID> onlinePlayers);
72+
public abstract void reload(List<UUID> onlinePlayers);
73+
74+
/**
75+
* Drop all values from the handler.
76+
*/
77+
public abstract void drop();
78+
79+
/**
80+
* Load a profile into the handler.
81+
*
82+
* @param profile the profile to load
83+
*/
84+
public abstract void loadProfile(PermissifyProfile profile);
7285

7386
/**
7487
* Add a permission to a player

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

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import me.innectic.permissify.api.permission.Permission;
3131
import me.innectic.permissify.api.database.ConnectionInformation;
3232
import me.innectic.permissify.api.permission.PermissionGroup;
33+
import me.innectic.permissify.api.profile.PermissifyProfile;
3334
import me.innectic.permissify.api.util.FormatterType;
3435

3536
import java.sql.*;
@@ -156,7 +157,7 @@ public boolean connect() {
156157
}
157158

158159
@Override
159-
public void clear(List<UUID> onlinePlayers) {
160+
public void reload(List<UUID> onlinePlayers) {
160161
cachedGroups = new ArrayList<>();
161162
cachedPermissions = new HashMap<>();
162163
superAdmins = new ArrayList<>();
@@ -214,6 +215,45 @@ public void clear(List<UUID> onlinePlayers) {
214215
onlinePlayers.forEach(this::getPermissions);
215216
}
216217

218+
@Override
219+
public void drop() {
220+
cachedGroups = new ArrayList<>();
221+
cachedPermissions = new HashMap<>();
222+
superAdmins = new ArrayList<>();
223+
chatFormat = "";
224+
whisperFormat = "";
225+
}
226+
227+
@Override
228+
public void loadProfile(PermissifyProfile profile) {
229+
// Load player permissions
230+
profile.getPlayerPermissions().forEach((uuid, permissions) -> permissions.forEach(permission -> {
231+
if (!permission.isGranted()) addPermission(uuid, permission.getPermission());
232+
else removePermission(uuid, permission.getPermission());
233+
}));
234+
// Create groups
235+
profile.getGroups().forEach(group -> {
236+
createGroup(group.getName(), group.getPrefix(), group.getSuffix(), group.getChatColor());
237+
Optional<PermissionGroup> created = getGroup(group.getName());
238+
if (!created.isPresent()) {
239+
System.out.println("Profile group was never created?");
240+
return;
241+
}
242+
// Add permissions to the group
243+
group.getPermissions().forEach(permission -> {
244+
if (permission.isGranted()) created.get().addPermission(permission.getPermission());
245+
else created.get().removePermission(permission.getPermission());
246+
});
247+
// Add the players to the group
248+
group.getPlayers().forEach(created.get()::addPlayer);
249+
});
250+
// Set the other misc things.
251+
chatFormat = profile.getChatFormat();
252+
whisperFormat = profile.getWhisperFormat();
253+
superAdmins = profile.getSuperAdmins();
254+
defaultGroup = Optional.ofNullable(profile.getDefaultGroup());
255+
}
256+
217257
@Override
218258
public void addPermission(UUID uuid, String... permissions) {
219259
// Put the permissions into the cache

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@
2828
import lombok.Getter;
2929
import lombok.Setter;
3030

31+
import java.io.Serializable;
32+
3133
/**
3234
* @author Innectic
3335
* @since 6/8/2017
3436
*/
3537
@AllArgsConstructor
36-
public class Permission {
38+
public class Permission implements Serializable {
3739
@Getter private String permission;
3840
@Getter @Setter private boolean granted;
3941
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* @since 6/14/2017
3737
*/
3838
@RequiredArgsConstructor
39-
public class PermissionGroup {
39+
public class PermissionGroup implements Serializable {
4040
@Getter private final String name;
4141
@Getter private final String chatColor;
4242
@Getter private final String prefix;

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

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
/*
2+
*
3+
* This file is part of Permissify, licensed under the MIT License (MIT).
4+
* Copyright (c) Innectic
5+
* Copyright (c) contributors
6+
*
7+
* Permission is hereby granted, free of charge, to any person obtaining a copy
8+
* of this software and associated documentation files (the "Software"), to deal
9+
* in the Software without restriction, including without limitation the rights
10+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
* copies of the Software, and to permit persons to whom the Software is
12+
* furnished to do so, subject to the following conditions:
13+
*
14+
* The above copyright notice and this permission notice shall be included in all
15+
* copies or substantial portions of the Software.
16+
*
17+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
* SOFTWARE.
24+
*/
125
package me.innectic.permissify.api.profile;
226

327
import lombok.AllArgsConstructor;
@@ -8,7 +32,6 @@
832
import java.io.Serializable;
933
import java.util.List;
1034
import java.util.Map;
11-
import java.util.Optional;
1235
import java.util.UUID;
1336

1437
/**
@@ -19,7 +42,7 @@
1942
public class PermissifyProfile implements Serializable {
2043
@Getter private final List<PermissionGroup> groups;
2144
@Getter private Map<UUID, List<Permission>> playerPermissions;
22-
@Getter private Optional<PermissionGroup> defaultGroup;
45+
@Getter private PermissionGroup defaultGroup;
2346
@Getter private String chatFormat;
2447
@Getter private String whisperFormat;
2548
@Getter private List<UUID> superAdmins;

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

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1+
/*
2+
*
3+
* This file is part of Permissify, licensed under the MIT License (MIT).
4+
* Copyright (c) Innectic
5+
* Copyright (c) contributors
6+
*
7+
* Permission is hereby granted, free of charge, to any person obtaining a copy
8+
* of this software and associated documentation files (the "Software"), to deal
9+
* in the Software without restriction, including without limitation the rights
10+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
* copies of the Software, and to permit persons to whom the Software is
12+
* furnished to do so, subject to the following conditions:
13+
*
14+
* The above copyright notice and this permission notice shall be included in all
15+
* copies or substantial portions of the Software.
16+
*
17+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
* SOFTWARE.
24+
*/
125
package me.innectic.permissify.api.profile;
226

3-
import lombok.AllArgsConstructor;
4-
527
import java.io.*;
628
import java.util.Optional;
729

@@ -36,17 +58,16 @@ public boolean serialize(PermissifyProfile profile, String baseDirectory, String
3658
/**
3759
* Deserialize a permissify profile file into a real permissify profile
3860
*
39-
* @param profile the profile file
40-
* @return the profile, fulfilled if done, empty otherwise.
61+
* @param profile the profile file
62+
* @param baseDirectory the base directory that files are located in
63+
* @return the profile, fulfilled if done, empty otherwise.
4164
*/
42-
public Optional<PermissifyProfile> deserialize(String profile) {
65+
public Optional<PermissifyProfile> deserialize(String profile, String baseDirectory) {
4366
Optional<PermissifyProfile> deserialized = Optional.empty();
4467
try {
45-
long start = System.currentTimeMillis();
46-
FileInputStream inputStream = new FileInputStream(profile);
68+
FileInputStream inputStream = new FileInputStream(baseDirectory + "/profiles/" + profile + ".permissify");
4769
ObjectInputStream input = new ObjectInputStream(inputStream);
4870
deserialized = Optional.of((PermissifyProfile) input.readObject());
49-
long end = System.currentTimeMillis();
5071
} catch (IOException | ClassNotFoundException e) {
5172
e.printStackTrace();
5273
}

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,11 @@
2727
import lombok.Getter;
2828
import lombok.Setter;
2929
import me.innectic.permissify.spigot.commands.PermissifyCommand;
30-
import me.innectic.permissify.spigot.commands.permissify.CacheCommand;
31-
import me.innectic.permissify.spigot.commands.permissify.FormatCommand;
30+
import me.innectic.permissify.spigot.commands.permissify.*;
3231
import me.innectic.permissify.spigot.events.PlayerChat;
3332
import me.innectic.permissify.spigot.events.PlayerJoin;
3433
import me.innectic.permissify.api.PermissifyAPI;
3534
import me.innectic.permissify.api.database.handlers.FullHandler;
36-
import me.innectic.permissify.spigot.commands.permissify.GroupCommand;
37-
import me.innectic.permissify.spigot.commands.permissify.PlayerCommand;
3835
import me.innectic.permissify.spigot.events.PreProcess;
3936
import me.innectic.permissify.spigot.utils.ConfigVerifier;
4037
import me.innectic.permissify.spigot.utils.DisplayUtil;
@@ -59,6 +56,7 @@ public class PermissifyMain extends JavaPlugin {
5956
@Getter private PlayerCommand playerCommand;
6057
@Getter private FormatCommand formatCommand;
6158
@Getter private CacheCommand cacheCommand;
59+
@Getter private ProfileCommand profileCommand;
6260

6361
@Getter @Setter private boolean handleChat = false;
6462

@@ -121,6 +119,7 @@ private void registerCommands() {
121119
playerCommand = new PlayerCommand();
122120
formatCommand = new FormatCommand();
123121
cacheCommand = new CacheCommand();
122+
profileCommand = new ProfileCommand();
124123

125124
getCommand("permissify").setExecutor(new PermissifyCommand());
126125
}

Spigot/src/main/java/me/innectic/permissify/spigot/commands/PermissifyCommand.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,10 @@ else if (args[1].equalsIgnoreCase("listgroups"))
133133
} else if (args[0].equalsIgnoreCase("format")) {
134134
CommandResponse response = plugin.getFormatCommand().handleSetFormat(sender, ArgumentUtil.getRemainingArgs(1, args));
135135
sender.sendMessage(ColorUtil.makeReadable(response.getResponse()));
136-
}
136+
} else if (args[0].equalsIgnoreCase("profile")) {
137+
CommandResponse response = plugin.getProfileCommand().handleProfile(sender, ArgumentUtil.getRemainingArgs(1, args));
138+
sender.sendMessage(ColorUtil.makeReadable(response.getResponse()));
139+
} else sendHelp(sender);
137140
});
138141
return false;
139142
}

0 commit comments

Comments
 (0)