1 files changed, 231 insertions, 128 deletions
diff --git a/MediaBrowser.Controller/Providers/ImageFromMediaLocationProvider.cs b/MediaBrowser.Controller/Providers/ImageFromMediaLocationProvider.cs
index d6fd26d1c..985876406 100644
--- a/MediaBrowser.Controller/Providers/ImageFromMediaLocationProvider.cs
+++ b/MediaBrowser.Controller/Providers/ImageFromMediaLocationProvider.cs
@@ -1,128 +1,231 @@
-using MediaBrowser.Controller.Entities;
-using MediaBrowser.Controller.Library;
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.Composition;
-using System.IO;
-using System.Threading.Tasks;
-
-namespace MediaBrowser.Controller.Providers
-{
-    /// <summary>
-    /// Provides images for all types by looking for standard images - folder, backdrop, logo, etc.
-    /// </summary>
-    [Export(typeof(BaseMetadataProvider))]
-    public class ImageFromMediaLocationProvider : BaseMetadataProvider
-    {
-        public override bool Supports(BaseEntity item)
-        {
-            return true;
-        }
-
-        public override MetadataProviderPriority Priority
-        {
-            get { return MetadataProviderPriority.First; }
-        }
-
-        public override Task FetchAsync(BaseEntity item, ItemResolveEventArgs args)
-        {
-            if (args.IsDirectory)
-            {
-                var baseItem = item as BaseItem;
-
-                if (baseItem != null)
-                {
-                    return Task.Run(() => PopulateBaseItemImages(baseItem, args));
-                }
-
-                return Task.Run(() => PopulateImages(item, args));
-            }
-
-            return Task.FromResult<object>(null);
-        }
-
-        /// <summary>
-        /// Fills in image paths based on files win the folder
-        /// </summary>
-        private void PopulateImages(BaseEntity item, ItemResolveEventArgs args)
-        {
-            for (int i = 0; i < args.FileSystemChildren.Length; i++)
-            {
-                var file = args.FileSystemChildren[i];
-
-                string filePath = file.Path;
-
-                string ext = Path.GetExtension(filePath);
-
-                // Only support png and jpg files
-                if (!ext.EndsWith("png", StringComparison.OrdinalIgnoreCase) && !ext.EndsWith("jpg", StringComparison.OrdinalIgnoreCase))
-                {
-                    continue;
-                }
-
-                string name = Path.GetFileNameWithoutExtension(filePath);
-
-                if (name.Equals("folder", StringComparison.OrdinalIgnoreCase))
-                {
-                    item.PrimaryImagePath = filePath;
-                }
-            }
-        }
-
-        /// <summary>
-        /// Fills in image paths based on files win the folder
-        /// </summary>
-        private void PopulateBaseItemImages(BaseItem item, ItemResolveEventArgs args)
-        {
-            var backdropFiles = new List<string>();
-
-            for (int i = 0; i < args.FileSystemChildren.Length; i++)
-            {
-                var file = args.FileSystemChildren[i];
-
-                string filePath = file.Path;
-
-                string ext = Path.GetExtension(filePath);
-
-                // Only support png and jpg files
-                if (!ext.EndsWith("png", StringComparison.OrdinalIgnoreCase) && !ext.EndsWith("jpg", StringComparison.OrdinalIgnoreCase))
-                {
-                    continue;
-                }
-
-                string name = Path.GetFileNameWithoutExtension(filePath);
-
-                if (name.Equals("folder", StringComparison.OrdinalIgnoreCase))
-                {
-                    item.PrimaryImagePath = filePath;
-                }
-                else if (name.StartsWith("backdrop", StringComparison.OrdinalIgnoreCase))
-                {
-                    backdropFiles.Add(filePath);
-                }
-                if (name.Equals("logo", StringComparison.OrdinalIgnoreCase))
-                {
-                    item.LogoImagePath = filePath;
-                }
-                if (name.Equals("banner", StringComparison.OrdinalIgnoreCase))
-                {
-                    item.BannerImagePath = filePath;
-                }
-                if (name.Equals("clearart", StringComparison.OrdinalIgnoreCase))
-                {
-                    item.ArtImagePath = filePath;
-                }
-                if (name.Equals("thumb", StringComparison.OrdinalIgnoreCase))
-                {
-                    item.ThumbnailImagePath = filePath;
-                }
-            }
-
-            if (backdropFiles.Count > 0)
-            {
-                item.BackdropImagePaths = backdropFiles;
-            }
-        }
-
-    }
-}
+using MediaBrowser.Common.Win32;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Model.Entities;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel.Composition;
+using System.IO;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MediaBrowser.Controller.Providers
+{
+    /// <summary>
+    /// Provides images for all types by looking for standard images - folder, backdrop, logo, etc.
+    /// </summary>
+    [Export(typeof(BaseMetadataProvider))]
+    public class ImageFromMediaLocationProvider : BaseMetadataProvider
+    {
+        /// <summary>
+        /// Supportses the specified item.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <returns><c>true</c> if XXXX, <c>false</c> otherwise</returns>
+        public override bool Supports(BaseItem item)
+        {
+            return item.ResolveArgs.IsDirectory && item.LocationType == LocationType.FileSystem;
+        }
+
+        /// <summary>
+        /// Gets the priority.
+        /// </summary>
+        /// <value>The priority.</value>
+        public override MetadataProviderPriority Priority
+        {
+            get { return MetadataProviderPriority.First; }
+        }
+
+        /// <summary>
+        /// Returns true or false indicating if the provider should refresh when the contents of it's directory changes
+        /// </summary>
+        /// <value><c>true</c> if [refresh on file system stamp change]; otherwise, <c>false</c>.</value>
+        protected override bool RefreshOnFileSystemStampChange
+        {
+            get
+            {
+                return true;
+            }
+        }
+
+        /// <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="cancellationToken">The cancellation token.</param>
+        /// <returns>Task{System.Boolean}.</returns>
+        protected override Task<bool> FetchAsyncInternal(BaseItem item, bool force, CancellationToken cancellationToken)
+        {
+            cancellationToken.ThrowIfCancellationRequested();
+            
+            // Make sure current image paths still exist
+            ValidateImages(item);
+
+            cancellationToken.ThrowIfCancellationRequested();
+
+            // Make sure current backdrop paths still exist
+            ValidateBackdrops(item);
+
+            cancellationToken.ThrowIfCancellationRequested();
+            
+            PopulateBaseItemImages(item);
+
+            SetLastRefreshed(item, DateTime.UtcNow);
+            return TrueTaskResult;
+        }
+
+        /// <summary>
+        /// Validates that images within the item are still on the file system
+        /// </summary>
+        /// <param name="item">The item.</param>
+        private void ValidateImages(BaseItem item)
+        {
+            if (item.Images == null)
+            {
+                return;
+            }
+
+            // Only validate paths from the same directory - need to copy to a list because we are going to potentially modify the collection below
+            var deletedKeys = item.Images.Keys.Where(image =>
+            {
+                var path = item.Images[image];
+
+                return IsInSameDirectory(item, path) && !item.ResolveArgs.GetMetaFileByPath(path).HasValue;
+            }).ToList();
+
+            // Now remove them from the dictionary
+            foreach(var key in deletedKeys)
+            {
+                item.Images.Remove(key);
+            }
+        }
+
+        /// <summary>
+        /// Validates that backdrops within the item are still on the file system
+        /// </summary>
+        /// <param name="item">The item.</param>
+        private void ValidateBackdrops(BaseItem item)
+        {
+            if (item.BackdropImagePaths == null)
+            {
+                return;
+            }
+
+            // Only validate paths from the same directory - need to copy to a list because we are going to potentially modify the collection below
+            var deletedImages = item.BackdropImagePaths.Where(path => IsInSameDirectory(item, path) && !item.ResolveArgs.GetMetaFileByPath(path).HasValue).ToList();
+
+            // Now remove them from the dictionary
+            foreach (var path in deletedImages)
+            {
+                item.BackdropImagePaths.Remove(path);
+            }
+        }
+
+        /// <summary>
+        /// Determines whether [is in same directory] [the specified item].
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <param name="path">The path.</param>
+        /// <returns><c>true</c> if [is in same directory] [the specified item]; otherwise, <c>false</c>.</returns>
+        private bool IsInSameDirectory(BaseItem item, string path)
+        {
+            return string.Equals(Path.GetDirectoryName(path), item.Path, StringComparison.OrdinalIgnoreCase);
+        }
+
+        /// <summary>
+        /// Gets the image.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <param name="filenameWithoutExtension">The filename without extension.</param>
+        /// <returns>System.Nullable{WIN32_FIND_DATA}.</returns>
+        protected virtual WIN32_FIND_DATA? GetImage(BaseItem item, string filenameWithoutExtension)
+        {
+            return item.ResolveArgs.GetMetaFileByPath(Path.Combine(item.ResolveArgs.Path, filenameWithoutExtension + ".png")) ?? item.ResolveArgs.GetMetaFileByPath(Path.Combine(item.ResolveArgs.Path, filenameWithoutExtension + ".jpg"));
+        }
+
+        /// <summary>
+        /// Fills in image paths based on files win the folder
+        /// </summary>
+        /// <param name="item">The item.</param>
+        private void PopulateBaseItemImages(BaseItem item)
+        {
+            var backdropFiles = new List<string>();
+
+            // Primary Image
+            var image = GetImage(item, "folder");
+
+            if (image.HasValue)
+            {
+                item.SetImage(ImageType.Primary, image.Value.Path);
+            }
+
+            // Logo Image
+            image = GetImage(item, "logo");
+
+            if (image.HasValue)
+            {
+                item.SetImage(ImageType.Logo, image.Value.Path);
+            }
+
+            // Banner Image
+            image = GetImage(item, "banner");
+
+            if (image.HasValue)
+            {
+                item.SetImage(ImageType.Banner, image.Value.Path);
+            }
+
+            // Clearart
+            image = GetImage(item, "clearart");
+
+            if (image.HasValue)
+            {
+                item.SetImage(ImageType.Art, image.Value.Path);
+            }
+
+            // Thumbnail Image
+            image = GetImage(item, "thumb");
+
+            if (image.HasValue)
+            {
+                item.SetImage(ImageType.Thumb, image.Value.Path);
+            }
+
+            // Backdrop Image
+            image = GetImage(item, "backdrop");
+
+            if (image.HasValue)
+            {
+                backdropFiles.Add(image.Value.Path);
+            }
+
+            var unfound = 0;
+            for (var i = 1; i <= 20; i++)
+            {
+                // Backdrop Image
+                image = GetImage(item, "backdrop" + i);
+
+                if (image.HasValue)
+                {
+                    backdropFiles.Add(image.Value.Path);
+                }
+                else
+                {
+                    unfound++;
+
+                    if (unfound >= 3)
+                    {
+                        break;
+                    }
+                }
+            }
+
+            if (backdropFiles.Count > 0)
+            {
+                item.BackdropImagePaths = backdropFiles;
+            }
+        }
+
+    }
+}