Directory Picker Rework (#1325)

* Started on the directory picker refactor.

* Coded some basic working version. Needs styling and variable cleanup

* code cleanup

* Implemented the ability to expose swagger on non-development servers.

* Implemented the ability to expose swagger on non-development servers.

API/Controllers/LibraryController.cs

@@ -8,6 +8,7 @@ using API.Data.Repositories;
 using API.DTOs;
 using API.DTOs.JumpBar;
 using API.DTOs.Search;
+using API.DTOs.System;
 using API.Entities;
 using API.Entities.Enums;
 using API.Extensions;
@@ -89,11 +90,15 @@ namespace API.Controllers
         /// <returns></returns>
         [Authorize(Policy = "RequireAdminRole")]
         [HttpGet("list")]
-        public ActionResult<IEnumerable<string>> GetDirectories(string path)
+        public ActionResult<IEnumerable<DirectoryDto>> GetDirectories(string path)
         {
             if (string.IsNullOrEmpty(path))
             {
-                return Ok(Directory.GetLogicalDrives());
+                return Ok(Directory.GetLogicalDrives().Select(d => new DirectoryDto()
+                {
+                    Name = d,
+                    FullPath = d
+                }));
             }
 
             if (!Directory.Exists(path)) return BadRequest("This is not a valid path");

API/Controllers/SettingsController.cs

@@ -206,6 +206,12 @@ namespace API.Controllers
                     }
                 }
 
+                if (setting.Key == ServerSettingKey.EnableSwaggerUi && updateSettingsDto.EnableSwaggerUi + string.Empty != setting.Value)
+                {
+                    setting.Value = updateSettingsDto.EnableSwaggerUi + string.Empty;
+                    _unitOfWork.SettingsRepository.Update(setting);
+                }
+
                 if (setting.Key == ServerSettingKey.EmailServiceUrl && updateSettingsDto.EmailServiceUrl + string.Empty != setting.Value)
                 {
                     setting.Value = string.IsNullOrEmpty(updateSettingsDto.EmailServiceUrl) ? EmailService.DefaultApiUrl : updateSettingsDto.EmailServiceUrl;

API/DTOs/Settings/ServerSettingDTO.cs

@@ -40,5 +40,9 @@ namespace API.DTOs.Settings
         public string InstallVersion { get; set; }
 
         public bool ConvertBookmarkToWebP { get; set; }
+        /// <summary>
+        /// If the Swagger UI Should be exposed. Does not require authentication, but does require a JWT.
+        /// </summary>
+        public bool EnableSwaggerUi { get; set; }
     }
 }

API/DTOs/System/DirectoryDto.cs

@@ -0,0 +1,13 @@
+namespace API.DTOs.System;
+
+public class DirectoryDto
+{
+    /// <summary>
+    /// Name of the directory
+    /// </summary>
+    public string Name { get; set; }
+    /// <summary>
+    /// Full Directory Path
+    /// </summary>
+    public string FullPath { get; set; }
+}

API/Data/Seed.cs

@@ -101,6 +101,7 @@ namespace API.Data
                 new() {Key = ServerSettingKey.BookmarkDirectory, Value = directoryService.BookmarkDirectory},
                 new() {Key = ServerSettingKey.EmailServiceUrl, Value = EmailService.DefaultApiUrl},
                 new() {Key = ServerSettingKey.ConvertBookmarkToWebP, Value = "false"},
+                new() {Key = ServerSettingKey.EnableSwaggerUi, Value = "false"},
             }.ToArray());
 
             foreach (var defaultSetting in DefaultSettings)

API/Entities/Enums/ServerSettingKey.cs

@@ -81,5 +81,10 @@ namespace API.Entities.Enums
         /// </summary>
         [Description("ConvertBookmarkToWebP")]
         ConvertBookmarkToWebP = 14,
+        /// <summary>
+        /// If the Swagger UI Should be exposed. Does not require authentication, but does require a JWT.
+        /// </summary>
+        [Description("EnableSwaggerUi")]
+        EnableSwaggerUi = 15,
     }
 }

API/Helpers/Converters/ServerSettingConverter.cs

@@ -51,6 +51,9 @@ namespace API.Helpers.Converters
                     case ServerSettingKey.ConvertBookmarkToWebP:
                         destination.ConvertBookmarkToWebP = bool.Parse(row.Value);
                         break;
+                    case ServerSettingKey.EnableSwaggerUi:
+                        destination.EnableSwaggerUi = bool.Parse(row.Value);
+                        break;
                 }
             }
 

API/Services/DirectoryService.cs

@@ -6,6 +6,8 @@ using System.IO.Abstractions;
 using System.Linq;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
+using API.DTOs.System;
+using API.Entities.Enums;
 using API.Extensions;
 using Microsoft.Extensions.Logging;
 
@@ -29,7 +31,7 @@ namespace API.Services
         /// </summary>
         /// <param name="rootPath">Absolute path of directory to scan.</param>
         /// <returns>List of folder names</returns>
-        IEnumerable<string> ListDirectory(string rootPath);
+        IEnumerable<DirectoryDto> ListDirectory(string rootPath);
         Task<byte[]> ReadFileAsync(string path);
         bool CopyFilesToDirectory(IEnumerable<string> filePaths, string directoryPath, string prepend = "");
         bool Exists(string directory);
@@ -434,14 +436,18 @@ namespace API.Services
        /// </summary>
        /// <param name="rootPath"></param>
        /// <returns></returns>
-       public IEnumerable<string> ListDirectory(string rootPath)
+       public IEnumerable<DirectoryDto> ListDirectory(string rootPath)
         {
-            if (!FileSystem.Directory.Exists(rootPath)) return ImmutableList<string>.Empty;
+            if (!FileSystem.Directory.Exists(rootPath)) return ImmutableList<DirectoryDto>.Empty;
 
             var di = FileSystem.DirectoryInfo.FromDirectoryName(rootPath);
             var dirs = di.GetDirectories()
                 .Where(dir => !(dir.Attributes.HasFlag(FileAttributes.Hidden) || dir.Attributes.HasFlag(FileAttributes.System)))
-                .Select(d => d.Name).ToImmutableList();
+                .Select(d => new DirectoryDto()
+                {
+                    Name = d.Name,
+                    FullPath = d.FullName,
+                }).ToImmutableList();
 
             return dirs;
         }

API/Startup.cs

@@ -176,13 +176,23 @@ namespace API
 
             app.UseMiddleware<ExceptionMiddleware>();
 
+            Task.Run(async () =>
+            {
+                var allowSwaggerUi = (await unitOfWork.SettingsRepository.GetSettingsDtoAsync())
+                    .EnableSwaggerUi;
+
+                if (env.IsDevelopment() || allowSwaggerUi)
+                {
+                    app.UseSwagger();
+                    app.UseSwaggerUI(c =>
+                    {
+                        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Kavita API " + BuildInfo.Version);
+                    });
+                }
+            });
+
             if (env.IsDevelopment())
             {
-                app.UseSwagger();
-                app.UseSwaggerUI(c =>
-                {
-                    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Kavita API " + BuildInfo.Version);
-                });
                 app.UseHangfireDashboard();
             }