Merge pull request #9560 from IDisposable/sort-nfo-data

Sort embedded collections in Nfo files

4 files changed, 62 insertions, 18 deletions

diff --git a/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs
index 2385e70485..440296f095 100644
--- a/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs
+++ b/MediaBrowser.XbmcMetadata/Savers/AlbumNfoSaver.cs
@@ -4,6 +4,7 @@ using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Xml;
+using Jellyfin.Extensions;
 using MediaBrowser.Controller.Configuration;
 using MediaBrowser.Controller.Entities;
 using MediaBrowser.Controller.Entities.Audio;
@@ -55,12 +56,12 @@ namespace MediaBrowser.XbmcMetadata.Savers
         {
             var album = (MusicAlbum)item;
 
-            foreach (var artist in album.Artists)
+            foreach (var artist in album.Artists.Trimmed().OrderBy(artist => artist))
             {
                 writer.WriteElementString("artist", artist);
             }
 
-            foreach (var artist in album.AlbumArtists)
+            foreach (var artist in album.AlbumArtists.Trimmed().OrderBy(artist => artist))
             {
                 writer.WriteElementString("albumartist", artist);
             }
@@ -70,11 +71,20 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
         private void AddTracks(IEnumerable<BaseItem> tracks, XmlWriter writer)
         {
-            foreach (var track in tracks.OrderBy(i => i.ParentIndexNumber ?? 0).ThenBy(i => i.IndexNumber ?? 0))
+            foreach (var track in tracks
+                .OrderBy(i => i.ParentIndexNumber ?? 0)
+                .ThenBy(i => i.IndexNumber ?? 0)
+                .ThenBy(i => SortNameOrName(i))
+                .ThenBy(i => i.Name?.Trim()))
             {
                 writer.WriteStartElement("track");
 
-                if (track.IndexNumber.HasValue)
+                if (track.ParentIndexNumber.HasValue && track.ParentIndexNumber.Value != 0)
+                {
+                    writer.WriteElementString("disc", track.ParentIndexNumber.Value.ToString(CultureInfo.InvariantCulture));
+                }
+
+                if (track.IndexNumber.HasValue && track.IndexNumber.Value != 0)
                 {
                     writer.WriteElementString("position", track.IndexNumber.Value.ToString(CultureInfo.InvariantCulture));
                 }
diff --git a/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs
index df72ff0442..b5ba2d24f2 100644
--- a/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs
+++ b/MediaBrowser.XbmcMetadata/Savers/ArtistNfoSaver.cs
@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
+using System.Linq;
 using System.Xml;
 using MediaBrowser.Controller.Configuration;
 using MediaBrowser.Controller.Entities;
@@ -69,7 +70,10 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
         private void AddAlbums(IReadOnlyList<BaseItem> albums, XmlWriter writer)
         {
-            foreach (var album in albums)
+            foreach (var album in albums
+                .OrderBy(album => album.ProductionYear ?? 0)
+                .ThenBy(album => SortNameOrName(album))
+                .ThenBy(album => album.Name?.Trim()))
             {
                 writer.WriteStartElement("album");
 
diff --git a/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs
index 51c5a20803..f14bd437a8 100644
--- a/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs
+++ b/MediaBrowser.XbmcMetadata/Savers/BaseNfoSaver.cs
@@ -488,7 +488,9 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
             var directors = people
                 .Where(i => i.IsType(PersonKind.Director))
-                .Select(i => i.Name)
+                .Select(i => i.Name?.Trim())
+                .Distinct(StringComparer.OrdinalIgnoreCase)
+                .OrderBy(i => i)
                 .ToList();
 
             foreach (var person in directors)
@@ -498,8 +500,9 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
             var writers = people
                 .Where(i => i.IsType(PersonKind.Writer))
-                .Select(i => i.Name)
+                .Select(i => i.Name?.Trim())
                 .Distinct(StringComparer.OrdinalIgnoreCase)
+                .OrderBy(i => i)
                 .ToList();
 
             foreach (var person in writers)
@@ -512,7 +515,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
                 writer.WriteElementString("credits", person);
             }
 
-            foreach (var trailer in item.RemoteTrailers)
+            foreach (var trailer in item.RemoteTrailers.OrderBy(t => t.Url?.Trim()))
             {
                 writer.WriteElementString("trailer", GetOutputTrailerUrl(trailer.Url));
             }
@@ -660,22 +663,22 @@ namespace MediaBrowser.XbmcMetadata.Savers
                 writer.WriteElementString("tagline", item.Tagline);
             }
 
-            foreach (var country in item.ProductionLocations)
+            foreach (var country in item.ProductionLocations.Trimmed().OrderBy(country => country))
             {
                 writer.WriteElementString("country", country);
             }
 
-            foreach (var genre in item.Genres)
+            foreach (var genre in item.Genres.Trimmed().OrderBy(genre => genre))
             {
                 writer.WriteElementString("genre", genre);
             }
 
-            foreach (var studio in item.Studios)
+            foreach (var studio in item.Studios.Trimmed().OrderBy(studio => studio))
             {
                 writer.WriteElementString("studio", studio);
             }
 
-            foreach (var tag in item.Tags)
+            foreach (var tag in item.Tags.Trimmed().OrderBy(tag => tag))
             {
                 if (item is MusicAlbum || item is MusicArtist)
                 {
@@ -752,7 +755,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
             if (item.ProviderIds is not null)
             {
-                foreach (var providerKey in item.ProviderIds.Keys)
+                foreach (var providerKey in item.ProviderIds.Keys.OrderBy(providerKey => providerKey))
                 {
                     var providerId = item.ProviderIds[providerKey];
                     if (!string.IsNullOrEmpty(providerId) && !writtenProviderIds.Contains(providerKey))
@@ -764,7 +767,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
                             XmlConvert.VerifyName(tagName);
                             Logger.LogDebug("Saving custom provider tagname {0}", tagName);
 
-                            writer.WriteElementString(GetTagForProviderKey(providerKey), providerId);
+                            writer.WriteElementString(tagName, providerId);
                         }
                         catch (ArgumentException)
                         {
@@ -785,7 +788,10 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
             AddUserData(item, writer, userManager, userDataRepo, options);
 
-            AddActors(people, writer, libraryManager, options.SaveImagePathsInNfo);
+            if (item is not MusicAlbum && item is not MusicArtist)
+            {
+                AddActors(people, writer, libraryManager, options.SaveImagePathsInNfo);
+            }
 
             if (item is BoxSet folder)
             {
@@ -797,6 +803,8 @@ namespace MediaBrowser.XbmcMetadata.Savers
         {
             var items = item.LinkedChildren
                 .Where(i => i.Type == LinkedChildType.Manual)
+                .OrderBy(i => i.Path?.Trim())
+                .ThenBy(i => i.LibraryItemId?.Trim())
                 .ToList();
 
             foreach (var link in items)
@@ -839,7 +847,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
                 writer.WriteElementString("poster", GetImagePathToSave(image, libraryManager));
             }
 
-            foreach (var backdrop in item.GetImages(ImageType.Backdrop))
+            foreach (var backdrop in item.GetImages(ImageType.Backdrop).OrderBy(b => b.Path?.Trim()))
             {
                 writer.WriteElementString("fanart", GetImagePathToSave(backdrop, libraryManager));
             }
@@ -916,7 +924,9 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
         private void AddActors(IReadOnlyList<PersonInfo> people, XmlWriter writer, ILibraryManager libraryManager, bool saveImagePath)
         {
-            foreach (var person in people)
+            foreach (var person in people
+                .OrderBy(person => person.SortOrder ?? 0)
+                .ThenBy(person => person.Name?.Trim()))
             {
                 if (person.IsType(PersonKind.Director) || person.IsType(PersonKind.Writer))
                 {
@@ -1027,5 +1037,24 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
         private string GetTagForProviderKey(string providerKey)
             => providerKey.ToLowerInvariant() + "id";
+
+        protected static string SortNameOrName(BaseItem item)
+        {
+            if (item == null)
+            {
+                return string.Empty;
+            }
+
+            if (item.SortName != null)
+            {
+                string trimmed = item.SortName.Trim();
+                if (trimmed.Length > 0)
+                {
+                    return trimmed;
+                }
+            }
+
+            return (item.Name ?? string.Empty).Trim();
+        }
     }
 }
diff --git a/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs b/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs
index e85e369d91..a32491c458 100644
--- a/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs
+++ b/MediaBrowser.XbmcMetadata/Savers/MovieNfoSaver.cs
@@ -2,6 +2,7 @@ using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Xml;
+using Jellyfin.Extensions;
 using MediaBrowser.Controller.Configuration;
 using MediaBrowser.Controller.Entities;
 using MediaBrowser.Controller.Entities.Movies;
@@ -100,7 +101,7 @@ namespace MediaBrowser.XbmcMetadata.Savers
 
             if (item is MusicVideo musicVideo)
             {
-                foreach (var artist in musicVideo.Artists)
+                foreach (var artist in musicVideo.Artists.Trimmed().OrderBy(artist => artist))
                 {
                     writer.WriteElementString("artist", artist);
                 }