mautrix-signal/mautrix_signal/commands/conn.py

# mautrix-signal - A Matrix-Signal puppeting bridge
# Copyright (C) 2021 Tulir Asokan
#
# 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.types import EventID
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.update()
    await evt.reply("This room has been marked as your bridge notice room")


@command_handler(needs_auth=True, management_only=False, help_section=SECTION_CONNECTION,
                 help_text="Relay messages in this room through your Signal account.")
async def set_relay(evt: CommandEvent) -> EventID:
    if not evt.config["bridge.relay.enabled"]:
        return await evt.reply("Relay mode is not enabled in this instance of the bridge.")
    elif not evt.is_portal:
        return await evt.reply("This is not a portal room.")
    await evt.portal.set_relay_user(evt.sender)
    return await evt.reply("Messages from non-logged-in users in this room will now be bridged "
                           "through your Signal account.")


@command_handler(needs_auth=True, management_only=False, help_section=SECTION_CONNECTION,
                 help_text="Stop relaying messages in this room.")
async def unset_relay(evt: CommandEvent) -> EventID:
    if not evt.config["bridge.relay.enabled"]:
        return await evt.reply("Relay mode is not enabled in this instance of the bridge.")
    elif not evt.is_portal:
        return await evt.reply("This is not a portal room.")
    elif not evt.portal.has_relay:
        return await evt.reply("This room does not have a relay user set.")
    await evt.portal.set_relay_user(None)
    return await evt.reply("Messages from non-logged-in users will no longer be bridged.")

# @command_handler(needs_auth=False, management_only=True, help_section=SECTION_CONNECTION,
#                  help_text="Check if you're logged into Twitter")
# async def ping(evt: CommandEvent) -> None:
#     if evt.sender.username:
#         await evt.reply("")
#     user_info = await evt.sender.get_info()
#     await evt.reply(f"You're logged in as {user_info.name} "
#                     f"([@{evt.sender.username}](https://twitter.com/{evt.sender.username}), "
#                     f"user ID: {evt.sender.twid})")


# TODO request syncs or something
# @command_handler(needs_auth=True, management_only=False, help_section=SECTION_CONNECTION,
#                  help_text="Synchronize portals")
# async def sync(evt: CommandEvent) -> None:
#     await evt.sender.sync()
#     await evt.reply("Synchronization complete")