From ce13ff95ad92fb2ee9448ac0a8d4054a6d043b14 Mon Sep 17 00:00:00 2001
From: Luke Pulverenti <luke.pulverenti@gmail.com>
Date: Tue, 14 Jan 2014 10:50:39 -0500
Subject: support plot keywords

---
 MediaBrowser.Controller/Entities/IHasKeywords.cs   | 31 ++++++++++++++
 MediaBrowser.Controller/Entities/Movies/BoxSet.cs  |  4 +-
 MediaBrowser.Controller/Entities/Movies/Movie.cs   |  6 ++-
 MediaBrowser.Controller/Entities/Trailer.cs        |  5 ++-
 MediaBrowser.Controller/Library/ItemResolveArgs.cs | 12 +++++-
 .../MediaBrowser.Controller.csproj                 |  1 +
 .../Providers/BaseItemXmlParser.cs                 | 47 ++++++++++++++++++++++
 7 files changed, 101 insertions(+), 5 deletions(-)
 create mode 100644 MediaBrowser.Controller/Entities/IHasKeywords.cs

(limited to 'MediaBrowser.Controller')

diff --git a/MediaBrowser.Controller/Entities/IHasKeywords.cs b/MediaBrowser.Controller/Entities/IHasKeywords.cs
new file mode 100644
index 0000000000..ab9eb4aeee
--- /dev/null
+++ b/MediaBrowser.Controller/Entities/IHasKeywords.cs
@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace MediaBrowser.Controller.Entities
+{
+    public interface IHasKeywords
+    {
+        /// <summary>
+        /// Gets or sets the keywords.
+        /// </summary>
+        /// <value>The keywords.</value>
+        List<string> Keywords { get; set; }
+    }
+
+    public static class KeywordExtensions
+    {
+        public static void AddKeyword(this IHasKeywords item, string name)
+        {
+            if (string.IsNullOrWhiteSpace(name))
+            {
+                throw new ArgumentNullException("name");
+            }
+
+            if (!item.Keywords.Contains(name, StringComparer.OrdinalIgnoreCase))
+            {
+                item.Keywords.Add(name);
+            }
+        }
+    }
+}
diff --git a/MediaBrowser.Controller/Entities/Movies/BoxSet.cs b/MediaBrowser.Controller/Entities/Movies/BoxSet.cs
index 91e7873c8c..19d0d66825 100644
--- a/MediaBrowser.Controller/Entities/Movies/BoxSet.cs
+++ b/MediaBrowser.Controller/Entities/Movies/BoxSet.cs
@@ -9,7 +9,7 @@ namespace MediaBrowser.Controller.Entities.Movies
     /// <summary>
     /// Class BoxSet
     /// </summary>
-    public class BoxSet : Folder, IHasTrailers, IHasTags, IHasPreferredMetadataLanguage, IHasDisplayOrder
+    public class BoxSet : Folder, IHasTrailers, IHasTags, IHasKeywords, IHasPreferredMetadataLanguage, IHasDisplayOrder
     {
         public BoxSet()
         {
@@ -18,6 +18,7 @@ namespace MediaBrowser.Controller.Entities.Movies
             Tags = new List<string>();
 
             DisplayOrder = ItemSortBy.PremiereDate;
+            Keywords = new List<string>();
         }
 
         public List<Guid> LocalTrailerIds { get; set; }
@@ -33,6 +34,7 @@ namespace MediaBrowser.Controller.Entities.Movies
         /// </summary>
         /// <value>The tags.</value>
         public List<string> Tags { get; set; }
+        public List<string> Keywords { get; set; }
 
         public string PreferredMetadataLanguage { get; set; }
 
diff --git a/MediaBrowser.Controller/Entities/Movies/Movie.cs b/MediaBrowser.Controller/Entities/Movies/Movie.cs
index f9d3f845c3..b1d3a871ad 100644
--- a/MediaBrowser.Controller/Entities/Movies/Movie.cs
+++ b/MediaBrowser.Controller/Entities/Movies/Movie.cs
@@ -12,7 +12,7 @@ namespace MediaBrowser.Controller.Entities.Movies
     /// <summary>
     /// Class Movie
     /// </summary>
-    public class Movie : Video, IHasCriticRating, IHasSoundtracks, IHasBudget, IHasTrailers, IHasThemeMedia, IHasTaglines, IHasTags, IHasPreferredMetadataLanguage
+    public class Movie : Video, IHasCriticRating, IHasSoundtracks, IHasBudget, IHasKeywords, IHasTrailers, IHasThemeMedia, IHasTaglines, IHasTags, IHasPreferredMetadataLanguage
     {
         public List<Guid> SpecialFeatureIds { get; set; }
 
@@ -39,10 +39,12 @@ namespace MediaBrowser.Controller.Entities.Movies
             ThemeVideoIds = new List<Guid>();
             Taglines = new List<string>();
             Tags = new List<string>();
+            Keywords = new List<string>();
         }
 
         public List<Guid> LocalTrailerIds { get; set; }
-        
+        public List<string> Keywords { get; set; }
+    
         public List<MediaUrl> RemoteTrailers { get; set; }
 
         /// <summary>
diff --git a/MediaBrowser.Controller/Entities/Trailer.cs b/MediaBrowser.Controller/Entities/Trailer.cs
index 7000d04d31..39869505ca 100644
--- a/MediaBrowser.Controller/Entities/Trailer.cs
+++ b/MediaBrowser.Controller/Entities/Trailer.cs
@@ -9,7 +9,7 @@ namespace MediaBrowser.Controller.Entities
     /// <summary>
     /// Class Trailer
     /// </summary>
-    public class Trailer : Video, IHasCriticRating, IHasSoundtracks, IHasBudget, IHasTrailers, IHasTaglines, IHasTags, IHasPreferredMetadataLanguage
+    public class Trailer : Video, IHasCriticRating, IHasSoundtracks, IHasBudget, IHasTrailers, IHasKeywords, IHasTaglines, IHasTags, IHasPreferredMetadataLanguage
     {
         public List<Guid> SoundtrackIds { get; set; }
 
@@ -28,12 +28,15 @@ namespace MediaBrowser.Controller.Entities
             SoundtrackIds = new List<Guid>();
             LocalTrailerIds = new List<Guid>();
             Tags = new List<string>();
+            Keywords = new List<string>();
         }
 
         public List<Guid> LocalTrailerIds { get; set; }
         
         public List<MediaUrl> RemoteTrailers { get; set; }
 
+        public List<string> Keywords { get; set; }
+        
         /// <summary>
         /// Gets or sets the tags.
         /// </summary>
diff --git a/MediaBrowser.Controller/Library/ItemResolveArgs.cs b/MediaBrowser.Controller/Library/ItemResolveArgs.cs
index c34180eb61..c45c142396 100644
--- a/MediaBrowser.Controller/Library/ItemResolveArgs.cs
+++ b/MediaBrowser.Controller/Library/ItemResolveArgs.cs
@@ -35,7 +35,17 @@ namespace MediaBrowser.Controller.Library
         /// <value>The file system children.</value>
         public IEnumerable<FileSystemInfo> FileSystemChildren
         {
-            get { return FileSystemDictionary.Values; }
+            get
+            {
+                var dict = FileSystemDictionary;
+
+                if (dict == null)
+                {
+                    return new List<FileSystemInfo>();
+                }
+
+                return dict.Values;
+            }
         }
 
         /// <summary>
diff --git a/MediaBrowser.Controller/MediaBrowser.Controller.csproj b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
index 14205e6685..af3857f178 100644
--- a/MediaBrowser.Controller/MediaBrowser.Controller.csproj
+++ b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
@@ -87,6 +87,7 @@
     <Compile Include="Entities\IHasCriticRating.cs" />
     <Compile Include="Entities\IHasDisplayOrder.cs" />
     <Compile Include="Entities\IHasImages.cs" />
+    <Compile Include="Entities\IHasKeywords.cs" />
     <Compile Include="Entities\IHasMediaStreams.cs" />
     <Compile Include="Entities\IHasPreferredMetadataLanguage.cs" />
     <Compile Include="Entities\IHasProductionLocations.cs" />
diff --git a/MediaBrowser.Controller/Providers/BaseItemXmlParser.cs b/MediaBrowser.Controller/Providers/BaseItemXmlParser.cs
index ea21e18b00..72cb0d73e2 100644
--- a/MediaBrowser.Controller/Providers/BaseItemXmlParser.cs
+++ b/MediaBrowser.Controller/Providers/BaseItemXmlParser.cs
@@ -79,6 +79,11 @@ namespace MediaBrowser.Controller.Providers
                 hasTags.Tags.Clear();
             }
 
+            var hasKeywords = item as IHasKeywords;
+            if (hasKeywords != null)
+            {
+                hasKeywords.Keywords.Clear();
+            }
 
             var hasTrailers = item as IHasTrailers;
             if (hasTrailers != null)
@@ -747,6 +752,19 @@ namespace MediaBrowser.Controller.Providers
                         break;
                     }
 
+                case "PlotKeywords":
+                    {
+                        using (var subtree = reader.ReadSubtree())
+                        {
+                            var hasTags = item as IHasKeywords;
+                            if (hasTags != null)
+                            {
+                                FetchFromKeywordsNode(subtree, hasTags);
+                            }
+                        }
+                        break;
+                    }
+
                 case "Persons":
                     {
                         using (var subtree = reader.ReadSubtree())
@@ -912,6 +930,35 @@ namespace MediaBrowser.Controller.Providers
             }
         }
 
+        private void FetchFromKeywordsNode(XmlReader reader, IHasKeywords item)
+        {
+            reader.MoveToContent();
+
+            while (reader.Read())
+            {
+                if (reader.NodeType == XmlNodeType.Element)
+                {
+                    switch (reader.Name)
+                    {
+                        case "PlotKeyword":
+                            {
+                                var tag = reader.ReadElementContentAsString();
+
+                                if (!string.IsNullOrWhiteSpace(tag))
+                                {
+                                    item.AddKeyword(tag);
+                                }
+                                break;
+                            }
+
+                        default:
+                            reader.Skip();
+                            break;
+                    }
+                }
+            }
+        }
+
         /// <summary>
         /// Fetches the data from persons node.
         /// </summary>
-- 
cgit v1.2.3