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

zerver/management/commands/export_single_user.py

@@ -0,0 +1,60 @@
+import os
+import subprocess
+import tempfile
+from argparse import ArgumentParser
+from typing import Any
+
+from django.core.management.base import CommandError
+from typing_extensions import override
+
+from zerver.lib.export import do_export_user, export_tarball_prefix
+from zerver.lib.management import ZulipBaseCommand
+
+
+class Command(ZulipBaseCommand):
+    help = """Exports message data from a Zulip user
+
+    This command exports the message history for a single Zulip user.
+
+    Note that this only exports the user's message history and
+    realm-public metadata needed to understand it; it does nothing
+    with (for example) any bots owned by the user."""
+
+    @override
+    def add_arguments(self, parser: ArgumentParser) -> None:
+        parser.add_argument("email", metavar="<email>", help="email of user to export")
+        parser.add_argument(
+            "--output", dest="output_dir", help="Directory to write exported data to."
+        )
+        self.add_realm_args(parser)
+
+    @override
+    def handle(self, *args: Any, **options: Any) -> None:
+        realm = self.get_realm(options)
+        user_profile = self.get_user(options["email"], realm)
+
+        output_dir = options["output_dir"]
+        if output_dir is None:
+            output_dir = tempfile.mkdtemp(prefix=export_tarball_prefix(user_profile.realm))
+        else:
+            output_dir = os.path.abspath(output_dir)
+            if os.path.exists(output_dir) and os.listdir(output_dir):
+                raise CommandError(
+                    f"Refusing to overwrite nonempty directory: {output_dir}. Aborting...",
+                )
+            else:
+                os.makedirs(output_dir)
+
+        print(f"Exporting user {user_profile.delivery_email}")
+        do_export_user(user_profile, output_dir)
+        print(f"Finished exporting to {output_dir}; tarring")
+        tarball_path = output_dir.rstrip("/") + ".tar.gz"
+        subprocess.check_call(
+            [
+                "tar",
+                f"-czf{tarball_path}",
+                f"-C{os.path.dirname(output_dir)}",
+                os.path.basename(output_dir),
+            ]
+        )
+        print(f"Tarball written to {tarball_path}")