jellyfin/MediaBrowser.Server.Implementations/Intros/DefaultIntroProvider.cs

548 lines
19 KiB
C#
Raw Normal View History

2014-09-22 21:56:54 +00:00
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Security;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Movies;
using MediaBrowser.Controller.Entities.TV;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Localization;
using MediaBrowser.Model.Configuration;
using MediaBrowser.Model.Entities;
using System;
using System.Collections.Generic;
2014-09-23 00:04:50 +00:00
using System.IO;
2014-09-22 21:56:54 +00:00
using System.Linq;
using System.Threading.Tasks;
2015-10-04 04:23:11 +00:00
using CommonIO;
2016-02-05 05:59:09 +00:00
using MoreLinq;
2014-09-22 21:56:54 +00:00
namespace MediaBrowser.Server.Implementations.Intros
{
public class DefaultIntroProvider : IIntroProvider
{
private readonly ISecurityManager _security;
private readonly ILocalizationManager _localization;
private readonly IConfigurationManager _serverConfig;
2014-11-16 20:44:08 +00:00
private readonly ILibraryManager _libraryManager;
2015-09-24 17:50:49 +00:00
private readonly IFileSystem _fileSystem;
2016-02-05 05:59:09 +00:00
private readonly IMediaSourceManager _mediaSourceManager;
2014-09-22 21:56:54 +00:00
2016-03-19 19:32:37 +00:00
public DefaultIntroProvider(ISecurityManager security, ILocalizationManager localization, IConfigurationManager serverConfig, ILibraryManager libraryManager, IFileSystem fileSystem, IMediaSourceManager mediaSourceManager)
2014-09-22 21:56:54 +00:00
{
_security = security;
_localization = localization;
_serverConfig = serverConfig;
2014-11-16 20:44:08 +00:00
_libraryManager = libraryManager;
2015-09-24 17:50:49 +00:00
_fileSystem = fileSystem;
2016-02-05 05:59:09 +00:00
_mediaSourceManager = mediaSourceManager;
2014-09-22 21:56:54 +00:00
}
public async Task<IEnumerable<IntroInfo>> GetIntros(BaseItem item, User user)
{
var config = GetOptions();
if (item is Movie)
{
if (!config.EnableIntrosForMovies)
{
return new List<IntroInfo>();
}
}
else if (item is Episode)
{
if (!config.EnableIntrosForEpisodes)
{
return new List<IntroInfo>();
}
}
else
{
return new List<IntroInfo>();
}
var ratingLevel = string.IsNullOrWhiteSpace(item.OfficialRating)
2014-12-03 03:13:03 +00:00
? null
2014-09-22 21:56:54 +00:00
: _localization.GetRatingLevel(item.OfficialRating);
var random = new Random(Environment.TickCount + Guid.NewGuid().GetHashCode());
var candidates = new List<ItemWithTrailer>();
2015-07-08 16:10:34 +00:00
var itemPeople = _libraryManager.GetPeople(item);
var allPeople = _libraryManager.GetPeople(new InternalPeopleQuery
{
AppearsInItemId = item.Id
});
2014-09-30 04:47:30 +00:00
var trailerTypes = new List<TrailerType>();
2016-03-19 19:32:37 +00:00
if (config.EnableIntrosFromMoviesInLibrary)
2014-09-30 04:47:30 +00:00
{
2016-03-19 19:32:37 +00:00
trailerTypes.Add(TrailerType.LocalTrailer);
2014-09-30 04:47:30 +00:00
}
2016-03-19 19:32:37 +00:00
if (IsSupporter)
2014-10-08 23:31:44 +00:00
{
2016-03-19 19:32:37 +00:00
if (config.EnableIntrosFromUpcomingTrailers)
{
trailerTypes.Add(TrailerType.ComingSoonToTheaters);
}
if (config.EnableIntrosFromUpcomingDvdMovies)
{
trailerTypes.Add(TrailerType.ComingSoonToDvd);
}
if (config.EnableIntrosFromUpcomingStreamingMovies)
{
trailerTypes.Add(TrailerType.ComingSoonToStreaming);
}
if (config.EnableIntrosFromSimilarMovies)
{
trailerTypes.Add(TrailerType.Archive);
}
2014-10-08 23:31:44 +00:00
}
2014-09-30 04:47:30 +00:00
2016-03-19 19:32:37 +00:00
if (trailerTypes.Count > 0)
2014-09-22 21:56:54 +00:00
{
2016-03-30 16:37:29 +00:00
var excludeTrailerTypes = Enum.GetNames(typeof(TrailerType))
.Select(i => (TrailerType)Enum.Parse(typeof(TrailerType), i, true))
.Except(trailerTypes)
.ToArray();
2016-03-20 06:46:51 +00:00
var trailerResult = _libraryManager.GetItemList(new InternalItemsQuery
2014-09-22 21:56:54 +00:00
{
2016-03-19 19:32:37 +00:00
IncludeItemTypes = new[] { typeof(Trailer).Name },
2016-03-30 16:37:29 +00:00
ExcludeTrailerTypes = excludeTrailerTypes
2016-03-19 19:32:37 +00:00
});
2014-09-22 21:56:54 +00:00
2016-03-20 06:46:51 +00:00
candidates.AddRange(trailerResult.Select(i => new ItemWithTrailer
2014-09-22 21:56:54 +00:00
{
Item = i,
2016-03-19 19:32:37 +00:00
Type = i.SourceType == SourceType.Channel ? ItemWithTrailerType.ChannelTrailer : ItemWithTrailerType.ItemWithTrailer,
2014-09-22 21:56:54 +00:00
User = user,
WatchingItem = item,
2015-07-08 16:10:34 +00:00
WatchingItemPeople = itemPeople,
AllPeople = allPeople,
2015-06-21 03:35:22 +00:00
Random = random,
LibraryManager = _libraryManager
2014-09-22 21:56:54 +00:00
}));
2016-03-19 19:32:37 +00:00
}
2014-09-22 21:56:54 +00:00
2015-01-25 06:34:50 +00:00
return GetResult(item, candidates, config, ratingLevel);
}
private IEnumerable<IntroInfo> GetResult(BaseItem item, IEnumerable<ItemWithTrailer> candidates, CinemaModeConfiguration config, int? ratingLevel)
{
2014-10-02 00:28:16 +00:00
var customIntros = !string.IsNullOrWhiteSpace(config.CustomIntroPath) ?
2015-11-17 17:46:15 +00:00
GetCustomIntros(config) :
2014-09-22 21:56:54 +00:00
new List<IntroInfo>();
2016-02-05 05:59:09 +00:00
var mediaInfoIntros = !string.IsNullOrWhiteSpace(config.MediaInfoIntroPath) ?
GetMediaInfoIntros(config, item) :
new List<IntroInfo>();
2014-10-09 22:22:04 +00:00
var trailerLimit = config.TrailerLimit;
2014-09-22 21:56:54 +00:00
// Avoid implicitly captured closure
return candidates.Where(i =>
{
if (config.EnableIntrosParentalControl && !FilterByParentalRating(ratingLevel, i.Item))
{
return false;
}
if (!config.EnableIntrosForWatchedContent && i.IsPlayed)
{
return false;
}
2014-10-02 01:36:58 +00:00
return !IsDuplicate(item, i.Item);
2014-09-22 21:56:54 +00:00
})
.OrderByDescending(i => i.Score)
.ThenBy(i => Guid.NewGuid())
2016-03-27 21:11:27 +00:00
.ThenByDescending(i => i.IsPlayed ? 0 : 1)
2014-09-22 21:56:54 +00:00
.Select(i => i.IntroInfo)
.Take(trailerLimit)
2016-02-05 05:59:09 +00:00
.Concat(customIntros.Take(1))
.Concat(mediaInfoIntros);
2014-09-22 21:56:54 +00:00
}
2014-10-02 01:36:58 +00:00
private bool IsDuplicate(BaseItem playingContent, BaseItem test)
{
var id = playingContent.GetProviderId(MetadataProviders.Imdb);
if (!string.IsNullOrWhiteSpace(id) && string.Equals(id, test.GetProviderId(MetadataProviders.Imdb), StringComparison.OrdinalIgnoreCase))
{
return true;
}
id = playingContent.GetProviderId(MetadataProviders.Tmdb);
if (!string.IsNullOrWhiteSpace(id) && string.Equals(id, test.GetProviderId(MetadataProviders.Tmdb), StringComparison.OrdinalIgnoreCase))
{
return true;
}
return false;
}
2014-09-22 21:56:54 +00:00
private CinemaModeConfiguration GetOptions()
{
return _serverConfig.GetConfiguration<CinemaModeConfiguration>("cinemamode");
}
2015-11-17 17:46:15 +00:00
private List<IntroInfo> GetCustomIntros(CinemaModeConfiguration options)
2014-09-22 21:56:54 +00:00
{
2014-09-23 00:04:50 +00:00
try
{
2015-11-17 17:46:15 +00:00
return GetCustomIntroFiles(options, true, false)
2014-09-23 00:04:50 +00:00
.OrderBy(i => Guid.NewGuid())
.Select(i => new IntroInfo
{
Path = i
}).ToList();
}
catch (IOException)
{
return new List<IntroInfo>();
}
}
2016-02-05 05:59:09 +00:00
private IEnumerable<IntroInfo> GetMediaInfoIntros(CinemaModeConfiguration options, BaseItem item)
{
try
{
var hasMediaSources = item as IHasMediaSources;
if (hasMediaSources == null)
{
return new List<IntroInfo>();
}
var mediaSource = _mediaSourceManager.GetStaticMediaSources(hasMediaSources, false)
.FirstOrDefault();
if (mediaSource == null)
{
return new List<IntroInfo>();
}
var videoStream = mediaSource.MediaStreams.FirstOrDefault(i => i.Type == MediaStreamType.Video);
var audioStream = mediaSource.MediaStreams.FirstOrDefault(i => i.Type == MediaStreamType.Audio);
var allIntros = GetCustomIntroFiles(options, false, true)
.OrderBy(i => Guid.NewGuid())
.Select(i => new IntroInfo
{
Path = i
}).ToList();
var returnResult = new List<IntroInfo>();
if (videoStream != null)
{
returnResult.AddRange(GetMediaInfoIntrosByVideoStream(allIntros, videoStream).Take(1));
}
if (audioStream != null)
{
returnResult.AddRange(GetMediaInfoIntrosByAudioStream(allIntros, audioStream).Take(1));
}
returnResult.AddRange(GetMediaInfoIntrosByTags(allIntros, item.Tags).Take(1));
return returnResult.DistinctBy(i => i.Path, StringComparer.OrdinalIgnoreCase);
}
catch (IOException)
{
return new List<IntroInfo>();
}
}
private IEnumerable<IntroInfo> GetMediaInfoIntrosByVideoStream(List<IntroInfo> allIntros, MediaStream stream)
{
var codec = stream.Codec;
if (string.IsNullOrWhiteSpace(codec))
{
return new List<IntroInfo>();
}
return allIntros
.Where(i => IsMatch(i.Path, codec));
}
private IEnumerable<IntroInfo> GetMediaInfoIntrosByAudioStream(List<IntroInfo> allIntros, MediaStream stream)
{
var codec = stream.Codec;
if (string.IsNullOrWhiteSpace(codec))
{
return new List<IntroInfo>();
}
return allIntros
.Where(i => IsAudioMatch(i.Path, stream));
}
private IEnumerable<IntroInfo> GetMediaInfoIntrosByTags(List<IntroInfo> allIntros, List<string> tags)
{
return allIntros
.Where(i => tags.Any(t => IsMatch(i.Path, t)));
}
private bool IsMatch(string file, string attribute)
{
var filename = Path.GetFileNameWithoutExtension(file) ?? string.Empty;
filename = Normalize(filename);
if (string.IsNullOrWhiteSpace(filename))
{
return false;
}
attribute = Normalize(attribute);
if (string.IsNullOrWhiteSpace(attribute))
{
return false;
}
return string.Equals(filename, attribute, StringComparison.OrdinalIgnoreCase);
}
private string Normalize(string value)
{
return value;
}
private bool IsAudioMatch(string path, MediaStream stream)
{
if (!string.IsNullOrWhiteSpace(stream.Codec))
{
if (IsMatch(path, stream.Codec))
{
return true;
}
}
if (!string.IsNullOrWhiteSpace(stream.Profile))
{
if (IsMatch(path, stream.Profile))
{
return true;
}
}
return false;
}
2015-11-17 17:46:15 +00:00
private IEnumerable<string> GetCustomIntroFiles(CinemaModeConfiguration options, bool enableCustomIntros, bool enableMediaInfoIntros)
2014-09-23 00:04:50 +00:00
{
2015-11-17 16:37:16 +00:00
var list = new List<string>();
2015-11-17 17:46:15 +00:00
if (enableCustomIntros && !string.IsNullOrWhiteSpace(options.CustomIntroPath))
2014-09-23 00:04:50 +00:00
{
2015-11-17 16:37:16 +00:00
list.AddRange(_fileSystem.GetFilePaths(options.CustomIntroPath, true)
.Where(_libraryManager.IsVideoFile));
2014-09-23 00:04:50 +00:00
}
2015-11-17 17:46:15 +00:00
if (enableMediaInfoIntros && !string.IsNullOrWhiteSpace(options.MediaInfoIntroPath))
2015-11-17 16:37:16 +00:00
{
2015-11-17 17:41:58 +00:00
list.AddRange(_fileSystem.GetFilePaths(options.MediaInfoIntroPath, true)
2015-11-17 16:37:16 +00:00
.Where(_libraryManager.IsVideoFile));
}
2015-11-17 17:46:15 +00:00
2015-11-17 16:37:16 +00:00
return list.Distinct(StringComparer.OrdinalIgnoreCase);
2014-09-22 21:56:54 +00:00
}
private bool FilterByParentalRating(int? ratingLevel, BaseItem item)
{
// Only content rated same or lower
if (ratingLevel.HasValue)
{
var level = string.IsNullOrWhiteSpace(item.OfficialRating)
? (int?)null
: _localization.GetRatingLevel(item.OfficialRating);
return level.HasValue && level.Value <= ratingLevel.Value;
}
return true;
}
2015-07-08 16:10:34 +00:00
internal static int GetSimiliarityScore(BaseItem item1, List<PersonInfo> item1People, List<PersonInfo> allPeople, BaseItem item2, Random random, ILibraryManager libraryManager)
2014-09-22 21:56:54 +00:00
{
var points = 0;
if (!string.IsNullOrEmpty(item1.OfficialRating) && string.Equals(item1.OfficialRating, item2.OfficialRating, StringComparison.OrdinalIgnoreCase))
{
points += 10;
}
// Find common genres
points += item1.Genres.Where(i => item2.Genres.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
// Find common tags
points += GetTags(item1).Where(i => GetTags(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
// Find common keywords
points += GetKeywords(item1).Where(i => GetKeywords(item2).Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 10);
// Find common studios
points += item1.Studios.Where(i => item2.Studios.Contains(i, StringComparer.OrdinalIgnoreCase)).Sum(i => 5);
2015-07-08 16:10:34 +00:00
var item2PeopleNames = allPeople.Where(i => i.ItemId == item2.Id)
.Select(i => i.Name)
.Where(i => !string.IsNullOrWhiteSpace(i))
.DistinctNames()
2014-09-22 21:56:54 +00:00
.ToDictionary(i => i, StringComparer.OrdinalIgnoreCase);
2015-07-08 16:10:34 +00:00
points += item1People.Where(i => item2PeopleNames.ContainsKey(i.Name)).Sum(i =>
2014-09-22 21:56:54 +00:00
{
if (string.Equals(i.Type, PersonType.Director, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Director, StringComparison.OrdinalIgnoreCase))
{
return 5;
}
if (string.Equals(i.Type, PersonType.Actor, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Actor, StringComparison.OrdinalIgnoreCase))
{
return 3;
}
if (string.Equals(i.Type, PersonType.Composer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Composer, StringComparison.OrdinalIgnoreCase))
{
return 3;
}
if (string.Equals(i.Type, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase))
{
return 3;
}
if (string.Equals(i.Type, PersonType.Writer, StringComparison.OrdinalIgnoreCase) || string.Equals(i.Role, PersonType.Writer, StringComparison.OrdinalIgnoreCase))
{
return 2;
}
return 1;
});
// Add some randomization so that you're not always seeing the same ones for a given movie
points += random.Next(0, 50);
return points;
}
private static IEnumerable<string> GetTags(BaseItem item)
{
var hasTags = item as IHasTags;
if (hasTags != null)
{
return hasTags.Tags;
}
return new List<string>();
}
private static IEnumerable<string> GetKeywords(BaseItem item)
{
var hasTags = item as IHasKeywords;
if (hasTags != null)
{
return hasTags.Keywords;
}
return new List<string>();
}
public IEnumerable<string> GetAllIntroFiles()
{
2015-11-17 17:46:15 +00:00
return GetCustomIntroFiles(GetOptions(), true, true);
2014-09-22 21:56:54 +00:00
}
private bool IsSupporter
{
get { return _security.IsMBSupporter; }
}
public string Name
{
get { return "Default"; }
}
internal class ItemWithTrailer
{
internal BaseItem Item;
internal ItemWithTrailerType Type;
internal User User;
internal BaseItem WatchingItem;
2015-07-08 16:10:34 +00:00
internal List<PersonInfo> WatchingItemPeople;
internal List<PersonInfo> AllPeople;
2014-09-22 21:56:54 +00:00
internal Random Random;
2015-06-21 03:35:22 +00:00
internal ILibraryManager LibraryManager;
2014-09-22 21:56:54 +00:00
private bool? _isPlayed;
public bool IsPlayed
{
get
{
if (!_isPlayed.HasValue)
{
_isPlayed = Item.IsPlayed(User);
}
return _isPlayed.Value;
}
}
private int? _score;
public int Score
{
get
{
if (!_score.HasValue)
{
2015-07-08 16:10:34 +00:00
_score = GetSimiliarityScore(WatchingItem, WatchingItemPeople, AllPeople, Item, Random, LibraryManager);
2014-09-22 21:56:54 +00:00
}
return _score.Value;
}
}
public IntroInfo IntroInfo
{
get
{
var id = Item.Id;
if (Type == ItemWithTrailerType.ItemWithTrailer)
{
var hasTrailers = Item as IHasTrailers;
if (hasTrailers != null)
{
id = hasTrailers.LocalTrailerIds.FirstOrDefault();
}
}
return new IntroInfo
{
ItemId = id
};
}
}
}
internal enum ItemWithTrailerType
{
ChannelTrailer,
ItemWithTrailer
}
}
public class CinemaModeConfigurationFactory : IConfigurationFactory
{
public IEnumerable<ConfigurationStore> GetConfigurations()
{
return new[]
{
new ConfigurationStore
{
ConfigurationType = typeof(CinemaModeConfiguration),
Key = "cinemamode"
}
};
}
}
}