# mautrix-signal - A Matrix-Signal puppeting bridge # Copyright (C) 2020 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 . from typing import Any, Dict from random import uniform import asyncio import logging from mautrix.bridge import Bridge from mautrix.types import RoomID, UserID from . import commands from .config import Config from .db import init as init_db, upgrade_table from .matrix import MatrixHandler from .portal import Portal from .puppet import Puppet from .signal import SignalHandler from .user import User from .version import linkified_version, version from .web import ProvisioningAPI SYNC_JITTER = 10 class SignalBridge(Bridge): module = "mautrix_signal" name = "mautrix-signal" command = "python -m mautrix-signal" description = "A Matrix-Signal puppeting bridge." repo_url = "https://github.com/mautrix/signal" version = version markdown_version = linkified_version config_class = Config matrix_class = MatrixHandler upgrade_table = upgrade_table matrix: MatrixHandler signal: SignalHandler config: Config provisioning_api: ProvisioningAPI periodic_sync_task: asyncio.Task def prepare_db(self) -> None: super().prepare_db() init_db(self.db) def prepare_bridge(self) -> None: self.signal = SignalHandler(self) super().prepare_bridge() cfg = self.config["bridge.provisioning"] self.provisioning_api = ProvisioningAPI( self, cfg["shared_secret"], cfg["segment_key"], cfg["segment_user_id"] ) self.az.app.add_subapp(cfg["prefix"], self.provisioning_api.app) async def start(self) -> None: User.init_cls(self) self.add_startup_actions(Puppet.init_cls(self)) Portal.init_cls(self) self.add_startup_actions(Portal.restart_scheduled_disappearing()) if self.config["bridge.resend_bridge_info"]: self.add_startup_actions(self.resend_bridge_info()) self.add_startup_actions(self.signal.start()) await super().start() self.periodic_sync_task = asyncio.create_task(self._periodic_sync_loop()) async def _actual_periodic_sync_loop(self, log: logging.Logger, interval: int) -> None: n = 0 hacky_daily_resync = self.config["bridge.hacky_contact_name_mixup_detection"] while True: n += 1 try: await asyncio.sleep(interval) except asyncio.CancelledError: return log.info("Executing periodic syncs") for user in User.by_username.values(): # Add some randomness to the sync to avoid a thundering herd await asyncio.sleep(uniform(0, SYNC_JITTER)) try: await user.sync(is_startup=hacky_daily_resync and n % 24 == 23) except asyncio.CancelledError: return except Exception: log.exception("Error while syncing %s", user.mxid) async def _periodic_sync_loop(self) -> None: log = logging.getLogger("mau.periodic_sync") interval = self.config["bridge.periodic_sync"] if interval <= 0: log.debug("Periodic sync is not enabled") return log.debug("Starting periodic sync loop") try: await self._actual_periodic_sync_loop(log, interval) except Exception: log.fatal("Error in periodic resync", exc_info=True) log.debug("Periodic sync stopped") def prepare_stop(self) -> None: self.add_shutdown_actions(self.signal.stop()) for puppet in Puppet.by_custom_mxid.values(): puppet.stop() async def resend_bridge_info(self) -> None: self.config["bridge.resend_bridge_info"] = False self.config.save() self.log.info("Re-sending bridge info state event to all portals") async for portal in Portal.all_with_room(): await portal.update_bridge_info() self.log.info("Finished re-sending bridge info state events") async def get_user(self, user_id: UserID, create: bool = True) -> User: return await User.get_by_mxid(user_id, create=create) async def get_portal(self, room_id: RoomID) -> Portal: return await Portal.get_by_mxid(room_id) async def get_puppet(self, user_id: UserID, create: bool = False) -> Puppet: return await Puppet.get_by_mxid(user_id, create=create) async def get_double_puppet(self, user_id: UserID) -> Puppet: return await Puppet.get_by_custom_mxid(user_id) def is_bridge_ghost(self, user_id: UserID) -> bool: return bool(Puppet.get_id_from_mxid(user_id)) async def count_logged_in_users(self) -> int: return len([user for user in User.by_username.values() if user.username]) async def manhole_global_namespace(self, user_id: UserID) -> Dict[str, Any]: return { **await super().manhole_global_namespace(user_id), "User": User, "Portal": Portal, "Puppet": Puppet, } SignalBridge().run()