jellyfin-server/MediaBrowser.Api/Images/ImageByNameService.cs

278 lines
9.9 KiB
C#
Raw Normal View History

using System;
2014-05-07 02:28:19 +00:00
using System.Collections.Generic;
2013-05-02 15:12:27 +00:00
using System.IO;
using System.Linq;
2016-11-10 21:06:00 +00:00
using System.Threading.Tasks;
using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Configuration;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.Dto;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
using MediaBrowser.Model.Services;
using Microsoft.Extensions.Logging;
2013-05-02 15:12:27 +00:00
namespace MediaBrowser.Api.Images
{
/// <summary>
/// Class GetGeneralImage
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Images/General/{Name}/{Type}", "GET", Summary = "Gets a general image by name")]
2013-05-03 18:33:47 +00:00
public class GetGeneralImage
2013-05-02 15:12:27 +00:00
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The name of the image", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { get; set; }
2013-05-03 18:33:47 +00:00
[ApiMember(Name = "Type", Description = "Image Type (primary, backdrop, logo, etc).", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Type { get; set; }
2013-05-02 15:12:27 +00:00
}
/// <summary>
/// Class GetRatingImage
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Images/Ratings/{Theme}/{Name}", "GET", Summary = "Gets a rating image by name")]
2013-05-03 18:33:47 +00:00
public class GetRatingImage
2013-05-02 15:12:27 +00:00
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The name of the image", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { get; set; }
/// <summary>
/// Gets or sets the theme.
/// </summary>
/// <value>The theme.</value>
[ApiMember(Name = "Theme", Description = "The theme to get the image from", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Theme { get; set; }
}
/// <summary>
/// Class GetMediaInfoImage
/// </summary>
2014-11-15 02:31:03 +00:00
[Route("/Images/MediaInfo/{Theme}/{Name}", "GET", Summary = "Gets a media info image by name")]
2013-05-03 18:33:47 +00:00
public class GetMediaInfoImage
2013-05-02 15:12:27 +00:00
{
/// <summary>
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
[ApiMember(Name = "Name", Description = "The name of the image", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Name { get; set; }
/// <summary>
/// Gets or sets the theme.
/// </summary>
/// <value>The theme.</value>
[ApiMember(Name = "Theme", Description = "The theme to get the image from", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
public string Theme { get; set; }
}
2014-11-15 02:31:03 +00:00
[Route("/Images/MediaInfo", "GET", Summary = "Gets all media info image by name")]
[Authenticated]
2014-05-07 02:28:19 +00:00
public class GetMediaInfoImages : IReturn<List<ImageByNameInfo>>
{
}
2014-11-15 02:31:03 +00:00
[Route("/Images/Ratings", "GET", Summary = "Gets all rating images by name")]
[Authenticated]
2014-05-07 02:28:19 +00:00
public class GetRatingImages : IReturn<List<ImageByNameInfo>>
{
}
2014-11-15 02:31:03 +00:00
[Route("/Images/General", "GET", Summary = "Gets all general images by name")]
[Authenticated]
2014-05-07 02:28:19 +00:00
public class GetGeneralImages : IReturn<List<ImageByNameInfo>>
{
}
2013-05-02 15:12:27 +00:00
/// <summary>
/// Class ImageByNameService
/// </summary>
public class ImageByNameService : BaseApiService
{
/// <summary>
/// The _app paths
/// </summary>
private readonly IServerApplicationPaths _appPaths;
2014-07-26 17:30:15 +00:00
private readonly IFileSystem _fileSystem;
2013-05-02 15:12:27 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="ImageByNameService" /> class.
/// </summary>
public ImageByNameService(
ILogger<ImageByNameService> logger,
IServerConfigurationManager serverConfigurationManager,
IHttpResultFactory resultFactory,
IFileSystem fileSystem)
: base(logger, serverConfigurationManager, resultFactory)
2013-05-02 15:12:27 +00:00
{
_appPaths = serverConfigurationManager.ApplicationPaths;
2014-07-26 17:30:15 +00:00
_fileSystem = fileSystem;
2013-05-02 15:12:27 +00:00
}
2014-05-07 02:28:19 +00:00
public object Get(GetMediaInfoImages request)
{
return ToOptimizedResult(GetImageList(_appPaths.MediaInfoImagesPath, true));
2014-05-07 02:28:19 +00:00
}
public object Get(GetRatingImages request)
{
return ToOptimizedResult(GetImageList(_appPaths.RatingsPath, true));
2014-05-07 02:28:19 +00:00
}
public object Get(GetGeneralImages request)
{
return ToOptimizedResult(GetImageList(_appPaths.GeneralPath, false));
2014-05-07 02:28:19 +00:00
}
private List<ImageByNameInfo> GetImageList(string path, bool supportsThemes)
2014-05-07 02:28:19 +00:00
{
try
{
2019-01-07 23:24:34 +00:00
return _fileSystem.GetFiles(path, BaseItem.SupportedImageExtensions, false, true)
2014-05-07 02:28:19 +00:00
.Select(i => new ImageByNameInfo
{
2014-07-26 17:30:15 +00:00
Name = _fileSystem.GetFileNameWithoutExtension(i),
2014-05-07 02:28:19 +00:00
FileLength = i.Length,
// For themeable images, use the Theme property
// For general images, the same object structure is fine,
// but it's not owned by a theme, so call it Context
Theme = supportsThemes ? GetThemeName(i.FullName, path) : null,
Context = supportsThemes ? null : GetThemeName(i.FullName, path),
2019-01-27 11:03:43 +00:00
Format = i.Extension.ToLowerInvariant().TrimStart('.')
2014-05-07 02:28:19 +00:00
})
.OrderBy(i => i.Name)
.ToList();
}
2016-11-01 03:07:45 +00:00
catch (IOException)
2014-05-07 02:28:19 +00:00
{
return new List<ImageByNameInfo>();
}
}
private string GetThemeName(string path, string rootImagePath)
{
var parentName = Path.GetDirectoryName(path);
2014-05-07 02:28:19 +00:00
if (string.Equals(parentName, rootImagePath, StringComparison.OrdinalIgnoreCase))
{
return null;
}
parentName = Path.GetFileName(parentName);
return string.Equals(parentName, "all", StringComparison.OrdinalIgnoreCase) ?
null :
parentName;
}
2013-05-02 15:12:27 +00:00
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
2016-11-10 21:06:00 +00:00
public Task<object> Get(GetGeneralImage request)
2013-05-02 15:12:27 +00:00
{
2013-05-03 19:34:25 +00:00
var filename = string.Equals(request.Type, "primary", StringComparison.OrdinalIgnoreCase)
2013-05-03 18:33:47 +00:00
? "folder"
: request.Type;
var paths = BaseItem.SupportedImageExtensions.Select(i => Path.Combine(_appPaths.GeneralPath, request.Name, filename + i)).ToList();
2013-05-02 15:12:27 +00:00
var path = paths.FirstOrDefault(File.Exists) ?? paths.FirstOrDefault();
return ResultFactory.GetStaticFileResult(Request, path);
2013-05-02 15:12:27 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
public object Get(GetRatingImage request)
{
2013-05-02 15:31:39 +00:00
var themeFolder = Path.Combine(_appPaths.RatingsPath, request.Theme);
if (Directory.Exists(themeFolder))
2013-05-02 15:31:39 +00:00
{
2014-05-07 02:28:19 +00:00
var path = BaseItem.SupportedImageExtensions
.Select(i => Path.Combine(themeFolder, request.Name + i))
.FirstOrDefault(File.Exists);
2013-05-02 15:31:39 +00:00
if (!string.IsNullOrEmpty(path))
2013-05-02 15:31:39 +00:00
{
return ResultFactory.GetStaticFileResult(Request, path);
2013-05-02 15:31:39 +00:00
}
}
var allFolder = Path.Combine(_appPaths.RatingsPath, "all");
if (Directory.Exists(allFolder))
2013-05-02 15:31:39 +00:00
{
// Avoid implicitly captured closure
var currentRequest = request;
2013-05-02 15:31:39 +00:00
2014-05-07 02:28:19 +00:00
var path = BaseItem.SupportedImageExtensions
.Select(i => Path.Combine(allFolder, currentRequest.Name + i))
.FirstOrDefault(File.Exists);
2013-05-02 15:31:39 +00:00
if (!string.IsNullOrEmpty(path))
2013-05-02 15:31:39 +00:00
{
return ResultFactory.GetStaticFileResult(Request, path);
2013-05-02 15:31:39 +00:00
}
}
throw new ResourceNotFoundException("MediaInfo image not found: " + request.Name);
2013-05-02 15:12:27 +00:00
}
/// <summary>
/// Gets the specified request.
/// </summary>
/// <param name="request">The request.</param>
/// <returns>System.Object.</returns>
2016-11-10 21:06:00 +00:00
public Task<object> Get(GetMediaInfoImage request)
2013-05-02 15:12:27 +00:00
{
2013-05-02 15:31:39 +00:00
var themeFolder = Path.Combine(_appPaths.MediaInfoImagesPath, request.Theme);
2013-05-02 15:12:27 +00:00
if (Directory.Exists(themeFolder))
2013-05-02 15:31:39 +00:00
{
var path = BaseItem.SupportedImageExtensions.Select(i => Path.Combine(themeFolder, request.Name + i))
.FirstOrDefault(File.Exists);
2013-05-02 15:12:27 +00:00
if (!string.IsNullOrEmpty(path))
2013-05-02 15:31:39 +00:00
{
return ResultFactory.GetStaticFileResult(Request, path);
2013-05-02 15:31:39 +00:00
}
}
2013-05-03 18:33:47 +00:00
2013-05-02 15:31:39 +00:00
var allFolder = Path.Combine(_appPaths.MediaInfoImagesPath, "all");
if (Directory.Exists(allFolder))
2013-05-02 15:31:39 +00:00
{
// Avoid implicitly captured closure
var currentRequest = request;
2013-05-02 15:31:39 +00:00
var path = BaseItem.SupportedImageExtensions.Select(i => Path.Combine(allFolder, currentRequest.Name + i))
.FirstOrDefault(File.Exists);
2014-05-07 02:28:19 +00:00
if (!string.IsNullOrEmpty(path))
2013-05-02 15:31:39 +00:00
{
return ResultFactory.GetStaticFileResult(Request, path);
2013-05-02 15:31:39 +00:00
}
}
throw new ResourceNotFoundException("MediaInfo image not found: " + request.Name);
2013-05-02 15:12:27 +00:00
}
}
}