jellyfin/MediaBrowser.Controller/Entities/TV/Series.cs

600 lines
20 KiB
C#
Raw Normal View History

2015-02-15 03:36:07 +00:00
using MediaBrowser.Controller.Providers;
2013-12-26 16:53:23 +00:00
using MediaBrowser.Model.Configuration;
2013-02-21 01:33:05 +00:00
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Querying;
2014-12-27 05:08:39 +00:00
using MediaBrowser.Model.Users;
2013-02-21 01:33:05 +00:00
using System;
using System.Collections.Generic;
using System.Linq;
2015-02-15 03:36:07 +00:00
using System.Threading;
using System.Threading.Tasks;
2016-10-22 02:08:34 +00:00
using MediaBrowser.Model.Extensions;
2016-05-31 15:38:47 +00:00
using MediaBrowser.Model.Providers;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.Serialization;
2013-02-21 01:33:05 +00:00
namespace MediaBrowser.Controller.Entities.TV
{
/// <summary>
/// Class Series
/// </summary>
2016-10-31 04:28:23 +00:00
public class Series : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo<SeriesInfo>, IMetadataContainer
2013-02-21 01:33:05 +00:00
{
2014-02-28 04:49:02 +00:00
public int? AnimeSeriesIndex { get; set; }
2013-05-15 13:57:13 +00:00
public Series()
{
AirDays = new List<DayOfWeek>();
2013-12-02 16:46:25 +00:00
RemoteTrailers = new List<MediaUrl>();
LocalTrailerIds = new List<Guid>();
2014-12-11 06:20:28 +00:00
RemoteTrailerIds = new List<Guid>();
2013-05-15 13:57:13 +00:00
}
2014-08-30 14:26:29 +00:00
[IgnoreDataMember]
public override bool SupportsAddingToPlaylist
{
get { return true; }
}
[IgnoreDataMember]
public override bool IsPreSorted
{
get
{
2016-05-09 03:13:38 +00:00
return true;
}
}
[IgnoreDataMember]
public override bool SupportsDateLastMediaAdded
{
get
{
return true;
}
}
2013-12-02 16:46:25 +00:00
public List<Guid> LocalTrailerIds { get; set; }
2014-12-11 06:20:28 +00:00
public List<Guid> RemoteTrailerIds { get; set; }
2013-12-02 16:46:25 +00:00
public List<MediaUrl> RemoteTrailers { get; set; }
/// <summary>
/// airdate, dvd or absolute
/// </summary>
public string DisplayOrder { get; set; }
2015-04-29 17:39:23 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets or sets the status.
/// </summary>
/// <value>The status.</value>
public SeriesStatus? Status { get; set; }
/// <summary>
/// Gets or sets the air days.
/// </summary>
/// <value>The air days.</value>
public List<DayOfWeek> AirDays { get; set; }
/// <summary>
/// Gets or sets the air time.
/// </summary>
/// <value>The air time.</value>
public string AirTime { get; set; }
2013-09-30 00:51:21 +00:00
/// <summary>
/// Gets or sets the date last episode added.
/// </summary>
/// <value>The date last episode added.</value>
2014-12-27 05:08:39 +00:00
[IgnoreDataMember]
public DateTime DateLastEpisodeAdded
{
get
{
2016-06-12 05:03:52 +00:00
return DateLastMediaAdded ?? DateTime.MinValue;
2014-12-27 05:08:39 +00:00
}
2013-02-21 01:33:05 +00:00
}
public override string CreatePresentationUniqueKey()
2016-05-01 22:11:24 +00:00
{
2016-12-06 08:24:29 +00:00
if (LibraryManager.GetLibraryOptions(this).EnableAutomaticSeriesGrouping)
{
2016-12-06 08:24:29 +00:00
var userdatakeys = GetUserDataKeys();
if (userdatakeys.Count > 1)
{
return AddLibrariesToPresentationUniqueKey(userdatakeys[0]);
}
2016-05-12 19:21:43 +00:00
}
2016-12-06 08:24:29 +00:00
return base.CreatePresentationUniqueKey();
}
private string AddLibrariesToPresentationUniqueKey(string key)
{
2016-10-22 02:08:34 +00:00
var lang = GetPreferredMetadataLanguage();
if (!string.IsNullOrWhiteSpace(lang))
{
key += "-" + lang;
}
var folders = LibraryManager.GetCollectionFolders(this)
.Select(i => i.Id.ToString("N"))
.ToArray();
if (folders.Length == 0)
{
return key;
}
return key + "-" + string.Join("-", folders);
2016-05-01 22:11:24 +00:00
}
2016-07-01 15:51:35 +00:00
private static string GetUniqueSeriesKey(BaseItem series)
{
return series.GetPresentationUniqueKey();
2016-07-01 15:51:35 +00:00
}
2016-06-16 13:24:12 +00:00
public override int GetChildCount(User user)
{
2016-12-06 08:24:29 +00:00
var enableSeriesPresentationKey = ConfigurationManager.Configuration.EnableSeriesPresentationUniqueKey;
var seriesKey = GetUniqueSeriesKey(this);
2016-12-12 19:40:27 +00:00
var result = LibraryManager.GetCount(new InternalItemsQuery(user)
2016-06-16 13:24:12 +00:00
{
2016-12-06 08:24:29 +00:00
AncestorWithPresentationUniqueKey = enableSeriesPresentationKey ? null : seriesKey,
SeriesPresentationUniqueKey = enableSeriesPresentationKey ? seriesKey : null,
2016-06-16 13:24:12 +00:00
IncludeItemTypes = new[] { typeof(Season).Name },
IsVirtualItem = false,
2016-12-12 19:40:27 +00:00
Limit = 0,
DtoOptions = new Dto.DtoOptions
{
Fields = new List<ItemFields>
{
},
EnableImages = false
}
2016-06-16 13:24:12 +00:00
});
2016-12-12 19:40:27 +00:00
return result;
2016-06-16 13:24:12 +00:00
}
2016-11-25 17:36:00 +00:00
public override int GetRecursiveChildCount(User user)
{
2016-12-06 08:24:29 +00:00
var enableSeriesPresentationKey = ConfigurationManager.Configuration.EnableSeriesPresentationUniqueKey;
var seriesKey = GetUniqueSeriesKey(this);
var query = new InternalItemsQuery(user)
{
AncestorWithPresentationUniqueKey = enableSeriesPresentationKey ? null : seriesKey,
SeriesPresentationUniqueKey = enableSeriesPresentationKey ? seriesKey : null,
2016-12-12 19:40:27 +00:00
DtoOptions = new Dto.DtoOptions
{
Fields = new List<ItemFields>
{
},
EnableImages = false
}
2016-12-06 08:24:29 +00:00
};
2016-11-25 17:36:00 +00:00
if (query.IncludeItemTypes.Length == 0)
{
query.IncludeItemTypes = new[] { typeof(Episode).Name, typeof(Season).Name };
}
query.IsVirtualItem = false;
query.Limit = 0;
2016-12-12 19:40:27 +00:00
var totalRecordCount = LibraryManager.GetCount(query);
2016-12-12 08:53:25 +00:00
return totalRecordCount;
2016-11-25 17:36:00 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the user data key.
2013-02-21 01:33:05 +00:00
/// </summary>
/// <returns>System.String.</returns>
2016-04-30 23:05:21 +00:00
public override List<string> GetUserDataKeys()
2013-02-21 01:33:05 +00:00
{
2016-04-30 23:05:21 +00:00
var list = base.GetUserDataKeys();
2015-04-29 17:39:23 +00:00
2016-04-30 23:05:21 +00:00
var key = this.GetProviderId(MetadataProviders.Imdb);
if (!string.IsNullOrWhiteSpace(key))
2015-04-29 17:39:23 +00:00
{
2016-04-30 23:05:21 +00:00
list.Insert(0, key);
2015-04-29 17:39:23 +00:00
}
2016-04-30 23:05:21 +00:00
key = this.GetProviderId(MetadataProviders.Tvdb);
if (!string.IsNullOrWhiteSpace(key))
2015-04-29 17:39:23 +00:00
{
2016-04-30 23:05:21 +00:00
list.Insert(0, key);
2015-04-29 17:39:23 +00:00
}
2016-04-30 23:05:21 +00:00
return list;
2013-02-21 01:33:05 +00:00
}
2014-12-11 06:20:28 +00:00
/// <summary>
/// Gets the trailer ids.
/// </summary>
/// <returns>List&lt;Guid&gt;.</returns>
public List<Guid> GetTrailerIds()
{
var list = LocalTrailerIds.ToList();
list.AddRange(RemoteTrailerIds);
return list;
}
2013-02-21 01:33:05 +00:00
// Studio, Genre and Rating will all be the same so makes no sense to index by these
2013-12-11 02:51:26 +00:00
protected override IEnumerable<string> GetIndexByOptions()
2013-02-21 01:33:05 +00:00
{
2016-04-30 23:05:21 +00:00
return new List<string> {
{"None"},
2015-02-05 05:29:37 +00:00
{"Performer"},
{"Director"},
{"Year"},
2013-02-21 01:33:05 +00:00
};
}
[IgnoreDataMember]
public bool ContainsEpisodesWithoutSeasonFolders
{
get
{
return Children.OfType<Video>().Any();
}
}
2013-12-11 02:51:26 +00:00
public override IEnumerable<BaseItem> GetChildren(User user, bool includeLinkedChildren)
{
return GetSeasons(user);
}
public IEnumerable<Season> GetSeasons(User user)
{
var config = user.Configuration;
2016-12-06 08:24:29 +00:00
var enableSeriesPresentationKey = ConfigurationManager.Configuration.EnableSeriesPresentationUniqueKey;
2016-08-18 05:56:10 +00:00
var seriesKey = GetUniqueSeriesKey(this);
var query = new InternalItemsQuery(user)
{
2016-12-06 08:24:29 +00:00
AncestorWithPresentationUniqueKey = enableSeriesPresentationKey ? null : seriesKey,
SeriesPresentationUniqueKey = enableSeriesPresentationKey ? seriesKey : null,
2016-10-22 02:08:34 +00:00
IncludeItemTypes = new[] { typeof(Season).Name },
SortBy = new[] { ItemSortBy.SortName }
2016-08-18 05:56:10 +00:00
};
if (!config.DisplayMissingEpisodes && !config.DisplayUnairedEpisodes)
{
query.IsVirtualItem = false;
}
else if (!config.DisplayMissingEpisodes)
{
query.IsMissing = false;
}
else if (!config.DisplayUnairedEpisodes)
{
query.IsVirtualUnaired = false;
}
return LibraryManager.GetItemList(query).Cast<Season>();
}
protected override Task<QueryResult<BaseItem>> GetItemsInternal(InternalItemsQuery query)
2016-02-26 06:38:29 +00:00
{
2016-06-04 00:15:14 +00:00
if (query.User == null)
{
return base.GetItemsInternal(query);
}
2016-02-26 06:38:29 +00:00
var user = query.User;
2016-06-15 18:56:37 +00:00
if (query.Recursive)
{
2016-12-06 08:24:29 +00:00
var enableSeriesPresentationKey = ConfigurationManager.Configuration.EnableSeriesPresentationUniqueKey;
var seriesKey = GetUniqueSeriesKey(this);
query.AncestorWithPresentationUniqueKey = enableSeriesPresentationKey ? null : seriesKey;
query.SeriesPresentationUniqueKey = enableSeriesPresentationKey ? seriesKey : null;
2016-06-15 18:56:37 +00:00
if (query.SortBy.Length == 0)
{
query.SortBy = new[] { ItemSortBy.SortName };
}
if (query.IncludeItemTypes.Length == 0)
{
query.IncludeItemTypes = new[] { typeof(Episode).Name, typeof(Season).Name };
}
query.IsVirtualItem = false;
return Task.FromResult(LibraryManager.GetItemsResult(query));
}
2016-02-26 06:38:29 +00:00
2016-06-15 18:56:37 +00:00
Func<BaseItem, bool> filter = i => UserViewBuilder.Filter(i, user, query, UserDataManager, LibraryManager);
2016-02-26 06:38:29 +00:00
2016-06-15 18:56:37 +00:00
var items = GetSeasons(user).Where(filter);
2016-08-17 20:52:16 +00:00
var result = PostFilterAndSort(items, query, false, true);
2016-02-26 06:38:29 +00:00
return Task.FromResult(result);
}
2016-08-18 05:56:10 +00:00
public IEnumerable<Episode> GetEpisodes(User user)
{
2016-12-06 08:24:29 +00:00
var enableSeriesPresentationKey = ConfigurationManager.Configuration.EnableSeriesPresentationUniqueKey;
2016-08-16 06:13:54 +00:00
var seriesKey = GetUniqueSeriesKey(this);
2016-05-02 05:32:04 +00:00
2016-08-18 05:56:10 +00:00
var query = new InternalItemsQuery(user)
2016-05-02 05:32:04 +00:00
{
2016-12-06 08:24:29 +00:00
AncestorWithPresentationUniqueKey = enableSeriesPresentationKey ? null : seriesKey,
SeriesPresentationUniqueKey = enableSeriesPresentationKey ? seriesKey : null,
2016-10-22 02:08:34 +00:00
IncludeItemTypes = new[] { typeof(Episode).Name, typeof(Season).Name },
SortBy = new[] { ItemSortBy.SortName }
2016-08-18 05:56:10 +00:00
};
var config = user.Configuration;
if (!config.DisplayMissingEpisodes && !config.DisplayUnairedEpisodes)
{
2016-08-18 05:56:10 +00:00
query.IsVirtualItem = false;
}
2016-08-18 05:56:10 +00:00
else if (!config.DisplayMissingEpisodes)
{
2016-08-18 05:56:10 +00:00
query.IsMissing = false;
}
2016-08-18 05:56:10 +00:00
else if (!config.DisplayUnairedEpisodes)
2016-06-04 16:10:10 +00:00
{
2016-08-18 05:56:10 +00:00
query.IsVirtualUnaired = false;
}
2016-06-12 05:03:52 +00:00
2016-08-18 05:56:10 +00:00
var allItems = LibraryManager.GetItemList(query).ToList();
2016-06-04 16:10:10 +00:00
var allSeriesEpisodes = allItems.OfType<Episode>().ToList();
2016-06-04 00:15:14 +00:00
2016-06-04 16:10:10 +00:00
var allEpisodes = allItems.OfType<Season>()
2016-08-18 05:56:10 +00:00
.SelectMany(i => i.GetEpisodes(this, user, allSeriesEpisodes))
.Reverse()
.ToList();
// Specials could appear twice based on above - once in season 0, once in the aired season
// This depends on settings for that series
// When this happens, remove the duplicate from season 0
2016-05-07 17:47:41 +00:00
return allEpisodes.DistinctBy(i => i.Id).Reverse();
}
2015-01-28 21:29:02 +00:00
public async Task RefreshAllMetadata(MetadataRefreshOptions refreshOptions, IProgress<double> progress, CancellationToken cancellationToken)
{
// Refresh bottom up, children first, then the boxset
// By then hopefully the movies within will have Tmdb collection values
var items = GetRecursiveChildren().ToList();
var seasons = items.OfType<Season>().ToList();
var otherItems = items.Except(seasons).ToList();
var totalItems = seasons.Count + otherItems.Count;
var numComplete = 0;
// Refresh current item
await RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
// Refresh seasons
2015-01-28 21:29:02 +00:00
foreach (var item in seasons)
{
cancellationToken.ThrowIfCancellationRequested();
await item.RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
numComplete++;
double percent = numComplete;
percent /= totalItems;
progress.Report(percent * 100);
}
// Refresh episodes and other children
2015-01-28 21:29:02 +00:00
foreach (var item in otherItems)
{
cancellationToken.ThrowIfCancellationRequested();
var skipItem = false;
var episode = item as Episode;
if (episode != null
&& refreshOptions.MetadataRefreshMode != MetadataRefreshMode.FullRefresh
&& !refreshOptions.ReplaceAllMetadata
2016-04-30 23:05:21 +00:00
&& episode.IsMissingEpisode
2016-05-29 20:20:32 +00:00
&& episode.LocationType == LocationType.Virtual
2016-04-30 23:05:21 +00:00
&& episode.PremiereDate.HasValue
&& (DateTime.UtcNow - episode.PremiereDate.Value).TotalDays > 30)
{
skipItem = true;
}
if (!skipItem)
{
await item.RefreshMetadata(refreshOptions, cancellationToken).ConfigureAwait(false);
}
2015-01-28 21:29:02 +00:00
numComplete++;
double percent = numComplete;
percent /= totalItems;
progress.Report(percent * 100);
}
2016-05-29 20:20:32 +00:00
refreshOptions = new MetadataRefreshOptions(refreshOptions);
refreshOptions.IsPostRecursiveRefresh = true;
2015-03-14 15:38:16 +00:00
await ProviderManager.RefreshSingleItem(this, refreshOptions, cancellationToken).ConfigureAwait(false);
2015-01-28 21:29:02 +00:00
progress.Report(100);
}
2016-09-03 18:18:59 +00:00
public IEnumerable<Episode> GetSeasonEpisodes(Season parentSeason, User user)
2016-06-04 00:15:14 +00:00
{
2016-12-06 08:24:29 +00:00
var enableSeriesPresentationKey = ConfigurationManager.Configuration.EnableSeriesPresentationUniqueKey;
var queryFromSeries = ConfigurationManager.Configuration.DisplaySpecialsWithinSeasons;
2016-11-25 17:36:00 +00:00
// add optimization when this setting is not enabled
2016-12-06 08:24:29 +00:00
var seriesKey = queryFromSeries ?
2016-11-25 17:36:00 +00:00
GetUniqueSeriesKey(this) :
GetUniqueSeriesKey(parentSeason);
2016-06-04 00:15:14 +00:00
2016-08-18 05:56:10 +00:00
var query = new InternalItemsQuery(user)
2016-06-04 00:15:14 +00:00
{
2016-12-06 08:24:29 +00:00
AncestorWithPresentationUniqueKey = queryFromSeries && enableSeriesPresentationKey ? null : seriesKey,
SeriesPresentationUniqueKey = queryFromSeries && enableSeriesPresentationKey ? seriesKey : null,
2016-08-18 05:56:10 +00:00
IncludeItemTypes = new[] { typeof(Episode).Name },
SortBy = new[] { ItemSortBy.SortName }
};
2016-09-03 18:18:59 +00:00
if (user != null)
{
2016-09-03 18:18:59 +00:00
var config = user.Configuration;
if (!config.DisplayMissingEpisodes && !config.DisplayUnairedEpisodes)
{
query.IsVirtualItem = false;
}
else if (!config.DisplayMissingEpisodes)
{
query.IsMissing = false;
}
else if (!config.DisplayUnairedEpisodes)
{
query.IsVirtualUnaired = false;
}
}
2016-08-18 05:56:10 +00:00
var allItems = LibraryManager.GetItemList(query).OfType<Episode>();
2013-12-19 21:51:32 +00:00
2016-09-03 18:18:59 +00:00
return GetSeasonEpisodes(parentSeason, user, allItems);
}
2016-09-03 18:18:59 +00:00
public IEnumerable<Episode> GetSeasonEpisodes(Season parentSeason, User user, IEnumerable<Episode> allSeriesEpisodes)
{
2016-08-18 05:56:10 +00:00
if (allSeriesEpisodes == null)
{
2016-09-03 18:18:59 +00:00
return GetSeasonEpisodes(parentSeason, user);
}
2016-08-18 05:56:10 +00:00
var episodes = FilterEpisodesBySeason(allSeriesEpisodes, parentSeason, ConfigurationManager.Configuration.DisplaySpecialsWithinSeasons);
2016-08-18 05:56:10 +00:00
var sortBy = (parentSeason.IndexNumber ?? -1) == 0 ? ItemSortBy.SortName : ItemSortBy.AiredEpisodeOrder;
2016-08-18 05:56:10 +00:00
return LibraryManager.Sort(episodes, user, new[] { sortBy }, SortOrder.Ascending)
.Cast<Episode>();
}
2013-12-26 16:53:23 +00:00
2016-05-24 19:48:53 +00:00
/// <summary>
/// Filters the episodes by season.
/// </summary>
public static IEnumerable<Episode> FilterEpisodesBySeason(IEnumerable<Episode> episodes, Season parentSeason, bool includeSpecials)
{
var seasonNumber = parentSeason.IndexNumber;
2016-07-01 15:51:35 +00:00
var seasonPresentationKey = GetUniqueSeriesKey(parentSeason);
2016-05-24 19:48:53 +00:00
2016-06-08 05:24:25 +00:00
var supportSpecialsInSeason = includeSpecials && seasonNumber.HasValue && seasonNumber.Value != 0;
2016-05-24 19:48:53 +00:00
2016-06-08 05:24:25 +00:00
return episodes.Where(episode =>
{
var currentSeasonNumber = supportSpecialsInSeason ? episode.AiredSeasonNumber : episode.ParentIndexNumber;
if (currentSeasonNumber.HasValue && seasonNumber.HasValue && currentSeasonNumber.Value == seasonNumber.Value)
2016-05-24 19:48:53 +00:00
{
2016-06-08 05:24:25 +00:00
return true;
}
2016-05-24 19:48:53 +00:00
2016-06-08 05:24:25 +00:00
if (!currentSeasonNumber.HasValue && !seasonNumber.HasValue && parentSeason.LocationType == LocationType.Virtual)
{
return true;
}
2016-05-24 19:48:53 +00:00
2016-07-10 15:44:53 +00:00
var season = episode.Season;
return season != null && string.Equals(GetUniqueSeriesKey(season), seasonPresentationKey, StringComparison.OrdinalIgnoreCase);
2016-06-08 05:24:25 +00:00
});
2016-05-24 19:48:53 +00:00
}
2016-08-18 05:56:10 +00:00
/// <summary>
/// Filters the episodes by season.
/// </summary>
public static IEnumerable<Episode> FilterEpisodesBySeason(IEnumerable<Episode> episodes, int seasonNumber, bool includeSpecials)
{
if (!includeSpecials || seasonNumber < 1)
{
return episodes.Where(i => (i.ParentIndexNumber ?? -1) == seasonNumber);
}
return episodes.Where(i =>
{
var episode = i;
if (episode != null)
{
var currentSeasonNumber = episode.AiredSeasonNumber;
return currentSeasonNumber.HasValue && currentSeasonNumber.Value == seasonNumber;
}
return false;
});
}
2014-12-20 06:06:27 +00:00
protected override bool GetBlockUnratedValue(UserPolicy config)
2013-12-26 16:53:23 +00:00
{
return config.BlockUnratedItems.Contains(UnratedItem.Series);
2013-12-26 16:53:23 +00:00
}
2015-11-06 15:02:22 +00:00
public override UnratedItem GetBlockUnratedType()
{
return UnratedItem.Series;
}
2014-02-07 03:10:13 +00:00
public SeriesInfo GetLookupInfo()
{
2014-02-28 04:49:02 +00:00
var info = GetItemLookupInfo<SeriesInfo>();
info.AnimeSeriesIndex = AnimeSeriesIndex;
return info;
2014-02-07 03:10:13 +00:00
}
2014-02-13 05:11:54 +00:00
public override bool BeforeMetadataRefresh()
{
var hasChanges = base.BeforeMetadataRefresh();
if (!ProductionYear.HasValue)
{
2014-11-16 22:46:01 +00:00
var info = LibraryManager.ParseName(Name);
2014-02-13 05:11:54 +00:00
2014-11-16 22:46:01 +00:00
var yearInName = info.Year;
2014-02-13 05:11:54 +00:00
if (yearInName.HasValue)
{
ProductionYear = yearInName;
hasChanges = true;
}
}
return hasChanges;
}
2016-05-31 15:38:47 +00:00
public override List<ExternalUrl> GetRelatedUrls()
{
var list = base.GetRelatedUrls();
var imdbId = this.GetProviderId(MetadataProviders.Imdb);
if (!string.IsNullOrWhiteSpace(imdbId))
{
list.Add(new ExternalUrl
{
Name = "Trakt",
Url = string.Format("https://trakt.tv/shows/{0}", imdbId)
});
}
return list;
}
2016-08-14 21:29:35 +00:00
[IgnoreDataMember]
public override bool StopRefreshIfLocalMetadataFound
{
get
{
// Need people id's from internet metadata
return false;
}
}
2013-02-21 01:33:05 +00:00
}
}