Files
mautrix-telegram/mautrix_telegram/commands.py
T

233 lines
9.5 KiB
Python

# mautrix-telegram - A Matrix-Telegram puppeting bridge
# Copyright (C) 2018 Tulir Asokan
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from contextlib import contextmanager
import markdown
from telethon.errors import *
command_handlers = {}
def command_handler(func):
command_handlers[func.__name__] = func
class CommandHandler:
def __init__(self, context):
self.az, self.db, log, self.config = context
self.log = log.getChild("commands")
self.command_prefix = self.config["bridge.command_prefix"]
self._room_id = None
self._is_management = False
self._is_portal = False
def handle(self, room, sender, command, args, is_management, is_portal):
with self.handler(sender, room, command, args, is_management, is_portal) as handle_command:
handle_command(self, sender, args)
@contextmanager
def handler(self, sender, room, command, args, is_management, is_portal):
self._room_id = room
try:
command = command_handlers[command]
except KeyError:
if sender.command_status and "next" in sender.command_status:
args.insert(0, command)
command = sender.command_status["next"]
else:
command = command_handlers["unknown_command"]
self._is_management = is_management
self._is_portal = is_portal
yield command
self._is_management = None
self._is_portal = None
self._room_id = None
def reply(self, message, allow_html=False, render_markdown=True):
if not self._room_id:
raise AttributeError("the reply function can only be used from within"
"the `CommandHandler.run` context manager")
message = message.replace("$cmdprefix", self.command_prefix)
message = message.replace("$cmdprefix+sp ",
"" if self._is_management else f"{self.command_prefix} ")
html = None
if render_markdown:
html = markdown.markdown(message, safe_mode="escape" if allow_html else False)
elif allow_html:
html = message
self.az.intent.send_text(self._room_id, message, html=html, notice=True)
@command_handler
def register(self, sender, args):
self.reply("Not yet implemented.")
@command_handler
def login(self, sender, args):
if not self._is_management:
return self.reply(
"`login` is a restricted command: you may only run it in management rooms.")
elif sender.logged_in:
return self.reply("You are already logged in.")
elif len(args) == 0:
return self.reply("**Usage:** `$cmdprefix+sp login <phone number>`")
phone_number = args[0]
sender.client.send_code_request(phone_number)
sender.client.sign_in(phone_number)
sender.command_status = {
"next": command_handlers["enter_code"],
"action": "Login",
}
return self.reply(f"Login code sent to {phone_number}. Please send the code here.")
@command_handler
def enter_code(self, sender, args):
if not sender.command_status:
return self.reply("Request a login code first with `$cmdprefix+sp login <phone>`")
elif len(args) == 0:
return self.reply("**Usage:** `$cmdprefix+sp enter_code <code>")
try:
user = sender.client.sign_in(code=args[0])
sender.update_info(user)
sender.command_status = None
return self.reply(f"Successfully logged in as @{user.username}")
except PhoneNumberUnoccupiedError:
return self.reply("That phone number has not been registered."
"Please register with `$cmdprefix+sp register <phone>`.")
except PhoneCodeExpiredError:
return self.reply(
"Phone code expired. Try again with `$cmdprefix+sp login <phone>`.")
except PhoneCodeInvalidError:
return self.reply("Invalid phone code.")
except PhoneNumberAppSignupForbiddenError:
return self.reply(
"Your phone number does not allow 3rd party apps to sign in.")
except PhoneNumberFloodError:
return self.reply(
"Your phone number has been temporarily blocked for flooding. "
"The block is usually applied for around a day.")
except PhoneNumberBannedError:
return self.reply("Your phone number has been banned from Telegram.")
except SessionPasswordNeededError:
sender.command_status = {
"next": command_handlers["enter_password"],
"action": "Login (password entry)",
}
return self.reply("Your account has two-factor authentication."
"Please send your password here.")
except:
self.log.exception()
return self.reply("Unhandled exception while sending code."
"Check console for more details.")
@command_handler
def enter_password(self, sender, args):
if not sender.command_status:
return self.reply("Request a login code first with `$cmdprefix+sp login <phone>`")
elif len(args) == 0:
return self.reply("**Usage:** `$cmdprefix+sp enter_password <password>")
try:
user = sender.client.sign_in(password=args[0])
sender.update_info(user)
sender.command_status = None
return self.reply(f"Successfully logged in as @{user.username}")
except PasswordHashInvalidError:
return self.reply("Incorrect password.")
except:
self.log.exception()
return self.reply("Unhandled exception while sending password."
"Check console for more details.")
@command_handler
def logout(self, sender, args):
if not sender.logged_in:
return self.reply("You're not logged in.")
if sender.log_out():
return self.reply("Logged out successfully.")
return self.reply("Failed to log out.")
@command_handler
def ping(self, sender, args):
if not sender.logged_in:
return self.reply("You're not logged in.")
me = sender.client.get_me()
if me:
return self.reply(f"You're logged in as @{me.username}")
else:
return self.reply("You're not logged in.")
@command_handler
def search(self, sender, args):
self.reply("Not yet implemented.")
@command_handler
def pm(self, sender, args):
self.reply("Not yet implemented.")
@command_handler
def create(self, sender, args):
self.reply("Not yet implemented.")
@command_handler
def upgrade(self, sender, args):
self.reply("Not yet implemented.")
@command_handler
def cancel(self, sender, args):
if sender.command_status:
action = sender.command_status["action"]
sender.command_status = None
return self.reply(f"{action} cancelled.")
else:
return self.reply("No ongoing command.")
@command_handler
def unknown_command(self, sender, args):
if self._is_management:
return self.reply("Unknown command. Try `help` for help.")
else:
return self.reply("Unknown command. Try `$cmdprefix help` for help.")
@command_handler
def help(self, sender, args):
if self._is_management:
management_status = ("This is a management room: prefixing commands"
"with `$cmdprefix` is not required.\n")
elif self._is_portal:
management_status = ("**This is a portal room**: you must always"
"prefix commands with `$cmdprefix`.\n"
"Management commands will not be sent to Telegram.")
else:
management_status = ("**This is not a management room**: you must"
"prefix commands with `$cmdprefix`.\n")
help = """
_**Generic bridge commands**: commands for using the bridge that aren't related to Telegram._
**help** - Show this help message.
**cancel** - Cancel an ongoing action (such as login).
_**Telegram actions**: commands for using the bridge to interact with Telegram._
**login** <_phone_> - Request an authentication code.
**logout** - Log out from Telegram.
**ping** - Check if you're logged into Telegram.
**search** [_-r|--remote_] <_query_> - Search your contacts or the Telegram servers for users.
**pm** <_id_> - Open a private chat with the given Telegram user ID.
**create** <_group/channel_> [_room ID_] - Create a Telegram chat of the given type for a Matrix room.
If the room ID is not specified, a chat for the current room is created.
**upgrade** - Upgrade a normal Telegram group to a supergroup.
"""
return self.reply(management_status + help)