Allowed for settings to contain number of retries. Because this is sh…

…ould be a rarely used option, the only way to modify it is to edit the json settings file and restart the application. No GUI elements are added or changed.
Otiel · Dec 20, 2016 · 25bb3e9 · 25bb3e9
1 parent bd47fa4
commit 25bb3e9
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/Sources/BandcampDownloader/Miscellaneous/Constants.cs b/Sources/BandcampDownloader/Miscellaneous/Constants.cs
@@ -4,11 +4,7 @@
 
 namespace BandcampDownloader {
 
-    internal static class Constants {
-        /// <summary>
-        /// The maximum tries that can be done when downloading a file.
-        /// </summary>
-        public static readonly int DownloadMaxTries = 10;
+    internal static class Constants {      
         /// <summary>
         /// The website URL of BandcampDownloader.
         /// </summary>

diff --git a/Sources/BandcampDownloader/Miscellaneous/UserSettings.cs b/Sources/BandcampDownloader/Miscellaneous/UserSettings.cs
@@ -15,6 +15,9 @@ internal class UserSettings {
         public Boolean SaveCoverArtInTags { get; set; }
         public Boolean ShowVerboseLog { get; set; }
         public Boolean TagTracks { get; set; }
+        // Annotation required to allow serialization of static field
+        [JsonProperty]
+        public static int DownloadMaxTries { get; set; }
 
         /// <summary>
         ///  Creates a new UserSettings with default values.
@@ -52,6 +55,7 @@ internal class UserSettings {
             SaveCoverArtInTags = true;
             ShowVerboseLog = false;
             TagTracks = true;
+            DownloadMaxTries = 10;
         }
 
         /// <summary>

diff --git a/Sources/BandcampDownloader/Windows/MainWindow.xaml.cs b/Sources/BandcampDownloader/Windows/MainWindow.xaml.cs
@@ -180,10 +180,10 @@ public partial class MainWindow: Window {
 
                             Log($"Downloaded track \"{track.GetFileName(album.Artist)}\" from album \"{album.Title}\"", LogType.IntermediateSuccess);
                         } else if (!e.Cancelled && e.Error != null) {
-                            if (tries < Constants.DownloadMaxTries) {
-                                Log($"Unable to download track \"{track.GetFileName(album.Artist)}\" from album \"{album.Title}\". Try {tries} of {Constants.DownloadMaxTries}", LogType.Warning);
+                            if (tries < UserSettings.DownloadMaxTries) {
+                                Log($"Unable to download track \"{track.GetFileName(album.Artist)}\" from album \"{album.Title}\". Try {tries} of {UserSettings.DownloadMaxTries}", LogType.Warning);
                             } else {
-                                Log($"Unable to download track \"{track.GetFileName(album.Artist)}\" from album \"{album.Title}\". Hit max retries of {Constants.DownloadMaxTries}", LogType.Error);
+                                Log($"Unable to download track \"{track.GetFileName(album.Artist)}\" from album \"{album.Title}\". Hit max retries of {UserSettings.DownloadMaxTries}", LogType.Error);
                             }
                         } // Else the download has been cancelled (by the user)
 
@@ -207,7 +207,7 @@ public partial class MainWindow: Window {
                         this.pendingDownloads.Remove(webClient);
                     }
                 }
-            } while (!trackDownloaded && tries < Constants.DownloadMaxTries);
+            } while (!trackDownloaded && tries < UserSettings.DownloadMaxTries);
 
             return trackDownloaded;
         }
@@ -271,10 +271,10 @@ public partial class MainWindow: Window {
 
                             Log($"Downloaded artwork for album \"{album.Title}\"", LogType.IntermediateSuccess);
                         } else if (!e.Cancelled && e.Error != null) {
-                            if (tries < Constants.DownloadMaxTries) {
-                                Log($"Unable to download artwork for album \"{album.Title}\". Try {tries} of {Constants.DownloadMaxTries}", LogType.Warning);
+                            if (tries < UserSettings.DownloadMaxTries) {
+                                Log($"Unable to download artwork for album \"{album.Title}\". Try {tries} of {UserSettings.DownloadMaxTries}", LogType.Warning);
                             } else {
-                                Log($"Unable to download artwork for album \"{album.Title}\". Hit max retries of {Constants.DownloadMaxTries}", LogType.Error);
+                                Log($"Unable to download artwork for album \"{album.Title}\". Hit max retries of {UserSettings.DownloadMaxTries}", LogType.Error);
                             }
                         } // Else the download has been cancelled (by the user)
 
@@ -298,7 +298,7 @@ public partial class MainWindow: Window {
                         this.pendingDownloads.Remove(webClient);
                     }
                 }
-            } while (!artworkDownloaded && tries < Constants.DownloadMaxTries);
+            } while (!artworkDownloaded && tries < UserSettings.DownloadMaxTries);
 
             return artwork;
         }
@@ -408,13 +408,13 @@ public partial class MainWindow: Window {
                             Log($"Retrieved the size of the cover art file for album \"{album.Title}\"", LogType.VerboseInfo);
                         } catch {
                             sizeRetrieved = false;
-                            if (tries < Constants.DownloadMaxTries) {
-                                Log($"Failed to retrieve the size of the cover art file for album \"{album.Title}\". Try {tries} of {Constants.DownloadMaxTries}", LogType.Warning);
+                            if (tries < UserSettings.DownloadMaxTries) {
+                                Log($"Failed to retrieve the size of the cover art file for album \"{album.Title}\". Try {tries} of {UserSettings.DownloadMaxTries}", LogType.Warning);
                             } else {
-                                Log($"Failed to retrieve the size of the cover art file for album \"{album.Title}\". Hit max retries of {Constants.DownloadMaxTries}. Progress update may be wrong.", LogType.Error);
+                                Log($"Failed to retrieve the size of the cover art file for album \"{album.Title}\". Hit max retries of {UserSettings.DownloadMaxTries}. Progress update may be wrong.", LogType.Error);
                             }
                         }
-                    } while (!sizeRetrieved && tries < Constants.DownloadMaxTries);
+                    } while (!sizeRetrieved && tries < UserSettings.DownloadMaxTries);
 
                     files.Add(new TrackFile(album.ArtworkUrl, 0, size));
                 }
@@ -441,13 +441,13 @@ public partial class MainWindow: Window {
                             Log($"Retrieved the size of the MP3 file for the track \"{track.Title}\"", LogType.VerboseInfo);
                         } catch {
                             sizeRetrieved = false;
-                            if (tries < Constants.DownloadMaxTries) {
-                                Log($"Failed to retrieve the size of the MP3 file for the track \"{track.Title}\". Try {tries} of {Constants.DownloadMaxTries}", LogType.Warning);
+                            if (tries < UserSettings.DownloadMaxTries) {
+                                Log($"Failed to retrieve the size of the MP3 file for the track \"{track.Title}\". Try {tries} of {UserSettings.DownloadMaxTries}", LogType.Warning);
                             } else {
-                                Log($"Failed to retrieve the size of the MP3 file for the track \"{track.Title}\". Hit max retries of {Constants.DownloadMaxTries}. Progress update may be wrong.", LogType.Error);
+                                Log($"Failed to retrieve the size of the MP3 file for the track \"{track.Title}\". Hit max retries of {UserSettings.DownloadMaxTries}. Progress update may be wrong.", LogType.Error);
                             }
                         }
-                    } while (!sizeRetrieved && tries < Constants.DownloadMaxTries);
+                    } while (!sizeRetrieved && tries < UserSettings.DownloadMaxTries);
 
                     files.Add(new TrackFile(track.Mp3Url, 0, size));
                 }