Changeset 435

Timestamp:

May 18, 2023, 12:20:16 PM (18 months ago)

Author:

alloc

Message:

Added WebModules API POST support

Location:

binary-improvements2

Files:

• CommandExtensions/ModInfo.xml (modified) (1 diff)
• MapRendering/ModInfo.xml (modified) (1 diff)
• MarkersMod/ModInfo.xml (modified) (1 diff)
• WebServer/ModInfo.xml (modified) (1 diff)
• WebServer/src/Commands/WebPermissionsCmd.cs (modified) (1 diff)
• WebServer/src/Permissions/AdminWebModules.cs (modified) (5 diffs)
• WebServer/src/WebAPI/APIs/Permissions/WebModules.cs (modified) (7 diffs)
• bin/Mods/TFP_CommandExtensions/CommandExtensions.dll (modified) ( previous)
• bin/Mods/TFP_CommandExtensions/CommandExtensions.pdb (modified) ( previous)
• bin/Mods/TFP_CommandExtensions/ModInfo.xml (modified) (1 diff)
• bin/Mods/TFP_MapRendering/MapRendering.dll (modified) ( previous)
• bin/Mods/TFP_MapRendering/MapRendering.pdb (modified) ( previous)
• bin/Mods/TFP_MapRendering/ModInfo.xml (modified) (1 diff)
• bin/Mods/TFP_WebServer/ModInfo.xml (modified) (1 diff)
• bin/Mods/TFP_WebServer/SpaceWizards.HttpListener.dll (modified) ( previous)
• bin/Mods/TFP_WebServer/SpaceWizards.HttpListener.pdb (modified) ( previous)
• bin/Mods/TFP_WebServer/WebServer.dll (modified) ( previous)
• bin/Mods/TFP_WebServer/WebServer.pdb (modified) ( previous)
• bin/Mods/Xample_MarkersMod/MarkersMod.dll (modified) ( previous)
• bin/Mods/Xample_MarkersMod/MarkersMod.pdb (modified) ( previous)
• bin/Mods/Xample_MarkersMod/ModInfo.xml (modified) (1 diff)

binary-improvements2/CommandExtensions/ModInfo.xml

@@ -5 +5 @@
         <Description value="Additional commands for server operation" />
         <Author value="The Fun Pimps LLC" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

binary-improvements2/MapRendering/ModInfo.xml

@@ -5 +5 @@
         <Description value="Render the game map to image map tiles as it is uncovered" />
         <Author value="The Fun Pimps LLC" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

binary-improvements2/MarkersMod/ModInfo.xml

@@ -5 +5 @@
         <Description value="Allows placing custom markers on the web map" />
         <Author value="Catalysm and Alloc" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

binary-improvements2/WebServer/ModInfo.xml

@@ -5 +5 @@
         <Description value="Integrated Webserver for the Web Dashboard and server APIs" />
         <Author value="The Fun Pimps LLC" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

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

@@ -82 +82 @@
                         }
 
-                        if (permissionLevelString.EqualsCaseInsensitive ("inherit")) {
+                        if (permissionLevelString.EqualsCaseInsensitive (AdminWebModules.MethodLevelInheritKeyword)) {
                                 if (isGlobal) {
                                         SdtdConsole.Instance.Output ($"Permission level can not use the 'inherit' keyword with the 'global' method keyword.");

binary-improvements2/WebServer/src/Permissions/AdminWebModules.cs

@@ -81 +81 @@
                 
                 public struct WebModule {
-                        private const string methodLevelInheritKeyword = "inherit";
-
                         public string Name;
                         public int LevelGlobal;
@@ -135 +133 @@
                                         permissionElement.AddXmlElement ("method")
                                                 .SetAttrib ("name", method.ToStringCached ())
-                                                .SetAttrib ("permission_level", level == MethodLevelInheritGlobal ? methodLevelInheritKeyword : level.ToString ());
+                                                .SetAttrib ("permission_level", level == MethodLevelInheritGlobal ? MethodLevelInheritKeyword : level.ToString ());
                                 }
                         }
@@ -195 +193 @@
 
                                         int methodPermissionLevel;
-                                        if (permissionLevelString.EqualsCaseInsensitive (methodLevelInheritKeyword)) {
+                                        if (permissionLevelString.EqualsCaseInsensitive (MethodLevelInheritKeyword)) {
                                                 methodPermissionLevel = MethodLevelInheritGlobal;
                                         } else if (!int.TryParse (permissionLevelString, out methodPermissionLevel)) {
@@ -230 +228 @@
                 /// </summary>
                 public const int MethodLevelInheritGlobal = int.MinValue;
-                
+
+                /// <summary>
+                /// Keyword used to signal inherit level on user facing levels like admins.xml or WebAPIs
+                /// </summary>
+                public const string MethodLevelInheritKeyword = "inherit";
+
                 /// <summary>
                 /// Method not supported
@@ -287 +290 @@
                 
 #endregion
+
         }
 }

binary-improvements2/WebServer/src/WebAPI/APIs/Permissions/WebModules.cs

@@ +1 @@
+using System;
 using System.Collections.Generic;
 using System.Net;
@@ -67 +68 @@
                         _writer.WriteInt32 (_module.LevelGlobal);
                         _writer.WriteRaw (jsonKeyPermissionLevelPerMethod);
-                        
+
                         _writer.WriteBeginObject ();
 
@@ -74 +75 @@
                                 for (int iMethod = 0; iMethod < _module.LevelPerMethod.Length; iMethod++) {
                                         int methodLevel = _module.LevelPerMethod [iMethod];
-                                                
+
                                         if (methodLevel == AdminWebModules.MethodLevelNotSupported) {
                                                 continue;
@@ -84 +85 @@
 
                                         first = false;
-                                                
+
                                         _writer.WriteRaw (jsonMethodNameKeys [iMethod]);
                                         if (methodLevel == AdminWebModules.MethodLevelInheritGlobal) {
-                                                _writer.WriteString ("inherit");
+                                                _writer.WriteString (AdminWebModules.MethodLevelInheritKeyword);
                                         } else {
                                                 _writer.WriteInt32 (methodLevel);
@@ -95 +96 @@
 
                         _writer.WriteEndObject ();
-                        
+
                         _writer.WriteRaw (jsonKeyIsDefault);
                         _writer.WriteBoolean (_module.IsDefault);
-                        
+
                         _writer.WriteEndObject ();
                 }
@@ -105 +106 @@
                         string id = _context.RequestPath;
 
-                        // TODO
-                        
                         if (string.IsNullOrEmpty (id)) {
                                 SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "NO_MODULE");
@@ -112 +111 @@
                         }
 
-                        if (!JsonCommons.TryGetJsonField (_jsonInput, propertyPermissionLevelGlobal, out int permissionLevel)) {
-                                SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "NO_OR_INVALID_PERMISSION_LEVEL");
+                        if (!AdminWebModules.Instance.IsKnownModule (id)) {
+                                SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_MODULE");
                                 return;
                         }
 
-                        // ModulesInstance.AddModule (id, permissionLevel);
+                        AdminWebModules.WebModule module = AdminWebModules.Instance.GetModule (id);
+
+                        if (_jsonInput.ContainsKey (propertyPermissionLevelGlobal)) {
+                                if (!JsonCommons.TryGetJsonField (_jsonInput, propertyPermissionLevelGlobal, out int permissionLevelGlobal)) {
+                                        SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_PERMISSION_LEVEL_GLOBAL");
+                                        return;
+                                }
+
+                                module.LevelGlobal = permissionLevelGlobal;
+                        }
+
+                        if (_jsonInput.TryGetValue (propertyPermissionLevelPerMethod, out object perLevelField)) {
+                                if (perLevelField is not IDictionary<string, object> perLevelObj) {
+                                        SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_PERMISSION_LEVEL_PER_METHOD_PROPERTY");
+                                        return;
+                                }
+
+                                foreach ((string property, object valueObj) in perLevelObj) {
+                                        if (!EnumUtils.TryParse (property, out ERequestMethod method, true)) {
+                                                SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_METHOD_NAME");
+                                                return;
+                                        }
+
+                                        if (module.LevelPerMethod == null || module.LevelPerMethod [(int)method] == AdminWebModules.MethodLevelNotSupported) {
+                                                SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "UNSUPPORTED_METHOD");
+                                                return;
+                                        }
+
+                                        int permissionLevel;
+
+                                        if (valueObj is string valueString) {
+                                                if (!valueString.EqualsCaseInsensitive (AdminWebModules.MethodLevelInheritKeyword)) {
+                                                        SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_PERMISSION_STRING");
+                                                        return;
+                                                }                                               
+
+                                                permissionLevel = AdminWebModules.MethodLevelInheritGlobal;
+                                        } else if (valueObj is double valueDbl) {
+                                                try {
+                                                        permissionLevel = (int)valueDbl;
+                                                } catch (Exception) {
+                                                        SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_PERMISSION_VALUE");
+                                                        return;
+                                                }
+                                        } else {
+                                                SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_PERMISSION_VALUE_TYPE");
+                                                return;
+                                        }
+
+                                        module.LevelPerMethod [(int)method] = permissionLevel;
+                                }
+                        }
+
+                        module.IsDefault = false;
+                        ModulesInstance.AddModule (module);
 
                         SendEmptyResponse (_context, HttpStatusCode.Created);

binary-improvements2/bin/Mods/TFP_CommandExtensions/ModInfo.xml

@@ -5 +5 @@
         <Description value="Additional commands for server operation" />
         <Author value="The Fun Pimps LLC" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

binary-improvements2/bin/Mods/TFP_MapRendering/ModInfo.xml

@@ -5 +5 @@
         <Description value="Render the game map to image map tiles as it is uncovered" />
         <Author value="The Fun Pimps LLC" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

binary-improvements2/bin/Mods/TFP_WebServer/ModInfo.xml

@@ -5 +5 @@
         <Description value="Integrated Webserver for the Web Dashboard and server APIs" />
         <Author value="The Fun Pimps LLC" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>

binary-improvements2/bin/Mods/Xample_MarkersMod/ModInfo.xml

@@ -5 +5 @@
         <Description value="Allows placing custom markers on the web map" />
         <Author value="Catalysm and Alloc" />
-        <Version value="21.0.288.0" />
+        <Version value="21.0.289.0" />
         <Website value="" />
 </xml>