1542 lines
52 KiB
C#
1542 lines
52 KiB
C#
using MediaBrowser.Common.Extensions;
|
|
using MediaBrowser.Controller.Configuration;
|
|
using MediaBrowser.Controller.IO;
|
|
using MediaBrowser.Controller.Library;
|
|
using MediaBrowser.Controller.Localization;
|
|
using MediaBrowser.Controller.Persistence;
|
|
using MediaBrowser.Controller.Providers;
|
|
using MediaBrowser.Controller.Resolvers;
|
|
using MediaBrowser.Model.Entities;
|
|
using MediaBrowser.Model.Logging;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Runtime.Serialization;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Controller.Entities
|
|
{
|
|
/// <summary>
|
|
/// Class BaseItem
|
|
/// </summary>
|
|
public abstract class BaseItem : IHasProviderIds
|
|
{
|
|
/// <summary>
|
|
/// MusicAlbums in the library that are the soundtrack for this item
|
|
/// </summary>
|
|
public List<Guid> SoundtrackIds { get; set; }
|
|
|
|
protected BaseItem()
|
|
{
|
|
Genres = new List<string>();
|
|
RemoteTrailers = new List<MediaUrl>();
|
|
Studios = new List<string>();
|
|
People = new List<PersonInfo>();
|
|
Taglines = new List<string>();
|
|
ScreenshotImagePaths = new List<string>();
|
|
BackdropImagePaths = new List<string>();
|
|
ProductionLocations = new List<string>();
|
|
Images = new Dictionary<ImageType, string>();
|
|
ProviderIds = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
|
|
Tags = new List<string>();
|
|
ThemeSongIds = new List<Guid>();
|
|
ThemeVideoIds = new List<Guid>();
|
|
SoundtrackIds = new List<Guid>();
|
|
LocalTrailerIds = new List<Guid>();
|
|
LockedFields = new List<MetadataFields>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// The supported image extensions
|
|
/// </summary>
|
|
public static readonly string[] SupportedImageExtensions = new[] { ".png", ".jpg", ".jpeg" };
|
|
|
|
/// <summary>
|
|
/// The trailer folder name
|
|
/// </summary>
|
|
public const string TrailerFolderName = "trailers";
|
|
public const string ThemeSongsFolderName = "theme-music";
|
|
public const string ThemeSongFilename = "theme";
|
|
public const string ThemeVideosFolderName = "backdrops";
|
|
public const string XbmcTrailerFileSuffix = "-trailer";
|
|
|
|
public bool IsInMixedFolder { get; set; }
|
|
|
|
private string _name;
|
|
/// <summary>
|
|
/// Gets or sets the name.
|
|
/// </summary>
|
|
/// <value>The name.</value>
|
|
public string Name
|
|
{
|
|
get
|
|
{
|
|
return _name;
|
|
}
|
|
set
|
|
{
|
|
_name = value;
|
|
|
|
// lazy load this again
|
|
_sortName = null;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
public Guid Id { get; set; }
|
|
|
|
/// <summary>
|
|
/// Return the id that should be used to key display prefs for this item.
|
|
/// Default is based on the type for everything except actual generic folders.
|
|
/// </summary>
|
|
/// <value>The display prefs id.</value>
|
|
[IgnoreDataMember]
|
|
public virtual Guid DisplayPreferencesId
|
|
{
|
|
get
|
|
{
|
|
var thisType = GetType();
|
|
return thisType == typeof(Folder) ? Id : thisType.FullName.GetMD5();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the path.
|
|
/// </summary>
|
|
/// <value>The path.</value>
|
|
public virtual string Path { get; set; }
|
|
|
|
[IgnoreDataMember]
|
|
protected internal bool IsOffline { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the type of the location.
|
|
/// </summary>
|
|
/// <value>The type of the location.</value>
|
|
public virtual LocationType LocationType
|
|
{
|
|
get
|
|
{
|
|
if (IsOffline)
|
|
{
|
|
return LocationType.Offline;
|
|
}
|
|
|
|
if (string.IsNullOrEmpty(Path))
|
|
{
|
|
return LocationType.Virtual;
|
|
}
|
|
|
|
return System.IO.Path.IsPathRooted(Path) ? LocationType.FileSystem : LocationType.Remote;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// This is just a helper for convenience
|
|
/// </summary>
|
|
/// <value>The primary image path.</value>
|
|
[IgnoreDataMember]
|
|
public string PrimaryImagePath
|
|
{
|
|
get { return GetImage(ImageType.Primary); }
|
|
set { SetImage(ImageType.Primary, value); }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the images.
|
|
/// </summary>
|
|
/// <value>The images.</value>
|
|
public Dictionary<ImageType, string> Images { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the date created.
|
|
/// </summary>
|
|
/// <value>The date created.</value>
|
|
public DateTime DateCreated { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the date modified.
|
|
/// </summary>
|
|
/// <value>The date modified.</value>
|
|
public DateTime DateModified { get; set; }
|
|
|
|
/// <summary>
|
|
/// The logger
|
|
/// </summary>
|
|
public static ILogger Logger { get; set; }
|
|
public static ILibraryManager LibraryManager { get; set; }
|
|
public static IServerConfigurationManager ConfigurationManager { get; set; }
|
|
public static IProviderManager ProviderManager { get; set; }
|
|
public static ILocalizationManager LocalizationManager { get; set; }
|
|
public static IItemRepository ItemRepository { get; set; }
|
|
|
|
/// <summary>
|
|
/// Returns a <see cref="System.String" /> that represents this instance.
|
|
/// </summary>
|
|
/// <returns>A <see cref="System.String" /> that represents this instance.</returns>
|
|
public override string ToString()
|
|
{
|
|
return Name;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns true if this item should not attempt to fetch metadata
|
|
/// </summary>
|
|
/// <value><c>true</c> if [dont fetch meta]; otherwise, <c>false</c>.</value>
|
|
public bool DontFetchMeta { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the locked fields.
|
|
/// </summary>
|
|
/// <value>The locked fields.</value>
|
|
public List<MetadataFields> LockedFields { get; set; }
|
|
|
|
/// <summary>
|
|
/// Determines whether the item has a saved local image of the specified name (jpg or png).
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <returns><c>true</c> if [has local image] [the specified item]; otherwise, <c>false</c>.</returns>
|
|
/// <exception cref="System.ArgumentNullException">name</exception>
|
|
public bool HasLocalImage(string name)
|
|
{
|
|
if (string.IsNullOrEmpty(name))
|
|
{
|
|
throw new ArgumentNullException("name");
|
|
}
|
|
|
|
return ResolveArgs.ContainsMetaFileByName(name + ".jpg") ||
|
|
ResolveArgs.ContainsMetaFileByName(name + ".png");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Should be overridden to return the proper folder where metadata lives
|
|
/// </summary>
|
|
/// <value>The meta location.</value>
|
|
[IgnoreDataMember]
|
|
public virtual string MetaLocation
|
|
{
|
|
get
|
|
{
|
|
return Path ?? "";
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _provider data
|
|
/// </summary>
|
|
private Dictionary<Guid, BaseProviderInfo> _providerData;
|
|
/// <summary>
|
|
/// Holds persistent data for providers like last refresh date.
|
|
/// Providers can use this to determine if they need to refresh.
|
|
/// The BaseProviderInfo class can be extended to hold anything a provider may need.
|
|
/// Keyed by a unique provider ID.
|
|
/// </summary>
|
|
/// <value>The provider data.</value>
|
|
public Dictionary<Guid, BaseProviderInfo> ProviderData
|
|
{
|
|
get
|
|
{
|
|
return _providerData ?? (_providerData = new Dictionary<Guid, BaseProviderInfo>());
|
|
}
|
|
set
|
|
{
|
|
_providerData = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the type of the media.
|
|
/// </summary>
|
|
/// <value>The type of the media.</value>
|
|
[IgnoreDataMember]
|
|
public virtual string MediaType
|
|
{
|
|
get
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// The _resolve args
|
|
/// </summary>
|
|
private ItemResolveArgs _resolveArgs;
|
|
/// <summary>
|
|
/// The _resolve args initialized
|
|
/// </summary>
|
|
private bool _resolveArgsInitialized;
|
|
/// <summary>
|
|
/// The _resolve args sync lock
|
|
/// </summary>
|
|
private object _resolveArgsSyncLock = new object();
|
|
/// <summary>
|
|
/// We attach these to the item so that we only ever have to hit the file system once
|
|
/// (this includes the children of the containing folder)
|
|
/// </summary>
|
|
/// <value>The resolve args.</value>
|
|
[IgnoreDataMember]
|
|
public ItemResolveArgs ResolveArgs
|
|
{
|
|
get
|
|
{
|
|
try
|
|
{
|
|
LazyInitializer.EnsureInitialized(ref _resolveArgs, ref _resolveArgsInitialized, ref _resolveArgsSyncLock, () => CreateResolveArgs());
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error creating resolve args for {0}", ex, Path);
|
|
|
|
IsOffline = true;
|
|
|
|
throw;
|
|
}
|
|
|
|
return _resolveArgs;
|
|
}
|
|
set
|
|
{
|
|
_resolveArgs = value;
|
|
_resolveArgsInitialized = value != null;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Resets the resolve args.
|
|
/// </summary>
|
|
/// <param name="pathInfo">The path info.</param>
|
|
public void ResetResolveArgs(FileSystemInfo pathInfo)
|
|
{
|
|
ResolveArgs = CreateResolveArgs(pathInfo);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates ResolveArgs on demand
|
|
/// </summary>
|
|
/// <param name="pathInfo">The path info.</param>
|
|
/// <returns>ItemResolveArgs.</returns>
|
|
/// <exception cref="System.IO.IOException">Unable to retrieve file system info for + path</exception>
|
|
protected internal virtual ItemResolveArgs CreateResolveArgs(FileSystemInfo pathInfo = null)
|
|
{
|
|
var path = Path;
|
|
|
|
if (LocationType == LocationType.Remote || LocationType == LocationType.Virtual)
|
|
{
|
|
return new ItemResolveArgs(ConfigurationManager.ApplicationPaths, LibraryManager);
|
|
}
|
|
|
|
var isDirectory = false;
|
|
|
|
if (UseParentPathToCreateResolveArgs)
|
|
{
|
|
path = System.IO.Path.GetDirectoryName(path);
|
|
isDirectory = true;
|
|
}
|
|
|
|
pathInfo = pathInfo ?? (isDirectory ? new DirectoryInfo(path) : FileSystem.GetFileSystemInfo(path));
|
|
|
|
if (pathInfo == null || !pathInfo.Exists)
|
|
{
|
|
throw new IOException("Unable to retrieve file system info for " + path);
|
|
}
|
|
|
|
var args = new ItemResolveArgs(ConfigurationManager.ApplicationPaths, LibraryManager)
|
|
{
|
|
FileInfo = pathInfo,
|
|
Path = path,
|
|
Parent = Parent
|
|
};
|
|
|
|
// Gather child folder and files
|
|
if (args.IsDirectory)
|
|
{
|
|
var isPhysicalRoot = args.IsPhysicalRoot;
|
|
|
|
// When resolving the root, we need it's grandchildren (children of user views)
|
|
var flattenFolderDepth = isPhysicalRoot ? 2 : 0;
|
|
|
|
args.FileSystemDictionary = FileData.GetFilteredFileSystemEntries(args.Path, Logger, args, flattenFolderDepth: flattenFolderDepth, resolveShortcuts: isPhysicalRoot || args.IsVf);
|
|
|
|
// Need to remove subpaths that may have been resolved from shortcuts
|
|
// Example: if \\server\movies exists, then strip out \\server\movies\action
|
|
if (isPhysicalRoot)
|
|
{
|
|
var paths = args.FileSystemDictionary.Keys.ToList();
|
|
|
|
foreach (var subPath in paths
|
|
.Where(subPath => !subPath.EndsWith(":\\", StringComparison.OrdinalIgnoreCase) && paths.Any(i => subPath.StartsWith(i.TrimEnd(System.IO.Path.DirectorySeparatorChar) + System.IO.Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase))))
|
|
{
|
|
Logger.Info("Ignoring duplicate path: {0}", subPath);
|
|
args.FileSystemDictionary.Remove(subPath);
|
|
}
|
|
}
|
|
}
|
|
|
|
//update our dates
|
|
EntityResolutionHelper.EnsureDates(this, args, false);
|
|
|
|
IsOffline = false;
|
|
|
|
return args;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Some subclasses will stop resolving at a directory and point their Path to a file within. This will help ensure the on-demand resolve args are identical to the
|
|
/// original ones.
|
|
/// </summary>
|
|
/// <value><c>true</c> if [use parent path to create resolve args]; otherwise, <c>false</c>.</value>
|
|
[IgnoreDataMember]
|
|
protected virtual bool UseParentPathToCreateResolveArgs
|
|
{
|
|
get
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the name of the forced sort.
|
|
/// </summary>
|
|
/// <value>The name of the forced sort.</value>
|
|
public string ForcedSortName { get; set; }
|
|
|
|
private string _sortName;
|
|
/// <summary>
|
|
/// Gets or sets the name of the sort.
|
|
/// </summary>
|
|
/// <value>The name of the sort.</value>
|
|
[IgnoreDataMember]
|
|
public string SortName
|
|
{
|
|
get
|
|
{
|
|
if (!string.IsNullOrEmpty(ForcedSortName))
|
|
{
|
|
return ForcedSortName;
|
|
}
|
|
|
|
return _sortName ?? (_sortName = CreateSortName());
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates the name of the sort.
|
|
/// </summary>
|
|
/// <returns>System.String.</returns>
|
|
protected virtual string CreateSortName()
|
|
{
|
|
if (Name == null) return null; //some items may not have name filled in properly
|
|
|
|
var sortable = Name.Trim().ToLower();
|
|
sortable = ConfigurationManager.Configuration.SortRemoveCharacters.Aggregate(sortable, (current, search) => current.Replace(search.ToLower(), string.Empty));
|
|
|
|
sortable = ConfigurationManager.Configuration.SortReplaceCharacters.Aggregate(sortable, (current, search) => current.Replace(search.ToLower(), " "));
|
|
|
|
foreach (var search in ConfigurationManager.Configuration.SortRemoveWords)
|
|
{
|
|
var searchLower = search.ToLower();
|
|
// Remove from beginning if a space follows
|
|
if (sortable.StartsWith(searchLower + " "))
|
|
{
|
|
sortable = sortable.Remove(0, searchLower.Length + 1);
|
|
}
|
|
// Remove from middle if surrounded by spaces
|
|
sortable = sortable.Replace(" " + searchLower + " ", " ");
|
|
|
|
// Remove from end if followed by a space
|
|
if (sortable.EndsWith(" " + searchLower))
|
|
{
|
|
sortable = sortable.Remove(sortable.Length - (searchLower.Length + 1));
|
|
}
|
|
}
|
|
return sortable;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the parent.
|
|
/// </summary>
|
|
/// <value>The parent.</value>
|
|
[IgnoreDataMember]
|
|
public Folder Parent { get; set; }
|
|
|
|
/// <summary>
|
|
/// When the item first debuted. For movies this could be premiere date, episodes would be first aired
|
|
/// </summary>
|
|
/// <value>The premiere date.</value>
|
|
public DateTime? PremiereDate { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the end date.
|
|
/// </summary>
|
|
/// <value>The end date.</value>
|
|
public DateTime? EndDate { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the display type of the media.
|
|
/// </summary>
|
|
/// <value>The display type of the media.</value>
|
|
public string DisplayMediaType { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the backdrop image paths.
|
|
/// </summary>
|
|
/// <value>The backdrop image paths.</value>
|
|
public List<string> BackdropImagePaths { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the screenshot image paths.
|
|
/// </summary>
|
|
/// <value>The screenshot image paths.</value>
|
|
public List<string> ScreenshotImagePaths { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the official rating.
|
|
/// </summary>
|
|
/// <value>The official rating.</value>
|
|
public string OfficialRating { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the official rating description.
|
|
/// </summary>
|
|
/// <value>The official rating description.</value>
|
|
public string OfficialRatingDescription { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the custom rating.
|
|
/// </summary>
|
|
/// <value>The custom rating.</value>
|
|
public string CustomRating { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the language.
|
|
/// </summary>
|
|
/// <value>The language.</value>
|
|
public string Language { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets the overview.
|
|
/// </summary>
|
|
/// <value>The overview.</value>
|
|
public string Overview { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets the taglines.
|
|
/// </summary>
|
|
/// <value>The taglines.</value>
|
|
public List<string> Taglines { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the people.
|
|
/// </summary>
|
|
/// <value>The people.</value>
|
|
public List<PersonInfo> People { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the tags.
|
|
/// </summary>
|
|
/// <value>The tags.</value>
|
|
public List<string> Tags { get; set; }
|
|
|
|
/// <summary>
|
|
/// Override this if you need to combine/collapse person information
|
|
/// </summary>
|
|
/// <value>All people.</value>
|
|
[IgnoreDataMember]
|
|
public virtual IEnumerable<PersonInfo> AllPeople
|
|
{
|
|
get { return People; }
|
|
}
|
|
|
|
[IgnoreDataMember]
|
|
public virtual IEnumerable<string> AllStudios
|
|
{
|
|
get { return Studios; }
|
|
}
|
|
|
|
[IgnoreDataMember]
|
|
public virtual IEnumerable<string> AllGenres
|
|
{
|
|
get { return Genres; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the studios.
|
|
/// </summary>
|
|
/// <value>The studios.</value>
|
|
public List<string> Studios { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the genres.
|
|
/// </summary>
|
|
/// <value>The genres.</value>
|
|
public List<string> Genres { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the home page URL.
|
|
/// </summary>
|
|
/// <value>The home page URL.</value>
|
|
public string HomePageUrl { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the budget.
|
|
/// </summary>
|
|
/// <value>The budget.</value>
|
|
public double? Budget { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the revenue.
|
|
/// </summary>
|
|
/// <value>The revenue.</value>
|
|
public double? Revenue { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the production locations.
|
|
/// </summary>
|
|
/// <value>The production locations.</value>
|
|
public List<string> ProductionLocations { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the critic rating.
|
|
/// </summary>
|
|
/// <value>The critic rating.</value>
|
|
public float? CriticRating { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the critic rating summary.
|
|
/// </summary>
|
|
/// <value>The critic rating summary.</value>
|
|
public string CriticRatingSummary { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the community rating.
|
|
/// </summary>
|
|
/// <value>The community rating.</value>
|
|
public float? CommunityRating { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the community rating vote count.
|
|
/// </summary>
|
|
/// <value>The community rating vote count.</value>
|
|
public int? VoteCount { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the run time ticks.
|
|
/// </summary>
|
|
/// <value>The run time ticks.</value>
|
|
public long? RunTimeTicks { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the original run time ticks.
|
|
/// </summary>
|
|
/// <value>The original run time ticks.</value>
|
|
public long? OriginalRunTimeTicks { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets the aspect ratio.
|
|
/// </summary>
|
|
/// <value>The aspect ratio.</value>
|
|
public string AspectRatio { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets the production year.
|
|
/// </summary>
|
|
/// <value>The production year.</value>
|
|
public int? ProductionYear { get; set; }
|
|
|
|
/// <summary>
|
|
/// If the item is part of a series, this is it's number in the series.
|
|
/// This could be episode number, album track number, etc.
|
|
/// </summary>
|
|
/// <value>The index number.</value>
|
|
public int? IndexNumber { get; set; }
|
|
|
|
/// <summary>
|
|
/// For an episode this could be the season number, or for a song this could be the disc number.
|
|
/// </summary>
|
|
/// <value>The parent index number.</value>
|
|
public int? ParentIndexNumber { get; set; }
|
|
|
|
public List<Guid> ThemeSongIds { get; set; }
|
|
public List<Guid> ThemeVideoIds { get; set; }
|
|
public List<Guid> LocalTrailerIds { get; set; }
|
|
|
|
[IgnoreDataMember]
|
|
public virtual string OfficialRatingForComparison
|
|
{
|
|
get { return OfficialRating; }
|
|
}
|
|
|
|
[IgnoreDataMember]
|
|
public virtual string CustomRatingForComparison
|
|
{
|
|
get { return CustomRating; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads local trailers from the file system
|
|
/// </summary>
|
|
/// <returns>List{Video}.</returns>
|
|
private IEnumerable<Trailer> LoadLocalTrailers()
|
|
{
|
|
ItemResolveArgs resolveArgs;
|
|
|
|
try
|
|
{
|
|
resolveArgs = ResolveArgs;
|
|
|
|
if (!resolveArgs.IsDirectory)
|
|
{
|
|
return new List<Trailer>();
|
|
}
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error getting ResolveArgs for {0}", ex, Path);
|
|
return new List<Trailer>();
|
|
}
|
|
|
|
var files = new List<FileSystemInfo>();
|
|
|
|
var folder = resolveArgs.GetFileSystemEntryByName(TrailerFolderName);
|
|
|
|
// Path doesn't exist. No biggie
|
|
if (folder != null)
|
|
{
|
|
try
|
|
{
|
|
files.AddRange(new DirectoryInfo(folder.FullName).EnumerateFiles());
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error loading trailers for {0}", ex, Name);
|
|
}
|
|
}
|
|
|
|
// Support xbmc trailers (-trailer suffix on video file names)
|
|
files.AddRange(resolveArgs.FileSystemChildren.Where(i =>
|
|
{
|
|
try
|
|
{
|
|
if ((i.Attributes & FileAttributes.Directory) != FileAttributes.Directory)
|
|
{
|
|
if (System.IO.Path.GetFileNameWithoutExtension(i.Name).EndsWith(XbmcTrailerFileSuffix, StringComparison.OrdinalIgnoreCase) && !string.Equals(Path, i.FullName, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error accessing path {0}", ex, i.FullName);
|
|
}
|
|
|
|
return false;
|
|
}));
|
|
|
|
return LibraryManager.ResolvePaths<Trailer>(files, null).Select(video =>
|
|
{
|
|
// Try to retrieve it from the db. If we don't find it, use the resolved version
|
|
var dbItem = LibraryManager.RetrieveItem(video.Id) as Trailer;
|
|
|
|
if (dbItem != null)
|
|
{
|
|
dbItem.ResolveArgs = video.ResolveArgs;
|
|
video = dbItem;
|
|
}
|
|
|
|
return video;
|
|
|
|
}).ToList();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads the theme songs.
|
|
/// </summary>
|
|
/// <returns>List{Audio.Audio}.</returns>
|
|
private IEnumerable<Audio.Audio> LoadThemeSongs()
|
|
{
|
|
ItemResolveArgs resolveArgs;
|
|
|
|
try
|
|
{
|
|
resolveArgs = ResolveArgs;
|
|
|
|
if (!resolveArgs.IsDirectory)
|
|
{
|
|
return new List<Audio.Audio>();
|
|
}
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error getting ResolveArgs for {0}", ex, Path);
|
|
return new List<Audio.Audio>();
|
|
}
|
|
|
|
var files = new List<FileSystemInfo>();
|
|
|
|
var folder = resolveArgs.GetFileSystemEntryByName(ThemeSongsFolderName);
|
|
|
|
// Path doesn't exist. No biggie
|
|
if (folder != null)
|
|
{
|
|
try
|
|
{
|
|
files.AddRange(new DirectoryInfo(folder.FullName).EnumerateFiles());
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error loading theme songs for {0}", ex, Name);
|
|
}
|
|
}
|
|
|
|
// Support plex/xbmc convention
|
|
files.AddRange(resolveArgs.FileSystemChildren
|
|
.Where(i => string.Equals(System.IO.Path.GetFileNameWithoutExtension(i.Name), ThemeSongFilename, StringComparison.OrdinalIgnoreCase) && EntityResolutionHelper.IsAudioFile(i.Name))
|
|
);
|
|
|
|
return LibraryManager.ResolvePaths<Audio.Audio>(files, null).Select(audio =>
|
|
{
|
|
// Try to retrieve it from the db. If we don't find it, use the resolved version
|
|
var dbItem = LibraryManager.RetrieveItem(audio.Id) as Audio.Audio;
|
|
|
|
if (dbItem != null)
|
|
{
|
|
dbItem.ResolveArgs = audio.ResolveArgs;
|
|
audio = dbItem;
|
|
}
|
|
|
|
return audio;
|
|
}).ToList();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Loads the video backdrops.
|
|
/// </summary>
|
|
/// <returns>List{Video}.</returns>
|
|
private IEnumerable<Video> LoadThemeVideos()
|
|
{
|
|
ItemResolveArgs resolveArgs;
|
|
|
|
try
|
|
{
|
|
resolveArgs = ResolveArgs;
|
|
|
|
if (!resolveArgs.IsDirectory)
|
|
{
|
|
return new List<Video>();
|
|
}
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error getting ResolveArgs for {0}", ex, Path);
|
|
return new List<Video>();
|
|
}
|
|
|
|
var folder = resolveArgs.GetFileSystemEntryByName(ThemeVideosFolderName);
|
|
|
|
// Path doesn't exist. No biggie
|
|
if (folder == null)
|
|
{
|
|
return new List<Video>();
|
|
}
|
|
|
|
IEnumerable<FileSystemInfo> files;
|
|
|
|
try
|
|
{
|
|
files = new DirectoryInfo(folder.FullName).EnumerateFiles();
|
|
}
|
|
catch (IOException ex)
|
|
{
|
|
Logger.ErrorException("Error loading video backdrops for {0}", ex, Name);
|
|
return new List<Video>();
|
|
}
|
|
|
|
return LibraryManager.ResolvePaths<Video>(files, null).Select(item =>
|
|
{
|
|
// Try to retrieve it from the db. If we don't find it, use the resolved version
|
|
var dbItem = LibraryManager.RetrieveItem(item.Id) as Video;
|
|
|
|
if (dbItem != null)
|
|
{
|
|
dbItem.ResolveArgs = item.ResolveArgs;
|
|
item = dbItem;
|
|
}
|
|
|
|
return item;
|
|
}).ToList();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Overrides the base implementation to refresh metadata for local trailers
|
|
/// </summary>
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
|
/// <param name="forceSave">if set to <c>true</c> [is new item].</param>
|
|
/// <param name="forceRefresh">if set to <c>true</c> [force].</param>
|
|
/// <param name="allowSlowProviders">if set to <c>true</c> [allow slow providers].</param>
|
|
/// <param name="resetResolveArgs">if set to <c>true</c> [reset resolve args].</param>
|
|
/// <returns>true if a provider reports we changed</returns>
|
|
public virtual async Task<bool> RefreshMetadata(CancellationToken cancellationToken, bool forceSave = false, bool forceRefresh = false, bool allowSlowProviders = true, bool resetResolveArgs = true)
|
|
{
|
|
if (resetResolveArgs)
|
|
{
|
|
// Reload this
|
|
ResolveArgs = null;
|
|
}
|
|
|
|
// Refresh for the item
|
|
var itemRefreshTask = ProviderManager.ExecuteMetadataProviders(this, cancellationToken, forceRefresh, allowSlowProviders);
|
|
|
|
cancellationToken.ThrowIfCancellationRequested();
|
|
|
|
var themeSongsChanged = false;
|
|
|
|
var themeVideosChanged = false;
|
|
|
|
var localTrailersChanged = false;
|
|
|
|
if (LocationType == LocationType.FileSystem && Parent != null)
|
|
{
|
|
themeSongsChanged = await RefreshThemeSongs(cancellationToken, forceSave, forceRefresh, allowSlowProviders).ConfigureAwait(false);
|
|
|
|
themeVideosChanged = await RefreshThemeVideos(cancellationToken, forceSave, forceRefresh, allowSlowProviders).ConfigureAwait(false);
|
|
|
|
localTrailersChanged = await RefreshLocalTrailers(cancellationToken, forceSave, forceRefresh, allowSlowProviders).ConfigureAwait(false);
|
|
}
|
|
|
|
cancellationToken.ThrowIfCancellationRequested();
|
|
|
|
// Get the result from the item task
|
|
var updateReason = await itemRefreshTask.ConfigureAwait(false);
|
|
|
|
var changed = updateReason.HasValue;
|
|
|
|
if (changed || forceSave || themeSongsChanged || themeVideosChanged || localTrailersChanged)
|
|
{
|
|
cancellationToken.ThrowIfCancellationRequested();
|
|
|
|
await LibraryManager.UpdateItem(this, updateReason ?? ItemUpdateType.Unspecified, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
return changed;
|
|
}
|
|
|
|
private async Task<bool> RefreshLocalTrailers(CancellationToken cancellationToken, bool forceSave = false, bool forceRefresh = false, bool allowSlowProviders = true)
|
|
{
|
|
var newItems = LoadLocalTrailers().ToList();
|
|
var newItemIds = newItems.Select(i => i.Id).ToList();
|
|
|
|
var itemsChanged = !LocalTrailerIds.SequenceEqual(newItemIds);
|
|
|
|
var tasks = newItems.Select(i => i.RefreshMetadata(cancellationToken, forceSave, forceRefresh, allowSlowProviders));
|
|
|
|
var results = await Task.WhenAll(tasks).ConfigureAwait(false);
|
|
|
|
LocalTrailerIds = newItemIds;
|
|
|
|
return itemsChanged || results.Contains(true);
|
|
}
|
|
|
|
private async Task<bool> RefreshThemeVideos(CancellationToken cancellationToken, bool forceSave = false, bool forceRefresh = false, bool allowSlowProviders = true)
|
|
{
|
|
var newThemeVideos = LoadThemeVideos().ToList();
|
|
var newThemeVideoIds = newThemeVideos.Select(i => i.Id).ToList();
|
|
|
|
var themeVideosChanged = !ThemeVideoIds.SequenceEqual(newThemeVideoIds);
|
|
|
|
var tasks = newThemeVideos.Select(i => i.RefreshMetadata(cancellationToken, forceSave, forceRefresh, allowSlowProviders));
|
|
|
|
var results = await Task.WhenAll(tasks).ConfigureAwait(false);
|
|
|
|
ThemeVideoIds = newThemeVideoIds;
|
|
|
|
return themeVideosChanged || results.Contains(true);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Refreshes the theme songs.
|
|
/// </summary>
|
|
private async Task<bool> RefreshThemeSongs(CancellationToken cancellationToken, bool forceSave = false, bool forceRefresh = false, bool allowSlowProviders = true)
|
|
{
|
|
var newThemeSongs = LoadThemeSongs().ToList();
|
|
var newThemeSongIds = newThemeSongs.Select(i => i.Id).ToList();
|
|
|
|
var themeSongsChanged = !ThemeSongIds.SequenceEqual(newThemeSongIds);
|
|
|
|
var tasks = newThemeSongs.Select(i => i.RefreshMetadata(cancellationToken, forceSave, forceRefresh, allowSlowProviders));
|
|
|
|
var results = await Task.WhenAll(tasks).ConfigureAwait(false);
|
|
|
|
ThemeSongIds = newThemeSongIds;
|
|
|
|
return themeSongsChanged || results.Contains(true);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the trailer URL.
|
|
/// </summary>
|
|
/// <value>The trailer URL.</value>
|
|
public List<MediaUrl> RemoteTrailers { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the provider ids.
|
|
/// </summary>
|
|
/// <value>The provider ids.</value>
|
|
public Dictionary<string, string> ProviderIds { get; set; }
|
|
|
|
/// <summary>
|
|
/// Override this to false if class should be ignored for indexing purposes
|
|
/// </summary>
|
|
/// <value><c>true</c> if [include in index]; otherwise, <c>false</c>.</value>
|
|
[IgnoreDataMember]
|
|
public virtual bool IncludeInIndex
|
|
{
|
|
get { return true; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Override this to true if class should be grouped under a container in indicies
|
|
/// The container class should be defined via IndexContainer
|
|
/// </summary>
|
|
/// <value><c>true</c> if [group in index]; otherwise, <c>false</c>.</value>
|
|
[IgnoreDataMember]
|
|
public virtual bool GroupInIndex
|
|
{
|
|
get { return false; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Override this to return the folder that should be used to construct a container
|
|
/// for this item in an index. GroupInIndex should be true as well.
|
|
/// </summary>
|
|
/// <value>The index container.</value>
|
|
[IgnoreDataMember]
|
|
public virtual Folder IndexContainer
|
|
{
|
|
get { return null; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the user data key.
|
|
/// </summary>
|
|
/// <returns>System.String.</returns>
|
|
public virtual string GetUserDataKey()
|
|
{
|
|
return Id.ToString();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determines if a given user has access to this item
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
/// <param name="localizationManager">The localization manager.</param>
|
|
/// <returns><c>true</c> if [is parental allowed] [the specified user]; otherwise, <c>false</c>.</returns>
|
|
/// <exception cref="System.ArgumentNullException">user</exception>
|
|
public bool IsParentalAllowed(User user, ILocalizationManager localizationManager)
|
|
{
|
|
if (user == null)
|
|
{
|
|
throw new ArgumentNullException("user");
|
|
}
|
|
|
|
if (user.Configuration.MaxParentalRating == null)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
var rating = CustomRatingForComparison;
|
|
|
|
if (string.IsNullOrEmpty(rating))
|
|
{
|
|
rating = OfficialRatingForComparison;
|
|
}
|
|
|
|
if (string.IsNullOrEmpty(rating))
|
|
{
|
|
return !user.Configuration.BlockNotRated;
|
|
}
|
|
|
|
var value = localizationManager.GetRatingLevel(rating);
|
|
|
|
// Could not determine the integer value
|
|
if (!value.HasValue)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return value.Value <= user.Configuration.MaxParentalRating.Value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determines if this folder should be visible to a given user.
|
|
/// Default is just parental allowed. Can be overridden for more functionality.
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
/// <returns><c>true</c> if the specified user is visible; otherwise, <c>false</c>.</returns>
|
|
/// <exception cref="System.ArgumentNullException">user</exception>
|
|
public virtual bool IsVisible(User user)
|
|
{
|
|
if (user == null)
|
|
{
|
|
throw new ArgumentNullException("user");
|
|
}
|
|
|
|
return IsParentalAllowed(user, LocalizationManager);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Finds the particular item by searching through our parents and, if not found there, loading from repo
|
|
/// </summary>
|
|
/// <param name="id">The id.</param>
|
|
/// <returns>BaseItem.</returns>
|
|
/// <exception cref="System.ArgumentException"></exception>
|
|
protected BaseItem FindParentItem(Guid id)
|
|
{
|
|
if (id == Guid.Empty)
|
|
{
|
|
throw new ArgumentException();
|
|
}
|
|
|
|
var parent = Parent;
|
|
while (parent != null && !parent.IsRoot)
|
|
{
|
|
if (parent.Id == id) return parent;
|
|
parent = parent.Parent;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance is folder.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
|
|
[IgnoreDataMember]
|
|
public virtual bool IsFolder
|
|
{
|
|
get
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determine if we have changed vs the passed in copy
|
|
/// </summary>
|
|
/// <param name="copy">The copy.</param>
|
|
/// <returns><c>true</c> if the specified copy has changed; otherwise, <c>false</c>.</returns>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public virtual bool HasChanged(BaseItem copy)
|
|
{
|
|
if (copy == null)
|
|
{
|
|
throw new ArgumentNullException();
|
|
}
|
|
|
|
var changed = copy.DateModified != DateModified;
|
|
if (changed)
|
|
{
|
|
Logger.Debug(Name + " changed - original creation: " + DateCreated + " new creation: " + copy.DateCreated + " original modified: " + DateModified + " new modified: " + copy.DateModified);
|
|
}
|
|
return changed;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Determines if the item is considered new based on user settings
|
|
/// </summary>
|
|
/// <returns><c>true</c> if [is recently added] [the specified user]; otherwise, <c>false</c>.</returns>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public bool IsRecentlyAdded()
|
|
{
|
|
return (DateTime.UtcNow - DateCreated).TotalDays < ConfigurationManager.Configuration.RecentItemDays;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds a person to the item
|
|
/// </summary>
|
|
/// <param name="person">The person.</param>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public void AddPerson(PersonInfo person)
|
|
{
|
|
if (person == null)
|
|
{
|
|
throw new ArgumentNullException("person");
|
|
}
|
|
|
|
if (string.IsNullOrWhiteSpace(person.Name))
|
|
{
|
|
throw new ArgumentNullException();
|
|
}
|
|
|
|
// Normalize
|
|
if (string.Equals(person.Role, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
person.Type = PersonType.GuestStar;
|
|
}
|
|
else if (string.Equals(person.Role, PersonType.Director, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
person.Type = PersonType.Director;
|
|
}
|
|
else if (string.Equals(person.Role, PersonType.Producer, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
person.Type = PersonType.Producer;
|
|
}
|
|
else if (string.Equals(person.Role, PersonType.Writer, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
person.Type = PersonType.Writer;
|
|
}
|
|
|
|
// If the type is GuestStar and there's already an Actor entry, then update it to avoid dupes
|
|
if (string.Equals(person.Type, PersonType.GuestStar, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
var existing = People.FirstOrDefault(p => p.Name.Equals(person.Name, StringComparison.OrdinalIgnoreCase) && p.Type.Equals(PersonType.Actor, StringComparison.OrdinalIgnoreCase));
|
|
|
|
if (existing != null)
|
|
{
|
|
existing.Type = PersonType.GuestStar;
|
|
return;
|
|
}
|
|
}
|
|
|
|
if (string.Equals(person.Type, PersonType.Actor, StringComparison.OrdinalIgnoreCase))
|
|
{
|
|
// If the actor already exists without a role and we have one, fill it in
|
|
var existing = People.FirstOrDefault(p => p.Name.Equals(person.Name, StringComparison.OrdinalIgnoreCase) && (p.Type.Equals(PersonType.Actor, StringComparison.OrdinalIgnoreCase) || p.Type.Equals(PersonType.GuestStar, StringComparison.OrdinalIgnoreCase)));
|
|
if (existing == null)
|
|
{
|
|
// Wasn't there - add it
|
|
People.Add(person);
|
|
}
|
|
else
|
|
{
|
|
// Was there, if no role and we have one - fill it in
|
|
if (string.IsNullOrWhiteSpace(existing.Role) && !string.IsNullOrWhiteSpace(person.Role)) existing.Role = person.Role;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Check for dupes based on the combination of Name and Type
|
|
if (!People.Any(p => string.Equals(p.Name, person.Name, StringComparison.OrdinalIgnoreCase) && string.Equals(p.Type, person.Type, StringComparison.OrdinalIgnoreCase)))
|
|
{
|
|
People.Add(person);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds a studio to the item
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public void AddStudio(string name)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(name))
|
|
{
|
|
throw new ArgumentNullException("name");
|
|
}
|
|
|
|
if (!Studios.Contains(name, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
Studios.Add(name);
|
|
}
|
|
}
|
|
|
|
public void AddTag(string name)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(name))
|
|
{
|
|
throw new ArgumentNullException("name");
|
|
}
|
|
|
|
if (!Tags.Contains(name, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
Tags.Add(name);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds a tagline to the item
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public void AddTagline(string name)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(name))
|
|
{
|
|
throw new ArgumentNullException("name");
|
|
}
|
|
|
|
if (!Taglines.Contains(name, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
Taglines.Add(name);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds a TrailerUrl to the item
|
|
/// </summary>
|
|
/// <param name="url">The URL.</param>
|
|
/// <param name="isDirectLink">if set to <c>true</c> [is direct link].</param>
|
|
/// <exception cref="System.ArgumentNullException">url</exception>
|
|
public void AddTrailerUrl(string url, bool isDirectLink)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(url))
|
|
{
|
|
throw new ArgumentNullException("url");
|
|
}
|
|
|
|
var current = RemoteTrailers.FirstOrDefault(i => string.Equals(i.Url, url, StringComparison.OrdinalIgnoreCase));
|
|
|
|
if (current != null)
|
|
{
|
|
current.IsDirectLink = isDirectLink;
|
|
}
|
|
else
|
|
{
|
|
RemoteTrailers.Add(new MediaUrl
|
|
{
|
|
Url = url,
|
|
IsDirectLink = isDirectLink
|
|
});
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds a genre to the item
|
|
/// </summary>
|
|
/// <param name="name">The name.</param>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public void AddGenre(string name)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(name))
|
|
{
|
|
throw new ArgumentNullException("name");
|
|
}
|
|
|
|
if (!Genres.Contains(name, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
Genres.Add(name);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Adds the production location.
|
|
/// </summary>
|
|
/// <param name="location">The location.</param>
|
|
/// <exception cref="System.ArgumentNullException">location</exception>
|
|
public void AddProductionLocation(string location)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(location))
|
|
{
|
|
throw new ArgumentNullException("location");
|
|
}
|
|
|
|
if (!ProductionLocations.Contains(location, StringComparer.OrdinalIgnoreCase))
|
|
{
|
|
ProductionLocations.Add(location);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Marks the item as either played or unplayed
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
/// <param name="wasPlayed">if set to <c>true</c> [was played].</param>
|
|
/// <param name="userManager">The user manager.</param>
|
|
/// <returns>Task.</returns>
|
|
/// <exception cref="System.ArgumentNullException"></exception>
|
|
public virtual async Task SetPlayedStatus(User user, bool wasPlayed, IUserDataRepository userManager)
|
|
{
|
|
if (user == null)
|
|
{
|
|
throw new ArgumentNullException();
|
|
}
|
|
|
|
var key = GetUserDataKey();
|
|
|
|
var data = userManager.GetUserData(user.Id, key);
|
|
|
|
if (wasPlayed)
|
|
{
|
|
data.PlayCount = Math.Max(data.PlayCount, 1);
|
|
|
|
if (!data.LastPlayedDate.HasValue)
|
|
{
|
|
data.LastPlayedDate = DateTime.UtcNow;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
//I think it is okay to do this here.
|
|
// if this is only called when a user is manually forcing something to un-played
|
|
// then it probably is what we want to do...
|
|
data.PlayCount = 0;
|
|
data.PlaybackPositionTicks = 0;
|
|
data.LastPlayedDate = null;
|
|
}
|
|
|
|
data.Played = wasPlayed;
|
|
|
|
await userManager.SaveUserData(user.Id, key, data, CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Do whatever refreshing is necessary when the filesystem pertaining to this item has changed.
|
|
/// </summary>
|
|
/// <returns>Task.</returns>
|
|
public virtual Task ChangedExternally()
|
|
{
|
|
return RefreshMetadata(CancellationToken.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Finds a parent of a given type
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
/// <returns>``0.</returns>
|
|
public T FindParent<T>()
|
|
where T : Folder
|
|
{
|
|
var parent = Parent;
|
|
|
|
while (parent != null)
|
|
{
|
|
var result = parent as T;
|
|
if (result != null)
|
|
{
|
|
return result;
|
|
}
|
|
|
|
parent = parent.Parent;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets an image
|
|
/// </summary>
|
|
/// <param name="type">The type.</param>
|
|
/// <returns>System.String.</returns>
|
|
/// <exception cref="System.ArgumentException">Backdrops should be accessed using Item.Backdrops</exception>
|
|
public string GetImage(ImageType type)
|
|
{
|
|
if (type == ImageType.Backdrop)
|
|
{
|
|
throw new ArgumentException("Backdrops should be accessed using Item.Backdrops");
|
|
}
|
|
if (type == ImageType.Screenshot)
|
|
{
|
|
throw new ArgumentException("Screenshots should be accessed using Item.Screenshots");
|
|
}
|
|
|
|
string val;
|
|
Images.TryGetValue(type, out val);
|
|
return val;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets an image
|
|
/// </summary>
|
|
/// <param name="type">The type.</param>
|
|
/// <returns><c>true</c> if the specified type has image; otherwise, <c>false</c>.</returns>
|
|
/// <exception cref="System.ArgumentException">Backdrops should be accessed using Item.Backdrops</exception>
|
|
public bool HasImage(ImageType type)
|
|
{
|
|
if (type == ImageType.Backdrop)
|
|
{
|
|
throw new ArgumentException("Backdrops should be accessed using Item.Backdrops");
|
|
}
|
|
if (type == ImageType.Screenshot)
|
|
{
|
|
throw new ArgumentException("Screenshots should be accessed using Item.Screenshots");
|
|
}
|
|
|
|
return !string.IsNullOrEmpty(GetImage(type));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets an image
|
|
/// </summary>
|
|
/// <param name="type">The type.</param>
|
|
/// <param name="path">The path.</param>
|
|
/// <exception cref="System.ArgumentException">Backdrops should be accessed using Item.Backdrops</exception>
|
|
public void SetImage(ImageType type, string path)
|
|
{
|
|
if (type == ImageType.Backdrop)
|
|
{
|
|
throw new ArgumentException("Backdrops should be accessed using Item.Backdrops");
|
|
}
|
|
if (type == ImageType.Screenshot)
|
|
{
|
|
throw new ArgumentException("Screenshots should be accessed using Item.Screenshots");
|
|
}
|
|
|
|
var typeKey = type;
|
|
|
|
// If it's null remove the key from the dictionary
|
|
if (string.IsNullOrEmpty(path))
|
|
{
|
|
if (Images.ContainsKey(typeKey))
|
|
{
|
|
Images.Remove(typeKey);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
Images[typeKey] = path;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Deletes the image.
|
|
/// </summary>
|
|
/// <param name="type">The type.</param>
|
|
/// <param name="index">The index.</param>
|
|
/// <returns>Task.</returns>
|
|
public Task DeleteImage(ImageType type, int? index)
|
|
{
|
|
if (type == ImageType.Backdrop)
|
|
{
|
|
if (!index.HasValue)
|
|
{
|
|
throw new ArgumentException("Please specify a backdrop image index to delete.");
|
|
}
|
|
|
|
var file = BackdropImagePaths[index.Value];
|
|
|
|
BackdropImagePaths.Remove(file);
|
|
|
|
// Delete the source file
|
|
File.Delete(file);
|
|
}
|
|
else if (type == ImageType.Screenshot)
|
|
{
|
|
if (!index.HasValue)
|
|
{
|
|
throw new ArgumentException("Please specify a screenshot image index to delete.");
|
|
}
|
|
|
|
var file = ScreenshotImagePaths[index.Value];
|
|
|
|
ScreenshotImagePaths.Remove(file);
|
|
|
|
// Delete the source file
|
|
File.Delete(file);
|
|
}
|
|
else
|
|
{
|
|
// Delete the source file
|
|
File.Delete(GetImage(type));
|
|
|
|
// Remove it from the item
|
|
SetImage(type, null);
|
|
}
|
|
|
|
// Refresh metadata
|
|
return RefreshMetadata(CancellationToken.None, forceSave: true);
|
|
}
|
|
}
|
|
}
|