Changeset 426 for binary-improvements2/WebServer/src/Commands

Timestamp:

Apr 24, 2023, 2:40:34 PM (21 months ago)

Author:

alloc

Message:

*Updated web permissions system
*Fixed webpermissions command
*Moved API "webmods" to "mods", also lists non-webmod mods

File:

• binary-improvements2/WebServer/src/Commands/WebPermissionsCmd.cs (modified) (4 diffs)

binary-improvements2/WebServer/src/Commands/WebPermissionsCmd.cs

@@ -15 +15 @@
 
                 protected override string getHelp () {
-                        return "Set/get permission levels required to access a given web functionality. Default\n" +
-                               "level required for functions that are not explicitly specified is 0.\n" +
-                               "Usage:\n" +
-                               "   webpermission add <webfunction> <level>\n" +
-                               "   webpermission remove <webfunction>\n" +
-                               "   webpermission list [includedefaults]";
+                        return @"
+                                |Set/get permission levels required to access a given web functionality. Default
+                            |level required for functions that are not explicitly specified is 0.
+                            |Usage:
+                                |   1. webpermission add <webfunction> <method> <level>
+                            |   2. webpermission remove <webfunction>
+                            |   3. webpermission list [includedefaults]
+                                |1. Add a new override (or replace the existing one) for the given function. Method must be a HTTP method (like 'GET', 'POST')
+                                                supported by the function or the keyword 'global' for a per-API permission level. Use the permission level keyword
+                                                'inherit' to use the per-API permission level for the specified method instead of a custom one for just the single method.
+                                |2. Removes any custom overrides for the specified function.
+                                |3. List all permissions. Pass in 'true' for the includedefaults argument to also show functions that do not have a custom override defined.
+                                ".Unindent ();
                 }
 
@@ -40 +47 @@
 
                 private void ExecuteAdd (List<string> _params) {
-                        if (_params.Count != 3) {
-                                SdtdConsole.Instance.Output ($"Wrong number of arguments, expected 3, found {_params.Count}.");
+                        if (_params.Count != 4) {
+                                SdtdConsole.Instance.Output ($"Wrong number of arguments, expected 4, found {_params.Count}.");
                                 return;
                         }
 
-                        if (!AdminWebModules.Instance.IsKnownModule (_params [1])) {
-                                SdtdConsole.Instance.Output ($"\"{_params [1]}\" is not a valid web function.");
+                        string moduleString = _params [1];
+                        string methodString = _params [2];
+                        string permissionLevelString = _params [3];
+
+                        ERequestMethod method = ERequestMethod.Count;
+                        bool isGlobal = false;
+                        bool isInherit = false;
+                        int level;
+                        
+                        if (!AdminWebModules.Instance.IsKnownModule (moduleString)) {
+                                SdtdConsole.Instance.Output ($"\"{moduleString}\" is not a valid web function.");
                                 return;
                         }
 
-                        if (!int.TryParse (_params [2], out int level)) {
-                                SdtdConsole.Instance.Output ($"\"{_params [2]}\" is not a valid integer.");
-                                return;
+                        AdminWebModules.WebModule module = AdminWebModules.Instance.GetModule (moduleString);
+
+                        if (methodString.EqualsCaseInsensitive ("global")) {
+                                isGlobal = true;
+                        } else {
+                                if (!EnumUtils.TryParse (methodString, out method, true)) {
+                                        SdtdConsole.Instance.Output ($"\"{methodString}\" is neither a valid HTTP method nor the 'global' keyword.");
+                                        return;
+                                }
+
+                                if (module.LevelPerMethod == null || module.LevelPerMethod [(int)method] == AdminWebModules.MethodLevelNotSupported) {
+                                        SdtdConsole.Instance.Output ($"\"{methodString}\" is not a method supported by the \"{moduleString}\" function.");
+                                        return;
+                                }
                         }
 
-                        AdminWebModules.Instance.AddModule (_params [1], level);
-                        SdtdConsole.Instance.Output ($"{_params [1]} added with permission level of {level}.");
+                        if (permissionLevelString.EqualsCaseInsensitive ("inherit")) {
+                                if (isGlobal) {
+                                        SdtdConsole.Instance.Output ($"Permission level can not use the 'inherit' keyword with the 'global' method keyword.");
+                                        return;
+                                }
+                                
+                                isInherit = true;
+                                level = AdminWebModules.MethodLevelInheritGlobal;
+                        } else {
+                                if (!int.TryParse (permissionLevelString, out level)) {
+                                        SdtdConsole.Instance.Output ($"\"{permissionLevelString}\" is neither a valid integer nor the 'inherit' keyword.");
+                                        return;
+                                }
+                        }
+
+                        module.IsDefault = false;
+                        if (isGlobal) {
+                                module.LevelGlobal = level;
+                        } else {
+                                module.LevelPerMethod [(int)method] = level;
+                        }
+                        
+                        AdminWebModules.Instance.AddModule (module);
+                        
+                        SdtdConsole.Instance.Output (
+                                $"{moduleString}, method {methodString} added {(isInherit ? ", inheriting the APIs global permission level" : "with permission level " + level)}.");
                 }
 
@@ -78 +129 @@
                         
                         SdtdConsole.Instance.Output ("Defined web function permissions:");
-                        SdtdConsole.Instance.Output ("  Level: Web function");
                         
                         List<AdminWebModules.WebModule> wmps = AdminWebModules.Instance.GetModules ();
-                        for (int i = 0; i < wmps.Count; i++) {
-                                AdminWebModules.WebModule wmp = wmps [i];
+                        for (int iModule = 0; iModule < wmps.Count; iModule++) {
+                                AdminWebModules.WebModule wmp = wmps [iModule];
 
                                 if (!includeDefaults && wmp.IsDefault) {
@@ -88 +138 @@
                                 }
 
-                                if (wmp.IsDefault) {
-                                        if (wmp.PermissionLevel == int.MinValue) {
-                                                SdtdConsole.Instance.Output ($"    -  : {wmp.Name} (default permission)");
-                                        } else {
-                                                SdtdConsole.Instance.Output ($"  {wmp.PermissionLevel,5}: {wmp.Name} (default permission)");
+                                SdtdConsole.Instance.Output ($"  {wmp.Name,-25}: {wmp.LevelGlobal,4}{(wmp.IsDefault ? " (default permissions)" : "")}");
+                                if (wmp.LevelPerMethod != null) {
+                                        for (int iMethod = 0; iMethod < wmp.LevelPerMethod.Length; iMethod++) {
+                                                int methodLevel = wmp.LevelPerMethod [iMethod];
+                                                ERequestMethod method = (ERequestMethod)iMethod;
+                                                
+                                                if (methodLevel == AdminWebModules.MethodLevelNotSupported) {
+                                                        continue;
+                                                }
+                                                
+                                                if (methodLevel == AdminWebModules.MethodLevelInheritGlobal) {
+                                                        SdtdConsole.Instance.Output ($"  {method.ToStringCached (),25}: {wmp.LevelGlobal,4} (Using API level)");
+                                                } else {
+                                                        SdtdConsole.Instance.Output ($"  {method.ToStringCached (),25}: {methodLevel,4}");
+                                                }
                                         }
-                                } else {
-                                        SdtdConsole.Instance.Output ($"  {wmp.PermissionLevel,5}: {wmp.Name}");
                                 }
                         }