Allow customizing file collision handling in the the settings (#1199)

* Create setting for configuring default file collision behavior * Use setting to determine default collision behavior * Add translations * Wording
lay295 · Aug 28, 2024 · 4bcb917 · 4bcb917
1 parent 0762fe6
commit 4bcb917
Show file tree

Hide file tree

Showing 19 changed files with 352 additions and 21 deletions.
diff --git a/TwitchDownloaderWPF/App.config b/TwitchDownloaderWPF/App.config
@@ -244,6 +244,9 @@
             <setting name="PreferredQuality" serializeAs="String">
                 <value />
             </setting>
+            <setting name="FileCollisionBehavior" serializeAs="String">
+                <value>0</value>
+            </setting>
         </TwitchDownloaderWPF.Properties.Settings>
     </userSettings>
 </configuration>
diff --git a/TwitchDownloaderWPF/Models/CollisionBehavior.cs b/TwitchDownloaderWPF/Models/CollisionBehavior.cs
@@ -0,0 +1,10 @@
+namespace TwitchDownloaderWPF.Models
+{
+    internal enum CollisionBehavior
+    {
+        Prompt,
+        Overwrite,
+        Rename,
+        Cancel
+    }
+}
diff --git a/TwitchDownloaderWPF/Properties/Settings.Designer.cs b/TwitchDownloaderWPF/Properties/Settings.Designer.cs
diff --git a/TwitchDownloaderWPF/Properties/Settings.settings b/TwitchDownloaderWPF/Properties/Settings.settings
@@ -239,6 +239,9 @@
     <Setting Name="PreferredQuality" Type="System.String" Scope="User">
       <Value Profile="(Default)" />
     </Setting>
+    <Setting Name="FileCollisionBehavior" Type="System.Int32" Scope="User">
+      <Value Profile="(Default)">0</Value>
+    </Setting>
   </Settings>
 </SettingsFile>
 
diff --git a/TwitchDownloaderWPF/Services/FileCollisionService.cs b/TwitchDownloaderWPF/Services/FileCollisionService.cs
@@ -4,40 +4,36 @@
 using System.Windows;
 using Ookii.Dialogs.Wpf;
 using TwitchDownloaderCore.Tools;
+using TwitchDownloaderWPF.Models;
+using TwitchDownloaderWPF.Properties;
 
 namespace TwitchDownloaderWPF.Services
 {
     public static class FileCollisionService
     {
-        private enum CollisionCommand
-        {
-            Prompt,
-            Overwrite,
-            Rename,
-            Cancel
-        }
-
-        private static CollisionCommand _collisionCommand = CollisionCommand.Prompt;
+        private static CollisionBehavior? _sessionCollisionBehavior;
 
         [return: MaybeNull]
         public static FileInfo HandleCollisionCallback(FileInfo fileInfo, Window owner)
         {
-            if (_collisionCommand is not CollisionCommand.Prompt)
+            var collisionBehavior = _sessionCollisionBehavior ?? (CollisionBehavior)Settings.Default.FileCollisionBehavior;
+
+            if (collisionBehavior is not CollisionBehavior.Prompt)
             {
-                return GetResult(fileInfo, _collisionCommand);
+                return GetResult(fileInfo, collisionBehavior);
             }
 
             var result = ShowDialog(fileInfo, owner, out var rememberChoice);
 
             if (rememberChoice)
             {
-                _collisionCommand = result;
+                _sessionCollisionBehavior = result;
             }
 
             return GetResult(fileInfo, result);
         }
 
-        private static CollisionCommand ShowDialog(FileInfo fileInfo, Window owner, out bool rememberChoice)
+        private static CollisionBehavior ShowDialog(FileInfo fileInfo, Window owner, out bool rememberChoice)
         {
             using var dialog = new TaskDialog();
             dialog.WindowTitle = Translations.Strings.TitleFileAlreadyExists;
@@ -70,26 +66,26 @@ private static CollisionCommand ShowDialog(FileInfo fileInfo, Window owner, out
             rememberChoice = dialog.IsVerificationChecked;
 
             if (buttonResult == overwriteButton)
-                return CollisionCommand.Overwrite;
+                return CollisionBehavior.Overwrite;
 
             if (buttonResult == renameButton)
-                return CollisionCommand.Rename;
+                return CollisionBehavior.Rename;
 
             if (buttonResult == cancelButton)
-                return CollisionCommand.Cancel;
+                return CollisionBehavior.Cancel;
 
             // This should never happen
             throw new ArgumentOutOfRangeException();
         }
 
         [return: MaybeNull]
-        private static FileInfo GetResult(FileInfo fileInfo, CollisionCommand command)
+        private static FileInfo GetResult(FileInfo fileInfo, CollisionBehavior command)
         {
             return command switch
             {
-                CollisionCommand.Overwrite => fileInfo,
-                CollisionCommand.Rename => FilenameService.GetNonCollidingName(fileInfo),
-                CollisionCommand.Cancel => null,
+                CollisionBehavior.Overwrite => fileInfo,
+                CollisionBehavior.Rename => FilenameService.GetNonCollidingName(fileInfo),
+                CollisionBehavior.Cancel => null,
                 _ => throw new ArgumentOutOfRangeException(nameof(command), command, null)
             };
         }

diff --git a/TwitchDownloaderWPF/Translations/Strings.Designer.cs b/TwitchDownloaderWPF/Translations/Strings.Designer.cs
diff --git a/TwitchDownloaderWPF/Translations/Strings.es.resx b/TwitchDownloaderWPF/Translations/Strings.es.resx
@@ -983,4 +983,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.fr.resx b/TwitchDownloaderWPF/Translations/Strings.fr.resx
@@ -982,4 +982,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.it.resx b/TwitchDownloaderWPF/Translations/Strings.it.resx
@@ -983,4 +983,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.ja.resx b/TwitchDownloaderWPF/Translations/Strings.ja.resx
@@ -981,4 +981,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.pl.resx b/TwitchDownloaderWPF/Translations/Strings.pl.resx
@@ -982,4 +982,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.pt-br.resx b/TwitchDownloaderWPF/Translations/Strings.pt-br.resx
@@ -985,4 +985,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.resx b/TwitchDownloaderWPF/Translations/Strings.resx
@@ -981,4 +981,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.ru.resx b/TwitchDownloaderWPF/Translations/Strings.ru.resx
@@ -982,4 +982,22 @@
   <data name="FilenameParameterGameTooltip" xml:space="preserve">
     <value>The display name of the primary game/category in the video/clip/chat.</value>
   </data>
+  <data name="FileCollisionBehavior" xml:space="preserve">
+    <value>File Collision Behavior</value>
+  </data>
+  <data name="FileCollisionBehaviorTooltip" xml:space="preserve">
+    <value>The default handling for file collisions in the task queue. If a choice has already been remembered for the current session, an application restart will be required to override it.</value>
+  </data>
+  <data name="FileCollisionBehaviorAsk" xml:space="preserve">
+    <value>Ask</value>
+  </data>
+  <data name="FileCollisionBehaviorOverwrite" xml:space="preserve">
+    <value>Overwrite</value>
+  </data>
+  <data name="FileCollisionBehaviorRename" xml:space="preserve">
+    <value>Rename</value>
+  </data>
+  <data name="FileCollisionBehaviorCancel" xml:space="preserve">
+    <value>Cancel</value>
+  </data>
 </root>