snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/management/commands/restore_messages.py

@@ -0,0 +1,62 @@
+from typing import Any
+
+from django.core.management.base import CommandParser
+from typing_extensions import override
+
+from zerver.lib.management import ZulipBaseCommand
+from zerver.lib.retention import (
+    restore_all_data_from_archive,
+    restore_data_from_archive,
+    restore_data_from_archive_by_realm,
+)
+from zerver.models import ArchiveTransaction
+
+
+class Command(ZulipBaseCommand):
+    help = """
+Restore recently deleted messages from the archive, that
+have not been vacuumed (because the time limit of
+ARCHIVED_DATA_VACUUMING_DELAY_DAYS has not passed).
+
+Intended primarily for use after against potential bugs in
+Zulip's message retention and deletion features.
+
+Examples:
+To restore all recently deleted messages:
+  ./manage.py restore_messages --all --restore-deleted
+To restore a specific ArchiveTransaction:
+  ./manage.py restore_messages --transaction-id=1
+"""
+
+    @override
+    def add_arguments(self, parser: CommandParser) -> None:
+        target = parser.add_mutually_exclusive_group(required=True)
+        target.add_argument(
+            "--all",
+            action="store_true",
+            help="Restore archived messages from all realms. "
+            "(Does not restore manually deleted messages.)",
+        )
+        parser.add_argument(
+            "--restore-deleted",
+            action="store_true",
+            help="With --all, also restores manually deleted messages.",
+        )
+        target.add_argument(
+            "-t", "--transaction-id", type=int, help="Restore a specific ArchiveTransaction."
+        )
+        self.add_realm_args(
+            target,
+            help="Restore archived messages from the specified realm. "
+            "(Does not restore manually deleted messages.)",
+        )
+
+    @override
+    def handle(self, *args: Any, **options: Any) -> None:
+        realm = self.get_realm(options)
+        if realm:
+            restore_data_from_archive_by_realm(realm)
+        elif options["transaction_id"]:
+            restore_data_from_archive(ArchiveTransaction.objects.get(id=options["transaction_id"]))
+        elif options["all"]:
+            restore_all_data_from_archive(restore_manual_transactions=options["restore_deleted"])