refactor: enable image width/height behind a flag

Re-enable sending the image width/height in the v3 api behind
a setting.

Also add `#nullable enable` to the image model file.

Author: revam

Shoko.Server/API/v3/Models/Common/Image.cs

@@ -3,15 +3,17 @@
 using System.ComponentModel.DataAnnotations;
 using System.IO;
 using System.Linq;
-// using ImageMagick;
+using ImageMagick;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 using Shoko.Commons.Extensions;
 using Shoko.Models.Enums;
 using Shoko.Server.Extensions;
 using Shoko.Server.ImageDownload;
 using Shoko.Server.Repositories;
+using Shoko.Server.Utilities;
 
+#nullable enable
 namespace Shoko.Server.API.v3.Models.Common;
 
 /// <summary>
@@ -41,7 +43,7 @@ public class Image
     /// The relative path from the base image directory. A client with access to the server's filesystem can map
     /// these for quick access and no need for caching
     /// </summary>
-    public string RelativeFilepath { get; set; }
+    public string? RelativeFilepath { get; set; }
 
     /// <summary>
     /// Is it marked as default. Only one default is possible for a given <see cref="Image.Type"/>.
@@ -71,24 +73,20 @@ public Image(int id, ImageEntityType type, bool preferred = false, bool disabled
             throw new ArgumentException("Static Resources do not use an integer ID");
         }
 
-        RelativeFilepath = GetImagePath(type, id)?.Replace(ImageUtils.GetBaseImagesPath(), "").Replace("\\", "/");
-        /*
         var imagePath = GetImagePath(type, id);
-        if (string.IsNullOrEmpty(imagePath)) {
-            RelativeFilepath = null;
-            Width = null;
-            Height = null;
-        }
-        // This causes serious IO lag on some systems. Removing until we have better Image data structures
-        else
+        if (!string.IsNullOrEmpty(imagePath))
         {
-            var info = new MagickImageInfo(imagePath);
             RelativeFilepath = imagePath.Replace(ImageUtils.GetBaseImagesPath(), "").Replace("\\", "/");
             if (!RelativeFilepath.StartsWith("/"))
                 RelativeFilepath = "/" + RelativeFilepath;
-            Width = info.Width;
-            Height = info.Height;
-        }*/
+            // This causes serious IO lag on some systems. Enable at own risk.
+            if (Utils.SettingsProvider.GetSettings().LoadImageMetadata)
+            {
+                var info = new MagickImageInfo(imagePath);
+                Width = info.Width;
+                Height = info.Height;
+            }
+        }
     }
 
     public Image(string id, ImageEntityType type, bool preferred = false, bool disabled = false)
@@ -241,7 +239,7 @@ public static ImageSizeType GetImageSizeTypeFromType(ImageType imageType)
         };
     }
 
-    public static string GetImagePath(ImageEntityType type, int id)
+    public static string? GetImagePath(ImageEntityType type, int id)
     {
         string path;
 
@@ -528,7 +526,7 @@ internal static ImageSource GetRandomImageSource(ImageType imageType)
                 .Where(a => a != null && !a.GetAllTags().Contains("18 restricted"))
                 .SelectMany(a => RepoFactory.CrossRef_Anime_Staff.GetByAnimeID(a.AnimeID))
                 .Where(a => a.RoleType == (int)StaffRoleType.Seiyuu && a.RoleID.HasValue)
-                .Select(a => RepoFactory.AnimeCharacter.GetByID(a.RoleID.Value))
+                .Select(a => RepoFactory.AnimeCharacter.GetByID(a.RoleID!.Value))
                 .GetRandomElement()?.CharacterID,
             ImageEntityType.Staff => RepoFactory.AniDB_Anime.GetAll()
                 .Where(a => a != null && !a.GetAllTags().Contains("18 restricted"))
@@ -620,8 +618,8 @@ public class DefaultImageBody
             /// from the API. Also see <seealso cref="Image.ID"/>.
             /// </summary>
             /// <value></value>
-            [Required]
-            public string ID { get; set; }
+            [Required, MinLength(1)]
+            public string ID { get; set; } = "";
 
             /// <summary>
             /// The image source.

Shoko.Server/Settings/IServerSettings.cs

@@ -35,7 +35,15 @@ public interface IServerSettings
     DataSourceType EpisodeTitleSource { get; set; }
     DataSourceType SeriesDescriptionSource { get; set; }
     DataSourceType SeriesNameSource { get; set; }
+    /// <summary>
+    /// Path where the images are stored. If set to <c>null</c> then it will use
+    /// the default location.
+    /// </summary>
     string ImagesPath { get; set; }
+    /// <summary>
+    /// Load image metadata from the file system and send to the clients.
+    /// </summary>
+    bool LoadImageMetadata { get; set; }
     string UpdateChannel { get; set; }
     bool TraceLog { get; set; }
     int CachingDatabaseTimeout { get; set; }

Shoko.Server/Settings/ServerSettings.cs

@@ -105,6 +105,7 @@ public List<string> EpisodeLanguagePreference {
 
     [JsonIgnore] public string _ImagesPath;
 
+    /// <inheritdoc />
     public string ImagesPath
     {
         get => _ImagesPath;
@@ -115,6 +116,9 @@ public string ImagesPath
         }
     }
 
+    /// <inheritdoc/> />
+    public bool LoadImageMetadata { get; set; } = false;
+
     public TraktSettings TraktTv { get; set; } = new();
 
     public string UpdateChannel { get; set; } = "Stable";