LuckPerm: keep contexts active after reload of groups (#2186)

* Use context aware groups

* Revert "Use context aware groups"

This reverts commit 5adc6ef7

* Keep luckperm contexts after authentication

* Code cleanup

* Code cleanup

* Fix nullpointer for context maps

* Code cleanup

* Use uuids for sqlite and postgresql

* Revert "Use uuids for sqlite and postgresql"

This reverts commit 05296e5f23bd4379a89647656f08432c718e6f9c.

* Cleanup imports

* Fix test

Co-authored-by: David Maes <david.maes@kbc.be>
This commit is contained in:
David Maes
2021-08-21 22:19:45 +02:00
committed by GitHub
parent b1e58fa0b8
commit d969d314b3
21 changed files with 303 additions and 135 deletions
@@ -2,6 +2,7 @@ package fr.xephi.authme.permission;
import com.google.common.annotations.VisibleForTesting;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.data.limbo.UserGroup;
import fr.xephi.authme.initialization.Reloadable;
import fr.xephi.authme.output.ConsoleLoggerFactory;
import fr.xephi.authme.permission.handlers.LuckPermsHandler;
@@ -285,7 +286,7 @@ public class PermissionsManager implements Reloadable {
*
* @return Permission groups, or an empty collection if this feature is not supported.
*/
public Collection<String> getGroups(OfflinePlayer player) {
public Collection<UserGroup> getGroups(OfflinePlayer player) {
return isEnabled() ? handler.getGroups(player) : Collections.emptyList();
}
@@ -296,7 +297,7 @@ public class PermissionsManager implements Reloadable {
*
* @return The name of the primary permission group. Or null.
*/
public String getPrimaryGroup(OfflinePlayer player) {
public UserGroup getPrimaryGroup(OfflinePlayer player) {
return isEnabled() ? handler.getPrimaryGroup(player) : null;
}
@@ -309,7 +310,7 @@ public class PermissionsManager implements Reloadable {
* @return True if the player is in the specified group, false otherwise.
* False is also returned if groups aren't supported by the used permissions system.
*/
public boolean isInGroup(OfflinePlayer player, String groupName) {
public boolean isInGroup(OfflinePlayer player, UserGroup groupName) {
return isEnabled() && handler.isInGroup(player, groupName);
}
@@ -322,8 +323,8 @@ public class PermissionsManager implements Reloadable {
* @return True if succeed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
public boolean addGroup(OfflinePlayer player, String groupName) {
if (!isEnabled() || StringUtils.isEmpty(groupName)) {
public boolean addGroup(OfflinePlayer player, UserGroup groupName) {
if (!isEnabled() || StringUtils.isEmpty(groupName.getGroupName())) {
return false;
}
return handler.addToGroup(player, groupName);
@@ -338,7 +339,7 @@ public class PermissionsManager implements Reloadable {
* @return True if at least one group was added, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
public boolean addGroups(OfflinePlayer player, Collection<String> groupNames) {
public boolean addGroups(OfflinePlayer player, Collection<UserGroup> groupNames) {
// If no permissions system is used, return false
if (!isEnabled()) {
return false;
@@ -346,9 +347,9 @@ public class PermissionsManager implements Reloadable {
// Add each group to the user
boolean result = false;
for (String groupName : groupNames) {
if (!groupName.isEmpty()) {
result |= handler.addToGroup(player, groupName);
for (UserGroup group : groupNames) {
if (!group.getGroupName().isEmpty()) {
result |= handler.addToGroup(player, group);
}
}
@@ -360,13 +361,13 @@ public class PermissionsManager implements Reloadable {
* Remove the permission group of a player, if supported.
*
* @param player The player
* @param groupName The name of the group.
* @param group The name of the group.
*
* @return True if succeed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
public boolean removeGroup(OfflinePlayer player, String groupName) {
return isEnabled() && handler.removeFromGroup(player, groupName);
public boolean removeGroup(OfflinePlayer player, UserGroup group) {
return isEnabled() && handler.removeFromGroup(player, group);
}
/**
@@ -378,7 +379,7 @@ public class PermissionsManager implements Reloadable {
* @return True if at least one group was removed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
public boolean removeGroups(OfflinePlayer player, Collection<String> groupNames) {
public boolean removeGroups(OfflinePlayer player, Collection<UserGroup> groupNames) {
// If no permissions system is used, return false
if (!isEnabled()) {
return false;
@@ -386,9 +387,9 @@ public class PermissionsManager implements Reloadable {
// Add each group to the user
boolean result = false;
for (String groupName : groupNames) {
if (!groupName.isEmpty()) {
result |= handler.removeFromGroup(player, groupName);
for (UserGroup group : groupNames) {
if (!group.getGroupName().isEmpty()) {
result |= handler.removeFromGroup(player, group);
}
}
@@ -401,13 +402,13 @@ public class PermissionsManager implements Reloadable {
* This clears the current groups of the player.
*
* @param player The player
* @param groupName The name of the group.
* @param group The name of the group.
*
* @return True if succeed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
public boolean setGroup(OfflinePlayer player, String groupName) {
return isEnabled() && handler.setGroup(player, groupName);
public boolean setGroup(OfflinePlayer player, UserGroup group) {
return isEnabled() && handler.setGroup(player, group);
}
/**
@@ -427,10 +428,10 @@ public class PermissionsManager implements Reloadable {
}
// Get a list of current groups
Collection<String> groupNames = getGroups(player);
Collection<UserGroup> groups = getGroups(player);
// Remove each group
return removeGroups(player, groupNames);
return removeGroups(player, groups);
}
/**
@@ -0,0 +1,23 @@
package fr.xephi.authme.permission.handlers;
import net.luckperms.api.context.ImmutableContextSet;
import net.luckperms.api.model.group.Group;
public class LuckPermGroup {
private Group group;
private ImmutableContextSet contexts;
public LuckPermGroup(Group group, ImmutableContextSet contexts) {
this.group = group;
this.contexts = contexts;
}
public Group getGroup() {
return group;
}
public ImmutableContextSet getContexts() {
return contexts;
}
}
@@ -1,12 +1,14 @@
package fr.xephi.authme.permission.handlers;
import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.data.limbo.UserGroup;
import fr.xephi.authme.output.ConsoleLoggerFactory;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PermissionsSystemType;
import net.luckperms.api.LuckPerms;
import net.luckperms.api.LuckPermsProvider;
import net.luckperms.api.cacheddata.CachedPermissionData;
import net.luckperms.api.context.ContextSetFactory;
import net.luckperms.api.model.data.DataMutateResult;
import net.luckperms.api.model.group.Group;
import net.luckperms.api.model.user.User;
@@ -15,6 +17,7 @@ import net.luckperms.api.node.types.InheritanceNode;
import net.luckperms.api.query.QueryMode;
import net.luckperms.api.query.QueryOptions;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;
import java.util.Collections;
import java.util.List;
@@ -45,8 +48,8 @@ public class LuckPermsHandler implements PermissionHandler {
}
@Override
public boolean addToGroup(OfflinePlayer player, String group) {
Group newGroup = luckPerms.getGroupManager().getGroup(group);
public boolean addToGroup(OfflinePlayer player, UserGroup group) {
Group newGroup = luckPerms.getGroupManager().getGroup(group.getGroupName());
if (newGroup == null) {
return false;
}
@@ -60,7 +63,8 @@ public class LuckPermsHandler implements PermissionHandler {
return false;
}
InheritanceNode node = InheritanceNode.builder(group).build();
InheritanceNode node = buildGroupNode(group);
DataMutateResult result = user.data().add(node);
if (result == DataMutateResult.FAIL) {
return false;
@@ -85,12 +89,12 @@ public class LuckPermsHandler implements PermissionHandler {
}
CachedPermissionData permissionData = user.getCachedData()
.getPermissionData(QueryOptions.builder(QueryMode.NON_CONTEXTUAL).build());
.getPermissionData(QueryOptions.builder(QueryMode.CONTEXTUAL).build());
return permissionData.checkPermission(node.getNode()).asBoolean();
}
@Override
public boolean isInGroup(OfflinePlayer player, String group) {
public boolean isInGroup(OfflinePlayer player, UserGroup group) {
String playerName = player.getName();
if (playerName == null) {
return false;
@@ -102,12 +106,12 @@ public class LuckPermsHandler implements PermissionHandler {
return false;
}
InheritanceNode inheritanceNode = InheritanceNode.builder(group).build();
InheritanceNode inheritanceNode = InheritanceNode.builder(group.getGroupName()).build();
return user.data().contains(inheritanceNode, NodeEqualityPredicate.EXACT).asBoolean();
}
@Override
public boolean removeFromGroup(OfflinePlayer player, String group) {
public boolean removeFromGroup(OfflinePlayer player, UserGroup group) {
String playerName = player.getName();
if (playerName == null) {
return false;
@@ -119,7 +123,7 @@ public class LuckPermsHandler implements PermissionHandler {
return false;
}
InheritanceNode groupNode = InheritanceNode.builder(group).build();
InheritanceNode groupNode = InheritanceNode.builder(group.getGroupName()).build();
boolean result = user.data().remove(groupNode) != DataMutateResult.FAIL;
luckPerms.getUserManager().saveUser(user);
@@ -127,7 +131,7 @@ public class LuckPermsHandler implements PermissionHandler {
}
@Override
public boolean setGroup(OfflinePlayer player, String group) {
public boolean setGroup(OfflinePlayer player, UserGroup group) {
String playerName = player.getName();
if (playerName == null) {
return false;
@@ -138,7 +142,9 @@ public class LuckPermsHandler implements PermissionHandler {
+ player.getName() + " but it isn't loaded!");
return false;
}
InheritanceNode groupNode = InheritanceNode.builder(group).build();
InheritanceNode groupNode = buildGroupNode(group);
DataMutateResult result = user.data().add(groupNode);
if (result == DataMutateResult.FAIL) {
return false;
@@ -156,7 +162,7 @@ public class LuckPermsHandler implements PermissionHandler {
}
@Override
public List<String> getGroups(OfflinePlayer player) {
public List<UserGroup> getGroups(OfflinePlayer player) {
String playerName = player.getName();
if (playerName == null) {
return Collections.emptyList();
@@ -171,17 +177,16 @@ public class LuckPermsHandler implements PermissionHandler {
return user.getDistinctNodes().stream()
.filter(node -> node instanceof InheritanceNode)
.map(node -> (InheritanceNode) node)
.map(node -> luckPerms.getGroupManager().getGroup(node.getGroupName()))
.filter(Objects::nonNull)
.sorted((o1, o2) -> {
if (o1.getName().equals(user.getPrimaryGroup()) || o2.getName().equals(user.getPrimaryGroup())) {
return o1.getName().equals(user.getPrimaryGroup()) ? 1 : -1;
.map(node -> {
Group group = luckPerms.getGroupManager().getGroup(node.getGroupName());
if (group == null) {
return null;
}
int i = Integer.compare(o2.getWeight().orElse(0), o1.getWeight().orElse(0));
return i != 0 ? i : o1.getName().compareToIgnoreCase(o2.getName());
return new LuckPermGroup(group, node.getContexts());
})
.map(Group::getName)
.filter(Objects::nonNull)
.sorted((o1, o2) -> sortGroups(user, o1, o2))
.map(g -> new UserGroup(g.getGroup().getName(), g.getContexts().toFlattenedMap()))
.collect(Collectors.toList());
}
@@ -199,4 +204,24 @@ public class LuckPermsHandler implements PermissionHandler {
}
}
@NotNull
private InheritanceNode buildGroupNode(UserGroup group) {
ContextSetFactory contextSetFactory = luckPerms.getContextManager().getContextSetFactory();
InheritanceNode.Builder builder = InheritanceNode.builder(group.getGroupName());
if (group.getContextMap() != null) {
group.getContextMap().forEach((k, v) -> builder.withContext((contextSetFactory.immutableOf(k, v))));
}
return builder.build();
}
private int sortGroups(User user, LuckPermGroup o1, LuckPermGroup o2) {
Group group1 = o1.getGroup();
Group group2 = o2.getGroup();
if (group1.getName().equals(user.getPrimaryGroup()) || group2.getName().equals(user.getPrimaryGroup())) {
return group1.getName().equals(user.getPrimaryGroup()) ? 1 : -1;
}
int i = Integer.compare(group2.getWeight().orElse(0), group1.getWeight().orElse(0));
return i != 0 ? i : group1.getName().compareToIgnoreCase(group2.getName());
}
}
@@ -1,5 +1,6 @@
package fr.xephi.authme.permission.handlers;
import fr.xephi.authme.data.limbo.UserGroup;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PermissionsSystemType;
import fr.xephi.authme.util.Utils;
@@ -19,7 +20,7 @@ public interface PermissionHandler {
* @return True if succeed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
boolean addToGroup(OfflinePlayer player, String group);
boolean addToGroup(OfflinePlayer player, UserGroup group);
/**
* Check whether the current permissions system has group support.
@@ -49,7 +50,7 @@ public interface PermissionHandler {
* @return True if the player is in the specified group, false otherwise.
* False is also returned if groups aren't supported by the used permissions system.
*/
default boolean isInGroup(OfflinePlayer player, String group) {
default boolean isInGroup(OfflinePlayer player, UserGroup group) {
return getGroups(player).contains(group);
}
@@ -62,7 +63,7 @@ public interface PermissionHandler {
* @return True if succeed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
boolean removeFromGroup(OfflinePlayer player, String group);
boolean removeFromGroup(OfflinePlayer player, UserGroup group);
/**
* Set the permission group of a player, if supported.
@@ -74,7 +75,7 @@ public interface PermissionHandler {
* @return True if succeed, false otherwise.
* False is also returned if this feature isn't supported for the current permissions system.
*/
boolean setGroup(OfflinePlayer player, String group);
boolean setGroup(OfflinePlayer player, UserGroup group);
/**
* Get the permission groups of a player, if available.
@@ -83,7 +84,7 @@ public interface PermissionHandler {
*
* @return Permission groups, or an empty list if this feature is not supported.
*/
Collection<String> getGroups(OfflinePlayer player);
Collection<UserGroup> getGroups(OfflinePlayer player);
/**
* Get the primary group of a player, if available.
@@ -92,8 +93,8 @@ public interface PermissionHandler {
*
* @return The name of the primary permission group. Or null.
*/
default String getPrimaryGroup(OfflinePlayer player) {
Collection<String> groups = getGroups(player);
default UserGroup getPrimaryGroup(OfflinePlayer player) {
Collection<UserGroup> groups = getGroups(player);
if (Utils.isCollectionEmpty(groups)) {
return null;
}
@@ -1,5 +1,6 @@
package fr.xephi.authme.permission.handlers;
import fr.xephi.authme.data.limbo.UserGroup;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PermissionsSystemType;
import org.bukkit.OfflinePlayer;
@@ -10,6 +11,8 @@ import ru.tehkode.permissions.bukkit.PermissionsEx;
import java.util.ArrayList;
import java.util.List;
import static java.util.stream.Collectors.toList;
/**
* Handler for PermissionsEx.
*
@@ -28,13 +31,13 @@ public class PermissionsExHandler implements PermissionHandler {
}
@Override
public boolean addToGroup(OfflinePlayer player, String group) {
public boolean addToGroup(OfflinePlayer player, UserGroup group) {
if (!PermissionsEx.getPermissionManager().getGroupNames().contains(group)) {
return false;
}
PermissionUser user = PermissionsEx.getUser(player.getName());
user.addGroup(group);
user.addGroup(group.getGroupName());
return true;
}
@@ -50,22 +53,22 @@ public class PermissionsExHandler implements PermissionHandler {
}
@Override
public boolean isInGroup(OfflinePlayer player, String group) {
public boolean isInGroup(OfflinePlayer player, UserGroup group) {
PermissionUser user = permissionManager.getUser(player.getName());
return user.inGroup(group);
return user.inGroup(group.getGroupName());
}
@Override
public boolean removeFromGroup(OfflinePlayer player, String group) {
public boolean removeFromGroup(OfflinePlayer player, UserGroup group) {
PermissionUser user = permissionManager.getUser(player.getName());
user.removeGroup(group);
user.removeGroup(group.getGroupName());
return true;
}
@Override
public boolean setGroup(OfflinePlayer player, String group) {
public boolean setGroup(OfflinePlayer player, UserGroup group) {
List<String> groups = new ArrayList<>();
groups.add(group);
groups.add(group.getGroupName());
PermissionUser user = permissionManager.getUser(player.getName());
user.setParentsIdentifier(groups);
@@ -73,9 +76,11 @@ public class PermissionsExHandler implements PermissionHandler {
}
@Override
public List<String> getGroups(OfflinePlayer player) {
public List<UserGroup> getGroups(OfflinePlayer player) {
PermissionUser user = permissionManager.getUser(player.getName());
return user.getParentIdentifiers(null);
return user.getParentIdentifiers(null).stream()
.map(i -> new UserGroup(i, null))
.collect(toList());
}
@Override
@@ -1,6 +1,7 @@
package fr.xephi.authme.permission.handlers;
import com.google.common.annotations.VisibleForTesting;
import fr.xephi.authme.data.limbo.UserGroup;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PermissionsSystemType;
import net.milkbowl.vault.permission.Permission;
@@ -12,6 +13,8 @@ import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import static java.util.stream.Collectors.toList;
/**
* Handler for permissions via Vault.
*
@@ -51,8 +54,8 @@ public class VaultHandler implements PermissionHandler {
}
@Override
public boolean addToGroup(OfflinePlayer player, String group) {
return vaultProvider.playerAddGroup(null, player, group);
public boolean addToGroup(OfflinePlayer player, UserGroup group) {
return vaultProvider.playerAddGroup(null, player, group.getGroupName());
}
@Override
@@ -66,33 +69,33 @@ public class VaultHandler implements PermissionHandler {
}
@Override
public boolean isInGroup(OfflinePlayer player, String group) {
return vaultProvider.playerInGroup(null, player, group);
public boolean isInGroup(OfflinePlayer player, UserGroup group) {
return vaultProvider.playerInGroup(null, player, group.getGroupName());
}
@Override
public boolean removeFromGroup(OfflinePlayer player, String group) {
return vaultProvider.playerRemoveGroup(null, player, group);
public boolean removeFromGroup(OfflinePlayer player, UserGroup group) {
return vaultProvider.playerRemoveGroup(null, player, group.getGroupName());
}
@Override
public boolean setGroup(OfflinePlayer player, String group) {
for (String groupName : getGroups(player)) {
removeFromGroup(player, groupName);
public boolean setGroup(OfflinePlayer player, UserGroup group) {
for (UserGroup g : getGroups(player)) {
removeFromGroup(player, g);
}
return vaultProvider.playerAddGroup(null, player, group);
return vaultProvider.playerAddGroup(null, player, group.getGroupName());
}
@Override
public List<String> getGroups(OfflinePlayer player) {
public List<UserGroup> getGroups(OfflinePlayer player) {
String[] groups = vaultProvider.getPlayerGroups(null, player);
return groups == null ? Collections.emptyList() : Arrays.asList(groups);
return groups == null ? Collections.emptyList() : Arrays.stream(groups).map(UserGroup::new).collect(toList());
}
@Override
public String getPrimaryGroup(OfflinePlayer player) {
return vaultProvider.getPrimaryGroup(null, player);
public UserGroup getPrimaryGroup(OfflinePlayer player) {
return new UserGroup(vaultProvider.getPrimaryGroup(null, player));
}
@Override
@@ -1,5 +1,6 @@
package fr.xephi.authme.permission.handlers;
import fr.xephi.authme.data.limbo.UserGroup;
import fr.xephi.authme.permission.PermissionNode;
import fr.xephi.authme.permission.PermissionsSystemType;
import org.bukkit.Bukkit;
@@ -9,6 +10,8 @@ import org.tyrannyofheaven.bukkit.zPermissions.ZPermissionsService;
import java.util.Collection;
import java.util.Map;
import static java.util.stream.Collectors.toList;
/**
* Handler for zPermissions.
*
@@ -29,9 +32,9 @@ public class ZPermissionsHandler implements PermissionHandler {
}
@Override
public boolean addToGroup(OfflinePlayer player, String group) {
public boolean addToGroup(OfflinePlayer player, UserGroup group) {
return Bukkit.dispatchCommand(Bukkit.getConsoleSender(),
"permissions player " + player.getName() + " addgroup " + group);
"permissions player " + player.getName() + " addgroup " + group.getGroupName());
}
@Override
@@ -46,25 +49,27 @@ public class ZPermissionsHandler implements PermissionHandler {
}
@Override
public boolean removeFromGroup(OfflinePlayer player, String group) {
public boolean removeFromGroup(OfflinePlayer player, UserGroup group) {
return Bukkit.dispatchCommand(Bukkit.getConsoleSender(),
"permissions player " + player.getName() + " removegroup " + group);
"permissions player " + player.getName() + " removegroup " + group.getGroupName());
}
@Override
public boolean setGroup(OfflinePlayer player, String group) {
public boolean setGroup(OfflinePlayer player, UserGroup group) {
return Bukkit.dispatchCommand(Bukkit.getConsoleSender(),
"permissions player " + player.getName() + " setgroup " + group);
"permissions player " + player.getName() + " setgroup " + group.getGroupName());
}
@Override
public Collection<String> getGroups(OfflinePlayer player) {
return zPermissionsService.getPlayerGroups(player.getName());
public Collection<UserGroup> getGroups(OfflinePlayer player) {
return zPermissionsService.getPlayerGroups(player.getName()).stream()
.map(UserGroup::new)
.collect(toList());
}
@Override
public String getPrimaryGroup(OfflinePlayer player) {
return zPermissionsService.getPlayerPrimaryGroup(player.getName());
public UserGroup getPrimaryGroup(OfflinePlayer player) {
return new UserGroup(zPermissionsService.getPlayerPrimaryGroup(player.getName()));
}
@Override