Write playlist details to the output file

Configuration/ApplicationSettings.cs

@@ -10,6 +10,8 @@ public sealed class ApplicationSettings
 
         public bool AreTvGuideTagsEnabled { get; set; }
 
+        public bool ArePlaylistDetailsTagsEnabled { get; set; }
+
         public string UserAgent { get; set; }
     }
 }

README.md

@@ -91,6 +91,7 @@ The settings are stored in the `appsettings.json` file in the root directory.
  - *daysToCheck*: How far in the past to go for each playlist. If today's playlist is not found (sometimes the providers skip some days) then the service will move on to the previous day, again and again until one is found or the daysToCheck limit is reached.
  - *canIncludeUnmatchedChannels*: Boolean value indicating whether provider channels that were not able to be matched with the data in the channelStorePath file should be included in the output file (in the Unknown category) or not at all
  - *areTvGuideTagsEnabled*: Boolean value indicating whether TV Guide tags (logo URLs, groups, TVG IDs, channel numbers, etc) should be included in the output file or not
+ - *arePlaylistDetailsTagsEnabled*: Boolean value indicating whether playlist details (playlist ID, the playlist's original channel name) should be included in the output file or not
  - *userAgent*: String value indicating the UserAgent that should be used when performing HTTP operations
 
 ### Channel data

Service/Models/Channel.cs

@@ -14,6 +14,10 @@ public sealed class Channel
 
         public int Number { get; set; }
 
+        public string PlaylistId { get; set; }
+
+        public string PlaylistChannelName { get; set; }
+
         public string Url { get; set; }
     }
 }

Service/PlaylistAggregator.cs

@@ -171,6 +171,8 @@ IEnumerable<Channel> GetEnabledChannels(IEnumerable<Channel> filteredProviderCha
                 channel.Country = channelDef.Country;
                 channel.Group = groups[channelDef.GroupId].Name;
                 channel.LogoUrl = channelDef.LogoUrl;
+                channel.PlaylistId = matchedChannel.PlaylistId;
+                channel.PlaylistChannelName = matchedChannel.PlaylistChannelName;
                 channel.Url = matchedChannel.Url;
 
                 channels.Add(channel);

Service/PlaylistFetcher.cs

@@ -89,9 +89,11 @@ public async Task<Playlist> FetchProviderPlaylistAsync(PlaylistProvider provider
                 return null;
             }
 
-            if (!string.IsNullOrWhiteSpace(provider.ChannelNameOverride))
+            foreach (Channel channel in playlist.Channels)
             {
-                foreach (Channel channel in playlist.Channels)
+                channel.PlaylistId = provider.Id;
+
+                if (!string.IsNullOrWhiteSpace(provider.ChannelNameOverride))
                 {
                     channel.Name = provider.ChannelNameOverride;
                 }

Service/PlaylistFileBuilder.cs

@@ -20,6 +20,8 @@ public sealed class PlaylistFileBuilder : IPlaylistFileBuilder
         const string TvGuideLogoTagKey = "tvg-logo";
         const string TvGuideCountryTagKey = "tvg-country";
         const string TvGuideGroupTagKey = "group-title";
+        const string PlaylistIdTagKey = "playlist-id";
+        const string PlaylistChannelNameTagKey = "playlist-channel-name";
         const int DefaultEntryRuntime = -1;
 
         readonly ICacheManager cache;
@@ -48,6 +50,11 @@ public string BuildFile(Playlist playlist)
                     file += BuildTvGuideHeaderTags(channel);
                 }
 
+                if (settings.ArePlaylistDetailsTagsEnabled)
+                {
+                    file += BuildPlaylistDetailsHeaderTags(channel);
+                }
+
                 file +=
                     $"{EntryValuesSeparator}{channel.Name}{Environment.NewLine}" +
                     $"{channel.Url}{Environment.NewLine}";
@@ -102,6 +109,7 @@ public Playlist ParseFile(string content)
 
                     Channel channel = new Channel();
                     channel.Name = lineSplit[lineSplit.Length - 1];
+                    channel.PlaylistChannelName = channel.Name;
 
                     playlist.Channels.Add(channel);
                 }
@@ -151,5 +159,12 @@ string BuildTvGuideHeaderTags(Channel channel)
 
             return tvgTags;
         }
+
+        string BuildPlaylistDetailsHeaderTags(Channel channel)
+        {
+            return
+                $" {PlaylistIdTagKey}=\"{channel.PlaylistId}\"" +
+                $" {PlaylistChannelNameTagKey}=\"{channel.PlaylistChannelName}\"";
+        }
     }
 }

appsettings.json

@@ -9,6 +9,7 @@
         "daysToCheck": "7",
         "canIncludeUnmatchedChannels": "true",
         "areTvGuideTagsEnabled": "true",
+        "arePlaylistDetailsTagsEnabled": "true",
         "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36"
     },
     "cacheSettings": {