Kyoo/Kyoo.Core/Controllers/ThumbnailsManager.cs

using System;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models;
using Microsoft.AspNetCore.StaticFiles;
using Microsoft.Extensions.Logging;

namespace Kyoo.Core.Controllers
{
	/// <summary>
	/// Download images and retrieve the path of those images for a resource.
	/// </summary>
	public class ThumbnailsManager : IThumbnailsManager
	{
		/// <summary>
		/// The file manager used to download the image if the file is distant
		/// </summary>
		private readonly IFileSystem _files;
		/// <summary>
		/// A logger to report errors.
		/// </summary>
		private readonly ILogger<ThumbnailsManager> _logger;

		/// <summary>
		/// Create a new <see cref="ThumbnailsManager"/>.
		/// </summary>
		/// <param name="files">The file manager to use.</param>
		/// <param name="logger">A logger to report errors</param>
		public ThumbnailsManager(IFileSystem files,
			ILogger<ThumbnailsManager> logger)
		{
			_files = files;
			_logger = logger;
		}

		/// <summary>
		/// An helper function to download an image using a <see cref="LocalFileSystem"/>.
		/// </summary>
		/// <param name="url">The distant url of the image</param>
		/// <param name="localPath">The local path of the image</param>
		/// <param name="what">What is currently downloaded (used for errors)</param>
		/// <returns><c>true</c> if an image has been downloaded, <c>false</c> otherwise.</returns>
		private async Task<bool> _DownloadImage(string url, string localPath, string what)
		{
			if (url == localPath)
				return false;

			try
			{
				AsyncRef<string> mime = new();
				await using Stream reader = await _files.GetReader(url, mime);
				string extension = new FileExtensionContentTypeProvider()
					.Mappings.FirstOrDefault(x => x.Value == mime.Value)
					.Key;
				await using Stream local = await _files.NewFile(localPath + extension);
				await reader.CopyToAsync(local);
				return true;
			}
			catch (Exception ex)
			{
				_logger.LogError(ex, "{What} could not be downloaded", what);
				return false;
			}
		}

		/// <inheritdoc />
		public async Task<bool> DownloadImages<T>(T item, bool alwaysDownload = false)
			where T : IThumbnails
		{
			if (item == null)
				throw new ArgumentNullException(nameof(item));

			if (item.Images == null)
				return false;

			string name = item is IResource res ? res.Slug : "???";
			bool ret = false;

			foreach ((int id, string image) in item.Images.Where(x => x.Value != null))
			{
				string localPath = await _GetPrivateImagePath(item, id);
				if (alwaysDownload || !await _files.Exists(localPath))
					ret |= await _DownloadImage(image, localPath, $"The image n°{id} of {name}");
			}

			return ret;
		}

		/// <summary>
		/// Retrieve the local path of an image of the given item <b>without an extension</b>.
		/// </summary>
		/// <param name="item">The item to retrieve the poster from.</param>
		/// <param name="imageID">The ID of the image. See <see cref="Images"/> for values.</param>
		/// <typeparam name="T">The type of the item</typeparam>
		/// <returns>The path of the image for the given resource, <b>even if it does not exists</b></returns>
		private async Task<string> _GetPrivateImagePath<T>(T item, int imageID)
		{
			if (item == null)
				throw new ArgumentNullException(nameof(item));

			string directory = await _files.GetExtraDirectory(item);
			string imageName = imageID switch
			{
				Images.Poster => "poster",
				Images.Logo => "logo",
				Images.Thumbnail => "thumbnail",
				Images.Trailer => "trailer",
				_ => $"{imageID}"
			};

			switch (item)
			{
				case Season season:
					imageName = $"season-{season.SeasonNumber}-{imageName}";
					break;
				case Episode episode:
					directory = await _files.CreateDirectory(_files.Combine(directory, "Thumbnails"));
					imageName = $"{Path.GetFileNameWithoutExtension(episode.Path)}-{imageName}";
					break;
			}

			return _files.Combine(directory, imageName);
		}

		/// <inheritdoc />
		public async Task<string> GetImagePath<T>(T item, int imageID)
			where T : IThumbnails
		{
			string basePath = await _GetPrivateImagePath(item, imageID);
			string directory = Path.GetDirectoryName(basePath);
			string baseFile = Path.GetFileName(basePath);
			return (await _files.ListFiles(directory!))
				.FirstOrDefault(x => Path.GetFileNameWithoutExtension(x) == baseFile);
		}
	}
}