< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.ItemUpdateController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/ItemUpdateController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 113
Coverable lines: 113
Total lines: 538
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 38
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetMetadataEditorInfo(...)0%600240%
UpdateItemContentType(...)0%2040%
GetSeriesStatus(...)0%620%
NormalizeDateTime(...)100%210%
GetContentTypeOptions(...)0%7280%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/ItemUpdateController.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.ComponentModel.DataAnnotations;
 4using System.Linq;
 5using System.Threading;
 6using System.Threading.Tasks;
 7using Jellyfin.Api.Constants;
 8using Jellyfin.Api.Extensions;
 9using Jellyfin.Api.Helpers;
 10using Jellyfin.Data.Enums;
 11using MediaBrowser.Common.Api;
 12using MediaBrowser.Controller.Configuration;
 13using MediaBrowser.Controller.Entities;
 14using MediaBrowser.Controller.Entities.Audio;
 15using MediaBrowser.Controller.Entities.TV;
 16using MediaBrowser.Controller.Library;
 17using MediaBrowser.Controller.LiveTv;
 18using MediaBrowser.Controller.Providers;
 19using MediaBrowser.Model.Dto;
 20using MediaBrowser.Model.Entities;
 21using MediaBrowser.Model.Globalization;
 22using MediaBrowser.Model.IO;
 23using Microsoft.AspNetCore.Authorization;
 24using Microsoft.AspNetCore.Http;
 25using Microsoft.AspNetCore.Mvc;
 26
 27namespace Jellyfin.Api.Controllers;
 28
 29/// <summary>
 30/// Item update controller.
 31/// </summary>
 32[Route("")]
 33[Authorize(Policy = Policies.RequiresElevation)]
 34public class ItemUpdateController : BaseJellyfinApiController
 35{
 36    private readonly ILibraryManager _libraryManager;
 37    private readonly IProviderManager _providerManager;
 38    private readonly ILocalizationManager _localizationManager;
 39    private readonly IFileSystem _fileSystem;
 40    private readonly IServerConfigurationManager _serverConfigurationManager;
 41
 42    /// <summary>
 43    /// Initializes a new instance of the <see cref="ItemUpdateController"/> class.
 44    /// </summary>
 45    /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param>
 46    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 47    /// <param name="providerManager">Instance of the <see cref="IProviderManager"/> interface.</param>
 48    /// <param name="localizationManager">Instance of the <see cref="ILocalizationManager"/> interface.</param>
 49    /// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</p
 050    public ItemUpdateController(
 051        IFileSystem fileSystem,
 052        ILibraryManager libraryManager,
 053        IProviderManager providerManager,
 054        ILocalizationManager localizationManager,
 055        IServerConfigurationManager serverConfigurationManager)
 56    {
 057        _libraryManager = libraryManager;
 058        _providerManager = providerManager;
 059        _localizationManager = localizationManager;
 060        _fileSystem = fileSystem;
 061        _serverConfigurationManager = serverConfigurationManager;
 062    }
 63
 64    /// <summary>
 65    /// Updates an item.
 66    /// </summary>
 67    /// <param name="itemId">The item id.</param>
 68    /// <param name="request">The new item properties.</param>
 69    /// <response code="204">Item updated.</response>
 70    /// <response code="404">Item not found.</response>
 71    /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the item could not be
 72    [HttpPost("Items/{itemId}")]
 73    [ProducesResponseType(StatusCodes.Status204NoContent)]
 74    [ProducesResponseType(StatusCodes.Status404NotFound)]
 75    public async Task<ActionResult> UpdateItem([FromRoute, Required] Guid itemId, [FromBody, Required] BaseItemDto reque
 76    {
 77        var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
 78        if (item is null)
 79        {
 80            return NotFound();
 81        }
 82
 83        var newLockData = request.LockData ?? false;
 84        var isLockedChanged = item.IsLocked != newLockData;
 85
 86        var series = item as Series;
 87        var displayOrderChanged = series is not null && !string.Equals(
 88            series.DisplayOrder ?? string.Empty,
 89            request.DisplayOrder ?? string.Empty,
 90            StringComparison.OrdinalIgnoreCase);
 91
 92        // Do this first so that metadata savers can pull the updates from the database.
 93        if (request.People is not null)
 94        {
 95            _libraryManager.UpdatePeople(
 96                item,
 97                request.People.Select(x => new PersonInfo
 98                {
 99                    Name = x.Name,
 100                    Role = x.Role,
 101                    Type = x.Type
 102                }).ToList());
 103        }
 104
 105        await UpdateItem(request, item).ConfigureAwait(false);
 106
 107        item.OnMetadataChanged();
 108
 109        await item.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).ConfigureAwait(false);
 110
 111        if (isLockedChanged && item.IsFolder)
 112        {
 113            var folder = (Folder)item;
 114
 115            foreach (var child in folder.GetRecursiveChildren())
 116            {
 117                child.IsLocked = newLockData;
 118                await child.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).ConfigureAwait(
 119            }
 120        }
 121
 122        if (displayOrderChanged)
 123        {
 124            _providerManager.QueueRefresh(
 125                series!.Id,
 126                new MetadataRefreshOptions(new DirectoryService(_fileSystem))
 127                {
 128                    MetadataRefreshMode = MetadataRefreshMode.FullRefresh,
 129                    ImageRefreshMode = MetadataRefreshMode.FullRefresh,
 130                    ReplaceAllMetadata = true
 131                },
 132                RefreshPriority.High);
 133        }
 134
 135        return NoContent();
 136    }
 137
 138    /// <summary>
 139    /// Gets metadata editor info for an item.
 140    /// </summary>
 141    /// <param name="itemId">The item id.</param>
 142    /// <response code="200">Item metadata editor returned.</response>
 143    /// <response code="404">Item not found.</response>
 144    /// <returns>An <see cref="OkResult"/> on success containing the metadata editor, or a <see cref="NotFoundResult"/> 
 145    [HttpGet("Items/{itemId}/MetadataEditor")]
 146    [ProducesResponseType(StatusCodes.Status200OK)]
 147    [ProducesResponseType(StatusCodes.Status404NotFound)]
 148    public ActionResult<MetadataEditorInfo> GetMetadataEditorInfo([FromRoute, Required] Guid itemId)
 149    {
 0150        var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
 0151        if (item is null)
 152        {
 0153            return NotFound();
 154        }
 155
 0156        var info = new MetadataEditorInfo
 0157        {
 0158            ParentalRatingOptions = _localizationManager.GetParentalRatings().ToList(),
 0159            ExternalIdInfos = _providerManager.GetExternalIdInfos(item).ToArray(),
 0160            Countries = _localizationManager.GetCountries().ToArray(),
 0161            Cultures = _localizationManager.GetCultures().ToArray()
 0162        };
 163
 0164        if (!item.IsVirtualItem
 0165            && item is not ICollectionFolder
 0166            && item is not UserView
 0167            && item is not AggregateFolder
 0168            && item is not LiveTvChannel
 0169            && item is not IItemByName
 0170            && item.SourceType == SourceType.Library)
 171        {
 0172            var inheritedContentType = _libraryManager.GetInheritedContentType(item);
 0173            var configuredContentType = _libraryManager.GetConfiguredContentType(item);
 174
 0175            if (inheritedContentType is null || configuredContentType is not null)
 176            {
 0177                info.ContentTypeOptions = GetContentTypeOptions(true).ToArray();
 0178                info.ContentType = configuredContentType;
 179
 0180                if (inheritedContentType is null || inheritedContentType == CollectionType.tvshows)
 181                {
 0182                    info.ContentTypeOptions = info.ContentTypeOptions
 0183                        .Where(i => string.IsNullOrWhiteSpace(i.Value)
 0184                                    || string.Equals(i.Value, "TvShows", StringComparison.OrdinalIgnoreCase))
 0185                        .ToArray();
 186                }
 187            }
 188        }
 189
 0190        return info;
 191    }
 192
 193    /// <summary>
 194    /// Updates an item's content type.
 195    /// </summary>
 196    /// <param name="itemId">The item id.</param>
 197    /// <param name="contentType">The content type of the item.</param>
 198    /// <response code="204">Item content type updated.</response>
 199    /// <response code="404">Item not found.</response>
 200    /// <returns>An <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the item could not be
 201    [HttpPost("Items/{itemId}/ContentType")]
 202    [ProducesResponseType(StatusCodes.Status204NoContent)]
 203    [ProducesResponseType(StatusCodes.Status404NotFound)]
 204    public ActionResult UpdateItemContentType([FromRoute, Required] Guid itemId, [FromQuery] string? contentType)
 205    {
 0206        var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
 0207        if (item is null)
 208        {
 0209            return NotFound();
 210        }
 211
 0212        var path = item.ContainingFolderPath;
 213
 0214        var types = _serverConfigurationManager.Configuration.ContentTypes
 0215            .Where(i => !string.IsNullOrWhiteSpace(i.Name))
 0216            .Where(i => !string.Equals(i.Name, path, StringComparison.OrdinalIgnoreCase))
 0217            .ToList();
 218
 0219        if (!string.IsNullOrWhiteSpace(contentType))
 220        {
 0221            types.Add(new NameValuePair
 0222            {
 0223                Name = path,
 0224                Value = contentType
 0225            });
 226        }
 227
 0228        _serverConfigurationManager.Configuration.ContentTypes = types.ToArray();
 0229        _serverConfigurationManager.SaveConfiguration();
 0230        return NoContent();
 231    }
 232
 233    private async Task UpdateItem(BaseItemDto request, BaseItem item)
 234    {
 235        item.Name = request.Name;
 236        item.ForcedSortName = request.ForcedSortName;
 237
 238        item.OriginalTitle = string.IsNullOrWhiteSpace(request.OriginalTitle) ? null : request.OriginalTitle;
 239
 240        item.CriticRating = request.CriticRating;
 241
 242        item.CommunityRating = request.CommunityRating;
 243        item.IndexNumber = request.IndexNumber;
 244        item.ParentIndexNumber = request.ParentIndexNumber;
 245        item.Overview = request.Overview;
 246        item.Genres = request.Genres;
 247
 248        if (item is Episode episode)
 249        {
 250            episode.AirsAfterSeasonNumber = request.AirsAfterSeasonNumber;
 251            episode.AirsBeforeEpisodeNumber = request.AirsBeforeEpisodeNumber;
 252            episode.AirsBeforeSeasonNumber = request.AirsBeforeSeasonNumber;
 253        }
 254
 255        if (request.Height is not null && item is LiveTvChannel channel)
 256        {
 257            channel.Height = request.Height.Value;
 258        }
 259
 260        if (request.Taglines is not null)
 261        {
 262            item.Tagline = request.Taglines.FirstOrDefault();
 263        }
 264
 265        if (request.Studios is not null)
 266        {
 267            item.Studios = Array.ConvertAll(request.Studios, x => x.Name);
 268        }
 269
 270        if (request.DateCreated.HasValue)
 271        {
 272            item.DateCreated = NormalizeDateTime(request.DateCreated.Value);
 273        }
 274
 275        item.EndDate = request.EndDate.HasValue ? NormalizeDateTime(request.EndDate.Value) : null;
 276        item.PremiereDate = request.PremiereDate.HasValue ? NormalizeDateTime(request.PremiereDate.Value) : null;
 277        item.ProductionYear = request.ProductionYear;
 278
 279        request.OfficialRating = string.IsNullOrWhiteSpace(request.OfficialRating) ? null : request.OfficialRating;
 280        item.OfficialRating = request.OfficialRating;
 281        item.CustomRating = request.CustomRating;
 282
 283        var currentTags = item.Tags;
 284        var newTags = request.Tags;
 285        var removedTags = currentTags.Except(newTags).ToList();
 286        var addedTags = newTags.Except(currentTags).ToList();
 287        item.Tags = newTags;
 288
 289        if (item is Series rseries)
 290        {
 291            foreach (var season in rseries.Children.OfType<Season>())
 292            {
 293                if (!season.LockedFields.Contains(MetadataField.OfficialRating))
 294                {
 295                    season.OfficialRating = request.OfficialRating;
 296                }
 297
 298                season.CustomRating = request.CustomRating;
 299
 300                if (!season.LockedFields.Contains(MetadataField.Tags))
 301                {
 302                    season.Tags = season.Tags.Concat(addedTags).Except(removedTags).Distinct().ToArray();
 303                }
 304
 305                season.OnMetadataChanged();
 306                await season.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).ConfigureAwait
 307
 308                foreach (var ep in season.Children.OfType<Episode>())
 309                {
 310                    if (!ep.LockedFields.Contains(MetadataField.OfficialRating))
 311                    {
 312                        ep.OfficialRating = request.OfficialRating;
 313                    }
 314
 315                    ep.CustomRating = request.CustomRating;
 316
 317                    if (!ep.LockedFields.Contains(MetadataField.Tags))
 318                    {
 319                        ep.Tags = ep.Tags.Concat(addedTags).Except(removedTags).Distinct().ToArray();
 320                    }
 321
 322                    ep.OnMetadataChanged();
 323                    await ep.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).ConfigureAwait
 324                }
 325            }
 326        }
 327        else if (item is Season season)
 328        {
 329            foreach (var ep in season.Children.OfType<Episode>())
 330            {
 331                if (!ep.LockedFields.Contains(MetadataField.OfficialRating))
 332                {
 333                    ep.OfficialRating = request.OfficialRating;
 334                }
 335
 336                ep.CustomRating = request.CustomRating;
 337
 338                if (!ep.LockedFields.Contains(MetadataField.Tags))
 339                {
 340                    ep.Tags = ep.Tags.Concat(addedTags).Except(removedTags).Distinct().ToArray();
 341                }
 342
 343                ep.OnMetadataChanged();
 344                await ep.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).ConfigureAwait(fal
 345            }
 346        }
 347        else if (item is MusicAlbum album)
 348        {
 349            foreach (BaseItem track in album.Children)
 350            {
 351                if (!track.LockedFields.Contains(MetadataField.OfficialRating))
 352                {
 353                    track.OfficialRating = request.OfficialRating;
 354                }
 355
 356                track.CustomRating = request.CustomRating;
 357
 358                if (!track.LockedFields.Contains(MetadataField.Tags))
 359                {
 360                    track.Tags = track.Tags.Concat(addedTags).Except(removedTags).Distinct().ToArray();
 361                }
 362
 363                track.OnMetadataChanged();
 364                await track.UpdateToRepositoryAsync(ItemUpdateType.MetadataEdit, CancellationToken.None).ConfigureAwait(
 365            }
 366        }
 367
 368        if (request.ProductionLocations is not null)
 369        {
 370            item.ProductionLocations = request.ProductionLocations;
 371        }
 372
 373        item.PreferredMetadataCountryCode = request.PreferredMetadataCountryCode;
 374        item.PreferredMetadataLanguage = request.PreferredMetadataLanguage;
 375
 376        if (item is IHasDisplayOrder hasDisplayOrder)
 377        {
 378            hasDisplayOrder.DisplayOrder = request.DisplayOrder;
 379        }
 380
 381        if (item is IHasAspectRatio hasAspectRatio)
 382        {
 383            hasAspectRatio.AspectRatio = request.AspectRatio;
 384        }
 385
 386        item.IsLocked = request.LockData ?? false;
 387
 388        if (request.LockedFields is not null)
 389        {
 390            item.LockedFields = request.LockedFields;
 391        }
 392
 393        // Only allow this for series. Runtimes for media comes from ffprobe.
 394        if (item is Series)
 395        {
 396            item.RunTimeTicks = request.RunTimeTicks;
 397        }
 398
 399        foreach (var pair in request.ProviderIds.ToList())
 400        {
 401            if (string.IsNullOrEmpty(pair.Value))
 402            {
 403                request.ProviderIds.Remove(pair.Key);
 404            }
 405        }
 406
 407        item.ProviderIds = request.ProviderIds;
 408
 409        if (item is Video video)
 410        {
 411            video.Video3DFormat = request.Video3DFormat;
 412        }
 413
 414        if (request.AlbumArtists is not null)
 415        {
 416            if (item is IHasAlbumArtist hasAlbumArtists)
 417            {
 418                hasAlbumArtists.AlbumArtists = Array.ConvertAll(request.AlbumArtists, i => i.Name);
 419            }
 420        }
 421
 422        if (request.ArtistItems is not null)
 423        {
 424            if (item is IHasArtist hasArtists)
 425            {
 426                hasArtists.Artists = Array.ConvertAll(request.ArtistItems, i => i.Name);
 427            }
 428        }
 429
 430        switch (item)
 431        {
 432            case Audio song:
 433                song.Album = request.Album;
 434                break;
 435            case MusicVideo musicVideo:
 436                musicVideo.Album = request.Album;
 437                break;
 438            case Series series:
 439                {
 440                    series.Status = GetSeriesStatus(request);
 441
 442                    if (request.AirDays is not null)
 443                    {
 444                        series.AirDays = request.AirDays;
 445                        series.AirTime = request.AirTime;
 446                    }
 447
 448                    break;
 449                }
 450        }
 451    }
 452
 453    private SeriesStatus? GetSeriesStatus(BaseItemDto item)
 454    {
 0455        if (string.IsNullOrEmpty(item.Status))
 456        {
 0457            return null;
 458        }
 459
 0460        return (SeriesStatus)Enum.Parse(typeof(SeriesStatus), item.Status, true);
 461    }
 462
 463    private DateTime NormalizeDateTime(DateTime val)
 464    {
 0465        return DateTime.SpecifyKind(val, DateTimeKind.Utc);
 466    }
 467
 468    private List<NameValuePair> GetContentTypeOptions(bool isForItem)
 469    {
 0470        var list = new List<NameValuePair>();
 471
 0472        if (isForItem)
 473        {
 0474            list.Add(new NameValuePair
 0475            {
 0476                Name = "Inherit",
 0477                Value = string.Empty
 0478            });
 479        }
 480
 0481        list.Add(new NameValuePair
 0482        {
 0483            Name = "Movies",
 0484            Value = "movies"
 0485        });
 0486        list.Add(new NameValuePair
 0487        {
 0488            Name = "Music",
 0489            Value = "music"
 0490        });
 0491        list.Add(new NameValuePair
 0492        {
 0493            Name = "Shows",
 0494            Value = "tvshows"
 0495        });
 496
 0497        if (!isForItem)
 498        {
 0499            list.Add(new NameValuePair
 0500            {
 0501                Name = "Books",
 0502                Value = "books"
 0503            });
 504        }
 505
 0506        list.Add(new NameValuePair
 0507        {
 0508            Name = "HomeVideos",
 0509            Value = "homevideos"
 0510        });
 0511        list.Add(new NameValuePair
 0512        {
 0513            Name = "MusicVideos",
 0514            Value = "musicvideos"
 0515        });
 0516        list.Add(new NameValuePair
 0517        {
 0518            Name = "Photos",
 0519            Value = "photos"
 0520        });
 521
 0522        if (!isForItem)
 523        {
 0524            list.Add(new NameValuePair
 0525            {
 0526                Name = "MixedContent",
 0527                Value = string.Empty
 0528            });
 529        }
 530
 0531        foreach (var val in list)
 532        {
 0533            val.Name = _localizationManager.GetLocalizedString(val.Name);
 534        }
 535
 0536        return list;
 537    }
 538}