implement all non image get endpoints

Jellyfin.Api/Controllers/ImageController.cs

@@ -1,15 +1,24 @@
 using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
+using Jellyfin.Api.Constants;
+using Jellyfin.Api.Helpers;
 using MediaBrowser.Controller.Configuration;
 using MediaBrowser.Controller.Drawing;
+using MediaBrowser.Controller.Entities;
 using MediaBrowser.Controller.Library;
 using MediaBrowser.Controller.Net;
 using MediaBrowser.Controller.Providers;
+using MediaBrowser.Model.Dto;
 using MediaBrowser.Model.Entities;
 using MediaBrowser.Model.IO;
 using MediaBrowser.Model.Net;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 
@@ -69,13 +78,18 @@ namespace Jellyfin.Api.Controllers
         /// <response code="204">Image updated.</response>
         /// <returns>A <see cref="NoContentResult"/>.</returns>
         [HttpPost("/Users/{userId}/Images/{imageType}")]
-        [HttpPost("/Users/{userId}/Images/{imageType}/{index}")]
+        [HttpPost("/Users/{userId}/Images/{imageType}/{index?}")]
+        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageType", Justification = "Imported from ServiceStack")]
+        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
         public async Task<ActionResult> PostUserImage(
             [FromRoute] Guid userId,
             [FromRoute] ImageType imageType,
-            [FromRoute] int? index)
+            [FromRoute] int? index = null)
         {
-            // TODO AssertCanUpdateUser(_authContext, _userManager, id, true);
+            if (!RequestHelpers.AssertCanUpdateUser(_authContext, HttpContext.Request, userId, true))
+            {
+                return Forbid("User is not allowed to update the image.");
+            }
 
             var user = _userManager.GetUserById(userId);
             await using var memoryStream = await GetMemoryStream(Request.Body).ConfigureAwait(false);
@@ -102,13 +116,19 @@ namespace Jellyfin.Api.Controllers
         /// <response code="204">Image deleted.</response>
         /// <returns>A <see cref="NoContentResult"/>.</returns>
         [HttpDelete("/Users/{userId}/Images/{itemType}")]
-        [HttpDelete("/Users/{userId}/Images/{itemType}/{index}")]
+        [HttpDelete("/Users/{userId}/Images/{itemType}/{index?}")]
+        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "imageType", Justification = "Imported from ServiceStack")]
+        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
         public ActionResult DeleteUserImage(
             [FromRoute] Guid userId,
             [FromRoute] ImageType imageType,
-            [FromRoute] int? index)
+            [FromRoute] int? index = null)
         {
-            // TODO AssertCanUpdateUser(_authContext, _userManager, userId, true);
+            if (!RequestHelpers.AssertCanUpdateUser(_authContext, HttpContext.Request, userId, true))
+            {
+                return Forbid("User is not allowed to delete the image.");
+            }
 
             var user = _userManager.GetUserById(userId);
             try
@@ -124,6 +144,164 @@ namespace Jellyfin.Api.Controllers
             return NoContent();
         }
 
+        /// <summary>
+        /// Delete an item's image.
+        /// </summary>
+        /// <param name="itemId">Item id.</param>
+        /// <param name="imageType">Image type.</param>
+        /// <param name="imageIndex">The image index.</param>
+        /// <response code="204">Image deleted.</response>
+        /// <response code="404">Item not found.</response>
+        /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
+        [HttpDelete("/Items/{itemId}/Images/{imageType}")]
+        [HttpDelete("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
+        [Authorize(Policy = Policies.RequiresElevation)]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public ActionResult DeleteItemImage(
+            [FromRoute] Guid itemId,
+            [FromRoute] ImageType imageType,
+            [FromRoute] int? imageIndex = null)
+        {
+            var item = _libraryManager.GetItemById(itemId);
+            if (item == null)
+            {
+                return NotFound();
+            }
+
+            item.DeleteImage(imageType, imageIndex ?? 0);
+            return NoContent();
+        }
+
+        /// <summary>
+        /// Set item image.
+        /// </summary>
+        /// <param name="itemId">Item id.</param>
+        /// <param name="imageType">Image type.</param>
+        /// <param name="imageIndex">(Unused) Image index.</param>
+        /// <response code="204">Image saved.</response>
+        /// <response code="400">Item not found.</response>
+        /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
+        [HttpPost("/Items/{itemId}/Images/{imageType}")]
+        [HttpPost("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
+        [Authorize(Policy = Policies.RequiresElevation)]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "index", Justification = "Imported from ServiceStack")]
+        public async Task<ActionResult> SetItemImage(
+            [FromRoute] Guid itemId,
+            [FromRoute] ImageType imageType,
+            [FromRoute] int? imageIndex = null)
+        {
+            var item = _libraryManager.GetItemById(itemId);
+            if (item == null)
+            {
+                return NotFound();
+            }
+
+            // Handle image/png; charset=utf-8
+            var mimeType = Request.ContentType.Split(';').FirstOrDefault();
+            await _providerManager.SaveImage(item, Request.Body, mimeType, imageType, null, CancellationToken.None).ConfigureAwait(false);
+            item.UpdateToRepository(ItemUpdateType.ImageUpdate, CancellationToken.None);
+
+            return NoContent();
+        }
+
+        /// <summary>
+        /// Updates the index for an item image.
+        /// </summary>
+        /// <param name="itemId">Item id.</param>
+        /// <param name="imageType">Image type.</param>
+        /// <param name="imageIndex">Old image index.</param>
+        /// <param name="newIndex">New image index.</param>
+        /// <response code="204">Image index updated.</response>
+        /// <response code="404">Item not found.</response>
+        /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if item not found.</returns>
+        [HttpPost("/Items/{itemId}/Images/{imageType}/{imageIndex}/Index")]
+        [Authorize(Policy = Policies.RequiresElevation)]
+        [ProducesResponseType(StatusCodes.Status204NoContent)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public ActionResult UpdateItemImageIndex(
+            [FromRoute] Guid itemId,
+            [FromRoute] ImageType imageType,
+            [FromRoute] int imageIndex,
+            [FromQuery] int newIndex)
+        {
+            var item = _libraryManager.GetItemById(itemId);
+            if (item == null)
+            {
+                return NotFound();
+            }
+
+            item.SwapImages(imageType, imageIndex, newIndex);
+            return NoContent();
+        }
+
+        /// <summary>
+        /// Get item image infos.
+        /// </summary>
+        /// <param name="itemId">Item id.</param>
+        /// <response code="200">Item images returned.</response>
+        /// <response code="404">Item not found.</response>
+        /// <returns>The list of image infos on success, or <see cref="NotFoundResult"/> if item not found.</returns>
+        [HttpGet("/Items/{itemId}/Images")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+        public ActionResult<IEnumerable<ImageInfo>> GetItemImageInfos([FromRoute] Guid itemId)
+        {
+            var item = _libraryManager.GetItemById(itemId);
+            if (item == null)
+            {
+                return NotFound();
+            }
+
+            var list = new List<ImageInfo>();
+            var itemImages = item.ImageInfos;
+
+            if (itemImages.Length == 0)
+            {
+                // short-circuit
+                return list;
+            }
+
+            _libraryManager.UpdateImages(item); // this makes sure dimensions and hashes are correct
+
+            foreach (var image in itemImages)
+            {
+                if (!item.AllowsMultipleImages(image.Type))
+                {
+                    var info = GetImageInfo(item, image, null);
+
+                    if (info != null)
+                    {
+                        list.Add(info);
+                    }
+                }
+            }
+
+            foreach (var imageType in itemImages.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
+            {
+                var index = 0;
+
+                // Prevent implicitly captured closure
+                var currentImageType = imageType;
+
+                foreach (var image in itemImages.Where(i => i.Type == currentImageType))
+                {
+                    var info = GetImageInfo(item, image, index);
+
+                    if (info != null)
+                    {
+                        list.Add(info);
+                    }
+
+                    index++;
+                }
+            }
+
+            return list;
+        }
+
         private static async Task<MemoryStream> GetMemoryStream(Stream inputStream)
         {
             using var reader = new StreamReader(inputStream);
@@ -135,5 +313,57 @@ namespace Jellyfin.Api.Controllers
                 Position = 0
             };
         }
+
+        private ImageInfo? GetImageInfo(BaseItem item, ItemImageInfo info, int? imageIndex)
+        {
+            int? width = null;
+            int? height = null;
+            string? blurhash = null;
+            long length = 0;
+
+            try
+            {
+                if (info.IsLocalFile)
+                {
+                    var fileInfo = _fileSystem.GetFileInfo(info.Path);
+                    length = fileInfo.Length;
+
+                    blurhash = info.BlurHash;
+                    width = info.Width;
+                    height = info.Height;
+
+                    if (width <= 0 || height <= 0)
+                    {
+                        width = null;
+                        height = null;
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, "Error getting image information for {Item}", item.Name);
+            }
+
+            try
+            {
+                return new ImageInfo
+                {
+                    Path = info.Path,
+                    ImageIndex = imageIndex,
+                    ImageType = info.Type,
+                    ImageTag = _imageProcessor.GetImageCacheTag(item, info),
+                    Size = length,
+                    BlurHash = blurhash,
+                    Width = width,
+                    Height = height
+                };
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, "Error getting image information for {Path}", info.Path);
+
+                return null;
+            }
+        }
     }
 }

MediaBrowser.Api/Images/ImageService.cs

@@ -3,7 +3,6 @@ using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
 using System.Linq;
-using System.Runtime.CompilerServices;
 using System.Threading;
 using System.Threading.Tasks;
 using MediaBrowser.Common.Extensions;
@@ -15,7 +14,6 @@ using MediaBrowser.Controller.Library;
 using MediaBrowser.Controller.Net;
 using MediaBrowser.Controller.Providers;
 using MediaBrowser.Model.Drawing;
-using MediaBrowser.Model.Dto;
 using MediaBrowser.Model.Entities;
 using MediaBrowser.Model.IO;
 using MediaBrowser.Model.Net;
@@ -26,21 +24,6 @@ using User = Jellyfin.Data.Entities.User;
 
 namespace MediaBrowser.Api.Images
 {
-    /// <summary>
-    /// Class GetItemImage.
-    /// </summary>
-    [Route("/Items/{Id}/Images", "GET", Summary = "Gets information about an item's images")]
-    [Authenticated]
-    public class GetItemImageInfos : IReturn<List<ImageInfo>>
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
-        public string Id { get; set; }
-    }
-
     [Route("/Items/{Id}/Images/{Type}", "GET")]
     [Route("/Items/{Id}/Images/{Type}/{Index}", "GET")]
     [Route("/Items/{Id}/Images/{Type}", "HEAD")]
@@ -57,42 +40,6 @@ namespace MediaBrowser.Api.Images
         public Guid Id { get; set; }
     }
 
-    /// <summary>
-    /// Class UpdateItemImageIndex
-    /// </summary>
-    [Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST", Summary = "Updates the index for an item image")]
-    [Authenticated(Roles = "admin")]
-    public class UpdateItemImageIndex : IReturnVoid
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string Id { get; set; }
-
-        /// <summary>
-        /// Gets or sets the type of the image.
-        /// </summary>
-        /// <value>The type of the image.</value>
-        [ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public ImageType Type { get; set; }
-
-        /// <summary>
-        /// Gets or sets the index.
-        /// </summary>
-        /// <value>The index.</value>
-        [ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")]
-        public int Index { get; set; }
-
-        /// <summary>
-        /// Gets or sets the new index.
-        /// </summary>
-        /// <value>The new index.</value>
-        [ApiMember(Name = "NewIndex", Description = "The new image index", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
-        public int NewIndex { get; set; }
-    }
-
     /// <summary>
     /// Class GetPersonImage
     /// </summary>
@@ -147,44 +94,6 @@ namespace MediaBrowser.Api.Images
         public Guid Id { get; set; }
     }
 
-    /// <summary>
-    /// Class DeleteItemImage
-    /// </summary>
-    [Route("/Items/{Id}/Images/{Type}", "DELETE")]
-    [Route("/Items/{Id}/Images/{Type}/{Index}", "DELETE")]
-    [Authenticated(Roles = "admin")]
-    public class DeleteItemImage : DeleteImageRequest, IReturnVoid
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
-        public string Id { get; set; }
-    }
-
-    /// <summary>
-    /// Class PostItemImage
-    /// </summary>
-    [Route("/Items/{Id}/Images/{Type}", "POST")]
-    [Route("/Items/{Id}/Images/{Type}/{Index}", "POST")]
-    [Authenticated(Roles = "admin")]
-    public class PostItemImage : DeleteImageRequest, IRequiresRequestStream, IReturnVoid
-    {
-        /// <summary>
-        /// Gets or sets the id.
-        /// </summary>
-        /// <value>The id.</value>
-        [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
-        public string Id { get; set; }
-
-        /// <summary>
-        /// The raw Http Request Input Stream
-        /// </summary>
-        /// <value>The request stream.</value>
-        public Stream RequestStream { get; set; }
-    }
-
     /// <summary>
     /// Class ImageService
     /// </summary>
@@ -223,126 +132,6 @@ namespace MediaBrowser.Api.Images
             _authContext = authContext;
         }
 
-        /// <summary>
-        /// Gets the specified request.
-        /// </summary>
-        /// <param name="request">The request.</param>
-        /// <returns>System.Object.</returns>
-        public object Get(GetItemImageInfos request)
-        {
-            var item = _libraryManager.GetItemById(request.Id);
-
-            var result = GetItemImageInfos(item);
-
-            return ToOptimizedResult(result);
-        }
-
-        /// <summary>
-        /// Gets the item image infos.
-        /// </summary>
-        /// <param name="item">The item.</param>
-        /// <returns>Task{List{ImageInfo}}.</returns>
-        public List<ImageInfo> GetItemImageInfos(BaseItem item)
-        {
-            var list = new List<ImageInfo>();
-            var itemImages = item.ImageInfos;
-
-            if (itemImages.Length == 0)
-            {
-                // short-circuit
-                return list;
-            }
-
-            _libraryManager.UpdateImages(item); // this makes sure dimensions and hashes are correct
-
-            foreach (var image in itemImages)
-            {
-                if (!item.AllowsMultipleImages(image.Type))
-                {
-                    var info = GetImageInfo(item, image, null);
-
-                    if (info != null)
-                    {
-                        list.Add(info);
-                    }
-                }
-            }
-
-            foreach (var imageType in itemImages.Select(i => i.Type).Distinct().Where(item.AllowsMultipleImages))
-            {
-                var index = 0;
-
-                // Prevent implicitly captured closure
-                var currentImageType = imageType;
-
-                foreach (var image in itemImages.Where(i => i.Type == currentImageType))
-                {
-                    var info = GetImageInfo(item, image, index);
-
-                    if (info != null)
-                    {
-                        list.Add(info);
-                    }
-
-                    index++;
-                }
-            }
-
-            return list;
-        }
-
-        private ImageInfo GetImageInfo(BaseItem item, ItemImageInfo info, int? imageIndex)
-        {
-            int? width = null;
-            int? height = null;
-            string blurhash = null;
-            long length = 0;
-
-            try
-            {
-                if (info.IsLocalFile)
-                {
-                    var fileInfo = _fileSystem.GetFileInfo(info.Path);
-                    length = fileInfo.Length;
-
-                    blurhash = info.BlurHash;
-                    width = info.Width;
-                    height = info.Height;
-
-                    if (width <= 0 || height <= 0)
-                    {
-                        width = null;
-                        height = null;
-                    }
-                }
-            }
-            catch (Exception ex)
-            {
-                Logger.LogError(ex, "Error getting image information for {Item}", item.Name);
-            }
-
-            try
-            {
-                return new ImageInfo
-                {
-                    Path = info.Path,
-                    ImageIndex = imageIndex,
-                    ImageType = info.Type,
-                    ImageTag = _imageProcessor.GetImageCacheTag(item, info),
-                    Size = length,
-                    BlurHash = blurhash,
-                    Width = width,
-                    Height = height
-                };
-            }
-            catch (Exception ex)
-            {
-                Logger.LogError(ex, "Error getting image information for {Path}", info.Path);
-
-                return null;
-            }
-        }
-
         /// <summary>
         /// Gets the specified request.
         /// </summary>
@@ -400,56 +189,6 @@ namespace MediaBrowser.Api.Images
             return GetImage(request, item.Id, item, true);
         }
 
-        /// <summary>
-        /// Posts the specified request.
-        /// </summary>
-        /// <param name="request">The request.</param>
-        public Task Post(PostItemImage request)
-        {
-            var id = Guid.Parse(GetPathValue(1));
-
-            request.Type = Enum.Parse<ImageType>(GetPathValue(3).ToString(), true);
-
-            var item = _libraryManager.GetItemById(id);
-
-            return PostImage(item, request.RequestStream, request.Type, Request.ContentType);
-        }
-
-        /// <summary>
-        /// Deletes the specified request.
-        /// </summary>
-        /// <param name="request">The request.</param>
-        public void Delete(DeleteItemImage request)
-        {
-            var item = _libraryManager.GetItemById(request.Id);
-
-            item.DeleteImage(request.Type, request.Index ?? 0);
-        }
-
-        /// <summary>
-        /// Posts the specified request.
-        /// </summary>
-        /// <param name="request">The request.</param>
-        public void Post(UpdateItemImageIndex request)
-        {
-            var item = _libraryManager.GetItemById(request.Id);
-
-            UpdateItemIndex(item, request.Type, request.Index, request.NewIndex);
-        }
-
-        /// <summary>
-        /// Updates the index of the item.
-        /// </summary>
-        /// <param name="item">The item.</param>
-        /// <param name="type">The type.</param>
-        /// <param name="currentIndex">Index of the current.</param>
-        /// <param name="newIndex">The new index.</param>
-        /// <returns>Task.</returns>
-        private void UpdateItemIndex(BaseItem item, ImageType type, int currentIndex, int newIndex)
-        {
-            item.SwapImages(type, currentIndex, newIndex);
-        }
-
         /// <summary>
         /// Gets the image.
         /// </summary>