jellyfin-server/MediaBrowser.Server.Implementations/Photos/BaseDynamicImageProvider.cs

254 lines
8.6 KiB
C#
Raw Normal View History

using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Extensions;
2014-10-29 22:01:02 +00:00
using MediaBrowser.Common.IO;
using MediaBrowser.Controller.Entities;
2015-03-14 17:02:51 +00:00
using MediaBrowser.Controller.Library;
2014-10-29 22:01:02 +00:00
using MediaBrowser.Controller.Providers;
2015-03-13 19:37:19 +00:00
using MediaBrowser.Model.Drawing;
2014-10-29 22:01:02 +00:00
using MediaBrowser.Model.Entities;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Server.Implementations.Photos
{
2015-03-14 17:02:51 +00:00
public abstract class BaseDynamicImageProvider<T> : IHasChangeMonitor, IForcedProvider, ICustomMetadataProvider<T>, IHasOrder
2015-03-13 19:16:34 +00:00
where T : IHasMetadata
2014-10-29 22:01:02 +00:00
{
protected IFileSystem FileSystem { get; private set; }
protected IProviderManager ProviderManager { get; private set; }
protected IApplicationPaths ApplicationPaths { get; private set; }
2014-10-29 22:01:02 +00:00
protected BaseDynamicImageProvider(IFileSystem fileSystem, IProviderManager providerManager, IApplicationPaths applicationPaths)
2014-10-29 22:01:02 +00:00
{
ApplicationPaths = applicationPaths;
2014-10-29 22:01:02 +00:00
ProviderManager = providerManager;
FileSystem = fileSystem;
}
2015-03-13 19:37:19 +00:00
public virtual bool Supports(IHasImages item)
2014-10-29 22:01:02 +00:00
{
2015-03-14 17:02:51 +00:00
return true;
2014-10-29 22:01:02 +00:00
}
2015-03-14 04:50:23 +00:00
public virtual IEnumerable<ImageType> GetSupportedImages(IHasImages item)
2014-10-29 22:01:02 +00:00
{
2015-03-13 19:37:19 +00:00
return new List<ImageType>
{
ImageType.Primary,
ImageType.Thumb
};
2014-10-29 22:01:02 +00:00
}
2015-03-14 17:02:51 +00:00
public async Task<ItemUpdateType> FetchAsync(T item, MetadataRefreshOptions options, CancellationToken cancellationToken)
{
if (!Supports(item))
{
return ItemUpdateType.None;
}
var primaryResult = await FetchAsync(item, ImageType.Primary, options, cancellationToken).ConfigureAwait(false);
var thumbResult = await FetchAsync(item, ImageType.Thumb, options, cancellationToken).ConfigureAwait(false);
return primaryResult | thumbResult;
}
protected async Task<ItemUpdateType> FetchAsync(IHasImages item, ImageType imageType, MetadataRefreshOptions options, CancellationToken cancellationToken)
{
var items = await GetItemsWithImages(item).ConfigureAwait(false);
2015-03-16 01:48:25 +00:00
var cacheKey = GetConfigurationCacheKey(items, item.Name);
2015-03-14 17:02:51 +00:00
if (!HasChanged(item, imageType, cacheKey))
{
return ItemUpdateType.None;
}
return await FetchToFileInternal(item, items, imageType, cacheKey, cancellationToken).ConfigureAwait(false);
}
protected async Task<ItemUpdateType> FetchToFileInternal(IHasImages item,
List<BaseItem> itemsWithImages,
ImageType imageType,
string cacheKey,
CancellationToken cancellationToken)
{
var stream = await CreateImageAsync(item, itemsWithImages, imageType, 0).ConfigureAwait(false);
if (stream == null)
{
return ItemUpdateType.None;
}
if (stream is MemoryStream)
{
using (stream)
{
stream.Position = 0;
await ProviderManager.SaveImage(item, stream, "image/png", imageType, null, cacheKey, cancellationToken).ConfigureAwait(false);
}
}
else
{
using (var ms = new MemoryStream())
{
await stream.CopyToAsync(ms).ConfigureAwait(false);
ms.Position = 0;
await ProviderManager.SaveImage(item, ms, "image/png", imageType, null, cacheKey, cancellationToken).ConfigureAwait(false);
}
}
return ItemUpdateType.ImageUpdate;
}
2015-03-13 19:37:19 +00:00
public async Task<DynamicImageResponse> GetImage(IHasImages item, ImageType type, CancellationToken cancellationToken)
2014-10-29 22:01:02 +00:00
{
var items = await GetItemsWithImages(item).ConfigureAwait(false);
2015-03-16 01:48:25 +00:00
var cacheKey = GetConfigurationCacheKey(items, item.Name);
2014-10-29 22:01:02 +00:00
2015-03-14 17:02:51 +00:00
var result = await CreateImageAsync(item, items, type, 0).ConfigureAwait(false);
2015-03-13 19:37:19 +00:00
return new DynamicImageResponse
2014-10-29 22:01:02 +00:00
{
2015-03-13 19:37:19 +00:00
HasImage = result != null,
Stream = result,
InternalCacheKey = cacheKey,
Format = ImageFormat.Png
};
}
2014-10-29 22:01:02 +00:00
2015-03-13 19:37:19 +00:00
protected abstract Task<List<BaseItem>> GetItemsWithImages(IHasImages item);
private const string Version = "3";
2015-03-16 01:48:25 +00:00
protected string GetConfigurationCacheKey(List<BaseItem> items, string itemName)
2015-03-13 19:37:19 +00:00
{
2015-03-16 01:48:25 +00:00
return (Version + "_" + (itemName ?? string.Empty) + "_" + string.Join(",", items.Select(i => i.Id.ToString("N")).ToArray())).GetMD5().ToString("N");
2014-10-29 22:01:02 +00:00
}
2014-11-11 04:26:53 +00:00
protected Task<Stream> GetThumbCollage(List<BaseItem> items)
2014-10-29 22:01:02 +00:00
{
2015-03-03 07:03:17 +00:00
var files = items
.Select(i => i.GetImagePath(ImageType.Primary) ?? i.GetImagePath(ImageType.Thumb))
.Where(i => !string.IsNullOrWhiteSpace(i))
.ToList();
return DynamicImageHelpers.GetThumbCollage(files,
2014-10-29 22:01:02 +00:00
FileSystem,
1600,
900,
ApplicationPaths);
2014-10-29 22:01:02 +00:00
}
2014-11-11 04:26:53 +00:00
protected Task<Stream> GetSquareCollage(List<BaseItem> items)
2014-10-29 22:01:02 +00:00
{
2015-03-03 07:03:17 +00:00
var files = items
.Select(i => i.GetImagePath(ImageType.Primary) ?? i.GetImagePath(ImageType.Thumb))
.Where(i => !string.IsNullOrWhiteSpace(i))
.ToList();
return DynamicImageHelpers.GetSquareCollage(files,
2014-10-29 22:01:02 +00:00
FileSystem,
800, ApplicationPaths);
2014-10-29 22:01:02 +00:00
}
public string Name
{
get { return "Dynamic Image Provider"; }
}
2015-03-13 19:52:49 +00:00
protected virtual async Task<Stream> CreateImageAsync(IHasImages item,
2014-10-29 22:01:02 +00:00
List<BaseItem> itemsWithImages,
2015-03-13 19:37:19 +00:00
ImageType imageType,
2014-10-29 22:01:02 +00:00
int imageIndex)
{
if (itemsWithImages.Count == 0)
{
return null;
}
return imageType == ImageType.Thumb ?
await GetThumbCollage(itemsWithImages).ConfigureAwait(false) :
await GetSquareCollage(itemsWithImages).ConfigureAwait(false);
}
public bool HasChanged(IHasMetadata item, IDirectoryService directoryService, DateTime date)
{
if (!Supports(item))
{
return false;
}
var items = GetItemsWithImages(item).Result;
2015-03-16 01:48:25 +00:00
var cacheKey = GetConfigurationCacheKey(items, item.Name);
2014-10-29 22:01:02 +00:00
return HasChanged(item, ImageType.Primary, cacheKey) || HasChanged(item, ImageType.Thumb, cacheKey);
}
protected bool HasChanged(IHasImages item, ImageType type, string cacheKey)
{
var image = item.GetImageInfo(type, 0);
if (image != null)
{
if (!FileSystem.ContainsSubPath(item.GetInternalMetadataPath(), image.Path))
{
return false;
}
var currentPathCacheKey = (Path.GetFileNameWithoutExtension(image.Path) ?? string.Empty).Split('_').LastOrDefault();
if (string.Equals(cacheKey, currentPathCacheKey, StringComparison.OrdinalIgnoreCase))
{
return false;
}
}
return true;
}
protected List<BaseItem> GetFinalItems(List<BaseItem> items)
2015-03-13 19:52:49 +00:00
{
// Rotate the images no more than once per week
return GetFinalItems(items, 4);
}
2015-03-14 17:02:51 +00:00
protected virtual List<BaseItem> GetFinalItems(List<BaseItem> items, int limit)
2014-10-29 22:01:02 +00:00
{
// Rotate the images no more than once per week
var random = new Random(GetWeekOfYear()).Next();
return items
.OrderBy(i => random - items.IndexOf(i))
2015-03-13 19:52:49 +00:00
.Take(limit)
2014-10-29 22:01:02 +00:00
.OrderBy(i => i.Name)
.ToList();
}
private int GetWeekOfYear()
{
var usCulture = new CultureInfo("en-US");
var weekNo = usCulture.Calendar.GetWeekOfYear(
DateTime.Now,
usCulture.DateTimeFormat.CalendarWeekRule,
usCulture.DateTimeFormat.FirstDayOfWeek);
return weekNo;
}
2015-03-13 19:37:19 +00:00
public int Order
{
get
{
// Run before the default image provider which will download placeholders
return 0;
}
}
2014-10-29 22:01:02 +00:00
}
}