# SPDX-License-Identifier: LGPL-3.0-or-later import asyncio import logging as log import os import re import sys import time import traceback from datetime import datetime from pathlib import Path from typing import Any, DefaultDict, Dict, List, Optional, Tuple from urllib.parse import urlparse import aiohttp from appdirs import AppDirs import nio from . import __app_name__ from .errors import MatrixError from .matrix_client import MatrixClient from .media_cache import MediaCache from .models import SyncId from .models.filters import FieldStringFilter from .models.items import Account, Event, Homeserver, PingStatus from .models.model import Model from .models.model_store import ModelStore from .presence import Presence from .sso_server import SSOServer from .user_files import Accounts, History, Theme, UISettings, UIState # Logging configuration log.getLogger().setLevel(log.INFO) nio.logger_group.level = nio.log.logbook.ERROR nio.log.logbook.StreamHandler(sys.stderr).push_application() class Backend: """Manage matrix clients and provide other useful general methods. Attributes: saved_accounts: User config file for saved matrix account. ui_settings: User config file for QML interface settings. ui_state: User data file for saving/restoring QML UI state. history: User data file for saving/restoring text typed into QML components. models: A mapping containing our data models that are synchronized between the Python backend and the QML UI. The models should only ever be modified from the backend. If a non-existent key is accessed, it is created and an associated `Model` and returned. The mapping keys are the `Model`'s synchronization ID, which a strings or tuple of strings. Currently used sync ID throughout the code are: - `"accounts"`: logged-in accounts; - `("", "rooms")`: rooms our account `user_id` is part of; - `("", "uploads")`: ongoing or failed file uploads for our account `user_id`; - `("", "", "members")`: members in the room `room_id` that our account `user_id` is part of; - `("", "", "events")`: state events and messages in the room `room_id` that our account `user_id` is part of. Special models: - `"all_rooms"`: See `models.special_models.AllRooms` docstring - `"matching_accounts"` See `models.special_models.MatchingAccounts` docstring - `("", "", "filtered_members")`: See `models.special_models.FilteredMembers` docstring - `("filtered_homeservers")`: See `models.special_models.FilteredHomeservers` docstring clients: A `{user_id: MatrixClient}` dict for the logged-in clients we managed. Every client is logged to one matrix account. media_cache: A matrix media cache for downloaded files. presences: A `{user_id: Presence}` dict for storing presence info about matrix users registered on Mirage. mxc_events: A dict storing media `Event` model items for any account that have the same mxc URI """ def __init__(self) -> None: self.appdirs = AppDirs(appname=__app_name__, roaming=True) self.saved_accounts = Accounts(self) self.ui_settings = UISettings(self) self.ui_state = UIState(self) self.history = History(self) self.models = ModelStore() self.clients: Dict[str, MatrixClient] = {} self._sso_server: Optional[SSOServer] = None self._sso_server_task: Optional[asyncio.Future] = None self._ping_tasks: Dict[str, asyncio.Future] = {} self._stability_tasks: Dict[str, asyncio.Future] = {} self.profile_cache: Dict[str, nio.ProfileGetResponse] = {} self.get_profile_locks: DefaultDict[str, asyncio.Lock] = \ DefaultDict(asyncio.Lock) # {user_id: lock} self.send_locks: DefaultDict[str, asyncio.Lock] = \ DefaultDict(asyncio.Lock) # {room_id: lock} cache_dir = Path( os.environ.get("MIRAGE_CACHE_DIR") or self.appdirs.user_cache_dir, ) self.media_cache: MediaCache = MediaCache(self, cache_dir) self.presences: Dict[str, Presence] = {} self.concurrent_get_presence_limit = asyncio.BoundedSemaphore(8) self.mxc_events: DefaultDict[str, List[Event]] = DefaultDict(list) def __repr__(self) -> str: return f"{type(self).__name__}(clients={self.clients!r})" # Clients management async def server_info(self, homeserver: str) -> Tuple[str, List[str]]: """Return server's real URL and supported login flows. Retrieving the real URL uses the `.well-known` API. Possible login methods include `m.login.password` or `m.login.sso`. """ if not re.match(r"https?://", homeserver): homeserver = f"http://{homeserver}" client = MatrixClient(self, homeserver=homeserver) http_re = re.compile("^http://") is_local = urlparse(client.homeserver).netloc.split(":")[0] in ( "localhost", "127.0.0.1", "::1", ) try: client.homeserver = (await client.discovery_info()).homeserver_url except MatrixError: # This is either already the real URL, or an invalid URL. pass try: try: login_response = await client.login_info() except (asyncio.TimeoutError, MatrixError): # Maybe we still have a http URL and server only supports https client.homeserver = http_re.sub("https://", client.homeserver) login_response = await client.login_info() # If we still have a http URL and server redirected to https if login_response.transport_response.real_url.scheme == "https": client.homeserver = http_re.sub("https://", client.homeserver) # If we still have a http URL and server accept both http and https if http_re.match(client.homeserver) and not is_local: original = client.homeserver client.homeserver = http_re.sub("https://", client.homeserver) try: await asyncio.wait_for(client.login_info(), timeout=6) except (asyncio.TimeoutError, MatrixError): client.homeserver = original return (client.homeserver, login_response.flows) finally: await client.close() async def password_auth( self, user: str, password: str, homeserver: str, ) -> str: """Create & register a `MatrixClient`, login using the password and return the user ID we get. """ client = MatrixClient(self, user=user, homeserver=homeserver) return await self._do_login(client, password=password) async def start_sso_auth(self, homeserver: str) -> str: """Start SSO server and return URL to open in the user's browser. See the `sso_server.SSOServer` class documentation. Once the returned URL has been opened in the user's browser (done from QML), `MatrixClient.continue_sso_auth()` should be called. """ server = SSOServer(homeserver) self._sso_server = server self._sso_server_task = asyncio.ensure_future(server.wait_for_token()) return server.url_to_open async def continue_sso_auth(self) -> str: """Wait for the started SSO server to get a token, then login. `MatrixClient.start_sso_auth()` must be called first. Creates and register a `MatrixClient` for logging in. Returns the user ID we get from logging in. """ if not self._sso_server or not self._sso_server_task: raise RuntimeError("Must call Backend.start_sso_auth() first") await self._sso_server_task homeserver = self._sso_server.for_homeserver token = self._sso_server_task.result() self._sso_server_task = None self._sso_server = None client = MatrixClient(self, homeserver=homeserver) return await self._do_login(client, token=token) async def _do_login(self, client: MatrixClient, **login_kwargs) -> str: """Login on a client. If successful, register it and return user ID.""" try: await client.login(**login_kwargs) except MatrixError: await client.close() raise if client.user_id in self.clients: await client.logout() return client.user_id self.clients[client.user_id] = client return client.user_id async def resume_client( self, user_id: str, token: str, device_id: str, homeserver: str, state: str = "online", status_msg: str = "", ) -> None: """Create and register a `MatrixClient` with known account details.""" client = MatrixClient( self, user=user_id, homeserver=homeserver, device_id=device_id, ) self.clients[user_id] = client await client.resume(user_id, token, device_id, state, status_msg) async def load_saved_accounts(self) -> List[str]: """Call `resume_client` for all saved accounts in user config.""" async def resume(user_id: str, info: Dict[str, Any]) -> str: # Get or create account model self.models["accounts"].setdefault( user_id, Account(user_id, info.get("order", -1)), ) await self.resume_client( user_id = user_id, token = info["token"], device_id = info["device_id"], homeserver = info["homeserver"], state = info.get("presence", "online"), status_msg = info.get("status_msg", ""), ) return user_id return await asyncio.gather(*( resume(uid, info) for uid, info in (await self.saved_accounts.read()).items() if info.get("enabled", True) )) async def logout_client(self, user_id: str) -> None: """Log a `MatrixClient` out and unregister it from our models.""" client = self.clients.pop(user_id, None) if client: self.models["accounts"].pop(user_id, None) self.models["matching_accounts"].pop(user_id, None) self.models[user_id, "uploads"].clear() for room_id in self.models[user_id, "rooms"]: self.models["all_rooms"].pop(room_id, None) self.models[user_id, room_id, "members"].clear() self.models[user_id, room_id, "events"].clear() self.models[user_id, room_id, "filtered_members"].clear() self.models[user_id, "rooms"].clear() await client.logout() await self.saved_accounts.delete(user_id) async def terminate_clients(self) -> None: """Call every `MatrixClient`'s `terminate()` method.""" log.info("Setting clients offline...") tasks = [client.terminate() for client in self.clients.values()] await asyncio.gather(*tasks) async def get_client(self, user_id: str) -> MatrixClient: """Wait until a `MatrixClient` is registered in model and return it.""" failures = 0 while True: if user_id in self.clients: return self.clients[user_id] if failures and failures % 100 == 0: # every 10s except first time log.warning( "Client %r not found after %ds, stack trace:\n%s", user_id, failures / 10, traceback.format_stack(), ) await asyncio.sleep(0.1) failures += 1 async def get_any_client(self) -> MatrixClient: """Return any healthy syncing `MatrixClient` registered in model.""" failures = 0 while True: for client in self.clients.values(): if client.healthy: return client if failures and failures % 300 == 0: log.warn( "No healthy client found after %ds, stack trace:\n%s", failures / 10, traceback.format_stack(), ) await asyncio.sleep(0.1) failures += 1 # Client functions that don't need authentification async def get_profile( self, user_id: str, use_cache: bool = True, ) -> nio.ProfileGetResponse: """Cache and return the matrix profile of `user_id`.""" async with self.get_profile_locks[user_id]: if use_cache and user_id in self.profile_cache: return self.profile_cache[user_id] client = self.clients.get(user_id) or await self.get_any_client() response = await client.get_profile(user_id) self.profile_cache[user_id] = response return response async def thumbnail( self, server_name: str, media_id: str, width: int, height: int, ) -> nio.ThumbnailResponse: """Return thumbnail for a matrix media.""" args = (server_name, media_id, width, height) client = await self.get_any_client() return await client.thumbnail(*args) async def download( self, server_name: str, media_id: str, ) -> nio.DownloadResponse: """Return the content of a matrix media.""" client = await self.get_any_client() return await client.download(server_name, media_id) async def update_room_read_marker( self, room_id: str, event_id: str, ) -> None: """Update room's read marker to an event for all accounts part of it. """ async def update(client: MatrixClient) -> None: room = self.models[client.user_id, "rooms"].get(room_id) account = self.models["accounts"][client.user_id] if room: room.set_fields( unreads = 0, highlights = 0, local_unreads = False, local_highlights = False, ) await client.update_account_unread_counts() # Only update server markers if the account is not invisible if account.presence != Presence.State.invisible: await client.update_receipt_marker(room_id, event_id) await asyncio.gather(*[update(c) for c in self.clients.values()]) # General functions async def get_config_dir(self) -> Path: return Path(self.appdirs.user_config_dir) async def load_settings(self) -> tuple: """Return parsed user config files.""" settings = await self.ui_settings.read() ui_state = await self.ui_state.read() history = await self.history.read() theme = await Theme(self, settings["theme"]).read() state_data = self.ui_state._data if state_data: for user, collapse in state_data["collapseAccounts"].items(): self.models["all_rooms"].set_account_collapse(user, collapse) return (settings, ui_state, history, theme) async def set_string_filter(self, model_id: SyncId, value: str) -> None: """Set a FieldStringFilter (or derived class) model's filter property. This should only be called from QML. """ if isinstance(model_id, list): # QML can't pass tuples model_id = tuple(model_id) model = Model.proxies[model_id] if not isinstance(model, FieldStringFilter): raise TypeError("model_id must point to a FieldStringFilter") model.filter = value async def set_account_collapse(self, user_id: str, collapse: bool) -> None: """Call `set_account_collapse()` on the `all_rooms` model. This should only be called from QML. """ self.models["all_rooms"].set_account_collapse(user_id, collapse) async def verify_device( self, user_id: str, device_id: str, ed25519_key: str, ) -> None: """Mark a device as verified on all our accounts.""" for client in self.clients.values(): try: device = client.device_store[user_id][device_id] except KeyError: continue if device.ed25519 == ed25519_key: client.verify_device(device) async def blacklist_device( self, user_id: str, device_id: str, ed25519_key: str, ) -> None: """Mark a device as blacklisted on all our accounts.""" for client in self.clients.values(): try: # This won't include the client's current device, as expected device = client.device_store[user_id][device_id] except KeyError: continue if device.ed25519 == ed25519_key: client.blacklist_device(device) async def _ping_homeserver( self, session: aiohttp.ClientSession, homeserver_url: str, ) -> None: """Ping a homeserver present in our model and set its `ping` field.""" item = self.models["homeservers"][homeserver_url] times = [] for i in range(16): start = time.time() try: await session.get(f"{homeserver_url}/_matrix/client/versions") except Exception as err: log.warning("Failed pinging %s: %r", homeserver_url, err) item.status = PingStatus.Failed return times.append(round((time.time() - start) * 1000)) if i == 7 or i == 15: item.set_fields( ping=sum(times) // len(times), status=PingStatus.Done, ) async def _get_homeserver_stability( self, session: aiohttp.ClientSession, homeserver_url: str, uptimerobot_id: int, ) -> None: api = "https://matrixservers.anchel.nl/api/getMonitor/wkMJmFGvo2?m={}" response = await session.get(api.format(uptimerobot_id)) logs = (await response.json())["monitor"]["logs"] stability = 100.0 for period in logs: started_at = datetime.fromtimestamp(period["time"]) time_since_now = datetime.now() - started_at if time_since_now.days > 30 or period["class"] != "danger": continue lasted_hours, lasted_mins = [ int(x.split()[0]) for x in period["duration"].split(", ") ] lasted_mins += lasted_hours * 60 stability -= ( (lasted_mins * stability / 1000) / max(1, time_since_now.days / 3) ) self.models["homeservers"][homeserver_url].stability = stability async def _add_homeserver_item( self, session: aiohttp.ClientSession, homeserver_url: str, uptimerobot_id: int, **fields, ) -> Homeserver: """Add homeserver to our model & start info-gathering tasks.""" if not re.match(r"^https?://.+", homeserver_url): homeserver_url = f"https://{homeserver_url}" if fields.get("country") == "USA": fields["country"] = "United States" if homeserver_url in self._ping_tasks: self._ping_tasks[homeserver_url].cancel() if homeserver_url in self._stability_tasks: self._stability_tasks[homeserver_url].cancel() item = Homeserver(id=homeserver_url, **fields) self.models["homeservers"][homeserver_url] = item self._ping_tasks[homeserver_url] = asyncio.ensure_future( self._ping_homeserver(session, homeserver_url), ) self._stability_tasks[homeserver_url] = asyncio.ensure_future( self._get_homeserver_stability( session, item.id, uptimerobot_id, ), ) return item async def fetch_homeservers(self) -> None: """Retrieve a list of public homeservers and add them to our model.""" api_list = "https://publiclist.anchel.nl/staticlist.json" tmout = aiohttp.ClientTimeout(total=20) session = aiohttp.ClientSession(raise_for_status=True, timeout=tmout) response = await session.get(api_list) data = (await response.json())["staticlist"] # Missing from the anchel.nl public list await self._add_homeserver_item( session = session, homeserver_url = "https://matrix-client.matrix.org", name = "matrix.org", site_url = "https://matrix.org", country = "Cloudflare", uptimerobot_id = 783115140, ) for server in data: if server["homeserver"].startswith("http://"): # insecure server continue await self._add_homeserver_item( session = session, homeserver_url = server["homeserver"], name = server["name"], site_url = server["url"], country = server["country"], uptimerobot_id = server["uptrid"], )