Changeset 367 for binary-improvements/MapRendering/Web/Handlers

Timestamp:

Aug 11, 2021, 6:22:03 PM (3 years ago)

Author:

alloc

Message:

Web:

• Added SSE (ServerSentEvents) subsystem
• Added log endpoint to SSE. Less heavy weight and more responsive way of watching the server log
• Bunch of refactoring

Location:

binary-improvements/MapRendering/Web/Handlers

Files:

• ApiHandler.cs (modified) (4 diffs)
• ItemIconHandler.cs (modified) (3 diffs)
• PathHandler.cs (modified) (2 diffs)
• SessionHandler.cs (modified) (3 diffs)
• StaticHandler.cs (modified) (2 diffs)

binary-improvements/MapRendering/Web/Handlers/ApiHandler.cs

@@ -4 +4 @@
 using System.Reflection;
 using AllocsFixes.NetConnections.Servers.Web.API;
-using UnityEngine.Profiling;
 
 namespace AllocsFixes.NetConnections.Servers.Web.Handlers {
         public class ApiHandler : PathHandler {
                 private readonly Dictionary<string, WebAPI> apis = new CaseInsensitiveStringDictionary<WebAPI> ();
-                private readonly string staticPart;
 
-                public ApiHandler (string _staticPart, string _moduleName = null) : base (_moduleName) {
-                        staticPart = _staticPart;
+                public ApiHandler (string _moduleName = null) : base (_moduleName) {
 
                         foreach (Type t in Assembly.GetExecutingAssembly ().GetTypes ()) {
@@ -19 +16 @@
                                         if (ctor != null) {
                                                 WebAPI apiInstance = (WebAPI) ctor.Invoke (new object [0]);
-                                                addApi (apiInstance.Name, apiInstance);
+                                                addApi (apiInstance);
                                         }
                                 }
                         }
 
-                        // Add dummy types
-                        Type dummy_t = typeof (Null);
-                        ConstructorInfo dummy_ctor = dummy_t.GetConstructor (new Type [0]);
-                        if (dummy_ctor != null) {
-                                WebAPI dummy_apiInstance = (WebAPI) dummy_ctor.Invoke (new object[0]);
-
-                                // Permissions that don't map to a real API
-                                addApi ("viewallclaims", dummy_apiInstance);
-                                addApi ("viewallplayers", dummy_apiInstance);
-                        }
+                        // Permissions that don't map to a real API
+                        addApi (new Null ("viewallclaims"));
+                        addApi (new Null ("viewallplayers"));
                 }
 
-                private void addApi (string _apiName, WebAPI _api) {
-                        apis.Add (_apiName, _api);
-                        WebPermissions.Instance.AddKnownModule ("webapi." + _apiName, _api.DefaultPermissionLevel ());
+                private void addApi (WebAPI _api) {
+                        apis.Add (_api.Name, _api);
+                        WebPermissions.Instance.AddKnownModule ("webapi." + _api.Name, _api.DefaultPermissionLevel ());
                 }
 
 #if ENABLE_PROFILER
-                private static readonly CustomSampler apiHandlerSampler = CustomSampler.Create ("API_Handler");
+                private static readonly UnityEngine.Profiling.CustomSampler apiHandlerSampler = UnityEngine.Profiling.CustomSampler.Create ("API_Handler");
 #endif
 
                 public override void HandleRequest (HttpListenerRequest _req, HttpListenerResponse _resp, WebConnection _user,
                         int _permissionLevel) {
-                        string apiName = _req.Url.AbsolutePath.Remove (0, staticPart.Length);
+                        string apiName = _req.Url.AbsolutePath.Remove (0, urlBasePath.Length);
 
-                        WebAPI api;
-                        if (!apis.TryGetValue (apiName, out api)) {
-                                Log.Out ("Error in ApiHandler.HandleRequest(): No handler found for API \"" + apiName + "\"");
+                        if (!apis.TryGetValue (apiName, out WebAPI api)) {
+                                Log.Out ($"Error in {nameof(ApiHandler)}.HandleRequest(): No handler found for API \"{apiName}\"");
                                 _resp.StatusCode = (int) HttpStatusCode.NotFound;
                                 return;
                         }
 
-                        if (!AuthorizeForCommand (apiName, _user, _permissionLevel)) {
+                        if (!AuthorizeForApi (apiName, _permissionLevel)) {
                                 _resp.StatusCode = (int) HttpStatusCode.Forbidden;
                                 if (_user != null) {
-                                        //Log.Out ("ApiHandler: user '{0}' not allowed to execute '{1}'", user.SteamID, apiName);
+                                        //Log.Out ($"{nameof(ApiHandler)}: user '{user.SteamID}' not allowed to execute '{apiName}'");
                                 }
 
@@ -74 +63 @@
 #endif
                         } catch (Exception e) {
-                                Log.Error ("Error in ApiHandler.HandleRequest(): Handler {0} threw an exception:", api.Name);
+                                Log.Error ($"Error in {nameof(ApiHandler)}.HandleRequest(): Handler {api.Name} threw an exception:");
                                 Log.Exception (e);
                                 _resp.StatusCode = (int) HttpStatusCode.InternalServerError;
@@ -80 +69 @@
                 }
 
-                private bool AuthorizeForCommand (string _apiName, WebConnection _user, int _permissionLevel) {
+                private bool AuthorizeForApi (string _apiName, int _permissionLevel) {
                         return WebPermissions.Instance.ModuleAllowedWithLevel ("webapi." + _apiName, _permissionLevel);
                 }

binary-improvements/MapRendering/Web/Handlers/ItemIconHandler.cs

@@ -11 +11 @@
                 private readonly bool logMissingFiles;
 
-                private readonly string staticPart;
                 private bool loaded;
 
@@ -18 +17 @@
                 }
 
-                public ItemIconHandler (string _staticPart, bool _logMissingFiles, string _moduleName = null) : base (_moduleName) {
-                        staticPart = _staticPart;
+                public ItemIconHandler (bool _logMissingFiles, string _moduleName = null) : base (_moduleName) {
                         logMissingFiles = _logMissingFiles;
                         Instance = this;
@@ -34 +32 @@
                         }
 
-                        string requestFileName = _req.Url.AbsolutePath.Remove (0, staticPart.Length);
+                        string requestFileName = _req.Url.AbsolutePath.Remove (0, urlBasePath.Length);
                         requestFileName = requestFileName.Remove (requestFileName.LastIndexOf ('.'));
 

binary-improvements/MapRendering/Web/Handlers/PathHandler.cs

@@ -3 +3 @@
 namespace AllocsFixes.NetConnections.Servers.Web.Handlers {
         public abstract class PathHandler {
-                private readonly string moduleName;
+                protected readonly string moduleName;
+                protected string urlBasePath;
+                protected Web parent;
 
                 protected PathHandler (string _moduleName, int _defaultPermissionLevel = 0) {
@@ -24 +26 @@
                         return true;
                 }
+
+                public virtual void Shutdown () {
+                }
+
+                public virtual void SetBasePathAndParent (Web _parent, string _relativePath) {
+                        parent = _parent;
+                        urlBasePath = _relativePath;
+                }
         }
 }

binary-improvements/MapRendering/Web/Handlers/SessionHandler.cs

@@ -7 +7 @@
                 private readonly string footer = "";
                 private readonly string header = "";
-                private readonly Web parent;
-                private readonly string staticPart;
 
-                public SessionHandler (string _staticPart, string _dataFolder, Web _parent, string _moduleName = null) :
-                        base (_moduleName) {
-                        staticPart = _staticPart;
-                        parent = _parent;
-
+                public SessionHandler (string _dataFolder, string _moduleName = null) : base (_moduleName) {
                         if (File.Exists (_dataFolder + "/sessionheader.tmpl")) {
                                 header = File.ReadAllText (_dataFolder + "/sessionheader.tmpl");
@@ -26 +20 @@
                 public override void HandleRequest (HttpListenerRequest _req, HttpListenerResponse _resp, WebConnection _user,
                         int _permissionLevel) {
-                        string subpath = _req.Url.AbsolutePath.Remove (0, staticPart.Length);
+                        string subpath = _req.Url.AbsolutePath.Remove (0, urlBasePath.Length);
 
                         StringBuilder result = new StringBuilder ();
@@ -52 +46 @@
                                         "<h1>Not logged in, <a href=\"/static/index.html\">click to return to main page</a>.</h1>");
                         } else if (subpath.StartsWith ("login")) {
-                                string host = (Web.isSslRedirected (_req) ? "https://" : "http://") + _req.UserHostName;
+                                string host = (Web.IsSslRedirected (_req) ? "https://" : "http://") + _req.UserHostName;
                                 string url = OpenID.GetOpenIdLoginUrl (host, host + "/session/verify");
                                 _resp.Redirect (url);

binary-improvements/MapRendering/Web/Handlers/StaticHandler.cs

@@ -8 +8 @@
                 private readonly string datapath;
                 private readonly bool logMissingFiles;
-                private readonly string staticPart;
 
-                public StaticHandler (string _staticPart, string _filePath, AbstractCache _cache, bool _logMissingFiles,
+                public StaticHandler (string _filePath, AbstractCache _cache, bool _logMissingFiles,
                         string _moduleName = null) : base (_moduleName) {
-                        staticPart = _staticPart;
                         datapath = _filePath + (_filePath [_filePath.Length - 1] == '/' ? "" : "/");
                         cache = _cache;
@@ -20 +18 @@
                 public override void HandleRequest (HttpListenerRequest _req, HttpListenerResponse _resp, WebConnection _user,
                         int _permissionLevel) {
-                        string fn = _req.Url.AbsolutePath.Remove (0, staticPart.Length);
+                        string fn = _req.Url.AbsolutePath.Remove (0, urlBasePath.Length);
 
                         byte[] content = cache.GetFileContent (datapath + fn);