Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2024-11-27 21:29:47 +01:00
Code Issues Projects Releases Wiki Activity

Add some alternate options for primary group calculation

Browse Source
This commit is contained in:
Luck 2017-03-17 22:54:18 +00:00
parent e91c2ca427
commit 2e75bc3f3b
No known key found for this signature in database
GPG Key ID: EFA9B3EC5FD90F8B
32 changed files with 311 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bukkit/src/main/java/me/lucko/luckperms/bukkit/migration/MigrationGroupManager.java
View File

@ -238,7 +238,7 @@ public class MigrationGroupManager extends SubCommand<Object> {
String primaryGroup = primaryGroups.get(e.getKey());
if (primaryGroup != null) {
user.setPermissionUnchecked(NodeFactory.make("group." + primaryGroup));
user.setPrimaryGroup(primaryGroup);
user.getPrimaryGroup().setStoredValue(primaryGroup);
user.unsetPermissionUnchecked(NodeFactory.make("group.default"));
}

2
bukkit/src/main/java/me/lucko/luckperms/bukkit/migration/MigrationPermissionsEx.java
View File

@ -221,7 +221,7 @@ public class MigrationPermissionsEx extends SubCommand<Object> {
if (primary != null && !primary.equalsIgnoreCase("default")) {
lpUser.setPermissionUnchecked(NodeFactory.make("group." + primary.toLowerCase()));
lpUser.setPrimaryGroup(primary);
lpUser.getPrimaryGroup().setStoredValue(primary);
lpUser.unsetPermissionUnchecked(NodeFactory.make("group.default"));
}

2
bukkit/src/main/java/me/lucko/luckperms/bukkit/migration/MigrationPowerfulPerms.java
View File

@ -262,7 +262,7 @@ public class MigrationPowerfulPerms extends SubCommand<Object> {
String primary = joinFuture(pm.getPlayerPrimaryGroup(uuid)).getName().toLowerCase();
if (!primary.equals("default")) {
user.setPermissionUnchecked(NodeFactory.make("group." + primary));
user.setPrimaryGroup(primary);
user.getPrimaryGroup().setStoredValue(primary);
}
plugin.getUserManager().cleanup(user);

2
bukkit/src/main/java/me/lucko/luckperms/bukkit/migration/MigrationZPermissions.java
View File

@ -132,7 +132,7 @@ public class MigrationZPermissions extends SubCommand<Object> {
plugin.getStorage().loadUser(u, username).join();
User user = plugin.getUserManager().get(u);
migrateEntity(user, entity, internalService.getGroups(u));
user.setPrimaryGroup(MigrationUtils.standardizeName(service.getPlayerPrimaryGroup(u)));
user.getPrimaryGroup().setStoredValue(MigrationUtils.standardizeName(service.getPlayerPrimaryGroup(u)));
plugin.getUserManager().cleanup(user);
plugin.getStorage().saveUser(user);

4
bukkit/src/main/java/me/lucko/luckperms/bukkit/vault/VaultPermissionHook.java
View File

@ -323,7 +323,7 @@ public class VaultPermissionHook extends Permission {
// nothing special, just return the value.
if (!isPgo()) {
String g = user.getPrimaryGroup();
String g = user.getPrimaryGroup().getValue();
return plugin.getConfiguration().get(ConfigKeys.GROUP_NAME_REWRITES).getOrDefault(g, g);
}
@ -376,7 +376,7 @@ public class VaultPermissionHook extends Permission {
}
// Fallback
String g = user.getPrimaryGroup();
String g = user.getPrimaryGroup().getValue();
return plugin.getConfiguration().get(ConfigKeys.GROUP_NAME_REWRITES).getOrDefault(g, g);
}

8
bukkit/src/main/resources/config.yml
View File

@ -56,6 +56,14 @@ log-notify: true
# If "deny": the command will just fail if you try to add another node with the same expiry
temporary-add-behaviour: deny
# How should LuckPerms determine a users "primary" group.
#
# Available Options:
# -> stored use the value stored against the users record in the file/database
# -> parents-by-weight just use the users most highly weighted parent
# -> all-parents-by-weight same as above, but calculates based upon all parents inherits from both directly and indirectly
primary-group-calculation: stored

8
bungee/src/main/resources/config.yml
View File

@ -66,6 +66,14 @@ group-name-rewrite:
# If "deny": the command will just fail if you try to add another node with the same expiry
temporary-add-behaviour: deny
# How should LuckPerms determine a users "primary" group.
#
# Available Options:
# -> stored use the value stored against the users record in the file/database
# -> parents-by-weight just use the users most highly weighted parent
# -> all-parents-by-weight same as above, but calculates based upon all parents inherits from both directly and indirectly
primary-group-calculation: stored

4
common/src/main/java/me/lucko/luckperms/common/api/delegates/UserDelegate.java
View File

@ -63,7 +63,7 @@ public final class UserDelegate extends PermissionHolderDelegate implements User
@Override
public String getPrimaryGroup() {
return master.getPrimaryGroup();
return master.getPrimaryGroup().getValue();
}
@Override
@ -76,7 +76,7 @@ public final class UserDelegate extends PermissionHolderDelegate implements User
throw new IllegalStateException("User is not a member of that group.");
}
master.setPrimaryGroup(s.toLowerCase());
master.getPrimaryGroup().setStoredValue(s.toLowerCase());
}
@Override

4
common/src/main/java/me/lucko/luckperms/common/commands/impl/generic/parent/ParentRemove.java
View File

@ -29,6 +29,7 @@ import me.lucko.luckperms.common.commands.abstraction.SharedSubCommand;
import me.lucko.luckperms.common.commands.sender.Sender;
import me.lucko.luckperms.common.commands.utils.ArgumentUtils;
import me.lucko.luckperms.common.commands.utils.ContextHelper;
import me.lucko.luckperms.common.config.ConfigKeys;
import me.lucko.luckperms.common.constants.Message;
import me.lucko.luckperms.common.constants.Permission;
import me.lucko.luckperms.common.core.model.PermissionHolder;
@ -68,7 +69,8 @@ public class ParentRemove extends SharedSubCommand {
boolean shouldPrevent = (context == ContextHelper.CommandContext.NONE ||
(context == ContextHelper.CommandContext.SERVER && server.equalsIgnoreCase("global"))) &&
user.getPrimaryGroup().equalsIgnoreCase(groupName);
plugin.getConfiguration().get(ConfigKeys.PRIMARY_GROUP_CALCULATION_METHOD).equals("stored") &&
user.getPrimaryGroup().getStoredValue().equalsIgnoreCase(groupName);
if (shouldPrevent) {
Message.USER_REMOVEGROUP_ERROR_PRIMARY.send(sender);

4
common/src/main/java/me/lucko/luckperms/common/commands/impl/generic/parent/ParentSet.java
View File

@ -82,7 +82,7 @@ public class ParentSet extends SharedSubCommand {
} catch (ObjectAlreadyHasException ignored) {}
if (holder instanceof User) {
((User) holder).setPrimaryGroup(group.getName());
((User) holder).getPrimaryGroup().setStoredValue(group.getName());
}
Message.SET_PARENT_SUCCESS.send(sender, holder.getFriendlyName(), group.getDisplayName());
@ -96,7 +96,7 @@ public class ParentSet extends SharedSubCommand {
}
if (server.equalsIgnoreCase("global") && holder instanceof User) {
((User) holder).setPrimaryGroup(group.getName());
((User) holder).getPrimaryGroup().setStoredValue(group.getName());
}
Message.SET_PARENT_SERVER_SUCCESS.send(sender, holder.getFriendlyName(), group.getDisplayName(), server);

4
common/src/main/java/me/lucko/luckperms/common/commands/impl/user/UserDemote.java
View File

@ -170,8 +170,8 @@ public class UserDemote extends SubCommand<User> {
user.setPermission(NodeFactory.newBuilder("group." + previousGroup.getName()).setServer(server).setWorld(world).build());
} catch (ObjectAlreadyHasException ignored) {}
if (server == null && world == null && user.getPrimaryGroup().equalsIgnoreCase(old)) {
user.setPrimaryGroup(previousGroup.getName());
if (server == null && world == null && user.getPrimaryGroup().getStoredValue().equalsIgnoreCase(old)) {
user.getPrimaryGroup().setStoredValue(previousGroup.getName());
}
switch (ContextHelper.determine(server, world)) {

2
common/src/main/java/me/lucko/luckperms/common/commands/impl/user/UserInfo.java
View File

@ -54,7 +54,7 @@ public class UserInfo extends SubCommand<User> {
user.getName(),
user.getUuid(),
plugin.getPlayerStatus(user.getUuid()),
user.getPrimaryGroup(),
user.getPrimaryGroup().getValue(),
user.getPermanentNodes().size(),
user.getTemporaryNodes().size(),
user.getPrefixNodes().size(),

4
common/src/main/java/me/lucko/luckperms/common/commands/impl/user/UserPromote.java
View File

@ -187,8 +187,8 @@ public class UserPromote extends SubCommand<User> {
user.setPermission(NodeFactory.newBuilder("group." + nextGroup.getName()).setServer(server).setWorld(world).build());
} catch (ObjectAlreadyHasException ignored) {}
if (server == null && world == null && user.getPrimaryGroup().equalsIgnoreCase(old)) {
user.setPrimaryGroup(nextGroup.getName());
if (server == null && world == null && user.getPrimaryGroup().getStoredValue().equalsIgnoreCase(old)) {
user.getPrimaryGroup().setStoredValue(nextGroup.getName());
}
switch (ContextHelper.determine(server, world)) {

10
common/src/main/java/me/lucko/luckperms/common/commands/impl/user/UserSwitchPrimaryGroup.java
View File

@ -27,6 +27,7 @@ import me.lucko.luckperms.common.commands.CommandException;
import me.lucko.luckperms.common.commands.CommandResult;
import me.lucko.luckperms.common.commands.abstraction.SubCommand;
import me.lucko.luckperms.common.commands.sender.Sender;
import me.lucko.luckperms.common.config.ConfigKeys;
import me.lucko.luckperms.common.constants.Message;
import me.lucko.luckperms.common.constants.Permission;
import me.lucko.luckperms.common.core.model.Group;
@ -47,13 +48,18 @@ public class UserSwitchPrimaryGroup extends SubCommand<User> {
@Override
public CommandResult execute(LuckPermsPlugin plugin, Sender sender, User user, List<String> args, String label) throws CommandException {
String opt = plugin.getConfiguration().get(ConfigKeys.PRIMARY_GROUP_CALCULATION_METHOD);
if (!opt.equals("stored")) {
Message.USER_PRIMARYGROUP_WARN_OPTION.send(sender, opt);
}
Group group = plugin.getGroupManager().getIfLoaded(args.get(0).toLowerCase());
if (group == null) {
Message.GROUP_DOES_NOT_EXIST.send(sender);
return CommandResult.INVALID_ARGS;
}
if (user.getPrimaryGroup().equalsIgnoreCase(group.getName())) {
if (user.getPrimaryGroup().getStoredValue().equalsIgnoreCase(group.getName())) {
Message.USER_PRIMARYGROUP_ERROR_ALREADYHAS.send(sender);
return CommandResult.STATE_ERROR;
}
@ -66,7 +72,7 @@ public class UserSwitchPrimaryGroup extends SubCommand<User> {
}
}
user.setPrimaryGroup(group.getName());
user.getPrimaryGroup().setStoredValue(group.getName());
Message.USER_PRIMARYGROUP_SUCCESS.send(sender, user.getName(), group.getDisplayName());
LogEntry.build().actor(sender).acted(user)
.action("setprimarygroup " + group.getName())

4
common/src/main/java/me/lucko/luckperms/common/commands/impl/usersbulkedit/BulkEditGroup.java
View File

@ -91,7 +91,7 @@ public class BulkEditGroup extends SubCommand<Storage> {
continue;
}
if (element.getGroupName().equals(user.getPrimaryGroup())) {
if (element.getGroupName().equals(user.getPrimaryGroup().getStoredValue())) {
if (!element.isServerSpecific() && !element.isWorldSpecific() && !element.isTemporary()) {
continue;
}
@ -117,7 +117,7 @@ public class BulkEditGroup extends SubCommand<Storage> {
continue;
}
if (element.getGroupName().equals(user.getPrimaryGroup())) {
if (element.getGroupName().equals(user.getPrimaryGroup().getStoredValue())) {
continue;
}

25
common/src/main/java/me/lucko/luckperms/common/config/ConfigKeys.java
View File

@ -37,7 +37,12 @@ import me.lucko.luckperms.common.config.keys.MapKey;
import me.lucko.luckperms.common.config.keys.StaticKey;
import me.lucko.luckperms.common.config.keys.StringKey;
import me.lucko.luckperms.common.core.TemporaryModifier;
import me.lucko.luckperms.common.core.model.User;
import me.lucko.luckperms.common.defaults.Rule;
import me.lucko.luckperms.common.primarygroup.AllParentsByWeightHolder;
import me.lucko.luckperms.common.primarygroup.ParentsByWeightHolder;
import me.lucko.luckperms.common.primarygroup.PrimaryGroupHolder;
import me.lucko.luckperms.common.primarygroup.StoredHolder;
import me.lucko.luckperms.common.storage.DatastoreConfiguration;
import me.lucko.luckperms.common.utils.ImmutableCollectors;
@ -46,6 +51,7 @@ import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
@UtilityClass
public class ConfigKeys {
@ -70,6 +76,25 @@ public class ConfigKeys {
return TemporaryModifier.valueOf(option.toUpperCase());
});
public static final ConfigKey<String> PRIMARY_GROUP_CALCULATION_METHOD = EnduringKey.wrap(AbstractKey.of(c -> {
String option = c.getString("primary-group-calculation", "stored").toLowerCase();
if (!option.equals("stored") && !option.equals("parents-by-weight") && !option.equals("all-parents-by-weight")) {
option = "stored";
}
return option;
}));
public static final ConfigKey<Function<User, PrimaryGroupHolder>> PRIMARY_GROUP_CALCULATION = EnduringKey.wrap(AbstractKey.of(c -> {
String option = PRIMARY_GROUP_CALCULATION_METHOD.get(c);
switch (option) {
case "stored":
return (Function<User, PrimaryGroupHolder>) StoredHolder::new;
case "parents-by-weight":
return (Function<User, PrimaryGroupHolder>) ParentsByWeightHolder::new;
default:
return (Function<User, PrimaryGroupHolder>) AllParentsByWeightHolder::new;
}
}));
public static final ConfigKey<Boolean> APPLYING_WILDCARDS = EnduringKey.wrap(BooleanKey.of("apply-wildcards", true));
public static final ConfigKey<Boolean> APPLYING_REGEX = EnduringKey.wrap(BooleanKey.of("apply-regex", true));
public static final ConfigKey<Boolean> APPLYING_SHORTHAND = EnduringKey.wrap(BooleanKey.of("apply-shorthand", true));

1
common/src/main/java/me/lucko/luckperms/common/constants/Message.java
View File

@ -330,6 +330,7 @@ public enum Message {
USER_GETUUID("&bThe UUID of &b{0}&b is &b{1}&b.", true),
USER_REMOVEGROUP_ERROR_PRIMARY("You cannot remove a user from their primary group.", true),
USER_PRIMARYGROUP_SUCCESS("&b{0}&a's primary group was set to &b{1}&a.", true),
USER_PRIMARYGROUP_WARN_OPTION("&cWarning: The primary group calculation method being used by this server &7({0}) &cmay not reflect this change.", true),
USER_PRIMARYGROUP_ERROR_ALREADYHAS("The user already has this group set as their primary group.", true),
USER_PRIMARYGROUP_ERROR_NOTMEMBER("&b{0}&a was not already a member of &b{1}&a, adding them now.", true),
USER_TRACK_ERROR_NOT_CONTAIN_GROUP("The user specified isn't already in any groups on this track.", true),

8
common/src/main/java/me/lucko/luckperms/common/core/model/PermissionHolder.java
View File

@ -95,7 +95,7 @@ public abstract class PermissionHolder {
/**
* Reference to the main plugin instance
*/
@Getter(AccessLevel.PROTECTED)
@Getter
private final LuckPermsPlugin plugin;
/**
@ -168,10 +168,6 @@ public abstract class PermissionHolder {
}
});
/* Caching apply methods. Are just called by the caching instances to gather data about the instance. */
protected void forceCleanup() {
getAllNodesCache.cleanUp();
getAllNodesFilteredCache.cleanUp();
@ -221,6 +217,8 @@ public abstract class PermissionHolder {
declareState();
}
/* Caching apply methods. Are just called by the caching instances to gather data about the instance. */
private ImmutableSortedSet<LocalizedNode> cacheApply(boolean mergeTemp) {
TreeSet<LocalizedNode> combined = new TreeSet<>(PriorityComparator.reverse());
Set<Node> enduring = getNodes();

7
common/src/main/java/me/lucko/luckperms/common/core/model/User.java
View File

@ -32,8 +32,10 @@ import me.lucko.luckperms.common.api.delegates.UserDelegate;
import me.lucko.luckperms.common.caching.UserCache;
import me.lucko.luckperms.common.caching.handlers.HolderReference;
import me.lucko.luckperms.common.caching.handlers.UserReference;
import me.lucko.luckperms.common.config.ConfigKeys;
import me.lucko.luckperms.common.core.UserIdentifier;
import me.lucko.luckperms.common.plugin.LuckPermsPlugin;
import me.lucko.luckperms.common.primarygroup.PrimaryGroupHolder;
import me.lucko.luckperms.common.utils.BufferedRequest;
import me.lucko.luckperms.common.utils.Identifiable;
@ -60,8 +62,7 @@ public class User extends PermissionHolder implements Identifiable<UserIdentifie
* The users primary group
*/
@Getter
@Setter
private String primaryGroup = null;
private final PrimaryGroupHolder primaryGroup;
/**
* The users data cache instance, if present.
@ -85,12 +86,14 @@ public class User extends PermissionHolder implements Identifiable<UserIdentifie
super(uuid.toString(), plugin);
this.uuid = uuid;
this.name = null;
this.primaryGroup = plugin.getConfiguration().get(ConfigKeys.PRIMARY_GROUP_CALCULATION).apply(this);
}
public User(UUID uuid, String name, LuckPermsPlugin plugin) {
super(uuid.toString(), plugin);
this.uuid = uuid;
this.name = name;
this.primaryGroup = plugin.getConfiguration().get(ConfigKeys.PRIMARY_GROUP_CALCULATION).apply(this);
}
@Override

2
common/src/main/java/me/lucko/luckperms/common/data/Exporter.java
View File

@ -226,7 +226,7 @@ public class Exporter implements Runnable {
output.add(NodeFactory.nodeAsCommand(node, user.getUuid().toString(), false));
}
if (!user.getPrimaryGroup().equalsIgnoreCase("default")) {
if (!user.getPrimaryGroup().getStoredValue().equalsIgnoreCase("default")) {
output.add("/luckperms user " + user.getUuid().toString() + " switchprimarygroup " + user.getPrimaryGroup());
}

2
common/src/main/java/me/lucko/luckperms/common/defaults/Rule.java
View File

@ -97,7 +97,7 @@ public class Rule {
}
if (setPrimaryGroup != null) {
user.setPrimaryGroup(setPrimaryGroup);
user.getPrimaryGroup().setStoredValue(setPrimaryGroup);
}
return true;

12
common/src/main/java/me/lucko/luckperms/common/managers/impl/GenericUserManager.java
View File

@ -25,12 +25,12 @@ package me.lucko.luckperms.common.managers.impl;
import lombok.RequiredArgsConstructor;
import me.lucko.luckperms.api.Node;
import me.lucko.luckperms.common.core.NodeFactory;
import me.lucko.luckperms.common.core.UserIdentifier;
import me.lucko.luckperms.common.core.model.User;
import me.lucko.luckperms.common.managers.AbstractManager;
import me.lucko.luckperms.common.managers.UserManager;
import me.lucko.luckperms.common.plugin.LuckPermsPlugin;
import me.lucko.luckperms.exceptions.ObjectAlreadyHasException;
import java.util.Set;
import java.util.UUID;
@ -40,7 +40,7 @@ public class GenericUserManager extends AbstractManager<UserIdentifier, User> im
public static boolean giveDefaultIfNeeded(User user, boolean save, LuckPermsPlugin plugin) {
boolean hasGroup = false;
if (user.getPrimaryGroup() != null && !user.getPrimaryGroup().isEmpty()) {
if (user.getPrimaryGroup().getStoredValue() != null && !user.getPrimaryGroup().getStoredValue().isEmpty()) {
for (Node node : user.getPermissions(false)) {
if (node.isServerSpecific() || node.isWorldSpecific()) {
continue;
@ -57,10 +57,8 @@ public class GenericUserManager extends AbstractManager<UserIdentifier, User> im
return false;
}
user.setPrimaryGroup("default");
try {
user.setPermission("group.default", true);
} catch (ObjectAlreadyHasException ignored) {}
user.getPrimaryGroup().setStoredValue("default");
user.setPermissionUnchecked(NodeFactory.make("group.default"));
if (save) {
plugin.getStorage().saveUser(user);
@ -97,7 +95,7 @@ public class GenericUserManager extends AbstractManager<UserIdentifier, User> im
}
// Not in the default primary group
return !user.getPrimaryGroup().equalsIgnoreCase("default");
return !user.getPrimaryGroup().getStoredValue().equalsIgnoreCase("default");
}
private final LuckPermsPlugin plugin;

64
common/src/main/java/me/lucko/luckperms/common/primarygroup/AllParentsByWeightHolder.java Normal file
View File

@ -0,0 +1,64 @@
/*
* Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
*
* 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.lucko.luckperms.common.primarygroup;
import me.lucko.luckperms.api.Contexts;
import me.lucko.luckperms.api.Node;
import me.lucko.luckperms.common.core.model.Group;
import me.lucko.luckperms.common.core.model.User;
import me.lucko.luckperms.common.utils.ExtractedContexts;
import java.util.Comparator;
import java.util.Optional;
public class AllParentsByWeightHolder extends StoredHolder {
private String cachedValue = null;
private boolean useCached = false;
public AllParentsByWeightHolder(User user) {
super(user);
user.getStateListeners().add(() -> useCached = false);
}
@Override
public String getValue() {
if (useCached) {
return cachedValue;
}
cachedValue = user.getAllNodes(null, ExtractedContexts.generate(Contexts.allowAll())).stream()
.filter(Node::isGroupNode)
.filter(Node::getValue)
.map(n -> Optional.ofNullable(user.getPlugin().getGroupManager().getIfLoaded(n.getGroupName())))
.filter(Optional::isPresent)
.map(Optional::get)
.sorted(Comparator.comparingInt(o -> o.getWeight().orElse(0)))
.findFirst()
.map(Group::getName)
.orElse(null);
useCached = true;
return cachedValue;
}
}

62
common/src/main/java/me/lucko/luckperms/common/primarygroup/ParentsByWeightHolder.java Normal file
View File

@ -0,0 +1,62 @@
/*
* Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
*
* 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.lucko.luckperms.common.primarygroup;
import me.lucko.luckperms.api.Node;
import me.lucko.luckperms.common.core.model.Group;
import me.lucko.luckperms.common.core.model.User;
import java.util.Comparator;
import java.util.Optional;
public class ParentsByWeightHolder extends StoredHolder {
private String cachedValue = null;
private boolean useCached = false;
public ParentsByWeightHolder(User user) {
super(user);
user.getStateListeners().add(() -> useCached = false);
}
@Override
public String getValue() {
if (useCached) {
return cachedValue;
}
cachedValue = user.getPermissions(true).stream()
.filter(Node::isGroupNode)
.filter(Node::getValue)
.map(n -> Optional.ofNullable(user.getPlugin().getGroupManager().getIfLoaded(n.getGroupName())))
.filter(Optional::isPresent)
.map(Optional::get)
.sorted(Comparator.comparingInt(o -> o.getWeight().orElse(0)))
.findFirst()
.map(Group::getName)
.orElse(null);
useCached = true;
return cachedValue;
}
}

33
common/src/main/java/me/lucko/luckperms/common/primarygroup/PrimaryGroupHolder.java Normal file
View File

@ -0,0 +1,33 @@
/*
* Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
*
* 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.lucko.luckperms.common.primarygroup;
public interface PrimaryGroupHolder {
String getValue();
String getStoredValue();
void setStoredValue(String storedValue);
}

44
common/src/main/java/me/lucko/luckperms/common/primarygroup/StoredHolder.java Normal file
View File

@ -0,0 +1,44 @@
/*
* Copyright (c) 2016 Lucko (Luck) <luck@lucko.me>
*
* 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.lucko.luckperms.common.primarygroup;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import me.lucko.luckperms.common.core.model.User;
@RequiredArgsConstructor
public class StoredHolder implements PrimaryGroupHolder {
protected final User user;
@Getter
@Setter
private String storedValue = null;
public String getValue() {
return storedValue;
}
}

8
common/src/main/java/me/lucko/luckperms/common/storage/backing/JSONBacking.java
View File

@ -118,7 +118,7 @@ public class JSONBacking extends FlatfileBacking {
reader.nextName(); // name record
String name = reader.nextString(); // name
reader.nextName(); // primaryGroup record
user.setPrimaryGroup(reader.nextString()); // primaryGroup
user.getPrimaryGroup().setStoredValue(reader.nextString()); // primaryGroup
reader.nextName(); // perms
reader.beginObject();
Map<String, Boolean> map = new HashMap<>();
@ -146,7 +146,7 @@ public class JSONBacking extends FlatfileBacking {
writer.beginObject();
writer.name("uuid").value(user.getUuid().toString());
writer.name("name").value(user.getName());
writer.name("primaryGroup").value(user.getPrimaryGroup());
writer.name("primaryGroup").value(user.getPrimaryGroup().getStoredValue());
writer.name("perms");
writer.beginObject();
for (Map.Entry<String, Boolean> e : exportToLegacy(user.getNodes()).entrySet()) {
@ -162,7 +162,7 @@ public class JSONBacking extends FlatfileBacking {
} else {
if (GenericUserManager.shouldSave(user)) {
user.clearNodes();
user.setPrimaryGroup(null);
user.getPrimaryGroup().setStoredValue(null);
plugin.getUserManager().giveDefaultIfNeeded(user, false);
}
return true;
@ -202,7 +202,7 @@ public class JSONBacking extends FlatfileBacking {
writer.beginObject();
writer.name("uuid").value(user.getUuid().toString());
writer.name("name").value(user.getName());
writer.name("primaryGroup").value(user.getPrimaryGroup());
writer.name("primaryGroup").value(user.getPrimaryGroup().getStoredValue());
writer.name("perms");
writer.beginObject();
for (Map.Entry<String, Boolean> e : exportToLegacy(user.getNodes()).entrySet()) {

6
common/src/main/java/me/lucko/luckperms/common/storage/backing/MongoDBBacking.java
View File

@ -94,7 +94,7 @@ public class MongoDBBacking extends AbstractBacking {
private static Document fromUser(User user) {
Document main = new Document("_id", user.getUuid())
.append("name", user.getName())
.append("primaryGroup", user.getPrimaryGroup());
.append("primaryGroup", user.getPrimaryGroup().getStoredValue());
Document perms = new Document();
for (Map.Entry<String, Boolean> e : convert(exportToLegacy(user.getNodes())).entrySet()) {
@ -238,7 +238,7 @@ public class MongoDBBacking extends AbstractBacking {
// User exists, let's load.
Document d = cursor.next();
user.setNodes(revert((Map<String, Boolean>) d.get("perms")));
user.setPrimaryGroup(d.getString("primaryGroup"));
user.getPrimaryGroup().setStoredValue(d.getString("primaryGroup"));
boolean save = plugin.getUserManager().giveDefaultIfNeeded(user, false);
@ -256,7 +256,7 @@ public class MongoDBBacking extends AbstractBacking {
} else {
if (GenericUserManager.shouldSave(user)) {
user.clearNodes();
user.setPrimaryGroup(null);
user.getPrimaryGroup().setStoredValue(null);
plugin.getUserManager().giveDefaultIfNeeded(user, false);
}
}

6
common/src/main/java/me/lucko/luckperms/common/storage/backing/SQLBacking.java
View File

@ -301,7 +301,7 @@ public class SQLBacking extends AbstractBacking {
if (pg == null) {
pg = "default";
}
user.setPrimaryGroup(pg);
user.getPrimaryGroup().setStoredValue(pg);
String name = userName.get();
if (name == null) {
@ -328,7 +328,7 @@ public class SQLBacking extends AbstractBacking {
// User has no data in storage.
if (GenericUserManager.shouldSave(user)) {
user.clearNodes();
user.setPrimaryGroup(null);
user.getPrimaryGroup().setStoredValue(null);
plugin.getUserManager().giveDefaultIfNeeded(user, false);
}
}
@ -436,7 +436,7 @@ public class SQLBacking extends AbstractBacking {
try (Connection c = provider.getConnection()) {
try (PreparedStatement ps = c.prepareStatement(prefix.apply(PLAYER_UPDATE_PRIMARY_GROUP))) {
ps.setString(1, user.getPrimaryGroup() == null ? "default" : user.getPrimaryGroup());
ps.setString(1, user.getPrimaryGroup().getStoredValue() == null ? "default" : user.getPrimaryGroup().getStoredValue());
ps.setString(2, user.getUuid().toString());
ps.execute();
}

8
common/src/main/java/me/lucko/luckperms/common/storage/backing/YAMLBacking.java
View File

@ -115,7 +115,7 @@ public class YAMLBacking extends FlatfileBacking {
return readMapFromFile(userFile, values -> {
// User exists, let's load.
String name = (String) values.get("name");
user.setPrimaryGroup((String) values.get("primary-group"));
user.getPrimaryGroup().setStoredValue((String) values.get("primary-group"));
Map<String, Boolean> perms = (Map<String, Boolean>) values.get("perms");
user.setNodes(perms);
@ -133,7 +133,7 @@ public class YAMLBacking extends FlatfileBacking {
Map<String, Object> data = new HashMap<>();
data.put("uuid", user.getUuid().toString());
data.put("name", user.getName());
data.put("primary-group", user.getPrimaryGroup());
data.put("primary-group", user.getPrimaryGroup().getStoredValue());
data.put("perms", exportToLegacy(user.getNodes()));
writeMapToFile(userFile, data);
}
@ -142,7 +142,7 @@ public class YAMLBacking extends FlatfileBacking {
} else {
if (GenericUserManager.shouldSave(user)) {
user.clearNodes();
user.setPrimaryGroup(null);
user.getPrimaryGroup().setStoredValue(null);
plugin.getUserManager().giveDefaultIfNeeded(user, false);
}
return true;
@ -180,7 +180,7 @@ public class YAMLBacking extends FlatfileBacking {
Map<String, Object> values = new HashMap<>();
values.put("uuid", user.getUuid().toString());
values.put("name", user.getName());
values.put("primary-group", user.getPrimaryGroup());
values.put("primary-group", user.getPrimaryGroup().getStoredValue());
values.put("perms", exportToLegacy(user.getNodes()));
return writeMapToFile(userFile, values);
}, false);

1
default-lang.yml
View File

@ -252,6 +252,7 @@ info-temp-parent-header: "&f- &aTemporary Parent Groups:"
user-getuuid: "&bThe UUID of &b{0}&b is &b{1}&b."
user-removegroup-error-primary: "You cannot remove a user from their primary group."
user-primarygroup-success: "&b{0}&a's primary group was set to &b{1}&a."
user-primarygroup-warn-option: "&cWarning: The primary group calculation method being used by this server &7({0}) &cmay not reflect this change."
user-primarygroup-error-alreadyhas: "The user already has this group set as their primary group."
user-primarygroup-error-notmember: "&b{0}&a was not already a member of &b{1}&a, adding them now."
user-track-error-not-contain-group: "The user specified isn't already in any groups on this track."

8
sponge/src/main/resources/luckperms.conf
View File

@ -67,6 +67,14 @@ group-name-rewrite {
# If "deny": the command will just fail if you try to add another node with the same expiry
temporary-add-behaviour="deny"
# How should LuckPerms determine a users "primary" group.
#
# Available Options:
# -> stored use the value stored against the users record in the file/database
# -> parents-by-weight just use the users most highly weighted parent
# -> all-parents-by-weight same as above, but calculates based upon all parents inherits from both directly and indirectly
primary-group-calculation="parents-by-weight"