Provide backup cleanup command

Fixes #469

Author: facelessuser

LICENSE.md

@@ -1,6 +1,6 @@
 MIT license.
 
-Copyright (c) 2013 - 2024 Isaac Muse <[email protected]>
+Copyright (c) 2013 - 2025 Isaac Muse <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

docs/src/markdown/about/changelog.md

@@ -4,6 +4,7 @@
 
 -   **NEW**: Drop Python 3.8 support.
 -   **NEW**: Upgrade dependencies to pick up bug fixes.
+-   **NEW**: Add a command under the main menu to delete backups recursively under the current working directory.
 -   **FIX**: Custom focus is not needed to focus the app from macOS dock anymore.
 -   **FIX**: Fix some issues with context menu right click selection in list controls.
 

docs/src/markdown/preferences.md

@@ -186,6 +186,8 @@ The **Backups** panel allows you to configure where Rummage creates backups. You
 placed in the same folder as the original source, or if they are put into a subfolder. You can also configure the name
 of the subfolder used or the extension used when not writing to a subfolder.
 
+If you need to quickly delete all backups, you can select `File -> Delete Backups` from the main menu.
+
 ## Import/Export Settings
 
 If desired, Rummage's settings can be exported to a JSON file or imported from a JSON file.  This can be particularly

gui.fbp

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <wxFormBuilder_Project>
   <FileVersion major="1" minor="18"/>
-  <object class="Project" expanded="true">
+  <object class="Project" expanded="false">
     <property name="code_generation">Python</property>
     <property name="cpp_class_decoration"></property>
     <property name="cpp_disconnect_events">1</property>
@@ -5103,6 +5103,24 @@
             <property name="name">m_separator41</property>
             <property name="permission">none</property>
           </object>
+          <object class="wxMenuItem" expanded="false">
+            <property name="bitmap"></property>
+            <property name="checked">0</property>
+            <property name="enabled">1</property>
+            <property name="help"></property>
+            <property name="id">wxID_ANY</property>
+            <property name="kind">wxITEM_NORMAL</property>
+            <property name="label">Delete Backups</property>
+            <property name="name">m_delete_backups_menuitem</property>
+            <property name="permission">none</property>
+            <property name="shortcut"></property>
+            <property name="unchecked_bitmap"></property>
+            <event name="OnMenuSelection">on_delete_backups</event>
+          </object>
+          <object class="separator" expanded="false">
+            <property name="name">m_separator5</property>
+            <property name="permission">none</property>
+          </object>
           <object class="wxMenuItem" expanded="false">
             <property name="bitmap"></property>
             <property name="checked">0</property>

mkdocs.yml

@@ -4,7 +4,7 @@ repo_url: https://github.com/facelessuser/Rummage
 edit_uri: tree/master/docs/src/markdown
 site_description: A search and replace tool written in Python.
 copyright: |
-  Copyright &copy; 2013 - 2024 <a href="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/facelessuser" target="_blank" rel="noopener">Isaac Muse</a>
+  Copyright &copy; 2013 - 2025 <a href="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/facelessuser" target="_blank" rel="noopener">Isaac Muse</a>
 
 docs_dir: docs/src/markdown
 theme:

rummage/lib/gui/data/docs/.dochash

@@ -1 +1 @@
-373dd3370b7e5a84494d1b170b10d294
+27006063770f8c91bfb5fdc28ad86a1a

rummage/lib/gui/data/docs/about/changelog.html

@@ -29,6 +29,7 @@ <h2 id="422">4.22</h2>
 <ul>
 <li><strong>NEW</strong>: Drop Python 3.8 support.</li>
 <li><strong>NEW</strong>: Upgrade dependencies to pick up bug fixes.</li>
+<li><strong>NEW</strong>: Add a command under the main menu to delete backups recursively under the current working directory.</li>
 <li><strong>FIX</strong>: Custom focus is not needed to focus the app from macOS dock anymore.</li>
 <li><strong>FIX</strong>: Fix some issues with context menu right click selection in list controls.</li>
 </ul>

rummage/lib/gui/data/docs/preferences.html

@@ -252,6 +252,7 @@ <h2 id="backups">Backups</h2>
 <p>The <strong>Backups</strong> panel allows you to configure where Rummage creates backups. You can control whether backups are all
 placed in the same folder as the original source, or if they are put into a subfolder. You can also configure the name
 of the subfolder used or the extension used when not writing to a subfolder.</p>
+<p>If you need to quickly delete all backups, you can select <code>File -&gt; Delete Backups</code> from the main menu.</p>
 <h2 id="importexport-settings">Import/Export Settings</h2>
 <p>If desired, Rummage's settings can be exported to a <abbr title="JavaScript Object Notation">JSON</abbr> file or imported from a <abbr title="JavaScript Object Notation">JSON</abbr> file.  This can be particularly
 useful for importing regular expression patterns from one system into another system's existing regular expression list.

rummage/lib/gui/dialogs/delete_dialog.py

@@ -21,6 +21,7 @@
 import wx
 import os
 import time
+import shutil
 import threading
 from ..localization import _
 from .. import gui
@@ -68,7 +69,10 @@ def retry(self):
                             if self.recycle:
                                 send2trash(self.trouble_file)
                             else:
-                                os.remove(self.trouble_file)
+                                if os.path.isdir(self.trouble_file):
+                                    shutil.rmtree(self.trouble_file)
+                                else:
+                                    os.remove(self.trouble_file)
                         deleted = True
                         self.trouble_file = None
                     except Exception:
@@ -88,7 +92,10 @@ def run(self):
                     if self.recycle:
                         send2trash(f)
                     else:
-                        os.remove(f)
+                        if os.path.isdir(f):
+                            shutil.rmtree(f)
+                        else:
+                            os.remove(f)
                 self.count += 1
             except Exception:
                 self.trouble_file = f
@@ -115,7 +122,7 @@ def __init__(self, parent, file_list, recycle):
         self.file = None
         self.busy = False
         self.thread = None
-        self.total = len(file_list)
+        self.total = len(file_list) if isinstance(file_list, list) else 0
         self.message = None
         self.processing = False
         self.handling = False
@@ -128,15 +135,18 @@ def __init__(self, parent, file_list, recycle):
         title = None
         if self.action == ACTION_DELETE:
             title = _("Deleting Files")
-            self.message = _("Deleting %d/%d...")
+            self.message = _("Deleting %d/%d...") if self.total else _("Deleting %d...")
         elif self.action == ACTION_RECYCLE:
             title = _("Recycling Files")
-            self.message = _("Recycling %d/%d...")
+            self.message = _("Recycling %d/%d...") if self.total else _("Recycling %d...")
 
         self.localize()
         self.refresh_localization(title)
         if self.message:
-            self.m_progress_label.SetLabel(self.message % (0, self.total))
+            if self.total:
+                self.m_progress_label.SetLabel(self.message % (0, self.total))
+            else:
+                self.m_progress_label.SetLabel(self.message % 0)
 
         # Ensure good sizing of frame
         self.m_progress.SetValue(0)
@@ -201,7 +211,10 @@ def on_idle(self, event):
             ratio = (float(count) / float(self.total)) if self.total else 0
             percent = int(ratio * 100)
             self.m_progress.SetValue(percent)
-            self.m_progress_label.SetLabel(self.message % (count, self.total))
+            if self.total:
+                self.m_progress_label.SetLabel(self.message % (count, self.total))
+            else:
+                self.m_progress_label.SetLabel(self.message % count)
 
             if self.thread.request is True:
                 self.thread.request = False
@@ -226,7 +239,10 @@ def on_idle(self, event):
             if not self.thread.is_alive():
                 self.processing = False
                 self.m_progress.SetValue(100)
-                self.m_progress_label.SetLabel(self.message % (self.thread.count, self.total))
+                if self.total:
+                    self.m_progress_label.SetLabel(self.message % (self.thread.count, self.total))
+                else:
+                    self.m_progress_label.SetLabel(self.message % self.thread.count)
 
                 if not self.thread.abort:
                     if self.thread.errors:

rummage/lib/gui/dialogs/rummage_dialog.py

@@ -36,6 +36,7 @@
 from ..actions import export_csv
 from ..actions import fileops
 from ..actions import updates
+from wcmatch import glob
 try:
     from ..gui import GUI_PATCHED  # noqa: F401
 except ImportError as e:
@@ -599,6 +600,7 @@ def localize(self):
         self.MENU_EXPORT_RESULTS = _("Export Results")
         self.MENU_EXPORT_SETTINGS = _("Export Settings")
         self.MENU_IMPORT_SETTINGS = _("Import Settings")
+        self.MENU_DELETE_BACKUPS = _("Delete Backups")
         self.MENU_FILE = _("File")
         self.MENU_VIEW = _("View")
         self.MENU_HELP = _("Help")
@@ -686,6 +688,7 @@ def refresh_localization(self):
         self.m_export_csv_menuitem.SetItemLabel(self.MENU_CSV)
         self.m_export_settings_menuitem.SetItemLabel(self.MENU_EXPORT_SETTINGS)
         self.m_import_settings_menuitem.SetItemLabel(self.MENU_IMPORT_SETTINGS)
+        self.m_delete_backups_menuitem.SetItemLabel(self.MENU_DELETE_BACKUPS)
         self.m_log_menuitem.SetItemLabel(self.MENU_OPEN_LOG)
         self.m_about_menuitem.SetItemLabel(self.MENU_ABOUT)
         self.m_update_menuitem.SetItemLabel(self.MENU_UPDATE)
@@ -2337,6 +2340,27 @@ def on_export_settings(self, event):
         exporter.ShowModal()
         exporter.Destroy()
 
+    def on_delete_backups(self, event):
+        """Delete Backups."""
+
+        from ..dialogs.delete_dialog import DeleteDialog
+
+        if not yesno(_("Are you sure you wish to delete all backup files/folders?")):
+            return
+
+        target = self.m_searchin_text.GetValue()
+        backup_folder = bool(Settings.get_backup_type())
+        backup_location = Settings.get_backup_folder() if backup_folder else Settings.get_backup_ext()
+        if backup_folder:
+            pattern = f'**/{backup_location}/'
+            flags = glob.G
+        else:
+            pattern = f'**/*.{backup_location}'
+            flags = glob.G | glob.O
+        dlg = DeleteDialog(self, glob.iglob(pattern, flags=flags, root_dir=target), False)
+        dlg.ShowModal()
+        dlg.Destroy()
+
     def on_import_settings(self, event):
         """Import settings."""