Issue #64: Added support to export custom lists from trakt.tv

Export.cs

@@ -536,6 +536,108 @@ public static void CreatePausedMoviesCsv()
             }
         }
 
+        public static void CreateCustomListsCsv()
+        {
+            if (Cancel) return;
+
+            // First get the users custom lists
+
+            UIUtils.UpdateStatus("Getting custom lists from trakt.tv");
+            var customLists = TraktAPI.TraktAPI.GetCustomLists();
+            if (customLists != null)
+            {
+                var lists = new List<object>();
+                foreach (var item in customLists)
+                {
+                    lists.Add(new
+                    {
+                        TraktId = item.Ids.Trakt,
+                        Slug = item.Ids.Slug,
+                        Name = item.Name,
+                        Description = item.Description,
+                        Privacy = item.Privacy,
+                        DisplayNumbers = item.DisplayNumbers,
+                        AllowComments = item.AllowComments,
+                        SortBy = item.SortBy,
+                        SortHow = item.SortHow,
+                        ItemCount = item.ItemCount,
+                        CommentCount = item.Comments,
+                        Likes = item.Likes,
+                        CreatedAt = item.CreatedAt,
+                        UpdatedAt = item.UpdatedAt
+                    });
+                }
+
+                UIUtils.UpdateStatus("Creating custom lists csv file");
+                WriteToCsv(Path.Combine(AppSettings.CsvExportPath, "custom_lists.csv"), lists);
+            }
+            else
+            {
+                UIUtils.UpdateStatus("Failed to get current custom lists from trakt.tv", true);
+                Thread.Sleep(2000);
+                return;
+            }
+
+            // Next get the items for each custom list
+
+            foreach(var list in customLists)
+            {
+                UIUtils.UpdateStatus($"Getting custom list items for '{list.Name}' from trakt.tv");
+                var customListItems = TraktAPI.TraktAPI.GetCustomListItems(list.Ids.Trakt.ToString());
+                if (customListItems != null)
+                {
+                    var listItems = new List<object>();
+                    foreach (var item in customListItems)
+                    {
+                        // important to check for null as an item may be of a different type
+                        // NB: the season object does not return for episodes, so get season number from episode object
+                        listItems.Add(new
+                        {
+                            Rank = item.Rank,
+                            Id = item.Id,
+                            Type = item.Type,
+                            ListedAt = item.ListedAt,
+                            MovieTitle = item.Movie?.Title,
+                            MovieYear = item.Movie?.Year,
+                            MovieTraktId = item.Movie?.Ids.Trakt,
+                            MovieImdbId = item.Movie?.Ids.ImdbId,
+                            MovieTmdbId = item.Movie?.Ids.TmdbId,
+                            MovieSlug = item.Movie?.Ids.Slug,
+                            ShowTitle = item.Show?.Title,
+                            ShowYear = item.Show?.Year,
+                            ShowTraktId = item.Show?.Ids.Trakt,
+                            ShowTvdbId = item.Show?.Ids.TvdbId,
+                            ShowTmdbId = item.Show?.Ids.TmdbId,
+                            ShowSlug = item.Show?.Ids.Slug,
+                            SeasonTvdbId = item.Season?.Ids.TvdbId,
+                            SeasonTmdbId = item.Season?.Ids.TmdbId,
+                            SeasonNumber = item.Season?.Number.ToString() ?? item.Episode?.Season.ToString(),
+                            EpisodeNumber = item.Episode?.Number,
+                            EpisodeTraktId = item.Episode?.Ids.Trakt,
+                            EpisodeTvdbId = item.Episode?.Ids.TvdbId,
+                            EpisodeTmdbId = item.Episode?.Ids.TmdbId,
+                            EpisodeImdbId = item.Episode?.Ids.ImdbId,
+                            PersonName = item.Person?.Name,
+                            PersonTraktId = item.Person?.Ids.Trakt,
+                            PersonImdbId = item.Person?.Ids.ImdbId,
+                            PersonTmdbId = item.Person?.Ids.TmdbId,
+                            PersonSlug = item.Person?.Ids.Slug
+                        });                        
+                    }
+
+                    UIUtils.UpdateStatus($"Creating custom list '{list.Name}' csv file");
+                    // using the slug for the filename should be file system friendly
+                    WriteToCsv(Path.Combine(AppSettings.CsvExportPath, $"custom_list_{list.Ids.Slug}.csv"), listItems);
+                }
+                else
+                {
+                    UIUtils.UpdateStatus($"Failed to get current custom list items for '{list.Name}' from trakt.tv", true);
+                    Thread.Sleep(2000);
+                }
+
+            }
+        }
+
         private static void WriteToCsv(string filename, List<object> records)
         {
             string directory = Path.GetDirectoryName(filename);

Settings/ExportItems.cs

@@ -16,5 +16,6 @@ public class ExportItems
         public bool WatchlistMovies { get; set; }
         public bool PausedEpisodes { get; set; }
         public bool PausedMovies { get; set; }
+        public bool CustomLists { get; set; }
     }
 }

TraktAPI/DataStructures/TraktList.cs

@@ -19,5 +19,11 @@ public class TraktList
 
         [DataMember(Name = "allow_comments")]
         public bool AllowComments { get; set; }
+
+        [DataMember(Name = "sort_by")]
+        public string SortBy { get; set; }
+
+        [DataMember(Name = "sort_how")]
+        public string SortHow { get; set; }
     }
 }

TraktAPI/DataStructures/TraktListDetail.cs

@@ -5,6 +5,9 @@
     [DataContract]
     public class TraktListDetail : TraktList
     {
+        [DataMember(Name = "created_at")]
+        public string CreatedAt { get; set; }
+
         [DataMember(Name = "updated_at")]
         public string UpdatedAt { get; set; }
 

TraktAPI/DataStructures/TraktListItem.cs

@@ -5,6 +5,12 @@
     [DataContract]
     public class TraktListItem
     {
+        [DataMember(Name = "rank")]
+        public int Rank { get; set; }
+
+        [DataMember(Name = "id")]
+        public int Id { get; set; }
+
         [DataMember(Name = "listed_at")]
         public string ListedAt { get; set; }
 
@@ -18,10 +24,10 @@ public class TraktListItem
         public TraktShow Show { get; set; }
 
         [DataMember(Name = "season")]
-        public TraktSeason Season { get; set; }
+        public TraktSeasonEx Season { get; set; }
 
         [DataMember(Name = "episode")]
-        public TraktEpisode Episode { get; set; }
+        public TraktEpisodeSummary Episode { get; set; }
 
         [DataMember(Name = "person")]
         public TraktPerson Person { get; set; }

TraktAPI/DataStructures/TraktSeasonEx.cs

@@ -0,0 +1,11 @@
+using System.Runtime.Serialization;
+
+namespace TraktRater.TraktAPI.DataStructures
+{    
+    [DataContract]
+    public class TraktSeasonEx : TraktSeason
+    {
+        [DataMember(Name = "ids")]
+        public TraktSeasonId Ids { get; set; }
+    }
+}

TraktRater.cs

@@ -846,6 +846,10 @@ private void StartExport(ExportItems items)
                 {
                     Export.CreatePausedMoviesCsv();
                 }
+                if (AppSettings.CsvExportItems.CustomLists)
+                {
+                    Export.CreateCustomListsCsv();
+                }
 
                 // finished
                 SetControlState(true);

TraktRater.csproj

@@ -146,6 +146,7 @@
     <Compile Include="TraktAPI\DataStructures\TraktPerson.cs" />
     <Compile Include="TraktAPI\DataStructures\TraktPersonId.cs" />
     <Compile Include="TraktAPI\DataStructures\TraktSeason.cs" />
+    <Compile Include="TraktAPI\DataStructures\TraktSeasonEx.cs" />
     <Compile Include="TraktAPI\DataStructures\TraktSeasonId.cs" />
     <Compile Include="TraktAPI\DataStructures\TraktSeasonSync.cs" />
     <Compile Include="TraktAPI\DataStructures\TraktSeasonWatchlist.cs" />

UI/ExportDialog.cs

@@ -34,6 +34,7 @@ public ExportDialog(string path, ExportItems items)
             chkEpisodeCollection.Checked = ItemsToExport.CollectedEpisodes;
             chkMovieWatchedHistory.Checked = ItemsToExport.WatchedHistoryMovies;
             chkEpisodeWatchedHistory.Checked = ItemsToExport.WatchedHistoryEpisodes;
+            chkCustomLists.Checked = ItemsToExport.CustomLists;
 
             txtExportPath.Text = ExportPath;
             #endregion
@@ -133,6 +134,12 @@ private void chkMoviePausedStates_Click(object sender, EventArgs e)
         {
             ItemsToExport.PausedMovies = chkMoviePausedStates.Checked;
         }
+
+        private void chkCustomLists_Click(object sender, EventArgs e)
+        {
+            ItemsToExport.CustomLists = chkCustomLists.Checked;
+        }
         #endregion
+
     }
 }