#608 - Add manual image selection for People

MediaBrowser.Providers/TV/ManualTvdbPersonImageProvider.cs

@@ -0,0 +1,192 @@
+using MediaBrowser.Controller.Configuration;
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Controller.Entities.TV;
+using MediaBrowser.Controller.Library;
+using MediaBrowser.Controller.Providers;
+using MediaBrowser.Model.Entities;
+using MediaBrowser.Model.Providers;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Xml;
+
+namespace MediaBrowser.Providers.TV
+{
+    public class ManualTvdbPersonImageProvider : IImageProvider
+    {
+        private readonly IServerConfigurationManager _config;
+        private readonly ILibraryManager _library;
+
+        public ManualTvdbPersonImageProvider(IServerConfigurationManager config, ILibraryManager library)
+        {
+            _config = config;
+            _library = library;
+        }
+
+        public string Name
+        {
+            get { return ProviderName; }
+        }
+
+        public static string ProviderName
+        {
+            get { return "TheTVDB"; }
+        }
+
+        public bool Supports(BaseItem item)
+        {
+            return item is Person;
+        }
+
+        public async Task<IEnumerable<RemoteImageInfo>> GetImages(BaseItem item, ImageType imageType, CancellationToken cancellationToken)
+        {
+            var images = await GetAllImages(item, cancellationToken).ConfigureAwait(false);
+
+            return images.Where(i => i.Type == imageType);
+        }
+
+        public Task<IEnumerable<RemoteImageInfo>> GetAllImages(BaseItem item, CancellationToken cancellationToken)
+        {
+            var seriesWithPerson = _library.RootFolder
+                .RecursiveChildren
+                .OfType<Series>()
+                .Where(i => !string.IsNullOrEmpty(i.GetProviderId(MetadataProviders.Tvdb)) && i.People.Any(p => string.Equals(p.Name, item.Name, StringComparison.OrdinalIgnoreCase)))
+                .ToList();
+
+            var infos = seriesWithPerson.Select(i => GetImageFromSeriesData(i, item.Name, cancellationToken))
+                .Where(i => i != null)
+                .Take(1);
+
+            return Task.FromResult(infos);
+        }
+
+        private RemoteImageInfo GetImageFromSeriesData(Series series, string personName, CancellationToken cancellationToken)
+        {
+            var tvdbPath = TvdbSeriesProvider.GetSeriesDataPath(_config.ApplicationPaths, series.GetProviderId(MetadataProviders.Tvdb));
+
+            var actorXmlPath = Path.Combine(tvdbPath, "actors.xml");
+
+            try
+            {
+                return GetImageInfo(actorXmlPath, personName, cancellationToken);
+            }
+            catch (FileNotFoundException)
+            {
+                return null;
+            }
+        }
+
+        private RemoteImageInfo GetImageInfo(string xmlFile, string personName, CancellationToken cancellationToken)
+        {
+            var settings = new XmlReaderSettings
+            {
+                CheckCharacters = false,
+                IgnoreProcessingInstructions = true,
+                IgnoreComments = true,
+                ValidationType = ValidationType.None
+            };
+
+            using (var streamReader = new StreamReader(xmlFile, Encoding.UTF8))
+            {
+                // Use XmlReader for best performance
+                using (var reader = XmlReader.Create(streamReader, settings))
+                {
+                    reader.MoveToContent();
+
+                    // Loop through each element
+                    while (reader.Read())
+                    {
+                        cancellationToken.ThrowIfCancellationRequested();
+
+                        if (reader.NodeType == XmlNodeType.Element)
+                        {
+                            switch (reader.Name)
+                            {
+                                case "Actor":
+                                    {
+                                        using (var subtree = reader.ReadSubtree())
+                                        {
+                                            var info = FetchImageInfoFromActorNode(personName, subtree);
+
+                                            if (info != null)
+                                            {
+                                                return info;
+                                            }
+                                        }
+                                        break;
+                                    }
+                                default:
+                                    reader.Skip();
+                                    break;
+                            }
+                        }
+                    }
+                }
+            }
+
+            return null;
+        }
+
+        /// <summary>
+        /// Fetches the data from actor node.
+        /// </summary>
+        /// <param name="personName">Name of the person.</param>
+        /// <param name="reader">The reader.</param>
+        /// <returns>System.String.</returns>
+        private RemoteImageInfo FetchImageInfoFromActorNode(string personName, XmlReader reader)
+        {
+            reader.MoveToContent();
+
+            string name = null;
+            string image = null;
+
+            while (reader.Read())
+            {
+                if (reader.NodeType == XmlNodeType.Element)
+                {
+                    switch (reader.Name)
+                    {
+                        case "Name":
+                            {
+                                name = (reader.ReadElementContentAsString() ?? string.Empty).Trim();
+                                break;
+                            }
+
+                        case "Image":
+                            {
+                                image = (reader.ReadElementContentAsString() ?? string.Empty).Trim();
+                                break;
+                            }
+
+                        default:
+                            reader.Skip();
+                            break;
+                    }
+                }
+            }
+
+            if (!string.IsNullOrEmpty(name) && !string.IsNullOrEmpty(image) &&
+                string.Equals(name, personName, StringComparison.OrdinalIgnoreCase))
+            {
+                return new RemoteImageInfo
+                {
+                    Url = TVUtils.BannerUrl + image,
+                    Type = ImageType.Primary,
+                    ProviderName = Name
+
+                };
+            }
+
+            return null;
+        }
+
+        public int Priority
+        {
+            get { return 1; }
+        }
+    }
+}