zulip/zerver/management/commands/convert_bot_to_outgoing_webhook.py

from typing import Any

from argparse import ArgumentParser

from zerver.lib.management import ZulipBaseCommand
from zerver.models import Service, UserProfile

class Command(ZulipBaseCommand):
    help = """Given an existing bot, converts it into an outgoing webhook bot."""

    def add_arguments(self, parser):
        # type: (ArgumentParser) -> None
        self.add_realm_args(parser)
        parser.add_argument('bot_email', metavar='<bot_email>', type=str,
                            help='email of bot')
        parser.add_argument('service_name', metavar='<service_name>', type=str,
                            help='name of Service object to create')
        parser.add_argument('base_url', metavar='<base_url>', type=str,
                            help='base url of outgoing webhook')
        # TODO: Add token and interface as arguments once OutgoingWebhookWorker
        # uses these fields on the Service object.

    def handle(self, *args, **options):
        # type: (*Any, **str) -> None

        bot_email = options['bot_email']
        service_name = options['service_name']
        base_url = options['base_url']
        realm = self.get_realm(options)

        if not bot_email:
            print('Email of existing bot must be provided')
            exit(1)

        if not service_name:
            print('Name for Service object must be provided')
            exit(1)

        if not base_url:
            print('Base URL of outgoing webhook must be provided')
            exit(1)

        # TODO: Normalize email?
        bot_profile = self.get_user(email=bot_email, realm=realm)
        if not bot_profile.is_bot:
            print('User %s is not a bot' % (bot_email,))
            exit(1)
        if bot_profile.is_outgoing_webhook_bot:
            print('%s is already marked as an outgoing webhook bot' % (bot_email,))
            exit(1)

        Service.objects.create(name=service_name,
                               user_profile=bot_profile,
                               base_url=base_url,
                               token='',
                               interface=1)

        bot_profile.bot_type = UserProfile.OUTGOING_WEBHOOK_BOT
        bot_profile.save()

        print('Successfully converted %s into an outgoing webhook bot' % (bot_email,))