Remove unused config, correct a few things, add docs

Author: riperiperi

Documentation/Server Configuration.md

@@ -34,7 +34,7 @@ public Api()
         public void Init(NameValueCollection appSettings)
         {
             Config = new ApiConfig();
-            Config.Maintainance = bool.Parse(appSettings["maintainance"]);
+            Config.Maintenance = bool.Parse(appSettings["maintenance"]);
             Config.AuthTicketDuration = int.Parse(appSettings["authTicketDuration"]);
             Config.Regkey = appSettings["regkey"];
             Config.Secret = appSettings["secret"];

Documentation/media/maintenance.png

@@ -17,7 +17,7 @@ public class ApiConfig
         /// <summary>
         /// If true, only authentication from moderators and admins will be accepted
         /// </summary>
-        public bool Maintainance { get; set; }
+        public bool Maintenance { get; set; }
 
         public string Secret { get; set; }
 

TSOClient/FSO.Server.Api.Core/Api.cs

@@ -15,7 +15,7 @@ public class AuthLoginController : ControllerBase
         private static Func<IActionResult> ERROR_020 = printError("INV-020", "Please enter your member name and password.");
         private static Func<IActionResult> ERROR_110 = printError("INV-110", "The member name or password you have entered is incorrect. Please try again.");
         private static Func<IActionResult> ERROR_302 = printError("INV-302", "The game has experienced an internal error. Please try again.");
-        private static Func<IActionResult> ERROR_160 = printError("INV-160", "The server is currently down for maintainance. Please try again later.");
+        private static Func<IActionResult> ERROR_160 = printError("INV-160", "The server is currently down for maintenance. Please try again later.");
         private static Func<IActionResult> ERROR_150 = printError("INV-150", "We're sorry, but your account has been suspended or cancelled.");
         private static string LOCK_MESSAGE = "Your account has been locked due to too many incorrect login attempts. " +
             "If you cannot remember your password, it can be reset at https://beta.freeso.org/forgot. Locked for: ";
@@ -58,7 +58,7 @@ public IActionResult Get(string username, string password, string version, strin
                     return ERROR_150();
                 }
 
-                if (api.Config.Maintainance && !(user.is_admin || user.is_moderator))
+                if (api.Config.Maintenance && !(user.is_admin || user.is_moderator))
                 {
                     return ERROR_160();
                 }

TSOClient/FSO.Server.Api.Core/ApiConfig.cs

@@ -16,7 +16,7 @@ public class ShardSelectorController : ControllerBase
         private static Func<IActionResult> ERROR_AVATAR_NOT_FOUND = ApiResponse.XmlFuture(HttpStatusCode.OK, new XMLErrorMessage("504", "Avatar not found"));
         private static Func<IActionResult> ERROR_AVATAR_NOT_YOURS = ApiResponse.XmlFuture(HttpStatusCode.OK, new XMLErrorMessage("505", "You do not own this avatar!"));
         private static Func<IActionResult> ERROR_BANNED = ApiResponse.XmlFuture(HttpStatusCode.OK, new XMLErrorMessage("506", "Your account has been banned."));
-        private static Func<IActionResult> ERROR_MAINTAINANCE = ApiResponse.XmlFuture(HttpStatusCode.OK, new XMLErrorMessage("507", "The server is currently undergoing maintainance. Please try again later."));
+        private static Func<IActionResult> ERROR_MAINTENANCE = ApiResponse.XmlFuture(HttpStatusCode.OK, new XMLErrorMessage("507", "The server is currently undergoing maintainance. Please try again later."));
 
         public IActionResult Get(string shardName, string avatarId)
         {
@@ -58,9 +58,9 @@ public IActionResult Get(string shardName, string avatarId)
                         return ERROR_BANNED();
                     }
 
-                    if (api.Config.Maintainance && !(dbuser.is_admin || dbuser.is_moderator))
+                    if (api.Config.Maintenance && !(dbuser.is_admin || dbuser.is_moderator))
                     {
-                        return ERROR_MAINTAINANCE();
+                        return ERROR_MAINTENANCE();
                     }
 
                     /** Make an auth ticket **/

TSOClient/FSO.Server.Api.Core/Controllers/AuthLoginController.cs

@@ -24,7 +24,7 @@ public static IAPILifetime StartWebApi(UserApi api, string url)
             var config = api.Config;
             var userApiConfig = config.Services.UserApi;
             var settings = new NameValueCollection();
-            settings.Add("maintainance", userApiConfig.Maintainance.ToString());
+            settings.Add("maintenance", userApiConfig.Maintenance.ToString());
             settings.Add("authTicketDuration", userApiConfig.AuthTicketDuration.ToString());
             settings.Add("regkey", userApiConfig.Regkey);
             settings.Add("secret", config.Secret);

TSOClient/FSO.Server.Api.Core/Controllers/ShardSelectorController.cs

@@ -14,11 +14,6 @@ public class ApiServerConfiguration
         /// Hostname bindings
         /// </summary>
         public List<string> Bindings { get; set; }
-
-        /// <summary>
-        /// Indicates which routes to register on the api
-        /// </summary>
-        public List<ApiServerControllers> Controllers { get; set; }
 
         /// <summary>
         /// How long an auth ticket is valid for
@@ -33,15 +28,14 @@ public class ApiServerConfiguration
         /// <summary>
         /// If true, only authentication from moderators and admins will be accepted
         /// </summary>
-        public bool Maintainance { get; set; }
+        public bool Maintenance { get; set; }
         public string UpdateUrl { get; set; }
         public string CDNUrl { get; set; }
 
         public string SmtpHost { get; set; }
         public int SmtpPort { get; set; }
         public string SmtpPassword { get; set; }
         public string SmtpUser { get; set; }
-        public bool ForceEmailConfirmation { get; set; }
         public bool UseProxy { get; set; } = true;
 
         public AWSConfig AwsConfig { get; set; }

TSOClient/FSO.Server.Core/Program.cs

@@ -88,12 +88,8 @@
       "bindings": [
         "http://+:9000/"
       ],
-      "controllers": [
-        "auth",
-        "citySelector"
-      ],
       // "cdnUrl": "http://0.0.0.0:9000",
-      "maintainance": false
+      "maintenance": false
     },
     "cities": [
       {
@@ -109,12 +105,6 @@
           "min_nominations": 2,
           "election_week_align": true,
           "election_move_penalty": 14
-        },
-        "maintenance": {
-          "cron": "0 4 * * *",
-          "timeout": 3600,
-          "visits_retention_period": 7,
-          "top100_average_period": 4
         }
       }
     ],

TSOClient/FSO.Server/Servers/UserApi/ApiServerConfiguration.cs

@@ -18,7 +18,7 @@ public class UpgradeIff
         /// <summary>
         /// A list of tuning groups for this file. Groups allow the developer to group together tuning values with the same target effect, but
         /// used by different objects, eg. "Cheap Max Fun", "Expensive Max Fun". With these groups set up, tuning values can be easily copied
-        /// between objects (as they point to the groups instead of object specific entries) for easier maintainance and rebalancing.
+        /// between objects (as they point to the groups instead of object specific entries) for easier maintenance and rebalancing.
         /// </summary>
         public List<UpgradeGroup> Groups = new List<UpgradeGroup>();