matrix_chatgpt_bot/bot.py

import sys
import asyncio
import re
import os
import traceback
from typing import Optional, Union
from nio import (
    AsyncClient,
    MatrixRoom,
    RoomMessageText,
    InviteMemberEvent,
    MegolmEvent,
    LoginResponse,
    JoinError,
    ToDeviceError,
    LocalProtocolError,
    KeyVerificationEvent,
    KeyVerificationStart,
    KeyVerificationCancel,
    KeyVerificationKey,
    KeyVerificationMac,
    AsyncClientConfig
    )
from nio.store.database import SqliteStore
from askgpt import askGPT
from send_message import send_room_message
from v3 import Chatbot
from log import getlogger
from bing import BingBot
from BingImageGen import ImageGen
from send_image import send_room_image

logger = getlogger()


class Bot:
    def __init__(
        self,
        homeserver: str,
        user_id: str,
        device_id: str,
        chatgpt_api_endpoint: str = os.environ.get("CHATGPT_API_ENDPOINT") or "https://api.openai.com/v1/chat/completions",
        api_key: Optional[str] = os.environ.get("OPENAI_API_KEY") or "",
        room_id: Union[str, None] = None,
        bing_api_endpoint: Optional[str] = '',
        password: Union[str, None] = None,
        access_token: Union[str, None] = None,
        jailbreakEnabled: Optional[bool] = True,
        bing_auth_cookie: Optional[str] = '',
    ):
        if (homeserver is None or user_id is None \
            or device_id is None):
            logger.warning("homeserver && user_id && device_id is required")
            sys.exit(1)

        if (password is None and access_token is None):
            logger.warning("password and access_toekn is required")
            sys.exit(1)

        self.homeserver = homeserver
        self.user_id = user_id
        self.password = password
        self.access_token = access_token
        self.device_id = device_id
        self.room_id = room_id
        self.api_key = api_key
        self.chatgpt_api_endpoint = chatgpt_api_endpoint
        self.bing_api_endpoint = bing_api_endpoint
        self.jailbreakEnabled = jailbreakEnabled
        self.bing_auth_cookie = bing_auth_cookie
        # initialize AsyncClient object
        self.store_path = os.getcwd()
        self.config = AsyncClientConfig(store=SqliteStore,
                                        store_name="db",
                                        store_sync_tokens=True,
                                        encryption_enabled=True,
                                        )
        self.client = AsyncClient(homeserver=self.homeserver, user=self.user_id, device_id=self.device_id,
                                  config=self.config, store_path=self.store_path,)
        
        if self.access_token is not None:
            self.client.access_token = self.access_token

        # setup event callbacks 
        self.client.add_event_callback(self.message_callback, (RoomMessageText, ))
        self.client.add_event_callback(self.decryption_failure, (MegolmEvent, ))
        self.client.add_event_callback(self.invite_callback, (InviteMemberEvent, ))
        self.client.add_to_device_callback(self.to_device_callback, (KeyVerificationEvent, ))

        # regular expression to match keyword [!gpt {prompt}] [!chat {prompt}]
        self.gpt_prog = re.compile(r"^\s*!gpt\s*(.+)$")
        self.chat_prog = re.compile(r"^\s*!chat\s*(.+)$")
        self.bing_prog = re.compile(r"^\s*!bing\s*(.+)$")
        self.pic_prog = re.compile(r"^\s*!pic\s*(.+)$")
        self.help_prog = re.compile(r"^\s*!help\s*.*$")

        # initialize chatbot and chatgpt_api_endpoint
        if self.api_key != '':
            self.chatbot = Chatbot(api_key=self.api_key, timeout=60)

            self.chatgpt_api_endpoint = self.chatgpt_api_endpoint
            # request header for !gpt command
            self.headers = {
                "Content-Type": "application/json",
                "Authorization": f"Bearer {self.api_key}",
            }
        else:
            self.chatgpt_api_endpoint = self.chatgpt_api_endpoint
            self.headers = {
                "Content-Type": "application/json",
            }

        # initialize askGPT class
        self.askgpt = askGPT()

        # initialize bingbot
        if self.bing_api_endpoint != '':
            self.bingbot = BingBot(bing_api_endpoint, jailbreakEnabled=self.jailbreakEnabled)

        # initialize BingImageGen
        if self.bing_auth_cookie != '':
            self.imageGen = ImageGen(self.bing_auth_cookie)

    # message_callback RoomMessageText event
    async def message_callback(self, room: MatrixRoom, event: RoomMessageText) -> None:
        if self.room_id is None:
            room_id = room.room_id
        else:
            # if event room id does not match the room id in config, return
            if room.room_id != self.room_id:
                return
            room_id = self.room_id

        # reply event_id
        reply_to_event_id = event.event_id

        # sender_id
        sender_id = event.sender

        # user_message
        raw_user_message = event.body

        # print info to console
        print(
            f"Message received in room {room.display_name}\n"
            f"{room.user_name(event.sender)} | {raw_user_message}"
        )

        # prevent command trigger loop
        if self.user_id != event.sender:
            # remove newline character from event.body
            content_body = re.sub("\r\n|\r|\n", " ", raw_user_message)

            # chatgpt
            n = self.chat_prog.match(content_body)
            if n:
                prompt = n.group(1)
                if self.api_key != '':
                    try:
                        await self.chat(room_id, reply_to_event_id, prompt, sender_id, raw_user_message)
                    except Exception as e:
                        logger.error(e)
                        await send_room_message(self.client, room_id, reply_message=str(e))
                else:
                    logger.warning("No API_KEY provided")
                    await send_room_message(self.client, room_id, reply_message="API_KEY not provided")

            m = self.gpt_prog.match(content_body)
            if m:
                prompt = m.group(1)
                try:
                    await self.gpt(room_id, reply_to_event_id, prompt, sender_id, raw_user_message)
                except Exception as e:
                    logger.error(e)
                    await send_room_message(self.client, room_id, reply_message=str(e))

            # bing ai
            if self.bing_api_endpoint != '':
                b = self.bing_prog.match(content_body)
                if b:
                    prompt = b.group(1)
                    # raw_content_body used for construct formatted_body
                    try:
                        await self.bing(room_id, reply_to_event_id, prompt, sender_id, raw_user_message)
                    except Exception as e:
                        await send_room_message(self.client, room_id, reply_message=str(e))

            # Image Generation by Microsoft Bing
            if self.bing_auth_cookie != '':
                i = self.pic_prog.match(content_body)
                if i:
                    prompt = i.group(1)
                    try:
                        await self.pic(room_id, prompt)
                    except Exception as e:
                        await send_room_message(self.client, room_id, reply_message=str(e))

            # help command
            h = self.help_prog.match(content_body)
            if h:
                await self.help(room_id)

    # message_callback decryption_failure event
    async def decryption_failure(self, room: MatrixRoom, event: MegolmEvent) -> None:
        if not isinstance(event, MegolmEvent):
            return

        logger.error(
            f"Failed to decrypt message: {event.event_id} from {event.sender} in {room.room_id}\n" + \
            "Please make sure the bot current session is verified"
            )

    # invite_callback event
    async def invite_callback(self, room: MatrixRoom, event: InviteMemberEvent) -> None:
        """Handle an incoming invite event.
        https://github.com/8go/matrix-eno-bot/blob/ad037e02bd2960941109e9526c1033dd157bb212/callbacks.py#L104
        If an invite is received, then join the room specified in the invite.
        code copied from: 
        """
        logger.debug(f"Got invite to {room.room_id} from {event.sender}.")
        # Attempt to join 3 times before giving up
        for attempt in range(3):
            result = await self.client.join(room.room_id)
            if type(result) == JoinError:
                logger.error(
                    f"Error joining room {room.room_id} (attempt %d): %s",
                    attempt, result.message,
                )
            else:
                break
        else:
            logger.error("Unable to join room: %s", room.room_id)

        # Successfully joined room
        logger.info(f"Joined {room.room_id}")
        
    # to_device_callback event
    async def to_device_callback(self, event: KeyVerificationEvent) -> None:
        """Handle events sent to device.

        Specifically this will perform Emoji verification.
        It will accept an incoming Emoji verification requests
        and follow the verification protocol.
        code copied from: https://github.com/8go/matrix-eno-bot/blob/ad037e02bd2960941109e9526c1033dd157bb212/callbacks.py#L127
        """
        try:
            client = self.client
            logger.debug(
                f"Device Event of type {type(event)} received in "
                "to_device_cb().")

            if isinstance(event, KeyVerificationStart):  # first step
                """ first step: receive KeyVerificationStart
                KeyVerificationStart(
                    source={'content':
                            {'method': 'm.sas.v1',
                             'from_device': 'DEVICEIDXY',
                             'key_agreement_protocols':
                                ['curve25519-hkdf-sha256', 'curve25519'],
                             'hashes': ['sha256'],
                             'message_authentication_codes':
                                ['hkdf-hmac-sha256', 'hmac-sha256'],
                             'short_authentication_string':
                                ['decimal', 'emoji'],
                             'transaction_id': 'SomeTxId'
                             },
                            'type': 'm.key.verification.start',
                            'sender': '@user2:example.org'
                            },
                    sender='@user2:example.org',
                    transaction_id='SomeTxId',
                    from_device='DEVICEIDXY',
                    method='m.sas.v1',
                    key_agreement_protocols=[
                        'curve25519-hkdf-sha256', 'curve25519'],
                    hashes=['sha256'],
                    message_authentication_codes=[
                        'hkdf-hmac-sha256', 'hmac-sha256'],
                    short_authentication_string=['decimal', 'emoji'])
                """

                if "emoji" not in event.short_authentication_string:
                    estr = ("Other device does not support emoji verification "
                            f"{event.short_authentication_string}. Aborting.")
                    print(estr)
                    logger.info(estr)
                    return
                resp = await client.accept_key_verification(
                    event.transaction_id)
                if isinstance(resp, ToDeviceError):
                    estr = f"accept_key_verification() failed with {resp}"
                    print(estr)
                    logger.info(estr)

                sas = client.key_verifications[event.transaction_id]

                todevice_msg = sas.share_key()
                resp = await client.to_device(todevice_msg)
                if isinstance(resp, ToDeviceError):
                    estr = f"to_device() failed with {resp}"
                    print(estr)
                    logger.info(estr)

            elif isinstance(event, KeyVerificationCancel):  # anytime
                """ at any time: receive KeyVerificationCancel
                KeyVerificationCancel(source={
                    'content': {'code': 'm.mismatched_sas',
                                'reason': 'Mismatched authentication string',
                                'transaction_id': 'SomeTxId'},
                    'type': 'm.key.verification.cancel',
                    'sender': '@user2:example.org'},
                    sender='@user2:example.org',
                    transaction_id='SomeTxId',
                    code='m.mismatched_sas',
                    reason='Mismatched short authentication string')
                """

                # There is no need to issue a
                # client.cancel_key_verification(tx_id, reject=False)
                # here. The SAS flow is already cancelled.
                # We only need to inform the user.
                estr = (f"Verification has been cancelled by {event.sender} "
                        f"for reason \"{event.reason}\".")
                print(estr)
                logger.info(estr)

            elif isinstance(event, KeyVerificationKey):  # second step
                """ Second step is to receive KeyVerificationKey
                KeyVerificationKey(
                    source={'content': {
                            'key': 'SomeCryptoKey',
                            'transaction_id': 'SomeTxId'},
                        'type': 'm.key.verification.key',
                        'sender': '@user2:example.org'
                    },
                    sender='@user2:example.org',
                    transaction_id='SomeTxId',
                    key='SomeCryptoKey')
                """
                sas = client.key_verifications[event.transaction_id]

                print(f"{sas.get_emoji()}")
                # don't log the emojis

                # The bot process must run in forground with a screen and
                # keyboard so that user can accept/reject via keyboard.
                # For emoji verification bot must not run as service or
                # in background.
                yn = input("Do the emojis match? (Y/N) (C for Cancel) ")
                if yn.lower() == "y":
                    estr = ("Match! The verification for this "
                            "device will be accepted.")
                    print(estr)
                    logger.info(estr)
                    resp = await client.confirm_short_auth_string(
                        event.transaction_id)
                    if isinstance(resp, ToDeviceError):
                        estr = ("confirm_short_auth_string() "
                                f"failed with {resp}")
                        print(estr)
                        logger.info(estr)
                elif yn.lower() == "n":  # no, don't match, reject
                    estr = ("No match! Device will NOT be verified "
                            "by rejecting verification.")
                    print(estr)
                    logger.info(estr)
                    resp = await client.cancel_key_verification(
                        event.transaction_id, reject=True)
                    if isinstance(resp, ToDeviceError):
                        estr = (f"cancel_key_verification failed with {resp}")
                        print(estr)
                        logger.info(estr)
                else:  # C or anything for cancel
                    estr = ("Cancelled by user! Verification will be "
                            "cancelled.")
                    print(estr)
                    logger.info(estr)
                    resp = await client.cancel_key_verification(
                        event.transaction_id, reject=False)
                    if isinstance(resp, ToDeviceError):
                        estr = (f"cancel_key_verification failed with {resp}")
                        print(estr)
                        logger.info(estr)

            elif isinstance(event, KeyVerificationMac):  # third step
                """ Third step is to receive KeyVerificationMac
                KeyVerificationMac(
                    source={'content': {
                        'mac': {'ed25519:DEVICEIDXY': 'SomeKey1',
                                'ed25519:SomeKey2': 'SomeKey3'},
                        'keys': 'SomeCryptoKey4',
                        'transaction_id': 'SomeTxId'},
                        'type': 'm.key.verification.mac',
                        'sender': '@user2:example.org'},
                    sender='@user2:example.org',
                    transaction_id='SomeTxId',
                    mac={'ed25519:DEVICEIDXY': 'SomeKey1',
                         'ed25519:SomeKey2': 'SomeKey3'},
                    keys='SomeCryptoKey4')
                """
                sas = client.key_verifications[event.transaction_id]
                try:
                    todevice_msg = sas.get_mac()
                except LocalProtocolError as e:
                    # e.g. it might have been cancelled by ourselves
                    estr = (f"Cancelled or protocol error: Reason: {e}.\n"
                            f"Verification with {event.sender} not concluded. "
                            "Try again?")
                    print(estr)
                    logger.info(estr)
                else:
                    resp = await client.to_device(todevice_msg)
                    if isinstance(resp, ToDeviceError):
                        estr = f"to_device failed with {resp}"
                        print(estr)
                        logger.info(estr)
                    estr = (f"sas.we_started_it = {sas.we_started_it}\n"
                            f"sas.sas_accepted = {sas.sas_accepted}\n"
                            f"sas.canceled = {sas.canceled}\n"
                            f"sas.timed_out = {sas.timed_out}\n"
                            f"sas.verified = {sas.verified}\n"
                            f"sas.verified_devices = {sas.verified_devices}\n")
                    print(estr)
                    logger.info(estr)
                    estr = ("Emoji verification was successful!\n"
                            "Initiate another Emoji verification from "
                            "another device or room if desired. "
                            "Or if done verifying, hit Control-C to stop the "
                            "bot in order to restart it as a service or to "
                            "run it in the background.")
                    print(estr)
                    logger.info(estr)
            else:
                estr = (f"Received unexpected event type {type(event)}. "
                        f"Event is {event}. Event will be ignored.")
                print(estr)
                logger.info(estr)
        except BaseException:
            estr = traceback.format_exc()
            print(estr)
            logger.info(estr)

    # !chat command
    async def chat(self, room_id, reply_to_event_id, prompt, sender_id, raw_user_message):
        await self.client.room_typing(room_id, timeout=180000)
        try:
            text = await asyncio.wait_for(self.chatbot.ask_async(prompt), timeout=180)
        except TimeoutError as e:
            logger.error("timeoutException", exc_info=True)
            text = "Timeout error"
        except Exception as e:
            logger.error("Error", exc_info=True)
            print(f"Error: {e}")

        text = text.strip()
        try:
            await send_room_message(self.client, room_id, reply_message=text,
                                reply_to_event_id=reply_to_event_id, sender_id=sender_id, user_message=raw_user_message)
        except Exception as e:
            logger.error(f"Error: {e}", exc_info=True)
        
    # !gpt command
    async def gpt(self, room_id, reply_to_event_id, prompt, sender_id, raw_user_message):
        try:
            # sending typing state
            await self.client.room_typing(room_id, timeout=180000)
            # timeout 120s
            text = await asyncio.wait_for(self.askgpt.oneTimeAsk(prompt, self.chatgpt_api_endpoint, self.headers), timeout=180)
        except TimeoutError:
            logger.error("timeoutException", exc_info=True)
            text = "Timeout error"

        text = text.strip()
        try:
            await send_room_message(self.client, room_id, reply_message=text,
                                    reply_to_event_id=reply_to_event_id, sender_id=sender_id, user_message=raw_user_message)
        except Exception as e:
            logger.error(f"Error: {e}", exc_info=True)

    # !bing command
    async def bing(self, room_id, reply_to_event_id, prompt, sender_id, raw_content_body):
        try:
            # sending typing state
            await self.client.room_typing(room_id, timeout=180000)
            # timeout 120s
            text = await asyncio.wait_for(self.bingbot.ask_bing(prompt), timeout=180)
        except TimeoutError:
            logger.error("timeoutException", exc_info=True)
            text = "Timeout error"
        text = text.strip()
        try:
            await send_room_message(self.client, room_id, reply_message=text,
                                    reply_to_event_id=reply_to_event_id, sender=sender_id, raw_content_body=raw_content_body)
        except Exception as e:
            logger.error(f"Error: {e}", exc_info=True)

    # !pic command
    async def pic(self, room_id, prompt):
        try:
            await self.client.room_typing(room_id, timeout=180000)
            # generate image
            generated_image_path = self.imageGen.save_images(
                self.imageGen.get_images(prompt),
                "images",
            )
            # send image
            if generated_image_path != "":
                await send_room_image(self.client, room_id, generated_image_path)
                await self.client.room_typing(room_id, bool=False)
        except Exception as e:
            logger.error(f"Error: {e}", exc_info=True)

    # !help command
    async def help(self, room_id):
        try:
            # sending typing state
            await self.client.room_typing(room_id)
            help_info = "!gpt [content], generate response without context conversation\n" + \
                        "!chat [content], chat with context conversation\n" + \
                        "!bing [content], chat with context conversation powered by Bing AI\n" + \
                        "!pic [prompt], Image generation by Microsoft Bing\n" + \
                        "!help, help message"

            await send_room_message(self.client, room_id, reply_message=help_info)
        except Exception as e:
            logger.error(f"Error: {e}", exc_info=True)

    # bot login
    async def login(self) -> None:
        try:
            resp = await self.client.login(password=self.password)
            if not isinstance(resp, LoginResponse):
                logger.error("Login Failed")
                print(f"Login Failed: {resp}")
                sys.exit(1)
        except Exception as e:
            logger.error(f"Error: {e}", exc_info=True)

    # sync messages in the room
    async def sync_forever(self, timeout=30000, full_state=True) -> None:
        
        await self.client.sync_forever(timeout=timeout, full_state=full_state)

    # Sync encryption keys with the server
    async def sync_encryption_key(self) -> None:
        if self.client.should_upload_keys:
            await self.client.keys_upload()

    # Trust own devices
    async def trust_own_devices(self) -> None:
        await self.client.sync(timeout=30000, full_state=True)
        for device_id, olm_device in self.client.device_store[
            self.user_id].items():
            logger.debug("My other devices are: "
                                 f"device_id={device_id}, "
                                 f"olm_device={olm_device}.")
            logger.info("Setting up trust for my own "
                                f"device {device_id} and session key "
                                f"{olm_device.keys['ed25519']}.")
            self.client.verify_device(olm_device)