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

Timestamp:

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

Author:

alloc

Message:

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

Location:

binary-improvements2/WebServer/src/WebAPI

Files:

• APIs/Command.cs (modified) (2 diffs)
• APIs/Mods.cs (moved) (moved from binary-improvements2/WebServer/src/WebAPI/APIs/WebMods.cs ) (3 diffs)
• APIs/Player.cs (modified) (1 diff)
• APIs/RegisterUser.cs (modified) (2 diffs)
• APIs/ServerStats.cs (modified) (2 diffs)
• APIs/WebUiUpdates.cs (modified) (2 diffs)
• AbsRestApi.cs (modified) (3 diffs)
• AbsWebAPI.cs (modified) (2 diffs)
• JsonCommons.cs (modified) (1 diff)

binary-improvements2/WebServer/src/WebAPI/APIs/Command.cs

@@ -3 +3 @@
 using JetBrains.Annotations;
 using Utf8Json;
+using Webserver.Permissions;
 
 namespace Webserver.WebAPI.APIs {
@@ -130 +131 @@
                 }
 
-                public override int DefaultPermissionLevel () => 2000;
+                public override int DefaultPermissionLevel () => AdminWebModules.PermissionLevelGuest;
         }
 }

binary-improvements2/WebServer/src/WebAPI/APIs/Mods.cs

@@ -1 +1 @@
 using JetBrains.Annotations;
 using Utf8Json;
+using Webserver.Permissions;
 
 namespace Webserver.WebAPI.APIs {
         [UsedImplicitly]
-        public class WebMods : AbsRestApi {
+        public class Mods : AbsRestApi {
                 private readonly byte[] loadedWebMods;
 
-                public WebMods (Web _parent) {
+                public Mods (Web _parent) {
                         JsonWriter writer = new JsonWriter ();
                         writer.WriteBeginArray ();
@@ -13 +14 @@
                         for (int i = 0; i < _parent.webMods.Count; i++) {
                                 WebMod webMod = _parent.webMods [i];
-                                
+
                                 if (i > 0) {
                                         writer.WriteValueSeparator ();
                                 }
-
+                                
                                 writer.WriteBeginObject ();
 
-                                writer.WriteString ("name");
-                                writer.WriteNameSeparator ();
-                                writer.WriteString (webMod.ParentMod.Name);
+                                writeModJson (ref writer, webMod);
 
-                                string webModReactBundle = webMod.ReactBundle;
-                                if (webModReactBundle != null) {
+                                if (webMod.ReactBundle != null || webMod.CssPath != null) {
                                         writer.WriteValueSeparator ();
-                                        writer.WriteString ("bundle");
-                                        writer.WriteNameSeparator ();
-                                        writer.WriteString (webModReactBundle);
-                                }
 
-                                string webModCssFile = webMod.CssPath;
-                                if (webModCssFile != null) {
-                                        writer.WriteValueSeparator ();
-                                        writer.WriteString ("css");
-                                        writer.WriteNameSeparator ();
-                                        writer.WriteString (webModCssFile);
+                                        writer.WritePropertyName ("web");
+                                        writer.WriteBeginObject ();
+                                        
+                                        string webModReactBundle = webMod.ReactBundle;
+                                        if (webModReactBundle != null) {
+                                                writer.WritePropertyName ("bundle");
+                                                writer.WriteString (webModReactBundle);
+                                        }
+
+                                        string webModCssFile = webMod.CssPath;
+                                        if (webModCssFile != null) {
+                                                if (webModReactBundle != null) {
+                                                        writer.WriteValueSeparator ();
+                                                }
+
+                                                writer.WritePropertyName ("css");
+                                                writer.WriteString (webModCssFile);
+                                        }
+                                        
+                                        writer.WriteEndObject ();
                                 }
 
@@ -54 +62 @@
                 }
 
-                public override int DefaultPermissionLevel () => 2000;
+                public override int DefaultPermissionLevel () => AdminWebModules.PermissionLevelGuest;
+
+                private void writeModJson (ref JsonWriter _writer, WebMod _webMod) {
+                        _writer.WritePropertyName ("name");
+                        _writer.WriteString (_webMod.ParentMod.Name);
+                        
+                        _writer.WriteValueSeparator ();
+                        _writer.WritePropertyName ("displayName");
+                        JsonCommons.WriteStringOrNull (ref _writer, _webMod.ParentMod.DisplayName);
+
+                        _writer.WriteValueSeparator ();
+                        _writer.WritePropertyName ("description");
+                        JsonCommons.WriteStringOrNull (ref _writer, _webMod.ParentMod.Description);
+
+                        _writer.WriteValueSeparator ();
+                        _writer.WritePropertyName ("author");
+                        JsonCommons.WriteStringOrNull (ref _writer, _webMod.ParentMod.Author);
+
+                        _writer.WriteValueSeparator ();
+                        _writer.WritePropertyName ("version");
+                        JsonCommons.WriteStringOrNull (ref _writer, _webMod.ParentMod.VersionString);
+
+                        _writer.WriteValueSeparator ();
+                        _writer.WritePropertyName ("website");
+                        JsonCommons.WriteStringOrNull (ref _writer, _webMod.ParentMod.Website);
+                }
         }
 }

binary-improvements2/WebServer/src/WebAPI/APIs/Player.cs

@@ -256 +256 @@
                 }
 
-                public override int DefaultPermissionLevel () => 2000;
+                public override int DefaultPermissionLevel () => AdminWebModules.PermissionLevelGuest;
         }
 }

binary-improvements2/WebServer/src/WebAPI/APIs/RegisterUser.cs

@@ -80 +80 @@
                         }
                         
-                        // TODO: Check if username is already used!
+                        // TODO: Check if username is already used by someone else!
+                        // TODO: Remove existing username if player already had one!
 
                         AdminWebUsers.Instance.AddUser (username, password, regData.PlatformUserId, regData.CrossPlatformUserId);
@@ -95 +96 @@
                 }
 
-                public override int DefaultPermissionLevel () => 2000;
+                public override int DefaultPermissionLevel () => AdminWebModules.PermissionLevelGuest;
         }
 }

binary-improvements2/WebServer/src/WebAPI/APIs/ServerStats.cs

@@ -2 +2 @@
 using Utf8Json;
 using Webserver.LiveData;
+using Webserver.Permissions;
 
 namespace Webserver.WebAPI.APIs {
@@ -47 +48 @@
                 }
 
-                public override int DefaultPermissionLevel () => 2000;
+                public override int DefaultPermissionLevel () => AdminWebModules.PermissionLevelGuest;
         }
 }

binary-improvements2/WebServer/src/WebAPI/APIs/WebUiUpdates.cs

@@ -2 +2 @@
 using Utf8Json;
 using Webserver.LiveData;
+using Webserver.Permissions;
 
 namespace Webserver.WebAPI.APIs {
@@ -57 +58 @@
                 }
 
-                public override int DefaultPermissionLevel () => 2000;
+                public override int DefaultPermissionLevel () => AdminWebModules.PermissionLevelGuest;
         }
 }

binary-improvements2/WebServer/src/WebAPI/AbsRestApi.cs

@@ -10 +10 @@
                 private static readonly UnityEngine.Profiling.CustomSampler jsonDeserializeSampler = UnityEngine.Profiling.CustomSampler.Create ("JSON_Deserialize");
 
-                protected readonly string[] CachedPerMethodModuleNames = new string[(int)ERequestMethod.Count];
-
                 protected AbsRestApi (string _name = null) : this(null, _name) {
                 }
@@ -19 +17 @@
 
                 protected override void RegisterPermissions () {
-                        base.RegisterPermissions ();
-                        
-                        for (int i = 0; i < (int)ERequestMethod.Count; i++) {
-                                ERequestMethod method = (ERequestMethod)i;
-
-                                if (method is not (ERequestMethod.GET or ERequestMethod.PUT or ERequestMethod.POST or ERequestMethod.DELETE)) {
-                                        continue;
-                                }
-
-                                CachedPerMethodModuleNames [i] = $"webapi.{Name}:{method.ToStringCached ()}";
-                                AdminWebModules.Instance.AddKnownModule (CachedPerMethodModuleNames [i], DefaultMethodPermissionLevel (method));
-                        }
+                        AdminWebModules.Instance.AddKnownModule (new AdminWebModules.WebModule (CachedApiModuleName, DefaultPermissionLevel (),
+                                DefaultMethodPermissionLevels (), true));
                 }
 
@@ -136 +124 @@
 
                 public override bool Authorized (RequestContext _context) {
-                        return ActiveMethodPermissionLevel (_context.Method) >= _context.PermissionLevel;
+                        AdminWebModules.WebModule module = AdminWebModules.Instance.GetModule (CachedApiModuleName);
+
+                        if (module.LevelPerMethod != null) {
+                                int perMethodLevel = module.LevelPerMethod [(int)_context.Method];
+                                if (perMethodLevel == AdminWebModules.MethodLevelNotSupported) {
+                                        return false;
+                                }
+
+                                if (perMethodLevel != AdminWebModules.MethodLevelInheritGlobal) {
+                                        return perMethodLevel >= _context.PermissionLevel;
+                                }
+                        }
+
+                        return module.LevelGlobal >= _context.PermissionLevel;
                 }
 
                 /// <summary>
-                /// Define default permission levels per HTTP method
+                /// Define default permission levels per HTTP method as an array of levels. See <see cref="ERequestMethod"/> for the order of entries.
                 /// </summary>
-                /// <param name="_method">HTTP method to return the default value for</param>
-                /// <returns>Default permission level for the given HTTP method. A value of int.MinValue means no per-method default, use per-API default</returns>
-                public virtual int DefaultMethodPermissionLevel (ERequestMethod _method) => int.MinValue;
-
-                public virtual int ActiveMethodPermissionLevel (ERequestMethod _method) {
-                        string methodApiModuleName = CachedPerMethodModuleNames [(int)_method];
-
-                        if (methodApiModuleName == null) {
-                                return 0;
-                        }
-
-                        AdminWebModules.WebModule? overrideModule = AdminWebModules.Instance.GetModule (methodApiModuleName, false);
-                        if (overrideModule.HasValue) {
-                                return overrideModule.Value.PermissionLevel;
-                        }
-
-                        overrideModule = AdminWebModules.Instance.GetModule (CachedApiModuleName, false);
-                        if (overrideModule.HasValue) {
-                                return overrideModule.Value.PermissionLevel;
-                        }
-
-                        int defaultMethodPermissionLevel = DefaultMethodPermissionLevel (_method);
-                        // ReSharper disable once ConvertIfStatementToReturnStatement
-                        if (defaultMethodPermissionLevel != int.MinValue) {
-                                return defaultMethodPermissionLevel;
-                        }
-
-                        return DefaultPermissionLevel ();
-                }
+                /// <returns>Default permission levels for supported methods. See <see cref="AdminWebModules.MethodLevelNotSupported"/> and <see cref="AdminWebModules.MethodLevelInheritGlobal"/>.</returns>
+                public virtual int[] DefaultMethodPermissionLevels () => new[] {
+                        AdminWebModules.MethodLevelNotSupported,
+                        AdminWebModules.MethodLevelInheritGlobal,
+                        AdminWebModules.MethodLevelInheritGlobal,
+                        AdminWebModules.MethodLevelInheritGlobal,
+                        AdminWebModules.MethodLevelInheritGlobal
+                };
 
 #region Helpers

binary-improvements2/WebServer/src/WebAPI/AbsWebAPI.cs

@@ -19 +19 @@
 
                 protected virtual void RegisterPermissions () {
-                        AdminWebModules.Instance.AddKnownModule ($"webapi.{Name}", DefaultPermissionLevel ());
+                        AdminWebModules.Instance.AddKnownModule (new AdminWebModules.WebModule(CachedApiModuleName, DefaultPermissionLevel (), true));
                 }
 
@@ -25 +25 @@
 
                 public virtual bool Authorized (RequestContext _context) {
-                        return AdminWebModules.Instance.ModuleAllowedWithLevel (CachedApiModuleName, _context.PermissionLevel);
+                        return AdminWebModules.Instance.GetModule (CachedApiModuleName).LevelGlobal >= _context.PermissionLevel;
                 }
 

binary-improvements2/WebServer/src/WebAPI/JsonCommons.cs

@@ -60 +60 @@
                         _writer.WriteString (_dateTime.ToString ("o"));
                 }
+
+                public static void WriteStringOrNull (ref JsonWriter _writer, string _string) {
+                        if (_string == null) {
+                                _writer.WriteNull ();
+                        } else {
+                                _writer.WriteString (_string);
+                        }
+                }
         }
 }