plugable-matrix-bot/matrix_bot_api/matrix_bot_api.py

import traceback
import re
import os
import sys
import importlib

from matrix_client.client import MatrixClient
from matrix_client.api import MatrixRequestError, MatrixHttpApi
from matrix_client.user import User

from matrix_bot_api.mregex_handler import MRegexHandler

HELP_LOCATION = os.path.join(os.path.dirname(__file__), 'help')

private_message = "Hey {}! Ik heb je even een privébericht gestuurd 🙂"

def eprint(*args, **kwargs):
    print(*args, file=sys.stderr, **kwargs)

class MatrixBotAPI:
    # rooms    - List of rooms ids to operate in, or None to accept all rooms
    def __init__(self, config, rooms=None):
        self.username = config['bot_credentials']['username']

        # Authenticate with given credentials
        self.client = MatrixClient(config['bot_credentials']['server'])
        try:
            self.token = self.client.login_with_password(
                config['bot_credentials']['username'],
                config['bot_credentials']['password'])
        except MatrixRequestError as e:
            print(e)
            if e.code == 403:
                print("Bad username/password")
        except Exception as e:
            print("Invalid server URL")
            traceback.print_exc()

        self.api = MatrixHttpApi(
                config['bot_credentials']['server'],
                token=self.token)

        # Store allowed rooms
        self.rooms = rooms

        # Store empty list of handlers
        self.handlers = []

        # If rooms is None, we should listen for invites and automatically
        # accept them
        if rooms is None:
            self.client.add_invite_listener(self.handle_invite)
            self.rooms = []

            # Add all rooms we're currently in to self.rooms and add their
            # callbacks
            for room_id, room in self.client.get_rooms().items():
                room.add_listener(self.handle_message)
                self.rooms.append(room_id)
        else:
            # Add the message callback for all specified rooms
            for room in self.rooms:
                room.add_listener(self.handle_message)

        # This flag can be set by the calling function to cancel all threads
        # of all plugins
        self.cancel = False

        # Store empty list of plugins
        self.plugins = []


        # Try to import plugins. All plugins must be located in the
        # ./plugins directory
        modules = []

        try:
            for plugin in config['plugins']:
                modules.append(
                    importlib.import_module(
                        "plugins.{0}.{0}".format(plugin), package = None))
        except:
            eprint("Importing one or more of the plugins did not go well!")
            sys.exit()

        # Loop through the available modules and add their handler variables
        for i, module in enumerate(modules):
            # Create new instance of plugin and append to plugins array
            self.plugins.append(module.Plugin(self))

            # Add handler of newly created instance to bot
            self.add_handler(self.plugins[i].handler)

        # Run setup
        self.setup(config)

        # Add callback for help function
        self.help_handler = MRegexHandler("Peter help", self.help)
        self.add_handler(self.help_handler)

    def setup(self, config):
        """This function only runs once, ever. It initializes an SQLite
        database, sets the bot's avatar, and name"""

        try:
            # Try to make new directory
            os.mkdir("data")

            # Get user instance
            self.user = self.client.get_user(self.username)

            # Set username
            self.user.set_display_name(config['character']['name'])

            # Open, upload, and set avatar
            f = open(config['character']['avatar'], mode="rb")

            avatar = self.client.upload(f, config['charactar']['avatar_mime'])
            self.user.set_avatar_url(avatar)

        except FileExistsError:
            # Do nothing, data directory already exists
            pass

    def send_message_private_public(self, room, event, message):
        orig_room = room
        found_room = False

        for room_id, room in self.client.get_rooms().items():
            joined_members = room.get_joined_members()

            # Check for rooms with only two members
            if len(joined_members) == 2:
                # Check if sender is in that room
                for member in joined_members:
                    if event['sender'] == member.user_id:
                        found_room = True

            if found_room:
                # If the flag is set, we do not need to check further rooms
                break

        # Send help message to an existing room or to a new room
        if found_room:
            room.send_html(message)
        else:
            room = self.client.create_room(invitees=[event['sender']]);
            room.send_html(message)

        if room != orig_room:
            display_name_sender = self.api.get_display_name(event['sender'])
            orig_room.send_text(private_message.format(display_name_sender))

    def help(self, room, event):
        """Prints a general help message and then grabs all help
        messages from the different plugins
        """

        help_text = open(HELP_LOCATION, mode="r").read()

        for plugin in self.plugins:
            help_text += plugin.help()

        self.send_message_private_public(room, event, help_text)

    def add_handler(self, handler):
        self.handlers.append(handler)

    def handle_message(self, room, event):
        # Make sure we didn't send this message
        if re.match("@" + self.username, event['sender']):
            return

        # Loop through all installed handlers and see if they need to be called
        for handler in self.handlers:
            if handler.test_callback(room, event):
                # This handler needs to be called
                try:
                    handler.handle_callback(room, event)
                except:
                    traceback.print_exc()

    def handle_invite(self, room_id, state):
        print("Got invite to room: " + str(room_id))
        print("Joining...")
        room = self.client.join_room(room_id)

        # Add message callback for this room
        room.add_listener(self.handle_message)

        # Add room to list
        self.rooms.append(room)

    def start_polling(self):
        # Starts polling for messages
        self.client.start_listener_thread()
        return self.client.sync_thread