| | 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.Attributes; |
| | 10 | | using Jellyfin.Api.Extensions; |
| | 11 | | using Jellyfin.Api.Helpers; |
| | 12 | | using Jellyfin.Api.ModelBinders; |
| | 13 | | using Jellyfin.Api.Models.LibraryDtos; |
| | 14 | | using Jellyfin.Data.Entities; |
| | 15 | | using Jellyfin.Data.Enums; |
| | 16 | | using Jellyfin.Extensions; |
| | 17 | | using MediaBrowser.Common.Api; |
| | 18 | | using MediaBrowser.Common.Extensions; |
| | 19 | | using MediaBrowser.Controller.Configuration; |
| | 20 | | using MediaBrowser.Controller.Dto; |
| | 21 | | using MediaBrowser.Controller.Entities; |
| | 22 | | using MediaBrowser.Controller.Entities.Audio; |
| | 23 | | using MediaBrowser.Controller.Entities.Movies; |
| | 24 | | using MediaBrowser.Controller.Entities.TV; |
| | 25 | | using MediaBrowser.Controller.Library; |
| | 26 | | using MediaBrowser.Controller.Providers; |
| | 27 | | using MediaBrowser.Model.Activity; |
| | 28 | | using MediaBrowser.Model.Configuration; |
| | 29 | | using MediaBrowser.Model.Dto; |
| | 30 | | using MediaBrowser.Model.Entities; |
| | 31 | | using MediaBrowser.Model.Globalization; |
| | 32 | | using MediaBrowser.Model.Net; |
| | 33 | | using MediaBrowser.Model.Querying; |
| | 34 | | using Microsoft.AspNetCore.Authorization; |
| | 35 | | using Microsoft.AspNetCore.Http; |
| | 36 | | using Microsoft.AspNetCore.Mvc; |
| | 37 | | using Microsoft.Extensions.Logging; |
| | 38 | |
|
| | 39 | | namespace Jellyfin.Api.Controllers; |
| | 40 | |
|
| | 41 | | /// <summary> |
| | 42 | | /// Library Controller. |
| | 43 | | /// </summary> |
| | 44 | | [Route("")] |
| | 45 | | public class LibraryController : BaseJellyfinApiController |
| | 46 | | { |
| | 47 | | private readonly IProviderManager _providerManager; |
| | 48 | | private readonly ILibraryManager _libraryManager; |
| | 49 | | private readonly IUserManager _userManager; |
| | 50 | | private readonly IDtoService _dtoService; |
| | 51 | | private readonly IActivityManager _activityManager; |
| | 52 | | private readonly ILocalizationManager _localization; |
| | 53 | | private readonly ILibraryMonitor _libraryMonitor; |
| | 54 | | private readonly ILogger<LibraryController> _logger; |
| | 55 | | private readonly IServerConfigurationManager _serverConfigurationManager; |
| | 56 | |
|
| | 57 | | /// <summary> |
| | 58 | | /// Initializes a new instance of the <see cref="LibraryController"/> class. |
| | 59 | | /// </summary> |
| | 60 | | /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param> |
| | 61 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | 62 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | 63 | | /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param> |
| | 64 | | /// <param name="activityManager">Instance of the <see cref="IActivityManager"/> interface.</param> |
| | 65 | | /// <param name="localization">Instance of the <see cref="ILocalizationManager"/> interface.</param> |
| | 66 | | /// <param name="libraryMonitor">Instance of the <see cref="ILibraryMonitor"/> interface.</param> |
| | 67 | | /// <param name="logger">Instance of the <see cref="ILogger{LibraryController}"/> interface.</param> |
| | 68 | | /// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</p |
| 14 | 69 | | public LibraryController( |
| 14 | 70 | | IProviderManager providerManager, |
| 14 | 71 | | ILibraryManager libraryManager, |
| 14 | 72 | | IUserManager userManager, |
| 14 | 73 | | IDtoService dtoService, |
| 14 | 74 | | IActivityManager activityManager, |
| 14 | 75 | | ILocalizationManager localization, |
| 14 | 76 | | ILibraryMonitor libraryMonitor, |
| 14 | 77 | | ILogger<LibraryController> logger, |
| 14 | 78 | | IServerConfigurationManager serverConfigurationManager) |
| | 79 | | { |
| 14 | 80 | | _providerManager = providerManager; |
| 14 | 81 | | _libraryManager = libraryManager; |
| 14 | 82 | | _userManager = userManager; |
| 14 | 83 | | _dtoService = dtoService; |
| 14 | 84 | | _activityManager = activityManager; |
| 14 | 85 | | _localization = localization; |
| 14 | 86 | | _libraryMonitor = libraryMonitor; |
| 14 | 87 | | _logger = logger; |
| 14 | 88 | | _serverConfigurationManager = serverConfigurationManager; |
| 14 | 89 | | } |
| | 90 | |
|
| | 91 | | /// <summary> |
| | 92 | | /// Get the original file of an item. |
| | 93 | | /// </summary> |
| | 94 | | /// <param name="itemId">The item id.</param> |
| | 95 | | /// <response code="200">File stream returned.</response> |
| | 96 | | /// <response code="404">Item not found.</response> |
| | 97 | | /// <returns>A <see cref="FileStreamResult"/> with the original file.</returns> |
| | 98 | | [HttpGet("Items/{itemId}/File")] |
| | 99 | | [Authorize] |
| | 100 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 101 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 102 | | [ProducesFile("video/*", "audio/*")] |
| | 103 | | public ActionResult GetFile([FromRoute, Required] Guid itemId) |
| | 104 | | { |
| 1 | 105 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId()); |
| 1 | 106 | | if (item is null) |
| | 107 | | { |
| 1 | 108 | | return NotFound(); |
| | 109 | | } |
| | 110 | |
|
| 0 | 111 | | return PhysicalFile(item.Path, MimeTypes.GetMimeType(item.Path), true); |
| | 112 | | } |
| | 113 | |
|
| | 114 | | /// <summary> |
| | 115 | | /// Gets critic review for an item. |
| | 116 | | /// </summary> |
| | 117 | | /// <response code="200">Critic reviews returned.</response> |
| | 118 | | /// <returns>The list of critic reviews.</returns> |
| | 119 | | [HttpGet("Items/{itemId}/CriticReviews")] |
| | 120 | | [Authorize] |
| | 121 | | [Obsolete("This endpoint is obsolete.")] |
| | 122 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 123 | | public ActionResult<QueryResult<BaseItemDto>> GetCriticReviews() |
| | 124 | | { |
| | 125 | | return new QueryResult<BaseItemDto>(); |
| | 126 | | } |
| | 127 | |
|
| | 128 | | /// <summary> |
| | 129 | | /// Get theme songs for an item. |
| | 130 | | /// </summary> |
| | 131 | | /// <param name="itemId">The item id.</param> |
| | 132 | | /// <param name="userId">Optional. Filter by user id, and attach user data.</param> |
| | 133 | | /// <param name="inheritFromParent">Optional. Determines whether or not parent items should be searched for theme me |
| | 134 | | /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar |
| | 135 | | /// <param name="sortOrder">Optional. Sort Order - Ascending, Descending.</param> |
| | 136 | | /// <response code="200">Theme songs returned.</response> |
| | 137 | | /// <response code="404">Item not found.</response> |
| | 138 | | /// <returns>The item theme songs.</returns> |
| | 139 | | [HttpGet("Items/{itemId}/ThemeSongs")] |
| | 140 | | [Authorize] |
| | 141 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 142 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 143 | | public ActionResult<ThemeMediaResult> GetThemeSongs( |
| | 144 | | [FromRoute, Required] Guid itemId, |
| | 145 | | [FromQuery] Guid? userId, |
| | 146 | | [FromQuery] bool inheritFromParent = false, |
| | 147 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemSortBy[]? sortBy = null, |
| | 148 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] SortOrder[]? sortOrder = null) |
| | 149 | | { |
| 2 | 150 | | userId = RequestHelpers.GetUserId(User, userId); |
| 2 | 151 | | var user = userId.IsNullOrEmpty() |
| 2 | 152 | | ? null |
| 2 | 153 | | : _userManager.GetUserById(userId.Value); |
| | 154 | |
|
| 2 | 155 | | var item = itemId.IsEmpty() |
| 2 | 156 | | ? (userId.IsNullOrEmpty() |
| 2 | 157 | | ? _libraryManager.RootFolder |
| 2 | 158 | | : _libraryManager.GetUserRootFolder()) |
| 2 | 159 | | : _libraryManager.GetItemById<BaseItem>(itemId, user); |
| 2 | 160 | | if (item is null) |
| | 161 | | { |
| 2 | 162 | | return NotFound(); |
| | 163 | | } |
| | 164 | |
|
| 0 | 165 | | sortOrder ??= []; |
| 0 | 166 | | sortBy ??= []; |
| 0 | 167 | | var orderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder); |
| | 168 | |
|
| | 169 | | IReadOnlyList<BaseItem> themeItems; |
| | 170 | |
|
| 0 | 171 | | while (true) |
| | 172 | | { |
| 0 | 173 | | themeItems = item.GetThemeSongs(user, orderBy); |
| | 174 | |
|
| 0 | 175 | | if (themeItems.Count > 0 || !inheritFromParent) |
| | 176 | | { |
| | 177 | | break; |
| | 178 | | } |
| | 179 | |
|
| 0 | 180 | | var parent = item.GetParent(); |
| 0 | 181 | | if (parent is null) |
| | 182 | | { |
| | 183 | | break; |
| | 184 | | } |
| | 185 | |
|
| 0 | 186 | | item = parent; |
| | 187 | | } |
| | 188 | |
|
| 0 | 189 | | var dtoOptions = new DtoOptions().AddClientFields(User); |
| 0 | 190 | | var items = themeItems |
| 0 | 191 | | .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item)) |
| 0 | 192 | | .ToArray(); |
| | 193 | |
|
| 0 | 194 | | return new ThemeMediaResult |
| 0 | 195 | | { |
| 0 | 196 | | Items = items, |
| 0 | 197 | | TotalRecordCount = items.Length, |
| 0 | 198 | | OwnerId = item.Id |
| 0 | 199 | | }; |
| | 200 | | } |
| | 201 | |
|
| | 202 | | /// <summary> |
| | 203 | | /// Get theme videos for an item. |
| | 204 | | /// </summary> |
| | 205 | | /// <param name="itemId">The item id.</param> |
| | 206 | | /// <param name="userId">Optional. Filter by user id, and attach user data.</param> |
| | 207 | | /// <param name="inheritFromParent">Optional. Determines whether or not parent items should be searched for theme me |
| | 208 | | /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar |
| | 209 | | /// <param name="sortOrder">Optional. Sort Order - Ascending, Descending.</param> |
| | 210 | | /// <response code="200">Theme videos returned.</response> |
| | 211 | | /// <response code="404">Item not found.</response> |
| | 212 | | /// <returns>The item theme videos.</returns> |
| | 213 | | [HttpGet("Items/{itemId}/ThemeVideos")] |
| | 214 | | [Authorize] |
| | 215 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 216 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 217 | | public ActionResult<ThemeMediaResult> GetThemeVideos( |
| | 218 | | [FromRoute, Required] Guid itemId, |
| | 219 | | [FromQuery] Guid? userId, |
| | 220 | | [FromQuery] bool inheritFromParent = false, |
| | 221 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemSortBy[]? sortBy = null, |
| | 222 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] SortOrder[]? sortOrder = null) |
| | 223 | | { |
| 2 | 224 | | userId = RequestHelpers.GetUserId(User, userId); |
| 2 | 225 | | var user = userId.IsNullOrEmpty() |
| 2 | 226 | | ? null |
| 2 | 227 | | : _userManager.GetUserById(userId.Value); |
| 2 | 228 | | var item = itemId.IsEmpty() |
| 2 | 229 | | ? (userId.IsNullOrEmpty() |
| 2 | 230 | | ? _libraryManager.RootFolder |
| 2 | 231 | | : _libraryManager.GetUserRootFolder()) |
| 2 | 232 | | : _libraryManager.GetItemById<BaseItem>(itemId, user); |
| 2 | 233 | | if (item is null) |
| | 234 | | { |
| 2 | 235 | | return NotFound(); |
| | 236 | | } |
| | 237 | |
|
| 0 | 238 | | sortOrder ??= []; |
| 0 | 239 | | sortBy ??= []; |
| 0 | 240 | | var orderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder); |
| | 241 | |
|
| | 242 | | IEnumerable<BaseItem> themeItems; |
| | 243 | |
|
| 0 | 244 | | while (true) |
| | 245 | | { |
| 0 | 246 | | themeItems = item.GetThemeVideos(user, orderBy); |
| | 247 | |
|
| 0 | 248 | | if (themeItems.Any() || !inheritFromParent) |
| | 249 | | { |
| | 250 | | break; |
| | 251 | | } |
| | 252 | |
|
| 0 | 253 | | var parent = item.GetParent(); |
| 0 | 254 | | if (parent is null) |
| | 255 | | { |
| | 256 | | break; |
| | 257 | | } |
| | 258 | |
|
| 0 | 259 | | item = parent; |
| | 260 | | } |
| | 261 | |
|
| 0 | 262 | | var dtoOptions = new DtoOptions().AddClientFields(User); |
| 0 | 263 | | var items = themeItems |
| 0 | 264 | | .Select(i => _dtoService.GetBaseItemDto(i, dtoOptions, user, item)) |
| 0 | 265 | | .ToArray(); |
| | 266 | |
|
| 0 | 267 | | return new ThemeMediaResult |
| 0 | 268 | | { |
| 0 | 269 | | Items = items, |
| 0 | 270 | | TotalRecordCount = items.Length, |
| 0 | 271 | | OwnerId = item.Id |
| 0 | 272 | | }; |
| | 273 | | } |
| | 274 | |
|
| | 275 | | /// <summary> |
| | 276 | | /// Get theme songs and videos for an item. |
| | 277 | | /// </summary> |
| | 278 | | /// <param name="itemId">The item id.</param> |
| | 279 | | /// <param name="userId">Optional. Filter by user id, and attach user data.</param> |
| | 280 | | /// <param name="inheritFromParent">Optional. Determines whether or not parent items should be searched for theme me |
| | 281 | | /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar |
| | 282 | | /// <param name="sortOrder">Optional. Sort Order - Ascending, Descending.</param> |
| | 283 | | /// <response code="200">Theme songs and videos returned.</response> |
| | 284 | | /// <response code="404">Item not found.</response> |
| | 285 | | /// <returns>The item theme videos.</returns> |
| | 286 | | [HttpGet("Items/{itemId}/ThemeMedia")] |
| | 287 | | [Authorize] |
| | 288 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 289 | | public ActionResult<AllThemeMediaResult> GetThemeMedia( |
| | 290 | | [FromRoute, Required] Guid itemId, |
| | 291 | | [FromQuery] Guid? userId, |
| | 292 | | [FromQuery] bool inheritFromParent = false, |
| | 293 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemSortBy[]? sortBy = null, |
| | 294 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] SortOrder[]? sortOrder = null) |
| | 295 | | { |
| 1 | 296 | | var themeSongs = GetThemeSongs( |
| 1 | 297 | | itemId, |
| 1 | 298 | | userId, |
| 1 | 299 | | inheritFromParent, |
| 1 | 300 | | sortBy, |
| 1 | 301 | | sortOrder); |
| | 302 | |
|
| 1 | 303 | | var themeVideos = GetThemeVideos( |
| 1 | 304 | | itemId, |
| 1 | 305 | | userId, |
| 1 | 306 | | inheritFromParent, |
| 1 | 307 | | sortBy, |
| 1 | 308 | | sortOrder); |
| | 309 | |
|
| 1 | 310 | | if (themeSongs.Result is StatusCodeResult { StatusCode: StatusCodes.Status404NotFound } |
| 1 | 311 | | || themeVideos.Result is StatusCodeResult { StatusCode: StatusCodes.Status404NotFound }) |
| | 312 | | { |
| 1 | 313 | | return NotFound(); |
| | 314 | | } |
| | 315 | |
|
| 0 | 316 | | return new AllThemeMediaResult |
| 0 | 317 | | { |
| 0 | 318 | | ThemeSongsResult = themeSongs.Value, |
| 0 | 319 | | ThemeVideosResult = themeVideos.Value, |
| 0 | 320 | | SoundtrackSongsResult = new ThemeMediaResult() |
| 0 | 321 | | }; |
| | 322 | | } |
| | 323 | |
|
| | 324 | | /// <summary> |
| | 325 | | /// Starts a library scan. |
| | 326 | | /// </summary> |
| | 327 | | /// <response code="204">Library scan started.</response> |
| | 328 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | 329 | | [HttpPost("Library/Refresh")] |
| | 330 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | 331 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | 332 | | public async Task<ActionResult> RefreshLibrary() |
| | 333 | | { |
| | 334 | | try |
| | 335 | | { |
| | 336 | | await _libraryManager.ValidateMediaLibrary(new Progress<double>(), CancellationToken.None).ConfigureAwait(fa |
| | 337 | | } |
| | 338 | | catch (Exception ex) |
| | 339 | | { |
| | 340 | | _logger.LogError(ex, "Error refreshing library"); |
| | 341 | | } |
| | 342 | |
|
| | 343 | | return NoContent(); |
| | 344 | | } |
| | 345 | |
|
| | 346 | | /// <summary> |
| | 347 | | /// Deletes an item from the library and filesystem. |
| | 348 | | /// </summary> |
| | 349 | | /// <param name="itemId">The item id.</param> |
| | 350 | | /// <response code="204">Item deleted.</response> |
| | 351 | | /// <response code="401">Unauthorized access.</response> |
| | 352 | | /// <response code="404">Item not found.</response> |
| | 353 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | 354 | | [HttpDelete("Items/{itemId}")] |
| | 355 | | [Authorize] |
| | 356 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | 357 | | [ProducesResponseType(StatusCodes.Status401Unauthorized)] |
| | 358 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 359 | | public ActionResult DeleteItem(Guid itemId) |
| | 360 | | { |
| 1 | 361 | | var userId = User.GetUserId(); |
| 1 | 362 | | var isApiKey = User.GetIsApiKey(); |
| 1 | 363 | | var user = userId.IsEmpty() && isApiKey |
| 1 | 364 | | ? null |
| 1 | 365 | | : _userManager.GetUserById(userId); |
| | 366 | |
|
| 1 | 367 | | if (user is null && !isApiKey) |
| | 368 | | { |
| 0 | 369 | | return NotFound(); |
| | 370 | | } |
| | 371 | |
|
| 1 | 372 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| 1 | 373 | | if (item is null) |
| | 374 | | { |
| 1 | 375 | | return NotFound(); |
| | 376 | | } |
| | 377 | |
|
| 0 | 378 | | if (user is not null && !item.CanDelete(user)) |
| | 379 | | { |
| 0 | 380 | | return Unauthorized("Unauthorized access"); |
| | 381 | | } |
| | 382 | |
|
| 0 | 383 | | _libraryManager.DeleteItem( |
| 0 | 384 | | item, |
| 0 | 385 | | new DeleteOptions { DeleteFileLocation = true }, |
| 0 | 386 | | true); |
| | 387 | |
|
| 0 | 388 | | return NoContent(); |
| | 389 | | } |
| | 390 | |
|
| | 391 | | /// <summary> |
| | 392 | | /// Deletes items from the library and filesystem. |
| | 393 | | /// </summary> |
| | 394 | | /// <param name="ids">The item ids.</param> |
| | 395 | | /// <response code="204">Items deleted.</response> |
| | 396 | | /// <response code="401">Unauthorized access.</response> |
| | 397 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | 398 | | [HttpDelete("Items")] |
| | 399 | | [Authorize] |
| | 400 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | 401 | | [ProducesResponseType(StatusCodes.Status401Unauthorized)] |
| | 402 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 403 | | public ActionResult DeleteItems([FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] Guid[] ids) |
| | 404 | | { |
| 1 | 405 | | var isApiKey = User.GetIsApiKey(); |
| 1 | 406 | | var userId = User.GetUserId(); |
| 1 | 407 | | var user = !isApiKey && !userId.IsEmpty() |
| 1 | 408 | | ? _userManager.GetUserById(userId) ?? throw new ResourceNotFoundException() |
| 1 | 409 | | : null; |
| | 410 | |
|
| 1 | 411 | | if (!isApiKey && user is null) |
| | 412 | | { |
| 0 | 413 | | return Unauthorized("Unauthorized access"); |
| | 414 | | } |
| | 415 | |
|
| 3 | 416 | | foreach (var i in ids) |
| | 417 | | { |
| 1 | 418 | | var item = _libraryManager.GetItemById<BaseItem>(i, user); |
| 1 | 419 | | if (item is null) |
| | 420 | | { |
| 1 | 421 | | return NotFound(); |
| | 422 | | } |
| | 423 | |
|
| 0 | 424 | | if (user is not null && !item.CanDelete(user)) |
| | 425 | | { |
| 0 | 426 | | return Unauthorized("Unauthorized access"); |
| | 427 | | } |
| | 428 | |
|
| 0 | 429 | | _libraryManager.DeleteItem( |
| 0 | 430 | | item, |
| 0 | 431 | | new DeleteOptions { DeleteFileLocation = true }, |
| 0 | 432 | | true); |
| | 433 | | } |
| | 434 | |
|
| 0 | 435 | | return NoContent(); |
| | 436 | | } |
| | 437 | |
|
| | 438 | | /// <summary> |
| | 439 | | /// Get item counts. |
| | 440 | | /// </summary> |
| | 441 | | /// <param name="userId">Optional. Get counts from a specific user's library.</param> |
| | 442 | | /// <param name="isFavorite">Optional. Get counts of favorite items.</param> |
| | 443 | | /// <response code="200">Item counts returned.</response> |
| | 444 | | /// <returns>Item counts.</returns> |
| | 445 | | [HttpGet("Items/Counts")] |
| | 446 | | [Authorize] |
| | 447 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 448 | | public ActionResult<ItemCounts> GetItemCounts( |
| | 449 | | [FromQuery] Guid? userId, |
| | 450 | | [FromQuery] bool? isFavorite) |
| | 451 | | { |
| 0 | 452 | | userId = RequestHelpers.GetUserId(User, userId); |
| 0 | 453 | | var user = userId.IsNullOrEmpty() |
| 0 | 454 | | ? null |
| 0 | 455 | | : _userManager.GetUserById(userId.Value); |
| | 456 | |
|
| 0 | 457 | | var counts = new ItemCounts |
| 0 | 458 | | { |
| 0 | 459 | | AlbumCount = GetCount(BaseItemKind.MusicAlbum, user, isFavorite), |
| 0 | 460 | | EpisodeCount = GetCount(BaseItemKind.Episode, user, isFavorite), |
| 0 | 461 | | MovieCount = GetCount(BaseItemKind.Movie, user, isFavorite), |
| 0 | 462 | | SeriesCount = GetCount(BaseItemKind.Series, user, isFavorite), |
| 0 | 463 | | SongCount = GetCount(BaseItemKind.Audio, user, isFavorite), |
| 0 | 464 | | MusicVideoCount = GetCount(BaseItemKind.MusicVideo, user, isFavorite), |
| 0 | 465 | | BoxSetCount = GetCount(BaseItemKind.BoxSet, user, isFavorite), |
| 0 | 466 | | BookCount = GetCount(BaseItemKind.Book, user, isFavorite) |
| 0 | 467 | | }; |
| | 468 | |
|
| 0 | 469 | | return counts; |
| | 470 | | } |
| | 471 | |
|
| | 472 | | /// <summary> |
| | 473 | | /// Gets all parents of an item. |
| | 474 | | /// </summary> |
| | 475 | | /// <param name="itemId">The item id.</param> |
| | 476 | | /// <param name="userId">Optional. Filter by user id, and attach user data.</param> |
| | 477 | | /// <response code="200">Item parents returned.</response> |
| | 478 | | /// <response code="404">Item not found.</response> |
| | 479 | | /// <returns>Item parents.</returns> |
| | 480 | | [HttpGet("Items/{itemId}/Ancestors")] |
| | 481 | | [Authorize] |
| | 482 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 483 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 484 | | public ActionResult<IEnumerable<BaseItemDto>> GetAncestors([FromRoute, Required] Guid itemId, [FromQuery] Guid? user |
| | 485 | | { |
| 1 | 486 | | userId = RequestHelpers.GetUserId(User, userId); |
| 1 | 487 | | var user = userId.IsNullOrEmpty() |
| 1 | 488 | | ? null |
| 1 | 489 | | : _userManager.GetUserById(userId.Value); |
| 1 | 490 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| 1 | 491 | | if (item is null) |
| | 492 | | { |
| 1 | 493 | | return NotFound(); |
| | 494 | | } |
| | 495 | |
|
| 0 | 496 | | var baseItemDtos = new List<BaseItemDto>(); |
| | 497 | |
|
| 0 | 498 | | var dtoOptions = new DtoOptions().AddClientFields(User); |
| 0 | 499 | | BaseItem? parent = item.GetParent(); |
| | 500 | |
|
| 0 | 501 | | while (parent is not null) |
| | 502 | | { |
| 0 | 503 | | if (user is not null) |
| | 504 | | { |
| 0 | 505 | | parent = TranslateParentItem(parent, user); |
| 0 | 506 | | if (parent is null) |
| | 507 | | { |
| | 508 | | break; |
| | 509 | | } |
| | 510 | | } |
| | 511 | |
|
| 0 | 512 | | baseItemDtos.Add(_dtoService.GetBaseItemDto(parent, dtoOptions, user)); |
| | 513 | |
|
| 0 | 514 | | parent = parent.GetParent(); |
| | 515 | | } |
| | 516 | |
|
| 0 | 517 | | return baseItemDtos; |
| | 518 | | } |
| | 519 | |
|
| | 520 | | /// <summary> |
| | 521 | | /// Gets a list of physical paths from virtual folders. |
| | 522 | | /// </summary> |
| | 523 | | /// <response code="200">Physical paths returned.</response> |
| | 524 | | /// <returns>List of physical paths.</returns> |
| | 525 | | [HttpGet("Library/PhysicalPaths")] |
| | 526 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | 527 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 528 | | public ActionResult<IEnumerable<string>> GetPhysicalPaths() |
| | 529 | | { |
| 0 | 530 | | return Ok(_libraryManager.RootFolder.Children |
| 0 | 531 | | .SelectMany(c => c.PhysicalLocations)); |
| | 532 | | } |
| | 533 | |
|
| | 534 | | /// <summary> |
| | 535 | | /// Gets all user media folders. |
| | 536 | | /// </summary> |
| | 537 | | /// <param name="isHidden">Optional. Filter by folders that are marked hidden, or not.</param> |
| | 538 | | /// <response code="200">Media folders returned.</response> |
| | 539 | | /// <returns>List of user media folders.</returns> |
| | 540 | | [HttpGet("Library/MediaFolders")] |
| | 541 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | 542 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 543 | | public ActionResult<QueryResult<BaseItemDto>> GetMediaFolders([FromQuery] bool? isHidden) |
| | 544 | | { |
| 0 | 545 | | var items = _libraryManager.GetUserRootFolder().Children |
| 0 | 546 | | .Concat(_libraryManager.RootFolder.VirtualChildren) |
| 0 | 547 | | .Where(i => _libraryManager.GetLibraryOptions(i).Enabled) |
| 0 | 548 | | .OrderBy(i => i.SortName) |
| 0 | 549 | | .ToList(); |
| | 550 | |
|
| 0 | 551 | | if (isHidden.HasValue) |
| | 552 | | { |
| 0 | 553 | | var val = isHidden.Value; |
| | 554 | |
|
| 0 | 555 | | items = items.Where(i => i.IsHidden == val).ToList(); |
| | 556 | | } |
| | 557 | |
|
| 0 | 558 | | var dtoOptions = new DtoOptions().AddClientFields(User); |
| 0 | 559 | | var resultArray = _dtoService.GetBaseItemDtos(items, dtoOptions); |
| 0 | 560 | | return new QueryResult<BaseItemDto>(resultArray); |
| | 561 | | } |
| | 562 | |
|
| | 563 | | /// <summary> |
| | 564 | | /// Reports that new episodes of a series have been added by an external source. |
| | 565 | | /// </summary> |
| | 566 | | /// <param name="tvdbId">The tvdbId.</param> |
| | 567 | | /// <response code="204">Report success.</response> |
| | 568 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | 569 | | [HttpPost("Library/Series/Added", Name = "PostAddedSeries")] |
| | 570 | | [HttpPost("Library/Series/Updated")] |
| | 571 | | [Authorize] |
| | 572 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | 573 | | public ActionResult PostUpdatedSeries([FromQuery] string? tvdbId) |
| | 574 | | { |
| 0 | 575 | | var series = _libraryManager.GetItemList(new InternalItemsQuery |
| 0 | 576 | | { |
| 0 | 577 | | IncludeItemTypes = new[] { BaseItemKind.Series }, |
| 0 | 578 | | DtoOptions = new DtoOptions(false) |
| 0 | 579 | | { |
| 0 | 580 | | EnableImages = false |
| 0 | 581 | | } |
| 0 | 582 | | }).Where(i => string.Equals(tvdbId, i.GetProviderId(MediaBrowser.Model.Entities.MetadataProvider.Tvdb), StringCo |
| | 583 | |
|
| 0 | 584 | | foreach (var item in series) |
| | 585 | | { |
| 0 | 586 | | _libraryMonitor.ReportFileSystemChanged(item.Path); |
| | 587 | | } |
| | 588 | |
|
| 0 | 589 | | return NoContent(); |
| | 590 | | } |
| | 591 | |
|
| | 592 | | /// <summary> |
| | 593 | | /// Reports that new movies have been added by an external source. |
| | 594 | | /// </summary> |
| | 595 | | /// <param name="tmdbId">The tmdbId.</param> |
| | 596 | | /// <param name="imdbId">The imdbId.</param> |
| | 597 | | /// <response code="204">Report success.</response> |
| | 598 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | 599 | | [HttpPost("Library/Movies/Added", Name = "PostAddedMovies")] |
| | 600 | | [HttpPost("Library/Movies/Updated")] |
| | 601 | | [Authorize] |
| | 602 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | 603 | | public ActionResult PostUpdatedMovies([FromQuery] string? tmdbId, [FromQuery] string? imdbId) |
| | 604 | | { |
| 0 | 605 | | var movies = _libraryManager.GetItemList(new InternalItemsQuery |
| 0 | 606 | | { |
| 0 | 607 | | IncludeItemTypes = new[] { BaseItemKind.Movie }, |
| 0 | 608 | | DtoOptions = new DtoOptions(false) |
| 0 | 609 | | { |
| 0 | 610 | | EnableImages = false |
| 0 | 611 | | } |
| 0 | 612 | | }); |
| | 613 | |
|
| 0 | 614 | | if (!string.IsNullOrWhiteSpace(imdbId)) |
| | 615 | | { |
| 0 | 616 | | movies = movies.Where(i => string.Equals(imdbId, i.GetProviderId(MediaBrowser.Model.Entities.MetadataProvide |
| | 617 | | } |
| 0 | 618 | | else if (!string.IsNullOrWhiteSpace(tmdbId)) |
| | 619 | | { |
| 0 | 620 | | movies = movies.Where(i => string.Equals(tmdbId, i.GetProviderId(MediaBrowser.Model.Entities.MetadataProvide |
| | 621 | | } |
| | 622 | | else |
| | 623 | | { |
| 0 | 624 | | movies = new List<BaseItem>(); |
| | 625 | | } |
| | 626 | |
|
| 0 | 627 | | foreach (var item in movies) |
| | 628 | | { |
| 0 | 629 | | _libraryMonitor.ReportFileSystemChanged(item.Path); |
| | 630 | | } |
| | 631 | |
|
| 0 | 632 | | return NoContent(); |
| | 633 | | } |
| | 634 | |
|
| | 635 | | /// <summary> |
| | 636 | | /// Reports that new movies have been added by an external source. |
| | 637 | | /// </summary> |
| | 638 | | /// <param name="dto">The update paths.</param> |
| | 639 | | /// <response code="204">Report success.</response> |
| | 640 | | /// <returns>A <see cref="NoContentResult"/>.</returns> |
| | 641 | | [HttpPost("Library/Media/Updated")] |
| | 642 | | [Authorize] |
| | 643 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | 644 | | public ActionResult PostUpdatedMedia([FromBody, Required] MediaUpdateInfoDto dto) |
| | 645 | | { |
| 0 | 646 | | foreach (var item in dto.Updates) |
| | 647 | | { |
| 0 | 648 | | _libraryMonitor.ReportFileSystemChanged(item.Path ?? throw new ArgumentException("Item path can't be null.") |
| | 649 | | } |
| | 650 | |
|
| 0 | 651 | | return NoContent(); |
| | 652 | | } |
| | 653 | |
|
| | 654 | | /// <summary> |
| | 655 | | /// Downloads item media. |
| | 656 | | /// </summary> |
| | 657 | | /// <param name="itemId">The item id.</param> |
| | 658 | | /// <response code="200">Media downloaded.</response> |
| | 659 | | /// <response code="404">Item not found.</response> |
| | 660 | | /// <returns>A <see cref="FileResult"/> containing the media stream.</returns> |
| | 661 | | /// <exception cref="ArgumentException">User can't download or item can't be downloaded.</exception> |
| | 662 | | [HttpGet("Items/{itemId}/Download")] |
| | 663 | | [Authorize(Policy = Policies.Download)] |
| | 664 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 665 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | 666 | | [ProducesFile("video/*", "audio/*")] |
| | 667 | | public async Task<ActionResult> GetDownload([FromRoute, Required] Guid itemId) |
| | 668 | | { |
| | 669 | | var userId = User.GetUserId(); |
| | 670 | | var user = userId.IsEmpty() |
| | 671 | | ? null |
| | 672 | | : _userManager.GetUserById(userId); |
| | 673 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| | 674 | | if (item is null) |
| | 675 | | { |
| | 676 | | return NotFound(); |
| | 677 | | } |
| | 678 | |
|
| | 679 | | if (user is not null) |
| | 680 | | { |
| | 681 | | if (!item.CanDownload(user)) |
| | 682 | | { |
| | 683 | | throw new ArgumentException("Item does not support downloading"); |
| | 684 | | } |
| | 685 | | } |
| | 686 | | else |
| | 687 | | { |
| | 688 | | if (!item.CanDownload()) |
| | 689 | | { |
| | 690 | | throw new ArgumentException("Item does not support downloading"); |
| | 691 | | } |
| | 692 | | } |
| | 693 | |
|
| | 694 | | if (user is not null) |
| | 695 | | { |
| | 696 | | await LogDownloadAsync(item, user).ConfigureAwait(false); |
| | 697 | | } |
| | 698 | |
|
| | 699 | | // Quotes are valid in linux. They'll possibly cause issues here. |
| | 700 | | var filename = Path.GetFileName(item.Path)?.Replace("\"", string.Empty, StringComparison.Ordinal); |
| | 701 | |
|
| | 702 | | return PhysicalFile(item.Path, MimeTypes.GetMimeType(item.Path), filename, true); |
| | 703 | | } |
| | 704 | |
|
| | 705 | | /// <summary> |
| | 706 | | /// Gets similar items. |
| | 707 | | /// </summary> |
| | 708 | | /// <param name="itemId">The item id.</param> |
| | 709 | | /// <param name="excludeArtistIds">Exclude artist ids.</param> |
| | 710 | | /// <param name="userId">Optional. Filter by user id, and attach user data.</param> |
| | 711 | | /// <param name="limit">Optional. The maximum number of records to return.</param> |
| | 712 | | /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows mul |
| | 713 | | /// <response code="200">Similar items returned.</response> |
| | 714 | | /// <returns>A <see cref="QueryResult{BaseItemDto}"/> containing the similar items.</returns> |
| | 715 | | [HttpGet("Artists/{itemId}/Similar", Name = "GetSimilarArtists")] |
| | 716 | | [HttpGet("Items/{itemId}/Similar")] |
| | 717 | | [HttpGet("Albums/{itemId}/Similar", Name = "GetSimilarAlbums")] |
| | 718 | | [HttpGet("Shows/{itemId}/Similar", Name = "GetSimilarShows")] |
| | 719 | | [HttpGet("Movies/{itemId}/Similar", Name = "GetSimilarMovies")] |
| | 720 | | [HttpGet("Trailers/{itemId}/Similar", Name = "GetSimilarTrailers")] |
| | 721 | | [Authorize] |
| | 722 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 723 | | public ActionResult<QueryResult<BaseItemDto>> GetSimilarItems( |
| | 724 | | [FromRoute, Required] Guid itemId, |
| | 725 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] Guid[] excludeArtistIds, |
| | 726 | | [FromQuery] Guid? userId, |
| | 727 | | [FromQuery] int? limit, |
| | 728 | | [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields[] fields) |
| | 729 | | { |
| 6 | 730 | | userId = RequestHelpers.GetUserId(User, userId); |
| 6 | 731 | | var user = userId.IsNullOrEmpty() |
| 6 | 732 | | ? null |
| 6 | 733 | | : _userManager.GetUserById(userId.Value); |
| 6 | 734 | | var item = itemId.IsEmpty() |
| 6 | 735 | | ? (user is null |
| 6 | 736 | | ? _libraryManager.RootFolder |
| 6 | 737 | | : _libraryManager.GetUserRootFolder()) |
| 6 | 738 | | : _libraryManager.GetItemById<BaseItem>(itemId, user); |
| 6 | 739 | | if (item is null) |
| | 740 | | { |
| 6 | 741 | | return NotFound(); |
| | 742 | | } |
| | 743 | |
|
| 0 | 744 | | if (item is Episode || (item is IItemByName && item is not MusicArtist)) |
| | 745 | | { |
| 0 | 746 | | return new QueryResult<BaseItemDto>(); |
| | 747 | | } |
| | 748 | |
|
| 0 | 749 | | var dtoOptions = new DtoOptions { Fields = fields } |
| 0 | 750 | | .AddClientFields(User); |
| | 751 | |
|
| 0 | 752 | | var program = item as IHasProgramAttributes; |
| 0 | 753 | | bool? isMovie = item is Movie || (program is not null && program.IsMovie) || item is Trailer; |
| 0 | 754 | | bool? isSeries = item is Series || (program is not null && program.IsSeries); |
| | 755 | |
|
| 0 | 756 | | var includeItemTypes = new List<BaseItemKind>(); |
| 0 | 757 | | if (isMovie.Value) |
| | 758 | | { |
| 0 | 759 | | includeItemTypes.Add(BaseItemKind.Movie); |
| 0 | 760 | | if (_serverConfigurationManager.Configuration.EnableExternalContentInSuggestions) |
| | 761 | | { |
| 0 | 762 | | includeItemTypes.Add(BaseItemKind.Trailer); |
| 0 | 763 | | includeItemTypes.Add(BaseItemKind.LiveTvProgram); |
| | 764 | | } |
| | 765 | | } |
| 0 | 766 | | else if (isSeries.Value) |
| | 767 | | { |
| 0 | 768 | | includeItemTypes.Add(BaseItemKind.Series); |
| | 769 | | } |
| | 770 | | else |
| | 771 | | { |
| | 772 | | // For non series and movie types these columns are typically null |
| | 773 | | // isSeries = null; |
| 0 | 774 | | isMovie = null; |
| 0 | 775 | | includeItemTypes.Add(item.GetBaseItemKind()); |
| | 776 | | } |
| | 777 | |
|
| 0 | 778 | | var query = new InternalItemsQuery(user) |
| 0 | 779 | | { |
| 0 | 780 | | Genres = item.Genres, |
| 0 | 781 | | Limit = limit, |
| 0 | 782 | | IncludeItemTypes = includeItemTypes.ToArray(), |
| 0 | 783 | | SimilarTo = item, |
| 0 | 784 | | DtoOptions = dtoOptions, |
| 0 | 785 | | EnableTotalRecordCount = !isMovie ?? true, |
| 0 | 786 | | EnableGroupByMetadataKey = isMovie ?? false, |
| 0 | 787 | | MinSimilarityScore = 2 // A remnant from album/artist scoring |
| 0 | 788 | | }; |
| | 789 | |
|
| | 790 | | // ExcludeArtistIds |
| 0 | 791 | | if (excludeArtistIds.Length != 0) |
| | 792 | | { |
| 0 | 793 | | query.ExcludeArtistIds = excludeArtistIds; |
| | 794 | | } |
| | 795 | |
|
| 0 | 796 | | List<BaseItem> itemsResult = _libraryManager.GetItemList(query); |
| | 797 | |
|
| 0 | 798 | | var returnList = _dtoService.GetBaseItemDtos(itemsResult, dtoOptions, user); |
| | 799 | |
|
| 0 | 800 | | return new QueryResult<BaseItemDto>( |
| 0 | 801 | | query.StartIndex, |
| 0 | 802 | | itemsResult.Count, |
| 0 | 803 | | returnList); |
| | 804 | | } |
| | 805 | |
|
| | 806 | | /// <summary> |
| | 807 | | /// Gets the library options info. |
| | 808 | | /// </summary> |
| | 809 | | /// <param name="libraryContentType">Library content type.</param> |
| | 810 | | /// <param name="isNewLibrary">Whether this is a new library.</param> |
| | 811 | | /// <response code="200">Library options info returned.</response> |
| | 812 | | /// <returns>Library options info.</returns> |
| | 813 | | [HttpGet("Libraries/AvailableOptions")] |
| | 814 | | [Authorize(Policy = Policies.FirstTimeSetupOrDefault)] |
| | 815 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | 816 | | public ActionResult<LibraryOptionsResultDto> GetLibraryOptionsInfo( |
| | 817 | | [FromQuery] CollectionType? libraryContentType, |
| | 818 | | [FromQuery] bool isNewLibrary = false) |
| | 819 | | { |
| 0 | 820 | | var result = new LibraryOptionsResultDto(); |
| | 821 | |
|
| 0 | 822 | | var types = GetRepresentativeItemTypes(libraryContentType); |
| 0 | 823 | | var typesList = types.ToList(); |
| | 824 | |
|
| 0 | 825 | | var plugins = _providerManager.GetAllMetadataPlugins() |
| 0 | 826 | | .Where(i => types.Contains(i.ItemType, StringComparison.OrdinalIgnoreCase)) |
| 0 | 827 | | .OrderBy(i => typesList.IndexOf(i.ItemType)) |
| 0 | 828 | | .ToList(); |
| | 829 | |
|
| 0 | 830 | | result.MetadataSavers = plugins |
| 0 | 831 | | .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataSaver)) |
| 0 | 832 | | .Select(i => new LibraryOptionInfoDto |
| 0 | 833 | | { |
| 0 | 834 | | Name = i.Name, |
| 0 | 835 | | DefaultEnabled = IsSaverEnabledByDefault(i.Name, types, isNewLibrary) |
| 0 | 836 | | }) |
| 0 | 837 | | .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase) |
| 0 | 838 | | .ToArray(); |
| | 839 | |
|
| 0 | 840 | | result.MetadataReaders = plugins |
| 0 | 841 | | .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.LocalMetadataProvider)) |
| 0 | 842 | | .Select(i => new LibraryOptionInfoDto |
| 0 | 843 | | { |
| 0 | 844 | | Name = i.Name, |
| 0 | 845 | | DefaultEnabled = true |
| 0 | 846 | | }) |
| 0 | 847 | | .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase) |
| 0 | 848 | | .ToArray(); |
| | 849 | |
|
| 0 | 850 | | result.SubtitleFetchers = plugins |
| 0 | 851 | | .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.SubtitleFetcher)) |
| 0 | 852 | | .Select(i => new LibraryOptionInfoDto |
| 0 | 853 | | { |
| 0 | 854 | | Name = i.Name, |
| 0 | 855 | | DefaultEnabled = true |
| 0 | 856 | | }) |
| 0 | 857 | | .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase) |
| 0 | 858 | | .ToArray(); |
| | 859 | |
|
| 0 | 860 | | result.LyricFetchers = plugins |
| 0 | 861 | | .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.LyricFetcher)) |
| 0 | 862 | | .Select(i => new LibraryOptionInfoDto |
| 0 | 863 | | { |
| 0 | 864 | | Name = i.Name, |
| 0 | 865 | | DefaultEnabled = true |
| 0 | 866 | | }) |
| 0 | 867 | | .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase) |
| 0 | 868 | | .ToArray(); |
| | 869 | |
|
| 0 | 870 | | var typeOptions = new List<LibraryTypeOptionsDto>(); |
| | 871 | |
|
| 0 | 872 | | foreach (var type in types) |
| | 873 | | { |
| 0 | 874 | | TypeOptions.DefaultImageOptions.TryGetValue(type, out var defaultImageOptions); |
| | 875 | |
|
| 0 | 876 | | typeOptions.Add(new LibraryTypeOptionsDto |
| 0 | 877 | | { |
| 0 | 878 | | Type = type, |
| 0 | 879 | |
|
| 0 | 880 | | MetadataFetchers = plugins |
| 0 | 881 | | .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase)) |
| 0 | 882 | | .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.MetadataFetcher)) |
| 0 | 883 | | .Select(i => new LibraryOptionInfoDto |
| 0 | 884 | | { |
| 0 | 885 | | Name = i.Name, |
| 0 | 886 | | DefaultEnabled = IsMetadataFetcherEnabledByDefault(i.Name, type, isNewLibrary) |
| 0 | 887 | | }) |
| 0 | 888 | | .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase) |
| 0 | 889 | | .ToArray(), |
| 0 | 890 | |
|
| 0 | 891 | | ImageFetchers = plugins |
| 0 | 892 | | .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase)) |
| 0 | 893 | | .SelectMany(i => i.Plugins.Where(p => p.Type == MetadataPluginType.ImageFetcher)) |
| 0 | 894 | | .Select(i => new LibraryOptionInfoDto |
| 0 | 895 | | { |
| 0 | 896 | | Name = i.Name, |
| 0 | 897 | | DefaultEnabled = IsImageFetcherEnabledByDefault(i.Name, type, isNewLibrary) |
| 0 | 898 | | }) |
| 0 | 899 | | .DistinctBy(i => i.Name, StringComparer.OrdinalIgnoreCase) |
| 0 | 900 | | .ToArray(), |
| 0 | 901 | |
|
| 0 | 902 | | SupportedImageTypes = plugins |
| 0 | 903 | | .Where(i => string.Equals(i.ItemType, type, StringComparison.OrdinalIgnoreCase)) |
| 0 | 904 | | .SelectMany(i => i.SupportedImageTypes ?? Array.Empty<ImageType>()) |
| 0 | 905 | | .Distinct() |
| 0 | 906 | | .ToArray(), |
| 0 | 907 | |
|
| 0 | 908 | | DefaultImageOptions = defaultImageOptions ?? Array.Empty<ImageOption>() |
| 0 | 909 | | }); |
| | 910 | | } |
| | 911 | |
|
| 0 | 912 | | result.TypeOptions = typeOptions.ToArray(); |
| | 913 | |
|
| 0 | 914 | | return result; |
| | 915 | | } |
| | 916 | |
|
| | 917 | | private int GetCount(BaseItemKind itemKind, User? user, bool? isFavorite) |
| | 918 | | { |
| 0 | 919 | | var query = new InternalItemsQuery(user) |
| 0 | 920 | | { |
| 0 | 921 | | IncludeItemTypes = new[] { itemKind }, |
| 0 | 922 | | Limit = 0, |
| 0 | 923 | | Recursive = true, |
| 0 | 924 | | IsVirtualItem = false, |
| 0 | 925 | | IsFavorite = isFavorite, |
| 0 | 926 | | DtoOptions = new DtoOptions(false) |
| 0 | 927 | | { |
| 0 | 928 | | EnableImages = false |
| 0 | 929 | | } |
| 0 | 930 | | }; |
| | 931 | |
|
| 0 | 932 | | return _libraryManager.GetItemsResult(query).TotalRecordCount; |
| | 933 | | } |
| | 934 | |
|
| | 935 | | private BaseItem? TranslateParentItem(BaseItem item, User user) |
| | 936 | | { |
| 0 | 937 | | return item.GetParent() is AggregateFolder |
| 0 | 938 | | ? _libraryManager.GetUserRootFolder().GetChildren(user, true) |
| 0 | 939 | | .FirstOrDefault(i => i.PhysicalLocations.Contains(item.Path)) |
| 0 | 940 | | : item; |
| | 941 | | } |
| | 942 | |
|
| | 943 | | private async Task LogDownloadAsync(BaseItem item, User user) |
| | 944 | | { |
| | 945 | | try |
| | 946 | | { |
| | 947 | | await _activityManager.CreateAsync(new ActivityLog( |
| | 948 | | string.Format(CultureInfo.InvariantCulture, _localization.GetLocalizedString("UserDownloadingItemWithVal |
| | 949 | | "UserDownloadingContent", |
| | 950 | | User.GetUserId()) |
| | 951 | | { |
| | 952 | | ShortOverview = string.Format(CultureInfo.InvariantCulture, _localization.GetLocalizedString("AppDeviceV |
| | 953 | | ItemId = item.Id.ToString("N", CultureInfo.InvariantCulture) |
| | 954 | | }).ConfigureAwait(false); |
| | 955 | | } |
| | 956 | | catch |
| | 957 | | { |
| | 958 | | // Logged at lower levels |
| | 959 | | } |
| | 960 | | } |
| | 961 | |
|
| | 962 | | private static string[] GetRepresentativeItemTypes(CollectionType? contentType) |
| | 963 | | { |
| 0 | 964 | | return contentType switch |
| 0 | 965 | | { |
| 0 | 966 | | CollectionType.boxsets => new[] { "BoxSet" }, |
| 0 | 967 | | CollectionType.playlists => new[] { "Playlist" }, |
| 0 | 968 | | CollectionType.movies => new[] { "Movie" }, |
| 0 | 969 | | CollectionType.tvshows => new[] { "Series", "Season", "Episode" }, |
| 0 | 970 | | CollectionType.books => new[] { "Book" }, |
| 0 | 971 | | CollectionType.music => new[] { "MusicArtist", "MusicAlbum", "Audio", "MusicVideo" }, |
| 0 | 972 | | CollectionType.homevideos => new[] { "Video", "Photo" }, |
| 0 | 973 | | CollectionType.photos => new[] { "Video", "Photo" }, |
| 0 | 974 | | CollectionType.musicvideos => new[] { "MusicVideo" }, |
| 0 | 975 | | _ => new[] { "Series", "Season", "Episode", "Movie" } |
| 0 | 976 | | }; |
| | 977 | | } |
| | 978 | |
|
| | 979 | | private bool IsSaverEnabledByDefault(string name, string[] itemTypes, bool isNewLibrary) |
| | 980 | | { |
| 0 | 981 | | if (isNewLibrary) |
| | 982 | | { |
| 0 | 983 | | return false; |
| | 984 | | } |
| | 985 | |
|
| 0 | 986 | | var metadataOptions = _serverConfigurationManager.Configuration.MetadataOptions |
| 0 | 987 | | .Where(i => itemTypes.Contains(i.ItemType ?? string.Empty, StringComparison.OrdinalIgnoreCase)) |
| 0 | 988 | | .ToArray(); |
| | 989 | |
|
| 0 | 990 | | return metadataOptions.Length == 0 || metadataOptions.Any(i => !i.DisabledMetadataSavers.Contains(name, StringCo |
| | 991 | | } |
| | 992 | |
|
| | 993 | | private bool IsMetadataFetcherEnabledByDefault(string name, string type, bool isNewLibrary) |
| | 994 | | { |
| 0 | 995 | | if (isNewLibrary) |
| | 996 | | { |
| 0 | 997 | | if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase)) |
| | 998 | | { |
| 0 | 999 | | return !(string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase) |
| 0 | 1000 | | || string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase) |
| 0 | 1001 | | || string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase)); |
| | 1002 | | } |
| | 1003 | |
|
| 0 | 1004 | | return string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase) |
| 0 | 1005 | | || string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase) |
| 0 | 1006 | | || string.Equals(name, "MusicBrainz", StringComparison.OrdinalIgnoreCase); |
| | 1007 | | } |
| | 1008 | |
|
| 0 | 1009 | | var metadataOptions = _serverConfigurationManager.GetMetadataOptionsForType(type); |
| 0 | 1010 | | return metadataOptions is null || !metadataOptions.DisabledMetadataFetchers.Contains(name, StringComparison.Ordi |
| | 1011 | | } |
| | 1012 | |
|
| | 1013 | | private bool IsImageFetcherEnabledByDefault(string name, string type, bool isNewLibrary) |
| | 1014 | | { |
| 0 | 1015 | | if (isNewLibrary) |
| | 1016 | | { |
| 0 | 1017 | | if (string.Equals(name, "TheMovieDb", StringComparison.OrdinalIgnoreCase)) |
| | 1018 | | { |
| 0 | 1019 | | return !string.Equals(type, "Series", StringComparison.OrdinalIgnoreCase) |
| 0 | 1020 | | && !string.Equals(type, "Season", StringComparison.OrdinalIgnoreCase) |
| 0 | 1021 | | && !string.Equals(type, "Episode", StringComparison.OrdinalIgnoreCase) |
| 0 | 1022 | | && !string.Equals(type, "MusicVideo", StringComparison.OrdinalIgnoreCase); |
| | 1023 | | } |
| | 1024 | |
|
| 0 | 1025 | | return string.Equals(name, "TheTVDB", StringComparison.OrdinalIgnoreCase) |
| 0 | 1026 | | || string.Equals(name, "Screen Grabber", StringComparison.OrdinalIgnoreCase) |
| 0 | 1027 | | || string.Equals(name, "TheAudioDB", StringComparison.OrdinalIgnoreCase) |
| 0 | 1028 | | || string.Equals(name, "Image Extractor", StringComparison.OrdinalIgnoreCase); |
| | 1029 | | } |
| | 1030 | |
|
| 0 | 1031 | | var metadataOptions = _serverConfigurationManager.GetMetadataOptionsForType(type); |
| 0 | 1032 | | return metadataOptions is null || !metadataOptions.DisabledImageFetchers.Contains(name, StringComparison.Ordinal |
| | 1033 | | } |
| | 1034 | | } |