Provider Data on item and NeedsRefresh functionality for providers

3 files changed, 77 insertions, 0 deletions

diff --git a/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs b/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs
index bae1ff0f9c..80a264af27 100644
--- a/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs
+++ b/MediaBrowser.Controller/Providers/BaseMetadataProvider.cs
@@ -1,11 +1,23 @@
 using MediaBrowser.Controller.Entities;

 using MediaBrowser.Controller.Library;

+using MediaBrowser.Common.Extensions;

 using System.Threading.Tasks;

+using System;

 

 namespace MediaBrowser.Controller.Providers

 {

     public abstract class BaseMetadataProvider

     {

+        protected Guid _id;

+        public virtual Guid Id

+        {

+            get

+            {

+                if (_id == null) _id = this.GetType().FullName.GetMD5();

+                return _id;

+            }

+        }

+

         public abstract bool Supports(BaseEntity item);

 

         public virtual bool RequiresInternet

@@ -16,6 +28,49 @@ namespace MediaBrowser.Controller.Providers
             }

         }

 

+        /// <summary>

+        /// Returns the last refresh time of this provider for this item. Providers that care should

+        /// call SetLastRefreshed to update this value.

+        /// </summary>

+        /// <param name="item"></param>

+        /// <returns></returns>

+        protected virtual DateTime LastRefreshed(BaseEntity item)

+        {

+            return (item.ProviderData[this.Id] ?? new BaseProviderInfo()).LastRefreshed;

+        }

+

+        /// <summary>

+        /// Sets the persisted last refresh date on the item for this provider.

+        /// </summary>

+        /// <param name="item"></param>

+        /// <param name="value"></param>

+        protected virtual void SetLastRefreshed(BaseEntity item, DateTime value)

+        {

+            var data = item.ProviderData[this.Id] ?? new BaseProviderInfo();

+            data.LastRefreshed = value;

+            item.ProviderData[this.Id] = data;

+        }

+

+        /// <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>

+        /// <returns></returns>

+        public virtual bool NeedsRefresh(BaseEntity item)

+        {

+            return CompareDate(item) > LastRefreshed(item);

+        }

+

+        /// <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>

+        protected virtual DateTime CompareDate(BaseEntity item)

+        {

+            return DateTime.MinValue;

+        }

+            

         public abstract Task FetchAsync(BaseEntity item, ItemResolveEventArgs args);

 

         public abstract MetadataProviderPriority Priority { get; }

diff --git a/MediaBrowser.Controller/Providers/BaseProviderInfo.cs b/MediaBrowser.Controller/Providers/BaseProviderInfo.cs
new file mode 100644
index 0000000000..1538b2262f
--- /dev/null
+++ b/MediaBrowser.Controller/Providers/BaseProviderInfo.cs
@@ -0,0 +1,15 @@
+using System;

+using System.Collections.Generic;

+using System.Linq;

+using System.Text;

+using System.Threading.Tasks;

+

+namespace MediaBrowser.Controller.Providers

+{

+    public class BaseProviderInfo

+    {

+        public Guid ProviderId { get; set; }

+        public DateTime LastRefreshed { get; set; }

+

+    }

+}

diff --git a/MediaBrowser.Controller/Providers/Movies/MovieProviderFromXml.cs b/MediaBrowser.Controller/Providers/Movies/MovieProviderFromXml.cs
index f1d625aeb8..7ef53d546a 100644
--- a/MediaBrowser.Controller/Providers/Movies/MovieProviderFromXml.cs
+++ b/MediaBrowser.Controller/Providers/Movies/MovieProviderFromXml.cs
@@ -4,6 +4,7 @@ using MediaBrowser.Controller.Library;
 using System.ComponentModel.Composition;

 using System.IO;

 using System.Threading.Tasks;

+using System;

 

 namespace MediaBrowser.Controller.Providers.Movies

 {

@@ -20,6 +21,12 @@ namespace MediaBrowser.Controller.Providers.Movies
             get { return MetadataProviderPriority.First; }

         }

 

+        protected override DateTime CompareDate(BaseEntity item)

+        {

+            var entry = item.ResolveArgs.GetFileSystemEntry(Path.Combine(item.Path, "movie.xml"));

+            return entry != null ? entry.Value.LastWriteTimeUtc : DateTime.MinValue;

+        }

+

         public override async Task FetchAsync(BaseEntity item, ItemResolveEventArgs args)

         {

             await Task.Run(() => Fetch(item, args)).ConfigureAwait(false);