| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Globalization; |
| | | 5 | | using System.IO; |
| | | 6 | | using System.Linq; |
| | | 7 | | using System.Threading; |
| | | 8 | | using System.Threading.Tasks; |
| | | 9 | | using Jellyfin.Api.Extensions; |
| | | 10 | | using Jellyfin.Api.Helpers; |
| | | 11 | | using Jellyfin.Api.ModelBinders; |
| | | 12 | | using Jellyfin.Api.Models.LibraryStructureDto; |
| | | 13 | | using MediaBrowser.Common.Api; |
| | | 14 | | using MediaBrowser.Controller; |
| | | 15 | | using MediaBrowser.Controller.Configuration; |
| | | 16 | | using MediaBrowser.Controller.Entities; |
| | | 17 | | using MediaBrowser.Controller.Library; |
| | | 18 | | using MediaBrowser.Model.Configuration; |
| | | 19 | | using MediaBrowser.Model.Entities; |
| | | 20 | | using Microsoft.AspNetCore.Authorization; |
| | | 21 | | using Microsoft.AspNetCore.Http; |
| | | 22 | | using Microsoft.AspNetCore.Mvc; |
| | | 23 | | |
| | | 24 | | namespace Jellyfin.Api.Controllers; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// The library structure controller. |
| | | 28 | | /// </summary> |
| | | 29 | | [Route("Library/VirtualFolders")] |
| | | 30 | | [Authorize(Policy = Policies.FirstTimeSetupOrElevated)] |
| | | 31 | | public class LibraryStructureController : BaseJellyfinApiController |
| | | 32 | | { |
| | | 33 | | private readonly IServerApplicationPaths _appPaths; |
| | | 34 | | private readonly ILibraryManager _libraryManager; |
| | | 35 | | private readonly ILibraryMonitor _libraryMonitor; |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Initializes a new instance of the <see cref="LibraryStructureController"/> class. |
| | | 39 | | /// </summary> |
| | | 40 | | /// <param name="serverConfigurationManager">Instance of <see cref="IServerConfigurationManager"/> interface.</param |
| | | 41 | | /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/> interface.</param> |
| | | 42 | | /// <param name="libraryMonitor">Instance of <see cref="ILibraryMonitor"/> interface.</param> |
| | 14 | 43 | | public LibraryStructureController( |
| | 14 | 44 | | IServerConfigurationManager serverConfigurationManager, |
| | 14 | 45 | | ILibraryManager libraryManager, |
| | 14 | 46 | | ILibraryMonitor libraryMonitor) |
| | | 47 | | { |
| | 14 | 48 | | _appPaths = serverConfigurationManager.ApplicationPaths; |
| | 14 | 49 | | _libraryManager = libraryManager; |
| | 14 | 50 | | _libraryMonitor = libraryMonitor; |
| | 14 | 51 | | } |
| | | 52 | | |
| | | 53 | | /// <summary> |
| | | 54 | | /// Gets all virtual folders. |
| | | 55 | | /// </summary> |
| | | 56 | | /// <response code="200">Virtual folders retrieved.</response> |
| | | 57 | | /// <returns>An <see cref="IEnumerable{VirtualFolderInfo}"/> with the virtual folders.</returns> |
| | | 58 | | [HttpGet] |
| | | 59 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 60 | | public ActionResult<IEnumerable<VirtualFolderInfo>> GetVirtualFolders() |
| | | 61 | | { |
| | 1 | 62 | | return _libraryManager.GetVirtualFolders(true); |
| | | 63 | | } |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Adds a virtual folder. |
| | | 67 | | /// </summary> |
| | | 68 | | /// <param name="name">The name of the virtual folder.</param> |
| | | 69 | | /// <param name="collectionType">The type of the collection.</param> |
| | | 70 | | /// <param name="paths">The paths of the virtual folder.</param> |
| | | 71 | | /// <param name="libraryOptionsDto">The library options.</param> |
| | | 72 | | /// <param name="refreshLibrary">Whether to refresh the library.</param> |
| | | 73 | | /// <response code="204">Folder added.</response> |
| | | 74 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | | 75 | | [HttpPost] |
| | | 76 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 77 | | public async Task<ActionResult> AddVirtualFolder( |
| | | 78 | | [FromQuery] string name, |
| | | 79 | | [FromQuery] CollectionTypeOptions? collectionType, |
| | | 80 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] paths, |
| | | 81 | | [FromBody] AddVirtualFolderDto? libraryOptionsDto, |
| | | 82 | | [FromQuery] bool refreshLibrary = false) |
| | | 83 | | { |
| | | 84 | | var libraryOptions = libraryOptionsDto?.LibraryOptions ?? new LibraryOptions(); |
| | | 85 | | |
| | | 86 | | if (paths is not null && paths.Length > 0) |
| | | 87 | | { |
| | | 88 | | libraryOptions.PathInfos = Array.ConvertAll(paths, i => new MediaPathInfo(i)); |
| | | 89 | | } |
| | | 90 | | |
| | | 91 | | await _libraryManager.AddVirtualFolder(name, collectionType, libraryOptions, refreshLibrary).ConfigureAwait(fals |
| | | 92 | | |
| | | 93 | | return NoContent(); |
| | | 94 | | } |
| | | 95 | | |
| | | 96 | | /// <summary> |
| | | 97 | | /// Removes a virtual folder. |
| | | 98 | | /// </summary> |
| | | 99 | | /// <param name="name">The name of the folder.</param> |
| | | 100 | | /// <param name="refreshLibrary">Whether to refresh the library.</param> |
| | | 101 | | /// <response code="204">Folder removed.</response> |
| | | 102 | | /// <response code="404">Folder not found.</response> |
| | | 103 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | | 104 | | [HttpDelete] |
| | | 105 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 106 | | public async Task<ActionResult> RemoveVirtualFolder( |
| | | 107 | | [FromQuery] string name, |
| | | 108 | | [FromQuery] bool refreshLibrary = false) |
| | | 109 | | { |
| | | 110 | | // TODO: refactor! this relies on an FileNotFound exception to return NotFound when attempting to remove a libra |
| | | 111 | | await _libraryManager.RemoveVirtualFolder(name, refreshLibrary).ConfigureAwait(false); |
| | | 112 | | |
| | | 113 | | return NoContent(); |
| | | 114 | | } |
| | | 115 | | |
| | | 116 | | /// <summary> |
| | | 117 | | /// Renames a virtual folder. |
| | | 118 | | /// </summary> |
| | | 119 | | /// <param name="name">The name of the virtual folder.</param> |
| | | 120 | | /// <param name="newName">The new name.</param> |
| | | 121 | | /// <param name="refreshLibrary">Whether to refresh the library.</param> |
| | | 122 | | /// <response code="204">Folder renamed.</response> |
| | | 123 | | /// <response code="404">Library doesn't exist.</response> |
| | | 124 | | /// <response code="409">Library already exists.</response> |
| | | 125 | | /// <returns>A <see cref="NoContentResult"/> on success, a <see cref="NotFoundResult"/> if the library doesn't exist |
| | | 126 | | /// <exception cref="ArgumentNullException">The new name may not be null.</exception> |
| | | 127 | | [HttpPost("Name")] |
| | | 128 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 129 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 130 | | [ProducesResponseType(StatusCodes.Status409Conflict)] |
| | | 131 | | public ActionResult RenameVirtualFolder( |
| | | 132 | | [FromQuery] string? name, |
| | | 133 | | [FromQuery] string? newName, |
| | | 134 | | [FromQuery] bool refreshLibrary = false) |
| | | 135 | | { |
| | 3 | 136 | | if (string.IsNullOrWhiteSpace(name)) |
| | | 137 | | { |
| | 1 | 138 | | throw new ArgumentNullException(nameof(name)); |
| | | 139 | | } |
| | | 140 | | |
| | 2 | 141 | | if (string.IsNullOrWhiteSpace(newName)) |
| | | 142 | | { |
| | 1 | 143 | | throw new ArgumentNullException(nameof(newName)); |
| | | 144 | | } |
| | | 145 | | |
| | 1 | 146 | | var rootFolderPath = _appPaths.DefaultUserViewsPath; |
| | | 147 | | |
| | 1 | 148 | | var currentPath = Path.Combine(rootFolderPath, name); |
| | 1 | 149 | | var newPath = Path.Combine(rootFolderPath, newName); |
| | | 150 | | |
| | 1 | 151 | | if (!Directory.Exists(currentPath)) |
| | | 152 | | { |
| | 1 | 153 | | return NotFound("The media collection does not exist."); |
| | | 154 | | } |
| | | 155 | | |
| | 0 | 156 | | if (!string.Equals(currentPath, newPath, StringComparison.OrdinalIgnoreCase) && Directory.Exists(newPath)) |
| | | 157 | | { |
| | 0 | 158 | | return Conflict($"The media library already exists at {newPath}."); |
| | | 159 | | } |
| | | 160 | | |
| | 0 | 161 | | _libraryMonitor.Stop(); |
| | | 162 | | |
| | | 163 | | try |
| | | 164 | | { |
| | | 165 | | // Changing capitalization. Handle windows case insensitivity |
| | 0 | 166 | | if (string.Equals(currentPath, newPath, StringComparison.OrdinalIgnoreCase)) |
| | | 167 | | { |
| | 0 | 168 | | var tempPath = Path.Combine( |
| | 0 | 169 | | rootFolderPath, |
| | 0 | 170 | | Guid.NewGuid().ToString("N", CultureInfo.InvariantCulture)); |
| | 0 | 171 | | Directory.Move(currentPath, tempPath); |
| | 0 | 172 | | currentPath = tempPath; |
| | | 173 | | } |
| | | 174 | | |
| | 0 | 175 | | Directory.Move(currentPath, newPath); |
| | 0 | 176 | | } |
| | | 177 | | finally |
| | | 178 | | { |
| | 0 | 179 | | CollectionFolder.OnCollectionFolderChange(); |
| | | 180 | | |
| | 0 | 181 | | Task.Run(async () => |
| | 0 | 182 | | { |
| | 0 | 183 | | // No need to start if scanning the library because it will handle it |
| | 0 | 184 | | if (refreshLibrary) |
| | 0 | 185 | | { |
| | 0 | 186 | | await _libraryManager.ValidateTopLibraryFolders(CancellationToken.None, true).ConfigureAwait(false); |
| | 0 | 187 | | var newLib = _libraryManager.GetUserRootFolder().Children.FirstOrDefault(f => f.Path.Equals(newPath, |
| | 0 | 188 | | if (newLib is CollectionFolder folder) |
| | 0 | 189 | | { |
| | 0 | 190 | | foreach (var child in folder.GetPhysicalFolders()) |
| | 0 | 191 | | { |
| | 0 | 192 | | await child.RefreshMetadata(CancellationToken.None).ConfigureAwait(false); |
| | 0 | 193 | | await child.ValidateChildren(new Progress<double>(), CancellationToken.None).ConfigureAwait( |
| | 0 | 194 | | } |
| | 0 | 195 | | } |
| | 0 | 196 | | else |
| | 0 | 197 | | { |
| | 0 | 198 | | // We don't know if this one can be validated individually, trigger a new validation |
| | 0 | 199 | | await _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None).Confi |
| | 0 | 200 | | } |
| | 0 | 201 | | } |
| | 0 | 202 | | else |
| | 0 | 203 | | { |
| | 0 | 204 | | // Need to add a delay here or directory watchers may still pick up the changes |
| | 0 | 205 | | // Have to block here to allow exceptions to bubble |
| | 0 | 206 | | await Task.Delay(1000).ConfigureAwait(false); |
| | 0 | 207 | | _libraryMonitor.Start(); |
| | 0 | 208 | | } |
| | 0 | 209 | | }); |
| | 0 | 210 | | } |
| | | 211 | | |
| | 0 | 212 | | return NoContent(); |
| | | 213 | | } |
| | | 214 | | |
| | | 215 | | /// <summary> |
| | | 216 | | /// Add a media path to a library. |
| | | 217 | | /// </summary> |
| | | 218 | | /// <param name="mediaPathDto">The media path dto.</param> |
| | | 219 | | /// <param name="refreshLibrary">Whether to refresh the library.</param> |
| | | 220 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | | 221 | | /// <response code="204">Media path added.</response> |
| | | 222 | | /// <exception cref="ArgumentNullException">The name of the library may not be empty.</exception> |
| | | 223 | | [HttpPost("Paths")] |
| | | 224 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 225 | | public ActionResult AddMediaPath( |
| | | 226 | | [FromBody, Required] MediaPathDto mediaPathDto, |
| | | 227 | | [FromQuery] bool refreshLibrary = false) |
| | | 228 | | { |
| | 1 | 229 | | _libraryMonitor.Stop(); |
| | | 230 | | |
| | | 231 | | try |
| | | 232 | | { |
| | 1 | 233 | | var mediaPath = mediaPathDto.PathInfo ?? new MediaPathInfo(mediaPathDto.Path ?? throw new ArgumentException( |
| | | 234 | | |
| | 1 | 235 | | _libraryManager.AddMediaPath(mediaPathDto.Name, mediaPath); |
| | 0 | 236 | | } |
| | | 237 | | finally |
| | | 238 | | { |
| | 1 | 239 | | Task.Run(async () => |
| | 1 | 240 | | { |
| | 1 | 241 | | // No need to start if scanning the library because it will handle it |
| | 1 | 242 | | if (refreshLibrary) |
| | 1 | 243 | | { |
| | 1 | 244 | | await _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None).Configure |
| | 1 | 245 | | } |
| | 1 | 246 | | else |
| | 1 | 247 | | { |
| | 1 | 248 | | // Need to add a delay here or directory watchers may still pick up the changes |
| | 1 | 249 | | // Have to block here to allow exceptions to bubble |
| | 1 | 250 | | await Task.Delay(1000).ConfigureAwait(false); |
| | 1 | 251 | | _libraryMonitor.Start(); |
| | 1 | 252 | | } |
| | 1 | 253 | | }); |
| | 1 | 254 | | } |
| | | 255 | | |
| | 0 | 256 | | return NoContent(); |
| | | 257 | | } |
| | | 258 | | |
| | | 259 | | /// <summary> |
| | | 260 | | /// Updates a media path. |
| | | 261 | | /// </summary> |
| | | 262 | | /// <param name="mediaPathRequestDto">The name of the library and path infos.</param> |
| | | 263 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | | 264 | | /// <response code="204">Media path updated.</response> |
| | | 265 | | /// <exception cref="ArgumentNullException">The name of the library may not be empty.</exception> |
| | | 266 | | [HttpPost("Paths/Update")] |
| | | 267 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 268 | | public ActionResult UpdateMediaPath([FromBody, Required] UpdateMediaPathRequestDto mediaPathRequestDto) |
| | | 269 | | { |
| | 0 | 270 | | if (string.IsNullOrWhiteSpace(mediaPathRequestDto.Name)) |
| | | 271 | | { |
| | 0 | 272 | | throw new ArgumentNullException(nameof(mediaPathRequestDto), "Name must not be null or empty"); |
| | | 273 | | } |
| | | 274 | | |
| | 0 | 275 | | _libraryManager.UpdateMediaPath(mediaPathRequestDto.Name, mediaPathRequestDto.PathInfo); |
| | 0 | 276 | | return NoContent(); |
| | | 277 | | } |
| | | 278 | | |
| | | 279 | | /// <summary> |
| | | 280 | | /// Remove a media path. |
| | | 281 | | /// </summary> |
| | | 282 | | /// <param name="name">The name of the library.</param> |
| | | 283 | | /// <param name="path">The path to remove.</param> |
| | | 284 | | /// <param name="refreshLibrary">Whether to refresh the library.</param> |
| | | 285 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | | 286 | | /// <response code="204">Media path removed.</response> |
| | | 287 | | /// <exception cref="ArgumentException">The name of the library and path may not be empty.</exception> |
| | | 288 | | [HttpDelete("Paths")] |
| | | 289 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 290 | | public ActionResult RemoveMediaPath( |
| | | 291 | | [FromQuery] string name, |
| | | 292 | | [FromQuery] string path, |
| | | 293 | | [FromQuery] bool refreshLibrary = false) |
| | | 294 | | { |
| | 1 | 295 | | ArgumentException.ThrowIfNullOrWhiteSpace(name); |
| | 1 | 296 | | ArgumentException.ThrowIfNullOrWhiteSpace(path); |
| | | 297 | | |
| | 1 | 298 | | _libraryMonitor.Stop(); |
| | | 299 | | |
| | | 300 | | try |
| | | 301 | | { |
| | 1 | 302 | | _libraryManager.RemoveMediaPath(name, path); |
| | 0 | 303 | | } |
| | | 304 | | finally |
| | | 305 | | { |
| | 1 | 306 | | Task.Run(async () => |
| | 1 | 307 | | { |
| | 1 | 308 | | // No need to start if scanning the library because it will handle it |
| | 1 | 309 | | if (refreshLibrary) |
| | 1 | 310 | | { |
| | 1 | 311 | | await _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None).Configure |
| | 1 | 312 | | } |
| | 1 | 313 | | else |
| | 1 | 314 | | { |
| | 1 | 315 | | // Need to add a delay here or directory watchers may still pick up the changes |
| | 1 | 316 | | // Have to block here to allow exceptions to bubble |
| | 1 | 317 | | await Task.Delay(1000).ConfigureAwait(false); |
| | 1 | 318 | | _libraryMonitor.Start(); |
| | 1 | 319 | | } |
| | 1 | 320 | | }); |
| | 1 | 321 | | } |
| | | 322 | | |
| | 0 | 323 | | return NoContent(); |
| | | 324 | | } |
| | | 325 | | |
| | | 326 | | /// <summary> |
| | | 327 | | /// Update library options. |
| | | 328 | | /// </summary> |
| | | 329 | | /// <param name="request">The library name and options.</param> |
| | | 330 | | /// <response code="204">Library updated.</response> |
| | | 331 | | /// <response code="404">Item not found.</response> |
| | | 332 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | | 333 | | [HttpPost("LibraryOptions")] |
| | | 334 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 335 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 336 | | public ActionResult UpdateLibraryOptions( |
| | | 337 | | [FromBody] UpdateLibraryOptionsDto request) |
| | | 338 | | { |
| | 2 | 339 | | var item = _libraryManager.GetItemById<CollectionFolder>(request.Id); |
| | 2 | 340 | | if (item is null) |
| | | 341 | | { |
| | 1 | 342 | | return NotFound(); |
| | | 343 | | } |
| | | 344 | | |
| | 1 | 345 | | item.UpdateLibraryOptions(request.LibraryOptions); |
| | 1 | 346 | | return NoContent(); |
| | | 347 | | } |
| | | 348 | | } |