Files
zulip/zerver/management/commands/delete_realm.py
Alex Vandiver 6fe67f0143 delete_realm: Allow deletion of realms with empty customers.
This is effectively a step closer to what was proposed in
https://github.com/zulip/zulip/pull/18678#discussion_r644490540 when
this code was written in #18678.

If the Customer object has neither of a Stripe id, nor any historical
plans, then there's no real billing association contained in the
existence of the Customer object, and it's safe to delete.
2021-08-02 22:29:16 -07:00

63 lines
2.3 KiB
Python

from argparse import ArgumentParser
from typing import Any
from django.conf import settings
from django.core.management.base import CommandError
from zerver.lib.management import ZulipBaseCommand
from zerver.models import Message, UserProfile
class Command(ZulipBaseCommand):
help = """Script to permanently delete a realm. Recommended only for removing
realms used for testing; consider using deactivate_realm instead."""
def add_arguments(self, parser: ArgumentParser) -> None:
self.add_realm_args(parser, required=True)
def handle(self, *args: Any, **options: str) -> None:
realm = self.get_realm(options)
assert realm is not None # Should be ensured by parser
user_count = UserProfile.objects.filter(
realm_id=realm.id,
is_active=True,
is_bot=False,
).count()
message_count = Message.objects.filter(sender__realm=realm).count()
print(f"This realm has {user_count} users and {message_count} messages.\n")
if settings.BILLING_ENABLED:
# Deleting a Realm object also deletes associating billing
# metadata in an invariant-violating way, so we should
# never use this tool for a realm with billing setup.
from corporate.models import CustomerPlan, get_customer_by_realm
customer = get_customer_by_realm(realm)
if customer:
if (
customer.stripe_customer_id
or CustomerPlan.objects.filter(customer=customer).count() > 0
):
raise CommandError(
"This realm has had a billing relationship associated with it!"
)
print(
"This command will \033[91mPERMANENTLY DELETE\033[0m all data for this realm. "
"Most use cases will be better served by scrub_realm and/or deactivate_realm."
)
confirmation = input("Type the name of the realm to confirm: ")
if confirmation != realm.string_id:
raise CommandError("Aborting!")
# TODO: This approach leaks Recipient and Huddle objects,
# because those don't have a foreign key to the Realm or any
# other model it cascades to (Realm/Stream/UserProfile/etc.).
realm.delete()
print("Realm has been successfully permanently deleted.")