chore: add more annotations to routes and sort some files (#2467)

* refactor chat controller

* refactor demo controller

* add produce response types to the game object routes

* add produce response types to the guild controller

* add produce response types to the info controller

* add produce response types to the logs controller

* add produce response types and refactor player controller

* refactor user controller

* add produce response types to the server variables controller

* re-sorting some files to a new folder structure and making working

* fix: valid player not found on player route

* move lookupkey, sort and sortdirection to the right namespace

* create safe fetch on user

* create safe fetch on player

* rename files to be more descriptive

* fix: build broken

* converting into a record struct

* merging user/player tryfetch

* fix broken logic

* check if password is hashed on register by api

* better password checking

* cache password on user register

* cache password on validate password too

Author: WeylonSantana

Intersect (Core)/Security/PasswordUtils.cs

@@ -9,4 +9,7 @@ public static string ComputePasswordHash(string password)
     {
         return BitConverter.ToString(SHA256.HashData(Encoding.UTF8.GetBytes(password ?? string.Empty))).Replace("-", string.Empty);
     }
+
+    public static bool IsValidClientPasswordHash(string? hashToValidate) =>
+            hashToValidate is { Length: 64 } && hashToValidate.All(char.IsAsciiHexDigit);
 }

Intersect.Server.Core/Collections/Indexing/LookupKey.cs

@@ -1,9 +1,9 @@
-using System.ComponentModel;
+using System.ComponentModel;
 using System.Globalization;
 using Intersect.Server.Localization;
 using Intersect.Utilities;
 
-namespace Intersect.Server.Web.RestApi.Payloads;
+namespace Intersect.Server.Collections.Indexing;
 
 // TODO: Figure out how to get LookupKey to show up in swagger.json components/schemas despite being a "string", one or more of the following commented out attributes may help
 // [SwaggerSubType(typeof(Guid))]
@@ -14,15 +14,15 @@ namespace Intersect.Server.Web.RestApi.Payloads;
 public partial struct LookupKey
 {
 
-    public bool HasName => !string.IsNullOrWhiteSpace(Name);
+    public readonly bool HasName => !string.IsNullOrWhiteSpace(Name);
 
-    public bool HasId => Guid.Empty != Id;
+    public readonly bool HasId => Guid.Empty != Id;
 
-    public bool IsNameInvalid => !HasId && Name != null;
+    public readonly bool IsNameInvalid => !HasId && Name != null;
 
-    public bool IsIdInvalid => !HasId && Name == null;
+    public readonly bool IsIdInvalid => !HasId && Name == null;
 
-    public bool IsInvalid => !HasId && !HasName;
+    public readonly bool IsInvalid => !HasId && !HasName;
 
     public Guid Id { get; private set; }
 

Intersect.Server.Core/Collections/Sorting/Sort.cs

@@ -1,9 +1,7 @@
-namespace Intersect.Server.Web.RestApi.Payloads;
-
+namespace Intersect.Server.Collections.Sorting;
 
 public partial struct Sort
 {
-
     public string[] By { get; set; }
 
     public SortDirection Direction { get; set; }
@@ -21,14 +19,13 @@ public static Sort[] From(string[] sortBy, SortDirection[] sortDirections)
     {
         var filteredBy =
             sortBy?.Where(by => !string.IsNullOrWhiteSpace(by)).Take(sortDirections?.Length ?? 0).ToList() ??
-            new List<string>();
+            [];
 
-        var filteredDirections = sortDirections?.Take(filteredBy.Count).ToList() ?? new List<SortDirection>();
+        var filteredDirections = sortDirections?.Take(filteredBy.Count).ToList() ?? [];
 
         return filteredBy.Select(
                 (by, index) => From(by ?? throw new InvalidOperationException(), filteredDirections[index])
             )
             .ToArray();
     }
-
 }

Intersect.Server.Core/Collections/Sorting/SortDirection.cs

@@ -1,11 +1,8 @@
-namespace Intersect.Server.Web.RestApi.Payloads;
-
+namespace Intersect.Server.Collections.Sorting;
 
 public enum SortDirection
 {
-
     Ascending,
 
-    Descending
-
+    Descending,
 }

Intersect.Server.Core/Database/PlayerData/Players/Guild.cs

@@ -15,8 +15,8 @@
 using Intersect.Logging;
 using Intersect.Utilities;
 using Intersect.Server.Localization;
-using Intersect.Server.Web.RestApi.Payloads;
 using static Intersect.Server.Database.Logging.Entities.GuildHistory;
+using Intersect.Server.Collections.Sorting;
 
 namespace Intersect.Server.Database.PlayerData.Players;
 

Intersect.Server.Core/Database/PlayerData/User.cs

@@ -10,6 +10,8 @@
 using Intersect.Logging;
 using Intersect.Reflection;
 using Intersect.Security;
+using Intersect.Server.Collections.Indexing;
+using Intersect.Server.Collections.Sorting;
 using Intersect.Server.Core;
 using Intersect.Server.Database.Logging.Entities;
 using Intersect.Server.Database.PlayerData.Api;
@@ -19,7 +21,6 @@
 using Intersect.Server.General;
 using Intersect.Server.Localization;
 using Intersect.Server.Networking;
-using Intersect.Server.Web.RestApi.Payloads;
 using Intersect.Utilities;
 using Microsoft.EntityFrameworkCore;
 using Newtonsoft.Json;
@@ -529,18 +530,33 @@ public UserSaveResult Save(PlayerContext? playerContext, bool force = false, boo
         return user;
     }
 
-    public static Tuple<Client, User> Fetch(Guid userId)
+    public static bool TryFind(LookupKey lookupKey, [NotNullWhen(true)] out User? user)
     {
-        var client = Globals.Clients.Find(queryClient => userId == queryClient?.User?.Id);
-
-        return new Tuple<Client, User>(client, client?.User ?? FindById(userId));
+        using var playerContext = DbInterface.CreatePlayerContext();
+        return TryFind(lookupKey, playerContext, out user);
     }
 
-    public static Tuple<Client, User> Fetch(string userName)
+    public static bool TryFetch(LookupKey lookupKey, [NotNullWhen(true)] out User? user) => TryFetch(lookupKey, out user, out _);
+
+    public static bool TryFetch(LookupKey lookupKey, [NotNullWhen(true)] out User? user, out Client? client)
     {
-        var client = Globals.Clients.Find(queryClient => Entity.CompareName(userName, queryClient?.User?.Name));
+        if (lookupKey.IsInvalid)
+        {
+            user = default;
+            client = default;
+            return false;
+        }
 
-        return new Tuple<Client, User>(client, client?.User ?? Find(userName));
+        if (lookupKey.HasId)
+        {
+            client = Globals.Clients.Find(queryClient => lookupKey.Id == queryClient?.User?.Id);
+            user = client?.User ?? FindById(lookupKey.Id);
+            return user != default;
+        }
+
+        client = Globals.Clients.Find(queryClient => Entity.CompareName(lookupKey.Name, queryClient?.User?.Name));
+        user = client?.User ?? Find(lookupKey.Name);
+        return user != default;
     }
 
     public static bool TryLogin(
@@ -620,28 +636,6 @@ out LoginFailureReason failureReason
         }
     }
 
-    public static bool TryFetch(LookupKey lookupKey, [NotNullWhen(true)] out User? user) =>
-        TryFetch(lookupKey, out user, out _);
-
-    public static bool TryFetch(LookupKey lookupKey, [NotNullWhen(true)] out User? user, out Client? client)
-    {
-        if (lookupKey is { HasName: false, HasId: false })
-        {
-            user = default;
-            client = default;
-            return false;
-        }
-
-        (client, user) = lookupKey.HasId ? Fetch(lookupKey.Id) : Fetch(lookupKey.Name);
-        return user != default;
-    }
-
-    public static bool TryFind(LookupKey lookupKey, [NotNullWhen(true)] out User? user)
-    {
-        using var playerContext = DbInterface.CreatePlayerContext();
-        return TryFind(lookupKey, playerContext, out user);
-    }
-
     public static bool TryFind(LookupKey lookupKey, PlayerContext playerContext, [NotNullWhen(true)] out User? user)
     {
         if (lookupKey.HasId)

Intersect.Server.Core/Entities/Player.Database.cs

@@ -1,17 +1,18 @@
-using System.ComponentModel.DataAnnotations.Schema;
+using System.ComponentModel.DataAnnotations.Schema;
 using System.Diagnostics.CodeAnalysis;
 using Intersect.Logging;
 using Intersect.Server.Database;
 using Intersect.Server.Database.PlayerData;
 using Intersect.Server.General;
 using Intersect.Server.Networking;
-using Intersect.Server.Web.RestApi.Payloads;
 using Intersect.Server.Database.PlayerData.Players;
 using Intersect.Utilities;
 
 using Microsoft.EntityFrameworkCore;
 
 using Newtonsoft.Json;
+using Intersect.Server.Collections.Indexing;
+using Intersect.Server.Collections.Sorting;
 
 namespace Intersect.Server.Entities;
 
@@ -38,42 +39,39 @@ public partial class Player
 
     #region Lookup
 
-    public static bool TryFetch(LookupKey lookupKey, [NotNullWhen(true)] out Tuple<Client, Player>? tuple)
-    {
-        tuple = Fetch(lookupKey);
-        return tuple != default;
-    }
-
-    public static Tuple<Client, Player> Fetch(LookupKey lookupKey, bool loadRelationships = false,
-        bool loadBags = false)
+    public static bool TryFetch(
+        LookupKey lookupKey,
+        out Player? player,
+        bool loadRelationships = false,
+        bool loadBags = false
+    )
+        => TryFetch(lookupKey, out _, out player, loadRelationships, loadBags);
+
+    public static bool TryFetch(
+        LookupKey lookupKey,
+        [NotNullWhen(true)] out Client? client,
+        out Player? player,
+        bool loadRelationships = false,
+        bool loadBags = false
+    )
     {
-        if (lookupKey is { HasName: false, HasId: false })
+        if (lookupKey.IsInvalid)
         {
-            return new Tuple<Client, Player>(null, null);
+            client = default;
+            player = default;
+            return false;
         }
 
-        // HasName checks if null or empty
-        // ReSharper disable once AssignNullToNotNullAttribute
-        return lookupKey.HasId
-            ? Fetch(lookupKey.Id)
-            : Fetch(lookupKey.Name, loadRelationships: loadRelationships, loadBags: loadBags);
-    }
-
-    public static Tuple<Client, Player> Fetch(string playerName, bool loadRelationships = false, bool loadBags = false)
-    {
-        var client = Globals.Clients.Find(queryClient => Entity.CompareName(playerName, queryClient?.Entity?.Name));
-
-        return new Tuple<Client, Player>(
-            client,
-            client?.Entity ?? Find(playerName, loadRelationships: loadRelationships, loadBags: loadBags)
-        );
-    }
-
-    public static Tuple<Client, Player> Fetch(Guid playerId)
-    {
-        var client = Globals.Clients.Find(queryClient => playerId == queryClient?.Entity?.Id);
+        if (lookupKey.HasId)
+        {
+            client = Globals.Clients.Find(queryClient => lookupKey.Id == queryClient?.Entity?.Id);
+            player = client?.Entity ?? Find(lookupKey.Id);
+            return player != default;
+        }
 
-        return new Tuple<Client, Player>(client, client?.Entity ?? Player.Find(playerId));
+        client = Globals.Clients.Find(queryClient => CompareName(lookupKey.Name, queryClient?.Entity?.Name));
+        player = client?.Entity ?? Find(lookupKey.Name, loadRelationships: loadRelationships, loadBags: loadBags);
+        return player != default;
     }
 
     public static Player Find(Guid playerId)

Intersect.Server.Core/Extensions/EnumerableExtensions.cs

@@ -1,5 +1,4 @@
-using Intersect.Server.Web.RestApi.Payloads;
-
+using Intersect.Server.Collections.Sorting;
 using Microsoft.EntityFrameworkCore;
 
 namespace Intersect.Server.Extensions;

Intersect.Server.Core/Extensions/QueryableExtensions.cs

@@ -1,6 +1,5 @@
-using System.Linq.Expressions;
-
-using Intersect.Server.Web.RestApi.Payloads;
+using System.Linq.Expressions;
+using Intersect.Server.Collections.Sorting;
 
 using Microsoft.EntityFrameworkCore;
 

Intersect.Server/Web/Net7/ApiService.cs

@@ -10,7 +10,7 @@
 using Intersect.Server.Web.Configuration;
 using Intersect.Server.Web.Constraints;
 using Intersect.Server.Web.Middleware;
-using Intersect.Server.Web.RestApi.Payloads;
+using Intersect.Server.Web.RestApi.Types.Chat;
 using Intersect.Server.Web.RestApi.Routes;
 using Intersect.Server.Web.Serialization;
 using Intersect.Server.Web.Swagger.Filters;
@@ -32,6 +32,7 @@
 using Microsoft.IdentityModel.Tokens;
 using Microsoft.OpenApi.Models;
 using Newtonsoft.Json.Converters;
+using Intersect.Server.Collections.Indexing;
 #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
 
 namespace Intersect.Server.Web;
@@ -251,10 +252,10 @@ internal partial class ApiService : ApplicationService<ServerContext, IApiServic
                     options.TokenValidationParameters.ValidIssuer ??= tokenGenerationOptions.Issuer;
                     options.Events = new JwtBearerEvents
                     {
-                        OnAuthenticationFailed = async _ => {},
-                        OnChallenge = async _ => {},
-                        OnMessageReceived = async _ => {},
-                        OnTokenValidated = async _ => {},
+                        OnAuthenticationFailed = async _ => { },
+                        OnChallenge = async _ => { },
+                        OnMessageReceived = async _ => { },
+                        OnTokenValidated = async _ => { },
                     };
                     SymmetricSecurityKey issuerKey = new(tokenGenerationOptions.SecretData);
                     options.TokenValidationParameters.IssuerSigningKey = issuerKey;