Adding roles and admin command role permissions (#307)

# Changes
* Config `Roles`
  * rolename => role permissions
  * Permissions can be widely permissive or narrow depending on specificity
* Got rid of old "permission" property on users
* Added a couple of "example" roles.
* User/Admin are immutable. Users have no elevated permissions, admins have all.
* Added `teleport` command.

Author: Volte6

_datafiles/config.yaml

@@ -518,6 +518,26 @@ Validation:
   - "join"
   - "register"
 
+################################################################################
+#
+#   Roles
+#   Roles are string identifiers that map to a number of command names.
+#   They are used to determine what admin commands a player has access to.
+#   Two roles are build in and cannot be changed:
+#     - "user" - Has no admin commands
+#     - "admin" - Has all admin commands
+#   Role sub-commands should be separated by a dot: room.info
+#   Roles are more permissive the more they prefix.
+#   Example: room prefixes room.info so would permit that action as well.
+#   Role checks must be implemented wherever role-based restriction is desired:
+#   if user.HasRolePermission(`room`) { /* Do something */ }
+#
+################################################################################
+Roles:
+  builder: ["room.info", "build"]
+  helper: ["paz", "teleport.playername", "locate"]
+
+
 ################################################################################
 #
 #   Modules

_datafiles/world/default/templates/admincommands/help/command.modify.template

@@ -1,4 +1,4 @@
 The <ansi fg="command">modify</ansi> command modifies player records:
 
-<ansi fg="command">modify permission [username] [user/mod/admin]</ansi> - Changes a users permission level.
-Note: Cannot downgrade an admin to a lower permission.
+<ansi fg="command">modify role [username] [newrole]</ansi> - Changes a users role.
+Note: Cannot downgrade an admin to a lower role.

_datafiles/world/default/templates/admincommands/help/command.teleport.template

@@ -0,0 +1,11 @@
+The <ansi fg="command">teleport</ansi> command can be used in the following ways:
+
+<ansi fg="command">teleport [room_id]</ansi> - e.g. <ansi fg="command">teleport 1</ansi>
+Move to a specific room id
+
+<ansi fg="command">teleport [direction]</ansi> - e.g. <ansi fg="command">teleport east</ansi>
+Move through walls, across gaps, etc. to the first room found to the direction specified (if any).
+
+<ansi fg="command">teleport [name]</ansi> - e.g. <ansi fg="command">teleport davey</ansi>
+Move to the room of a player matching the specified name.
+

_datafiles/world/default/users/1.yaml

@@ -1,5 +1,5 @@
 userid: 1
-permission: admin
+role: admin
 username: admin
 password: password
 joined: 2024-10-31T13:28:45.395873-07:00
@@ -15,6 +15,8 @@ character:
     other adventurers, granting them strength, wisdom, or fortune beyond their wildest
     dreams. Conversely, he can also mete out justice to those who would seek to disrupt
     the balance of the world, swiftly and decisively.
+  adjectives:
+  - zombie
   roomid: 1
   zone: Frostfang
   raceid: 2
@@ -61,17 +63,16 @@ character:
     - buffid: 28
       onstartevent: true
       permabuff: true
-      roundcounter: 20
+      roundcounter: 3
       triggersleft: 1000000000
     - buffid: 29
       onstartevent: true
       permabuff: true
-      roundcounter: 43
+      roundcounter: 11
       triggersleft: 1000000000
     - buffid: 39
       onstartevent: false
       permabuff: true
-      roundcounter: 2
       triggersleft: 1000000000
   equipment:
     weapon:

_datafiles/world/empty/templates/admincommands/help/command.modify.template

@@ -1,4 +1,4 @@
 The <ansi fg="command">modify</ansi> command modifies player records:
 
-<ansi fg="command">modify permission [username] [user/mod/admin]</ansi> - Changes a users permission level.
-Note: Cannot downgrade an admin to a lower permission.
+<ansi fg="command">modify role [username] [newrole]</ansi> - Changes a users role.
+Note: Cannot downgrade an admin to a lower role.

_datafiles/world/empty/templates/admincommands/help/command.teleport.template

@@ -0,0 +1,11 @@
+The <ansi fg="command">teleport</ansi> command can be used in the following ways:
+
+<ansi fg="command">teleport [room_id]</ansi> - e.g. <ansi fg="command">teleport 1</ansi>
+Move to a specific room id
+
+<ansi fg="command">teleport [direction]</ansi> - e.g. <ansi fg="command">teleport east</ansi>
+Move through walls, across gaps, etc. to the first room found to the direction specified (if any).
+
+<ansi fg="command">teleport [name]</ansi> - e.g. <ansi fg="command">teleport davey</ansi>
+Move to the room of a player matching the specified name.
+

_datafiles/world/empty/users/1.yaml

@@ -1,5 +1,6 @@
 userid: 1
 permission: admin
+role: admin
 username: admin
 password: password
 joined: 2024-10-31T13:28:45.395873-07:00

internal/configs/config.roles.go

@@ -0,0 +1,17 @@
+package configs
+
+type Roles map[string]ConfigSliceString
+
+func (m *Roles) Validate() {
+}
+
+func GetRolesConfig() Roles {
+	configDataLock.RLock()
+	defer configDataLock.RUnlock()
+
+	if !configData.validated {
+		configData.Validate()
+	}
+
+	return configData.Roles
+}

internal/configs/configs.go

@@ -47,7 +47,7 @@ type Config struct {
 	Scripting    Scripting    `yaml:"Scripting"`
 	SpecialRooms SpecialRooms `yaml:"SpecialRooms"`
 	Validation   Validation   `yaml:"Validation"`
-
+	Roles        Roles        `yaml:"Roles"`
 	// Plugins is a special case
 	Modules Modules `yaml:"Modules"`
 
@@ -198,6 +198,7 @@ func (c *Config) Validate() {
 	c.SpecialRooms.Validate()
 	c.Validation.Validate()
 	c.Modules.Validate()
+	c.Roles.Validate()
 
 	// nothing to do with LootGoblinIncludeRecentRooms
 

internal/hooks/NewRound_InactivePlayers.go

@@ -32,7 +32,8 @@ func InactivePlayers(e events.Event) events.ListenerReturn {
 
 	for _, user := range users.GetAllActiveUsers() {
 
-		if !kickMods && user.Permission == users.PermissionAdmin || user.Permission == users.PermissionMod {
+		// If don't kick mods and they aren't a regular user, skip
+		if !kickMods && user.Role != users.RoleUser {
 			continue
 		}