diff options
Diffstat (limited to 'MediaBrowser.Controller/Providers/BaseMetadataProvider.cs')
| -rw-r--r-- | MediaBrowser.Controller/Providers/BaseMetadataProvider.cs | 268 |
1 files changed, 0 insertions, 268 deletions
diff --git a/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs b/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs deleted file mode 100644 index f8580244a..000000000 --- a/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs +++ /dev/null @@ -1,268 +0,0 @@ -using MediaBrowser.Common.Extensions; -using MediaBrowser.Controller.Configuration; -using MediaBrowser.Controller.Entities; -using MediaBrowser.Controller.Library; -using MediaBrowser.Model.Logging; -using System; -using System.Threading; -using System.Threading.Tasks; - -namespace MediaBrowser.Controller.Providers -{ - /// <summary> - /// Class BaseMetadataProvider - /// </summary> - public abstract class BaseMetadataProvider - { - /// <summary> - /// Gets the logger. - /// </summary> - /// <value>The logger.</value> - protected ILogger Logger { get; set; } - - protected ILogManager LogManager { get; set; } - - /// <summary> - /// Gets the configuration manager. - /// </summary> - /// <value>The configuration manager.</value> - protected IServerConfigurationManager ConfigurationManager { get; private set; } - - /// <summary> - /// The _id - /// </summary> - public readonly Guid Id; - - /// <summary> - /// The true task result - /// </summary> - protected static readonly Task<bool> TrueTaskResult = Task.FromResult(true); - - protected static readonly Task<bool> FalseTaskResult = Task.FromResult(false); - - /// <summary> - /// Supportses the specified item. - /// </summary> - /// <param name="item">The item.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - public abstract bool Supports(BaseItem item); - - /// <summary> - /// Gets a value indicating whether [requires internet]. - /// </summary> - /// <value><c>true</c> if [requires internet]; otherwise, <c>false</c>.</value> - public virtual bool RequiresInternet - { - get - { - return false; - } - } - - /// <summary> - /// Gets the provider version. - /// </summary> - /// <value>The provider version.</value> - protected virtual string ProviderVersion - { - get - { - return null; - } - } - - public virtual ItemUpdateType ItemUpdateType - { - get { return RequiresInternet ? ItemUpdateType.MetadataDownload : ItemUpdateType.MetadataImport; } - } - - /// <summary> - /// Gets a value indicating whether [refresh on version change]. - /// </summary> - /// <value><c>true</c> if [refresh on version change]; otherwise, <c>false</c>.</value> - protected virtual bool RefreshOnVersionChange - { - get - { - return false; - } - } - - /// <summary> - /// Determines if this provider is relatively slow and, therefore, should be skipped - /// in certain instances. Default is whether or not it requires internet. Can be overridden - /// for explicit designation. - /// </summary> - /// <value><c>true</c> if this instance is slow; otherwise, <c>false</c>.</value> - public virtual bool IsSlow - { - get { return RequiresInternet; } - } - - /// <summary> - /// Initializes a new instance of the <see cref="BaseMetadataProvider" /> class. - /// </summary> - protected BaseMetadataProvider(ILogManager logManager, IServerConfigurationManager configurationManager) - { - Logger = logManager.GetLogger(GetType().Name); - LogManager = logManager; - ConfigurationManager = configurationManager; - Id = GetType().FullName.GetMD5(); - - Initialize(); - } - - /// <summary> - /// Initializes this instance. - /// </summary> - protected virtual void Initialize() - { - } - - /// <summary> - /// Sets the persisted last refresh date on the item for this provider. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="value">The value.</param> - /// <param name="providerVersion">The provider version.</param> - /// <param name="providerInfo">The provider information.</param> - /// <param name="status">The status.</param> - /// <exception cref="System.ArgumentNullException">item</exception> - public virtual void SetLastRefreshed(BaseItem item, DateTime value, string providerVersion, - BaseProviderInfo providerInfo, ProviderRefreshStatus status = ProviderRefreshStatus.Success) - { - if (item == null) - { - throw new ArgumentNullException("item"); - } - - providerInfo.LastRefreshed = value; - providerInfo.LastRefreshStatus = status; - providerInfo.ProviderVersion = providerVersion; - } - - /// <summary> - /// Sets the last refreshed. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="value">The value.</param> - /// <param name="providerInfo">The provider information.</param> - /// <param name="status">The status.</param> - public void SetLastRefreshed(BaseItem item, DateTime value, - BaseProviderInfo providerInfo, ProviderRefreshStatus status = ProviderRefreshStatus.Success) - { - SetLastRefreshed(item, value, ProviderVersion, providerInfo, status); - } - - /// <summary> - /// Returns whether or not this provider should be re-fetched. Default functionality can - /// compare a provided date with a last refresh time. This can be overridden for more complex - /// determinations. - /// </summary> - /// <param name="item">The item.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - /// <exception cref="System.ArgumentNullException"></exception> - public bool NeedsRefresh(BaseItem item, BaseProviderInfo data) - { - if (item == null) - { - throw new ArgumentNullException(); - } - - return NeedsRefreshInternal(item, data); - } - - /// <summary> - /// Gets a value indicating whether [enforce dont fetch metadata]. - /// </summary> - /// <value><c>true</c> if [enforce dont fetch metadata]; otherwise, <c>false</c>.</value> - public virtual bool EnforceDontFetchMetadata - { - get - { - return true; - } - } - - /// <summary> - /// Needses the refresh internal. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="providerInfo">The provider info.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - /// <exception cref="System.ArgumentNullException"></exception> - protected virtual bool NeedsRefreshInternal(BaseItem item, BaseProviderInfo providerInfo) - { - if (item == null) - { - throw new ArgumentNullException("item"); - } - - if (providerInfo == null) - { - throw new ArgumentNullException("providerInfo"); - } - - if (providerInfo.LastRefreshed == default(DateTime)) - { - return true; - } - - if (NeedsRefreshBasedOnCompareDate(item, providerInfo)) - { - return true; - } - - if (RefreshOnVersionChange && !String.Equals(ProviderVersion, providerInfo.ProviderVersion)) - { - return true; - } - - if (providerInfo.LastRefreshStatus != ProviderRefreshStatus.Success) - { - return true; - } - - return false; - } - - /// <summary> - /// Needses the refresh based on compare date. - /// </summary> - /// <param name="item">The item.</param> - /// <param name="providerInfo">The provider info.</param> - /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns> - protected virtual bool NeedsRefreshBasedOnCompareDate(BaseItem item, BaseProviderInfo providerInfo) - { - return CompareDate(item) > providerInfo.LastRefreshed; - } - - /// <summary> - /// Override this to return the date that should be compared to the last refresh date - /// to determine if this provider should be re-fetched. - /// </summary> - /// <param name="item">The item.</param> - /// <returns>DateTime.</returns> - protected virtual DateTime CompareDate(BaseItem item) - { - return DateTime.MinValue.AddMinutes(1); // want this to be greater than mindate so new items will refresh - } - - /// <summary> - /// Fetches metadata and returns true or false indicating if any work that requires persistence was done - /// </summary> - /// <param name="item">The item.</param> - /// <param name="force">if set to <c>true</c> [force].</param> - /// <param name="providerInfo">The provider information.</param> - /// <param name="cancellationToken">The cancellation token.</param> - /// <returns>Task{System.Boolean}.</returns> - /// <exception cref="System.ArgumentNullException"></exception> - public abstract Task<bool> FetchAsync(BaseItem item, bool force, BaseProviderInfo providerInfo, CancellationToken cancellationToken); - - /// <summary> - /// Gets the priority. - /// </summary> - /// <value>The priority.</value> - public abstract MetadataProviderPriority Priority { get; } - } -} |