using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller.IO;
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.Localization;
using MediaBrowser.Controller.Providers;
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.Text;
using System.Threading;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Entities
{
///
/// Class BaseItem
///
public abstract class BaseItem : IHasProviderIds
{
///
/// The trailer folder name
///
public const string TrailerFolderName = "trailers";
///
/// Gets or sets the name.
///
/// The name.
public virtual string Name { get; set; }
///
/// Gets or sets the id.
///
/// The id.
public virtual Guid Id { get; set; }
///
/// Gets or sets the path.
///
/// The path.
public virtual string Path { get; set; }
///
/// Gets or sets the type of the location.
///
/// The type of the location.
public virtual LocationType LocationType
{
get
{
if (string.IsNullOrEmpty(Path))
{
return LocationType.Virtual;
}
return System.IO.Path.IsPathRooted(Path) ? LocationType.FileSystem : LocationType.Remote;
}
}
///
/// This is just a helper for convenience
///
/// The primary image path.
[IgnoreDataMember]
public virtual string PrimaryImagePath
{
get { return GetImage(ImageType.Primary); }
set { SetImage(ImageType.Primary, value); }
}
///
/// Gets or sets the images.
///
/// The images.
public Dictionary Images { get; set; }
///
/// Gets or sets the date created.
///
/// The date created.
public DateTime DateCreated { get; set; }
///
/// Gets or sets the date modified.
///
/// The date modified.
public DateTime DateModified { get; set; }
///
/// The logger
///
protected static internal ILogger Logger { get; internal set; }
protected static internal ILibraryManager LibraryManager { get; internal set; }
///
/// Returns a that represents this instance.
///
/// A that represents this instance.
public override string ToString()
{
return Name;
}
///
/// Returns true if this item should not attempt to fetch metadata
///
/// true if [dont fetch meta]; otherwise, false.
[IgnoreDataMember]
public virtual bool DontFetchMeta
{
get
{
if (Path != null)
{
return Path.IndexOf("[dontfetchmeta]", StringComparison.OrdinalIgnoreCase) != -1;
}
return false;
}
}
///
/// Determines whether the item has a saved local image of the specified name (jpg or png).
///
/// The name.
/// true if [has local image] [the specified item]; otherwise, false.
/// name
public bool HasLocalImage(string name)
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentNullException("name");
}
return ResolveArgs.ContainsMetaFileByName(name + ".jpg") ||
ResolveArgs.ContainsMetaFileByName(name + ".png");
}
///
/// Should be overridden to return the proper folder where metadata lives
///
/// The meta location.
[IgnoreDataMember]
public virtual string MetaLocation
{
get
{
return Path ?? "";
}
}
///
/// The _provider data
///
private Dictionary _providerData;
///
/// 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.
///
/// The provider data.
public Dictionary ProviderData
{
get
{
return _providerData ?? (_providerData = new Dictionary());
}
set
{
_providerData = value;
}
}
///
/// The _file system stamp
///
private Guid? _fileSystemStamp;
///
/// Gets a directory stamp, in the form of a string, that can be used for
/// comparison purposes to determine if the file system entries for this item have changed.
///
/// The file system stamp.
[IgnoreDataMember]
public Guid FileSystemStamp
{
get
{
if (!_fileSystemStamp.HasValue)
{
_fileSystemStamp = GetFileSystemStamp();
}
return _fileSystemStamp.Value;
}
}
///
/// Gets the type of the media.
///
/// The type of the media.
[IgnoreDataMember]
public virtual string MediaType
{
get
{
return null;
}
}
///
/// Gets a directory stamp, in the form of a string, that can be used for
/// comparison purposes to determine if the file system entries for this item have changed.
///
/// Guid.
private Guid GetFileSystemStamp()
{
// If there's no path or the item is a file, there's nothing to do
if (LocationType != LocationType.FileSystem || !ResolveArgs.IsDirectory)
{
return Guid.Empty;
}
var sb = new StringBuilder();
// Record the name of each file
// Need to sort these because accoring to msdn docs, our i/o methods are not guaranteed in any order
foreach (var file in ResolveArgs.FileSystemChildren.OrderBy(f => f.cFileName))
{
sb.Append(file.cFileName);
}
foreach (var file in ResolveArgs.MetadataFiles.OrderBy(f => f.cFileName))
{
sb.Append(file.cFileName);
}
return sb.ToString().GetMD5();
}
///
/// The _resolve args
///
private ItemResolveArgs _resolveArgs;
///
/// The _resolve args initialized
///
private bool _resolveArgsInitialized;
///
/// The _resolve args sync lock
///
private object _resolveArgsSyncLock = new object();
///
/// 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)
/// Use ResolveArgs.FileSystemDictionary to check for the existence of files instead of File.Exists
///
/// The resolve args.
[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 ", ex, Path);
throw;
}
return _resolveArgs;
}
set
{
_resolveArgs = value;
_resolveArgsInitialized = value != null;
// Null this out so that it can be lazy loaded again
_fileSystemStamp = null;
}
}
///
/// Resets the resolve args.
///
/// The path info.
public void ResetResolveArgs(WIN32_FIND_DATA? pathInfo)
{
ResolveArgs = CreateResolveArgs(pathInfo);
}
///
/// Creates ResolveArgs on demand
///
/// The path info.
/// ItemResolveArgs.
/// Unable to retrieve file system info for + path
protected internal virtual ItemResolveArgs CreateResolveArgs(WIN32_FIND_DATA? pathInfo = null)
{
var path = Path;
// non file-system entries will not have a path
if (string.IsNullOrEmpty(path))
{
return new ItemResolveArgs
{
FileInfo = new WIN32_FIND_DATA()
};
}
if (UseParentPathToCreateResolveArgs)
{
path = System.IO.Path.GetDirectoryName(path);
}
pathInfo = pathInfo ?? FileSystem.GetFileData(path);
if (!pathInfo.HasValue)
{
throw new IOException("Unable to retrieve file system info for " + path);
}
var args = new ItemResolveArgs
{
FileInfo = pathInfo.Value,
Path = path,
Parent = Parent
};
// Gather child folder and files
if (args.IsDirectory)
{
// When resolving the root, we need it's grandchildren (children of user views)
var flattenFolderDepth = args.IsPhysicalRoot ? 2 : 0;
args.FileSystemDictionary = FileData.GetFilteredFileSystemEntries(args.Path, Logger, flattenFolderDepth: flattenFolderDepth, args: args);
}
//update our dates
EntityResolutionHelper.EnsureDates(this, args);
return args;
}
///
/// 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.
///
/// true if [use parent path to create resolve args]; otherwise, false.
[IgnoreDataMember]
protected virtual bool UseParentPathToCreateResolveArgs
{
get
{
return false;
}
}
///
/// Gets or sets the name of the sort.
///
/// The name of the sort.
public string SortName { get; set; }
///
/// Gets or sets the parent.
///
/// The parent.
[IgnoreDataMember]
public Folder Parent { get; set; }
///
/// Gets the collection folder parent.
///
/// The collection folder parent.
[IgnoreDataMember]
public Folder CollectionFolder
{
get
{
if (this is AggregateFolder)
{
return null;
}
if (IsFolder)
{
var iCollectionFolder = this as ICollectionFolder;
if (iCollectionFolder != null)
{
return (Folder)this;
}
}
var parent = Parent;
while (parent != null)
{
var iCollectionFolder = parent as ICollectionFolder;
if (iCollectionFolder != null)
{
return parent;
}
parent = parent.Parent;
}
return null;
}
}
///
/// When the item first debuted. For movies this could be premiere date, episodes would be first aired
///
/// The premiere date.
public DateTime? PremiereDate { get; set; }
///
/// Gets or sets the display type of the media.
///
/// The display type of the media.
public virtual string DisplayMediaType { get; set; }
///
/// Gets or sets the backdrop image paths.
///
/// The backdrop image paths.
public List BackdropImagePaths { get; set; }
///
/// Gets or sets the screenshot image paths.
///
/// The screenshot image paths.
public List ScreenshotImagePaths { get; set; }
///
/// Gets or sets the official rating.
///
/// The official rating.
public string OfficialRating { get; set; }
///
/// Gets or sets the custom rating.
///
/// The custom rating.
public string CustomRating { get; set; }
///
/// Gets or sets the language.
///
/// The language.
public string Language { get; set; }
///
/// Gets or sets the overview.
///
/// The overview.
public string Overview { get; set; }
///
/// Gets or sets the taglines.
///
/// The taglines.
public List Taglines { get; set; }
///
/// Gets or sets the people.
///
/// The people.
public List People { get; set; }
///
/// Override this if you need to combine/collapse person information
///
/// All people.
[IgnoreDataMember]
public virtual IEnumerable AllPeople
{
get { return People; }
}
///
/// Gets or sets the studios.
///
/// The studios.
public virtual List Studios { get; set; }
///
/// Gets or sets the genres.
///
/// The genres.
public virtual List Genres { get; set; }
///
/// Gets or sets the community rating.
///
/// The community rating.
public float? CommunityRating { get; set; }
///
/// Gets or sets the run time ticks.
///
/// The run time ticks.
public long? RunTimeTicks { get; set; }
///
/// Gets or sets the aspect ratio.
///
/// The aspect ratio.
public string AspectRatio { get; set; }
///
/// Gets or sets the production year.
///
/// The production year.
public virtual int? ProductionYear { get; set; }
///
/// 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.
///
/// The index number.
public int? IndexNumber { get; set; }
///
/// For an episode this could be the season number, or for a song this could be the disc number.
///
/// The parent index number.
public int? ParentIndexNumber { get; set; }
///
/// The _local trailers
///
private List