Per-world permissions

api/src/main/java/me/lucko/luckperms/api/PermissionObject.java

@@ -35,6 +35,16 @@ public interface PermissionObject {
      */
     boolean hasPermission(String node, boolean b, String server);
 
+    /**
+     * Checks to see the the object has a permission on a certain server
+     * @param node The permission node
+     * @param b If the node is true/false(negated)
+     * @param server The server
+     * @param world The world
+     * @return true if the user has the permission
+     */
+    boolean hasPermission(String node, boolean b, String server, String world);
+
     /**
      * Checks to see the the object has a permission on a certain server
      * @param node The permission node
@@ -44,6 +54,27 @@ public interface PermissionObject {
      */
     boolean hasPermission(String node, boolean b, boolean temporary);
 
+    /**
+     * Checks to see the the object has a permission on a certain server
+     * @param node The permission node
+     * @param b If the node is true/false(negated)
+     * @param server The server to check on
+     * @param temporary if the permission is temporary
+     * @return true if the user has the permission
+     */
+    boolean hasPermission(String node, boolean b, String server, boolean temporary);
+
+    /**
+     * Checks to see the the object has a permission on a certain server
+     * @param node The permission node
+     * @param b If the node is true/false(negated)
+     * @param server The server to check on
+     * @param world The world to check on
+     * @param temporary if the permission is temporary
+     * @return true if the user has the permission
+     */
+    boolean hasPermission(String node, boolean b, String server, String world, boolean temporary);
+
     /**
      * Checks to see if the object inherits a certain permission
      * @param node The permission node
@@ -61,6 +92,16 @@ public interface PermissionObject {
      */
     boolean inheritsPermission(String node, boolean b, String server);
 
+    /**
+     * Checks to see the the object inherits a permission on a certain server
+     * @param node The permission node
+     * @param b If the node is true/false(negated)
+     * @param server The server
+     * @param world The world
+     * @return true if the user inherits the permission
+     */
+    boolean inheritsPermission(String node, boolean b, String server, String world);
+
     /**
      * Checks to see if the object inherits a certain permission
      * @param node The permission node
@@ -70,6 +111,27 @@ public interface PermissionObject {
      */
     boolean inheritsPermission(String node, boolean b, boolean temporary);
 
+    /**
+     * Checks to see if the object inherits a certain permission
+     * @param node The permission node
+     * @param b If the node is true/false(negated)
+     * @param server The server
+     * @param temporary if the permission is temporary
+     * @return true if the user inherits the permission
+     */
+    boolean inheritsPermission(String node, boolean b, String server, boolean temporary);
+
+    /**
+     * Checks to see if the object inherits a certain permission
+     * @param node The permission node
+     * @param b If the node is true/false(negated)
+     * @param server The server
+     * @param world The world
+     * @param temporary if the permission is temporary
+     * @return true if the user inherits the permission
+     */
+    boolean inheritsPermission(String node, boolean b, String server, String world, boolean temporary);
+
     /**
      * Sets a permission for the object
      * @param node The node to be set
@@ -87,6 +149,16 @@ public interface PermissionObject {
      */
     void setPermission(String node, boolean value, String server) throws ObjectAlreadyHasException;
 
+    /**
+     * Sets a permission for the object
+     * @param node The node to set
+     * @param value What to set the node to - true/false(negated)
+     * @param server The server to set the permission on
+     * @param world The world to set the permission on
+     * @throws ObjectAlreadyHasException if the object already has the permission
+     */
+    void setPermission(String node, boolean value, String server, String world) throws ObjectAlreadyHasException;
+
     /**
      * Sets a permission for the object
      * @param node The node to set
@@ -106,6 +178,17 @@ public interface PermissionObject {
      */
     void setPermission(String node, boolean value, String server, long expireAt) throws ObjectAlreadyHasException;
 
+    /**
+     * Sets a permission for the object
+     * @param node The node to set
+     * @param value What to set the node to - true/false(negated)
+     * @param server The server to set the permission on
+     * @param world The world to set the permission on
+     * @param expireAt The time in unixtime when the permission will expire
+     * @throws ObjectAlreadyHasException if the object already has the permission
+     */
+    void setPermission(String node, boolean value, String server, String world, long expireAt) throws ObjectAlreadyHasException;
+
     /**
      * Unsets a permission for the object
      * @param node The node to be unset
@@ -129,6 +212,15 @@ public interface PermissionObject {
      */
     void unsetPermission(String node, String server) throws ObjectLacksException;
 
+    /**
+     * Unsets a permission for the object
+     * @param node The node to be unset
+     * @param server The server to unset the node on
+     * @param world The world to unset the node on
+     * @throws ObjectLacksException if the node wasn't already set
+     */
+    void unsetPermission(String node, String server, String world) throws ObjectLacksException;
+
     /**
      * Unsets a permission for the object
      * @param node The node to be unset
@@ -138,6 +230,25 @@ public interface PermissionObject {
      */
     void unsetPermission(String node, String server, boolean temporary) throws ObjectLacksException;
 
+    /**
+     * Unsets a permission for the object
+     * @param node The node to be unset
+     * @param server The server to unset the node on
+     * @param world The world to unset the node on
+     * @param temporary if the permission being unset is temporary
+     * @throws ObjectLacksException if the node wasn't already set
+     */
+    void unsetPermission(String node, String server, String world, boolean temporary) throws ObjectLacksException;
+
+    /**
+     * Gets the permissions and inherited permissions that apply to a specific server
+     * @param server The server to get nodes for
+     * @param world The world to get nodes for
+     * @param excludedGroups Groups that shouldn't be inherited (to prevent circular inheritance issues)
+     * @return a {@link Map} of the permissions
+     */
+    Map<String, Boolean> getLocalPermissions(String server, String world, List<String> excludedGroups);
+
     /**
      * Gets the permissions and inherited permissions that apply to a specific server
      * @param server The server to get nodes for (can be null)

api/src/main/java/me/lucko/luckperms/api/User.java

@@ -14,10 +14,32 @@ import java.util.UUID;
 @SuppressWarnings("unused")
 public interface User extends PermissionObject {
 
+    /**
+     * @return the users Mojang assigned unique id
+     */
     UUID getUuid();
+
+    /**
+     * @return the Users Username
+     */
     String getName();
+
+    /**
+     * Gets the users primary group
+     * @return the users primary group
+     */
     String getPrimaryGroup();
+
+    /**
+     * Sets a users primary group
+     * @param s the new primary group
+     * @throws ObjectAlreadyHasException if the user already has this set as their primary group
+     */
     void setPrimaryGroup(String s) throws ObjectAlreadyHasException;
+
+    /**
+     * Refresh and re-assign the users permissions
+     */
     void refreshPermissions();
 
     /**
@@ -35,6 +57,15 @@ public interface User extends PermissionObject {
      */
     boolean isInGroup(Group group, String server);
 
+    /**
+     * Check to see if a user is a member of a group on a specific server
+     * @param group The group to check membership of
+     * @param server The server to check on
+     * @param world The world to check on
+     * @return true if the user is a member of the group
+     */
+    boolean isInGroup(Group group, String server, String world);
+
     /**
      * Add a user to a group
      * @param group The group to add the user to
@@ -50,6 +81,15 @@ public interface User extends PermissionObject {
      */
     void addGroup(Group group, String server) throws ObjectAlreadyHasException;
 
+    /**
+     * Add a user to a group on a specific server
+     * @param group The group to add the user to
+     * @param server The server to add the group on
+     * @param world The world to add the group on
+     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
+     */
+    void addGroup(Group group, String server, String world) throws ObjectAlreadyHasException;
+
     /**
      * Add a user to a group on a specific server
      * @param group The group to add the user to
@@ -67,6 +107,16 @@ public interface User extends PermissionObject {
      */
     void addGroup(Group group, String server, long expireAt) throws ObjectAlreadyHasException;
 
+    /**
+     * Add a user to a group on a specific server
+     * @param group The group to add the user to
+     * @param server The server to add the group on
+     * @param world The world to add the group on
+     * @param expireAt when the group should expire
+     * @throws ObjectAlreadyHasException if the user is already a member of the group on that server
+     */
+    void addGroup(Group group, String server, String world, long expireAt) throws ObjectAlreadyHasException;
+
     /**
      * Remove the user from a group
      * @param group the group to remove the user from
@@ -90,6 +140,15 @@ public interface User extends PermissionObject {
      */
     void removeGroup(Group group, String server) throws ObjectLacksException;
 
+    /**
+     * Remove the user from a group
+     * @param group The group to remove the user from
+     * @param server The server to remove the group on
+     * @param world The world to remove the group on
+     * @throws ObjectLacksException if the user isn't a member of the group
+     */
+    void removeGroup(Group group, String server, String world) throws ObjectLacksException;
+
     /**
      * Remove the user from a group
      * @param group The group to remove the user from
@@ -99,6 +158,16 @@ public interface User extends PermissionObject {
      */
     void removeGroup(Group group, String server, boolean temporary) throws ObjectLacksException;
 
+    /**
+     * Remove the user from a group
+     * @param group The group to remove the user from
+     * @param server The server to remove the group on
+     * @param world The world to remove the group on
+     * @param temporary if the group being removed is temporary
+     * @throws ObjectLacksException if the user isn't a member of the group
+     */
+    void removeGroup(Group group, String server, String world, boolean temporary) throws ObjectLacksException;
+
     /**
      * Clear all of the users permission nodes
      */
@@ -110,6 +179,13 @@ public interface User extends PermissionObject {
      */
     List<String> getGroupNames();
 
+    /**
+     * Get a {@link List} of the groups the user is a member of on a specific server
+     * @param server the server to check
+     * @return a {@link List} of group names
+     */
+    List<String> getLocalGroups(String server, String world);
+
     /**
      * Get a {@link List} of the groups the user is a member of on a specific server
      * @param server the server to check