zulip/zerver/management/commands/change_realm_subdomain.py

from argparse import ArgumentParser
from typing import Any

from django.core.exceptions import ValidationError
from django.core.management.base import CommandError
from typing_extensions import override

from zerver.actions.create_realm import do_change_realm_subdomain
from zerver.forms import check_subdomain_available
from zerver.lib.management import ZulipBaseCommand


class Command(ZulipBaseCommand):
    help = """Change realm's subdomain."""

    @override
    def add_arguments(self, parser: ArgumentParser) -> None:
        self.add_realm_args(parser, required=True)
        parser.add_argument("new_subdomain", metavar="<new subdomain>", help="realm new subdomain")
        parser.add_argument(
            "--skip-redirect",
            action="store_true",
            help="Do not redirect the old name to the new one",
        )
        parser.add_argument(
            "--allow-reserved-subdomain",
            action="store_true",
            help="Allow use of reserved subdomains",
        )

    @override
    def handle(self, *args: Any, **options: Any) -> None:
        realm = self.get_realm(options)
        assert realm is not None  # Should be ensured by parser

        new_subdomain = options["new_subdomain"]
        allow_reserved_subdomain = options["allow_reserved_subdomain"]
        try:
            check_subdomain_available(new_subdomain, allow_reserved_subdomain)
        except ValidationError as error:
            raise CommandError(error.message)
        do_change_realm_subdomain(
            realm,
            new_subdomain,
            acting_user=None,
            add_deactivated_redirect=not options["skip_redirect"],
        )
        print("Done!")