Fix MediaRestore path corruption for files containing "media" in their paths (#601)

This PR fixes a critical bug in the `mediarestore` command where files containing "media" in their path were being corrupted during restoration. The fix removes an unnecessary string replacement operation that was incorrectly modifying file paths.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Archmonger <16909269+Archmonger@users.noreply.github.com>
Co-authored-by: Mark Bakhit <archiethemonger@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

.github/copilot-instructions.md

@@ -90,11 +90,14 @@ Modern development process using Hatch:
 6. **Auto-format code**: `hatch run lint:format` (2 seconds)
 7. **Test documentation**: `hatch run docs:build` (2 seconds)
 8. **Update documentation** when making changes to Python source code (required)
+9. **Add changelog entry** for all significant changes (bug fixes, new features, breaking changes) to `CHANGELOG.md` under the "Unreleased" section
 
 Always run `hatch run lint:check` before committing. The CI (.github/workflows/build.yml) includes comprehensive checks across all supported Python/Django combinations.
 
 **IMPORTANT**: Documentation must be updated whenever changes are made to Python source code. This is enforced as part of the development workflow.
 
+**IMPORTANT**: Significant changes must always include a changelog entry in `CHANGELOG.md` under the appropriate category (Added, Changed, Deprecated, Removed, Fixed, Security) in the "Unreleased" section.
+
 ## Repository Structure and Navigation
 
 Key directories and files:

CHANGELOG.md

@@ -34,6 +34,7 @@ Don't forget to remove deprecated code on each major release!
 - Fix issues with parsing excess whitespace within `dbbackup -d "<COMMA_SEPARATED_ARGS>"`
 - Fix encryption support when using `gnupg==5.x`.
 - Resolve SQLite backup temporary file locking issues on Windows.
+- Fix MediaRestore path corruption for files containing "media" in their paths.
 
 ### Security
 

dbbackup/checks.py

@@ -32,8 +32,7 @@
 )
 W006 = Warning(
     "FAILURE_RECIPIENTS has been deprecated",
-    hint="settings.DBBACKUP_FAILURE_RECIPIENTS is replaced by "
-    "settings.DBBACKUP_ADMINS",
+    hint="settings.DBBACKUP_FAILURE_RECIPIENTS is replaced by settings.DBBACKUP_ADMINS",
     id="dbbackup.W006",
 )
 W007 = Warning(
@@ -97,16 +96,10 @@ def check_settings(app_configs, **kwargs):
     if not settings.STORAGE or not isinstance(settings.STORAGE, str):
         errors.append(W002)
 
-    if (
-        not callable(settings.FILENAME_TEMPLATE)
-        and "{datetime}" not in settings.FILENAME_TEMPLATE
-    ):
+    if not callable(settings.FILENAME_TEMPLATE) and "{datetime}" not in settings.FILENAME_TEMPLATE:
         errors.append(W003)
 
-    if (
-        not callable(settings.MEDIA_FILENAME_TEMPLATE)
-        and "{datetime}" not in settings.MEDIA_FILENAME_TEMPLATE
-    ):
+    if not callable(settings.MEDIA_FILENAME_TEMPLATE) and "{datetime}" not in settings.MEDIA_FILENAME_TEMPLATE:
         errors.append(W004)
 
     if re.search(r"[^A-Za-z0-9%_-]", settings.DATE_FORMAT):

dbbackup/db/postgresql.py

@@ -70,9 +70,7 @@ def _restore_dump(self, dump):
 
         cmd += " {}".format(self.settings["NAME"])
         cmd = f"{self.restore_prefix} {cmd} {self.restore_suffix}"
-        stdout, stderr = self.run_command(
-            cmd, stdin=dump, env={**self.restore_env, **pg_env}
-        )
+        stdout, stderr = self.run_command(cmd, stdin=dump, env={**self.restore_env, **pg_env})
         return stdout, stderr
 
 
@@ -148,25 +146,13 @@ def _restore_dump(self, dump: str):
 
         # Flatten optional values
         if self.restore_prefix:
-            cmd.extend(
-                self.restore_prefix
-                if isinstance(self.restore_prefix, list)
-                else [self.restore_prefix]
-            )
+            cmd.extend(self.restore_prefix if isinstance(self.restore_prefix, list) else [self.restore_prefix])
 
         if self.restore_cmd:
-            cmd.extend(
-                self.restore_cmd
-                if isinstance(self.restore_cmd, list)
-                else [self.restore_cmd]
-            )
+            cmd.extend(self.restore_cmd if isinstance(self.restore_cmd, list) else [self.restore_cmd])
 
         if self.pg_options:
-            cmd.extend(
-                self.pg_options
-                if isinstance(self.pg_options, list)
-                else [self.pg_options]
-            )
+            cmd.extend(self.pg_options if isinstance(self.pg_options, list) else [self.pg_options])
 
         cmd.extend([dbname])
 
@@ -184,15 +170,9 @@ def _restore_dump(self, dump: str):
             cmd.extend(["--if-exists"])
 
         if self.restore_suffix:
-            cmd.extend(
-                self.restore_suffix
-                if isinstance(self.restore_suffix, list)
-                else [self.restore_suffix]
-            )
+            cmd.extend(self.restore_suffix if isinstance(self.restore_suffix, list) else [self.restore_suffix])
 
         cmd_str = " ".join(cmd)
-        stdout, _ = self.run_command(
-            cmd_str, stdin=dump, env={**self.dump_env, **pg_env}
-        )
+        stdout, _ = self.run_command(cmd_str, stdin=dump, env={**self.dump_env, **pg_env})
 
         return stdout

dbbackup/log.py

@@ -16,9 +16,7 @@ def emit(self, record):
     def send_mail(self, subject, message, *args, **kwargs):
         from . import utils
 
-        utils.mail_admins(
-            subject, message, *args, connection=self.connection(), **kwargs
-        )
+        utils.mail_admins(subject, message, *args, connection=self.connection(), **kwargs)
 
 
 class MailEnabledFilter(logging.Filter):

dbbackup/management/commands/_base.py

@@ -63,21 +63,14 @@ class BaseDbBackupCommand(BaseCommand):
     def __init__(self, *args, **kwargs):
         self.option_list = self.base_option_list + self.option_list
         if django.VERSION < (1, 10):
-            options = tuple(
-                optparse_make_option(*_args, **_kwargs)
-                for _args, _kwargs in self.option_list
-            )
+            options = tuple(optparse_make_option(*_args, **_kwargs) for _args, _kwargs in self.option_list)
 
             self.option_list = options + BaseCommand.option_list
         super().__init__(*args, **kwargs)
 
     def add_arguments(self, parser):
         for args, kwargs in self.option_list:
-            kwargs = {
-                k: v
-                for k, v in kwargs.items()
-                if not k.startswith("_") and k not in USELESS_ARGS
-            }
+            kwargs = {k: v for k, v in kwargs.items() if not k.startswith("_") and k not in USELESS_ARGS}
             parser.add_argument(*args, **kwargs)
 
     def _set_logger_level(self):

dbbackup/management/commands/dbrestore.py

@@ -21,14 +21,11 @@ class Command(BaseDbBackupCommand):
     option_list = BaseDbBackupCommand.option_list + (
         make_option("-d", "--database", help="Database to restore"),
         make_option("-i", "--input-filename", help="Specify filename to backup from"),
-        make_option(
-            "-I", "--input-path", help="Specify path on local filesystem to backup from"
-        ),
+        make_option("-I", "--input-path", help="Specify path on local filesystem to backup from"),
         make_option(
             "-s",
             "--servername",
-            help="If backup file is not specified, filter the "
-            "existing ones with the given servername",
+            help="If backup file is not specified, filter the existing ones with the given servername",
         ),
         make_option(
             "-c",
@@ -37,9 +34,7 @@ class Command(BaseDbBackupCommand):
             action="store_true",
             help="Decrypt data before restoring",
         ),
-        make_option(
-            "-p", "--passphrase", help="Passphrase for decrypt file", default=None
-        ),
+        make_option("-p", "--passphrase", help="Passphrase for decrypt file", default=None),
         make_option(
             "-z",
             "--uncompress",
@@ -85,9 +80,7 @@ def handle(self, *args, **options):
             self.passphrase = options.get("passphrase")
             self.interactive = options.get("interactive")
             self.input_database_name = options.get("database")
-            self.database_name, self.database = self._get_database(
-                self.input_database_name
-            )
+            self.database_name, self.database = self._get_database(self.input_database_name)
             self.storage = get_storage()
             self.no_drop = options.get("no_drop")
             self.pg_options = options.get("pg_options", "")
@@ -100,10 +93,7 @@ def _get_database(self, database_name: str):
         """Get the database to restore."""
         if not database_name:
             if len(settings.DATABASES) > 1:
-                errmsg = (
-                    "Because this project contains more than one database, you"
-                    " must specify the --database option."
-                )
+                errmsg = "Because this project contains more than one database, you must specify the --database option."
                 raise CommandError(errmsg)
             database_name = list(settings.DATABASES.keys())[0]
         if database_name not in settings.DATABASES:
@@ -128,15 +118,11 @@ def _restore_backup(self):
         self.logger.info(f"Restoring: {input_filename}")
 
         if self.decrypt:
-            unencrypted_file, input_filename = utils.unencrypt_file(
-                input_file, input_filename, self.passphrase
-            )
+            unencrypted_file, input_filename = utils.unencrypt_file(input_file, input_filename, self.passphrase)
             input_file.close()
             input_file = unencrypted_file
         if self.uncompress:
-            uncompressed_file, input_filename = utils.uncompress_file(
-                input_file, input_filename
-            )
+            uncompressed_file, input_filename = utils.uncompress_file(input_file, input_filename)
             input_file.close()
             input_file = uncompressed_file
 

dbbackup/management/commands/listbackups.py

@@ -45,9 +45,7 @@ class Command(BaseDbBackupCommand):
             default=None,
             dest="encrypted",
         ),
-        make_option(
-            "-c", "--content-type", help="Filter by content type 'db' or 'media'"
-        ),
+        make_option("-c", "--content-type", help="Filter by content type 'db' or 'media'"),
     )
 
     def handle(self, **options):

dbbackup/management/commands/mediabackup.py

@@ -44,9 +44,7 @@ class Command(BaseDbBackupCommand):
             action="store_true",
             default=False,
         ),
-        make_option(
-            "-o", "--output-filename", default=None, help="Specify filename on storage"
-        ),
+        make_option("-o", "--output-filename", default=None, help="Specify filename on storage"),
         make_option(
             "-O",
             "--output-path",
@@ -111,9 +109,7 @@ def backup_mediafiles(self):
             filename = self.filename
         else:
             extension = f"tar{'.gz' if self.compress else ''}"
-            filename = utils.filename_generate(
-                extension, servername=self.servername, content_type=self.content_type
-            )
+            filename = utils.filename_generate(extension, servername=self.servername, content_type=self.content_type)
 
         tarball = self._create_tar(filename)
         # Apply trans

dbbackup/management/commands/mediarestore.py

@@ -21,14 +21,11 @@ class Command(BaseDbBackupCommand):
             action="store",
             help="Specify filename to backup from",
         ),
-        make_option(
-            "-I", "--input-path", help="Specify path on local filesystem to backup from"
-        ),
+        make_option("-I", "--input-path", help="Specify path on local filesystem to backup from"),
         make_option(
             "-s",
             "--servername",
-            help="If backup file is not specified, filter the existing ones with the "
-            "given servername",
+            help="If backup file is not specified, filter the existing ones with the given servername",
         ),
         make_option(
             "-e",
@@ -37,18 +34,14 @@ class Command(BaseDbBackupCommand):
             action="store_true",
             help="Decrypt data before restoring",
         ),
-        make_option(
-            "-p", "--passphrase", default=None, help="Passphrase for decrypt file"
-        ),
+        make_option("-p", "--passphrase", default=None, help="Passphrase for decrypt file"),
         make_option(
             "-z",
             "--uncompress",
             action="store_true",
             help="Uncompress gzip data before restoring",
         ),
-        make_option(
-            "-r", "--replace", help="Replace existing files", action="store_true"
-        ),
+        make_option("-r", "--replace", help="Replace existing files", action="store_true"),
     )
 
     def handle(self, *args, **options):
@@ -87,9 +80,7 @@ def _restore_backup(self):
         self.logger.info("Restoring: %s", input_filename)
 
         if self.decrypt:
-            unencrypted_file, input_filename = utils.unencrypt_file(
-                input_file, input_filename, self.passphrase
-            )
+            unencrypted_file, input_filename = utils.unencrypt_file(input_file, input_filename, self.passphrase)
             input_file.close()
             input_file = unencrypted_file
 
@@ -110,5 +101,5 @@ def _restore_backup(self):
             media_file = tar_file.extractfile(media_file_info)
             if media_file is None:
                 continue  # Skip directories
-            name = media_file_info.path.replace("media/", "")
+            name = media_file_info.path
             self._upload_file(name, media_file)