unified the two sorting api's

8 files changed, 52 insertions, 359 deletions

diff --git a/MediaBrowser.Controller/Entities/Folder.cs b/MediaBrowser.Controller/Entities/Folder.cs
index c6f4790298..ef34742df4 100644
--- a/MediaBrowser.Controller/Entities/Folder.cs
+++ b/MediaBrowser.Controller/Entities/Folder.cs
@@ -13,7 +13,6 @@ using System.Linq;
 using System.Runtime.Serialization;
 using System.Threading;
 using System.Threading.Tasks;
-using SortOrder = MediaBrowser.Controller.Sorting.SortOrder;
 
 namespace MediaBrowser.Controller.Entities
 {
@@ -177,63 +176,6 @@ namespace MediaBrowser.Controller.Entities
             }
         }
 
-        #region Sorting
-
-        /// <summary>
-        /// The _sort by options
-        /// </summary>
-        private Dictionary<string, IComparer<BaseItem>> _sortByOptions;
-        /// <summary>
-        /// Dictionary of sort options - consists of a display value (localized) and an IComparer of BaseItem
-        /// </summary>
-        /// <value>The sort by options.</value>
-        [IgnoreDataMember]
-        public Dictionary<string, IComparer<BaseItem>> SortByOptions
-        {
-            get { return _sortByOptions ?? (_sortByOptions = GetSortByOptions()); }
-        }
-
-        /// <summary>
-        /// Returns the valid set of sort by options for this folder type.
-        /// Override or extend to modify.
-        /// </summary>
-        /// <returns>Dictionary{System.StringIComparer{BaseItem}}.</returns>
-        protected virtual Dictionary<string, IComparer<BaseItem>> GetSortByOptions()
-        {
-            return new Dictionary<string, IComparer<BaseItem>> {            
-                {LocalizedStrings.Instance.GetString("NameDispPref"), new BaseItemComparer(SortOrder.Name, Logger)},
-                {LocalizedStrings.Instance.GetString("DateDispPref"), new BaseItemComparer(SortOrder.Date, Logger)},
-                {LocalizedStrings.Instance.GetString("RatingDispPref"), new BaseItemComparer(SortOrder.Rating, Logger)},
-                {LocalizedStrings.Instance.GetString("RuntimeDispPref"), new BaseItemComparer(SortOrder.Runtime, Logger)},
-                {LocalizedStrings.Instance.GetString("YearDispPref"), new BaseItemComparer(SortOrder.Year, Logger)}
-            };
-
-        }
-
-        /// <summary>
-        /// Get a sorting comparer by name
-        /// </summary>
-        /// <param name="name">The name.</param>
-        /// <returns>IComparer{BaseItem}.</returns>
-        private IComparer<BaseItem> GetSortingFunction(string name)
-        {
-            IComparer<BaseItem> sorting;
-            SortByOptions.TryGetValue(name ?? "", out sorting);
-            return sorting ?? new BaseItemComparer(SortOrder.Name, Logger);
-        }
-
-        /// <summary>
-        /// Get the list of sort by choices for this folder (localized).
-        /// </summary>
-        /// <value>The sort by option strings.</value>
-        [IgnoreDataMember]
-        public IEnumerable<string> SortByOptionStrings
-        {
-            get { return SortByOptions.Keys; }
-        }
-
-        #endregion
-
         #region Indexing
 
         /// <summary>
@@ -877,11 +819,9 @@ namespace MediaBrowser.Controller.Entities
         /// </summary>
         /// <param name="user">The user.</param>
         /// <param name="indexBy">The index by.</param>
-        /// <param name="sortBy">The sort by.</param>
-        /// <param name="sortOrder">The sort order.</param>
         /// <returns>IEnumerable{BaseItem}.</returns>
         /// <exception cref="System.ArgumentNullException"></exception>
-        public virtual IEnumerable<BaseItem> GetChildren(User user, string indexBy = null, string sortBy = null, Model.Entities.SortOrder? sortOrder = null)
+        public virtual IEnumerable<BaseItem> GetChildren(User user, string indexBy = null)
         {
             if (user == null)
             {
@@ -889,7 +829,7 @@ namespace MediaBrowser.Controller.Entities
             }
 
             //the true root should return our users root folder children
-            if (IsPhysicalRoot) return user.RootFolder.GetChildren(user, indexBy, sortBy, sortOrder);
+            if (IsPhysicalRoot) return user.RootFolder.GetChildren(user, indexBy);
 
             IEnumerable<BaseItem> result = null;
 
@@ -904,14 +844,7 @@ namespace MediaBrowser.Controller.Entities
                 result = ActualChildren.Where(c => c.IsVisible(user));
             }
 
-            if (string.IsNullOrEmpty(sortBy))
-            {
-                return result;
-            }
-
-            return sortOrder.HasValue && sortOrder.Value == Model.Entities.SortOrder.Descending
-                       ? result.OrderByDescending(i => i, GetSortingFunction(sortBy))
-                       : result.OrderBy(i => i, GetSortingFunction(sortBy));
+            return result;
         }
 
         /// <summary>
diff --git a/MediaBrowser.Controller/Library/DtoBuilder.cs b/MediaBrowser.Controller/Library/DtoBuilder.cs
index 92a15b117c..bdaa51b6c1 100644
--- a/MediaBrowser.Controller/Library/DtoBuilder.cs
+++ b/MediaBrowser.Controller/Library/DtoBuilder.cs
@@ -373,11 +373,6 @@ namespace MediaBrowser.Controller.Library
                 {
                     dto.IndexOptions = folder.IndexByOptionStrings.ToArray();
                 }
-
-                if (fields.Contains(ItemFields.SortOptions))
-                {
-                    dto.SortOptions = folder.SortByOptionStrings.ToArray();
-                }
             }
 
             // Add audio info
diff --git a/MediaBrowser.Controller/Library/ILibraryManager.cs b/MediaBrowser.Controller/Library/ILibraryManager.cs
index 3f19302093..40131b6d20 100644
--- a/MediaBrowser.Controller/Library/ILibraryManager.cs
+++ b/MediaBrowser.Controller/Library/ILibraryManager.cs
@@ -1,6 +1,7 @@
 using MediaBrowser.Controller.Entities;
 using MediaBrowser.Controller.IO;
 using MediaBrowser.Controller.Resolvers;
+using MediaBrowser.Controller.Sorting;
 using MediaBrowser.Model.Entities;
 using System;
 using System.Collections.Generic;
@@ -158,7 +159,19 @@ namespace MediaBrowser.Controller.Library
         /// <param name="pluginFolders">The plugin folders.</param>
         /// <param name="resolvers">The resolvers.</param>
         /// <param name="introProviders">The intro providers.</param>
+        /// <param name="itemComparers">The item comparers.</param>
         void AddParts(IEnumerable<IResolverIgnoreRule> rules, IEnumerable<IVirtualFolderCreator> pluginFolders,
-                      IEnumerable<IItemResolver> resolvers, IEnumerable<IIntroProvider> introProviders);
+                      IEnumerable<IItemResolver> resolvers, IEnumerable<IIntroProvider> introProviders, IEnumerable<IBaseItemComparer> itemComparers);
+
+        /// <summary>
+        /// Sorts the specified items.
+        /// </summary>
+        /// <param name="items">The items.</param>
+        /// <param name="user">The user.</param>
+        /// <param name="sortBy">The sort by.</param>
+        /// <param name="sortOrder">The sort order.</param>
+        /// <returns>IEnumerable{BaseItem}.</returns>
+        IEnumerable<BaseItem> Sort(IEnumerable<BaseItem> items, User user, IEnumerable<string> sortBy,
+                                   SortOrder sortOrder);
     }
 }
\ No newline at end of file
diff --git a/MediaBrowser.Controller/MediaBrowser.Controller.csproj b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
index 5ae6cccac5..9b75290237 100644
--- a/MediaBrowser.Controller/MediaBrowser.Controller.csproj
+++ b/MediaBrowser.Controller/MediaBrowser.Controller.csproj
@@ -185,8 +185,8 @@
     <Compile Include="Providers\FolderProviderFromXml.cs" />
     <Compile Include="Providers\ImageFromMediaLocationProvider.cs" />
     <Compile Include="Providers\MediaInfo\FFProbeVideoInfoProvider.cs" />
-    <Compile Include="Sorting\BaseItemComparer.cs" />
-    <Compile Include="Sorting\SortOrder.cs" />
+    <Compile Include="Sorting\IBaseItemComparer.cs" />
+    <Compile Include="Sorting\IUserBaseItemComparer.cs" />
     <Compile Include="Updates\IInstallationManager.cs" />
     <Compile Include="Weather\IWeatherProvider.cs" />
     <Compile Include="Providers\BaseItemXmlParser.cs" />
diff --git a/MediaBrowser.Controller/Sorting/BaseItemComparer.cs b/MediaBrowser.Controller/Sorting/BaseItemComparer.cs
deleted file mode 100644
index 94c16775d0..0000000000
--- a/MediaBrowser.Controller/Sorting/BaseItemComparer.cs
+++ /dev/null
@@ -1,248 +0,0 @@
-using MediaBrowser.Controller.Entities;
-using MediaBrowser.Model.Logging;
-using System;
-using System.Collections.Generic;
-
-namespace MediaBrowser.Controller.Sorting {
-    /// <summary>
-    /// Class BaseItemComparer
-    /// </summary>
-    public class BaseItemComparer : IComparer<BaseItem> {
-        /// <summary>
-        /// The _order
-        /// </summary>
-        private readonly SortOrder _order;
-        /// <summary>
-        /// The _property name
-        /// </summary>
-        private readonly string _propertyName;
-        /// <summary>
-        /// The _compare culture
-        /// </summary>
-        private readonly StringComparison _compareCulture = StringComparison.CurrentCultureIgnoreCase;
-
-        /// <summary>
-        /// Gets or sets the logger.
-        /// </summary>
-        /// <value>The logger.</value>
-        private ILogger Logger { get; set; }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="BaseItemComparer" /> class.
-        /// </summary>
-        /// <param name="order">The order.</param>
-        /// <param name="logger">The logger.</param>
-        public BaseItemComparer(SortOrder order, ILogger logger) {
-            _order = order;
-            Logger = logger;
-        }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="BaseItemComparer" /> class.
-        /// </summary>
-        /// <param name="order">The order.</param>
-        /// <param name="compare">The compare.</param>
-        /// <param name="logger">The logger.</param>
-        public BaseItemComparer(SortOrder order, StringComparison compare, ILogger logger)
-        {
-            _order = order;
-            _compareCulture = compare;
-            Logger = logger;
-        }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="BaseItemComparer" /> class.
-        /// </summary>
-        /// <param name="property">The property.</param>
-        /// <param name="logger">The logger.</param>
-        public BaseItemComparer(string property, ILogger logger)
-        {
-            _order = SortOrder.Custom;
-            _propertyName = property;
-            Logger = logger;
-        }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="BaseItemComparer" /> class.
-        /// </summary>
-        /// <param name="property">The property.</param>
-        /// <param name="compare">The compare.</param>
-        /// <param name="logger">The logger.</param>
-        public BaseItemComparer(string property, StringComparison compare, ILogger logger)
-        {
-            _order = SortOrder.Custom;
-            _propertyName = property;
-            _compareCulture = compare;
-            Logger = logger;
-        }
-
-        #region IComparer<BaseItem> Members
-
-        /// <summary>
-        /// Compares the specified x.
-        /// </summary>
-        /// <param name="x">The x.</param>
-        /// <param name="y">The y.</param>
-        /// <returns>System.Int32.</returns>
-        public int Compare(BaseItem x, BaseItem y) {
-            int compare = 0;
-
-            switch (_order) {
-
-                case SortOrder.Date:
-                    compare = -x.DateCreated.CompareTo(y.DateCreated);
-                    break;
-
-                case SortOrder.Year:
-
-                    var xProductionYear = x.ProductionYear ?? 0;
-                    var yProductionYear = y.ProductionYear ?? 0;
-
-
-                    compare = yProductionYear.CompareTo(xProductionYear); 
-                    break;
-
-                case SortOrder.Rating:
-
-                    var xRating = x.CommunityRating ?? 0;
-                    var yRating = y.CommunityRating ?? 0;
-
-                    compare = yRating.CompareTo(xRating);
-                    break;
-
-                case SortOrder.Runtime:
-                    var xRuntime = x.RunTimeTicks ?? 0;
-                    var yRuntime = y.RunTimeTicks ?? 0;
-
-                    compare = xRuntime.CompareTo(yRuntime);
-                    break;
-
-                case SortOrder.Custom:
-
-                    Logger.Debug("Sorting on custom field " + _propertyName);
-                    var yProp = y.GetType().GetProperty(_propertyName);
-                    var xProp = x.GetType().GetProperty(_propertyName);
-                    if (yProp == null || xProp == null) break;
-                    var yVal = yProp.GetValue(y, null);
-                    var xVal = xProp.GetValue(x,null);
-                    if (yVal == null && xVal == null) break;
-                    if (yVal == null) return 1;
-                    if (xVal == null) return -1;
-                    compare = String.Compare(xVal.ToString(), yVal.ToString(),_compareCulture);
-                    break;
-
-                default:
-                    compare = 0;
-                    break;
-            }
-
-            if (compare == 0) {
-
-                var name1 = x.SortName ?? x.Name ?? "";
-                var name2 = y.SortName ?? y.Name ?? "";
-
-                //if (Config.Instance.EnableAlphanumericSorting)
-                    compare = AlphaNumericCompare(name1, name2,_compareCulture);
-                //else
-                //    compare = String.Compare(name1,name2,_compareCulture);
-            }
-
-            return compare;
-        }
-
-
-        #endregion
-
-        /// <summary>
-        /// Alphas the numeric compare.
-        /// </summary>
-        /// <param name="s1">The s1.</param>
-        /// <param name="s2">The s2.</param>
-        /// <param name="compareCulture">The compare culture.</param>
-        /// <returns>System.Int32.</returns>
-        private int AlphaNumericCompare(string s1, string s2, StringComparison compareCulture) {
-            // http://dotnetperls.com/Content/Alphanumeric-Sorting.aspx
-
-            int len1 = s1.Length;
-            int len2 = s2.Length;
-            int marker1 = 0;
-            int marker2 = 0;
-
-            // Walk through two the strings with two markers.
-            while (marker1 < len1 && marker2 < len2) {
-                char ch1 = s1[marker1];
-                char ch2 = s2[marker2];
-
-                // Some buffers we can build up characters in for each chunk.
-                var space1 = new char[len1];
-                var loc1 = 0;
-                var space2 = new char[len2];
-                var loc2 = 0;
-
-                // Walk through all following characters that are digits or
-                // characters in BOTH strings starting at the appropriate marker.
-                // Collect char arrays.
-                do {
-                    space1[loc1++] = ch1;
-                    marker1++;
-
-                    if (marker1 < len1) {
-                        ch1 = s1[marker1];
-                    } else {
-                        break;
-                    }
-                } while (char.IsDigit(ch1) == char.IsDigit(space1[0]));
-
-                do {
-                    space2[loc2++] = ch2;
-                    marker2++;
-
-                    if (marker2 < len2) {
-                        ch2 = s2[marker2];
-                    } else {
-                        break;
-                    }
-                } while (char.IsDigit(ch2) == char.IsDigit(space2[0]));
-
-                // If we have collected numbers, compare them numerically.
-                // Otherwise, if we have strings, compare them alphabetically.
-                var str1 = new string(space1);
-                var str2 = new string(space2);
-                
-                var result = 0;
-
-                //biggest int - 2147483647
-                if (char.IsDigit(space1[0]) && char.IsDigit(space2[0]) /*&& str1.Length < 10 && str2.Length < 10*/) //this assumed the entire string was a number...
-                {
-                    int thisNumericChunk;
-                    var isValid = false;
-
-                    if (int.TryParse(str1.Substring(0, str1.Length > 9 ? 10 : str1.Length), out thisNumericChunk))
-                    {
-                        int thatNumericChunk;
-                        
-                        if (int.TryParse(str2.Substring(0, str2.Length > 9 ? 10 : str2.Length), out thatNumericChunk))
-                        {
-                            isValid = true;
-                            result = thisNumericChunk.CompareTo(thatNumericChunk);
-                        }
-                    }
-                    
-                    if (!isValid)
-                    {
-                        Logger.Error("Error comparing numeric strings: " + str1 + "/" + str2);
-                        result = String.Compare(str1, str2, compareCulture);
-                    }
-                    
-                } else {
-                    result = String.Compare(str1,str2,compareCulture);
-                }
-
-                if (result != 0) {
-                    return result;
-                }
-            }
-            return len1 - len2;
-        }
-    }
-}
diff --git a/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs b/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs
new file mode 100644
index 0000000000..6d0b95bcb5
--- /dev/null
+++ b/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs
@@ -0,0 +1,17 @@
+using MediaBrowser.Controller.Entities;
+using System.Collections.Generic;
+
+namespace MediaBrowser.Controller.Sorting
+{
+    /// <summary>
+    /// Interface IBaseItemComparer
+    /// </summary>
+    public interface IBaseItemComparer : IComparer<BaseItem>
+    {
+        /// <summary>
+        /// Gets the name.
+        /// </summary>
+        /// <value>The name.</value>
+        string Name { get; }
+    }
+}
diff --git a/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs b/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs
new file mode 100644
index 0000000000..b9da1f6a62
--- /dev/null
+++ b/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs
@@ -0,0 +1,16 @@
+using MediaBrowser.Controller.Entities;
+
+namespace MediaBrowser.Controller.Sorting
+{
+    /// <summary>
+    /// Represents a BaseItem comparer that requires a User to perform it's comparison
+    /// </summary>
+    public interface IUserBaseItemComparer : IBaseItemComparer
+    {
+        /// <summary>
+        /// Gets or sets the user.
+        /// </summary>
+        /// <value>The user.</value>
+        User User { get; set; }
+    }
+}
diff --git a/MediaBrowser.Controller/Sorting/SortOrder.cs b/MediaBrowser.Controller/Sorting/SortOrder.cs
deleted file mode 100644
index 3152ac67e4..0000000000
--- a/MediaBrowser.Controller/Sorting/SortOrder.cs
+++ /dev/null
@@ -1,33 +0,0 @@
-
-namespace MediaBrowser.Controller.Sorting {
-    /// <summary>
-    /// Enum SortOrder
-    /// </summary>
-    public enum SortOrder {
-
-        /// <summary>
-        /// Sort by name
-        /// </summary>
-        Name,
-        /// <summary>
-        /// Sort by date added to the library
-        /// </summary>
-        Date,
-        /// <summary>
-        /// Sort by community rating
-        /// </summary>
-        Rating,
-        /// <summary>
-        /// Sort by runtime
-        /// </summary>
-        Runtime,
-        /// <summary>
-        /// Sort by year
-        /// </summary>
-        Year,
-        /// <summary>
-        /// Custom sort order added by plugins
-        /// </summary>
-        Custom
-    }
-}