matrix-appservice-kakaotalk/matrix_appservice_kakaotalk/commands/conn.py

# matrix-appservice-kakaotalk - A Matrix-KakaoTalk puppeting bridge.
# Copyright (C) 2022 Tulir Asokan, Andrew Ferrazzutti
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
from mautrix.bridge.commands import HelpSection, command_handler

from .typehint import CommandEvent

SECTION_CONNECTION = HelpSection("Connection management", 15, "")


@command_handler(
    needs_auth=False,
    management_only=True,
    help_section=SECTION_CONNECTION,
    help_text="Mark this room as your bridge notice room",
)
async def set_notice_room(evt: CommandEvent) -> None:
    evt.sender.notice_room = evt.room_id
    await evt.sender.save()
    await evt.reply("This room has been marked as your bridge notice room")


@command_handler(
    needs_auth=True,
    management_only=True,
    help_section=SECTION_CONNECTION,
    help_text="Disconnect from KakaoTalk chats, but remain logged into profile-management commands",
)
async def disconnect(evt: CommandEvent) -> None:
    if not evt.sender.is_connected:
        await evt.reply("You are already disconnected from KakaoTalk chats")
        return
    if not evt.sender.config["bridge.remain_logged_in_on_disconnect"]:
        await evt.reply(
            "This instance of the KakaoTalk bridge does not allow being disconnected from KakaoTalk chats while logged in. "
            "So, to disconnect, you must log out entirely with the `logout` command."
        )
        return
    await evt.mark_read()
    await evt.sender.client.disconnect()
    await evt.reply("Successfully disconnected from KakaoTalk chats. To reconnect, use the `sync` command.")


@command_handler(
    needs_auth=False,
    management_only=True,
    help_section=SECTION_CONNECTION,
    help_text="Check if you're logged in to KakaoTalk and connected to chats",
)
async def ping(evt: CommandEvent) -> None:
    if not await evt.sender.is_logged_in():
        await evt.reply("You are **logged out** of KakaoTalk.")
    else:
        is_connected = evt.sender.is_connected and await evt.sender.client.is_connected()
        await evt.reply(
             "You are logged into KakaoTalk.\n\n"
            f"You are {'connected to' if is_connected else '**disconnected** from'} KakaoTalk chats."
        )


@command_handler(
    needs_auth=True,
    management_only=True,
    help_section=SECTION_CONNECTION,
    help_text="(Re)connect to KakaoTalk chats & sync any missed chat updates",
    help_args="[_number of channels to sync_]",
    aliases=["connect"],
)
async def sync(evt: CommandEvent) -> None:
    try:
        sync_count = int(evt.args[0])
    except IndexError:
        sync_count = None
    except ValueError:
        await evt.reply("The number of channels to sync must either be an integer, or be left unspecified.")
        return

    await evt.mark_read()
    if await evt.sender.connect_and_sync(sync_count, force_sync=True):
        await evt.reply("Sync complete")
    else:
        await evt.reply("Sync failed")