# SPDX-License-Identifier: LGPL-3.0-or-later import asyncio import logging as log import sys import traceback from pathlib import Path from typing import Any, DefaultDict, Dict, List, Optional import nio from appdirs import AppDirs from . import __app_name__ from .errors import MatrixError from .matrix_client import MatrixClient from .media_cache import MediaCache from .models import SyncId from .models.items import Account from .models.model_store import ModelStore 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 details. 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 lines typed into QML components. models: A dict 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. The dict keys are the `Model`'s synchronization ID, which are in one of these form: - A `ModelItem` type, the type of item that this model stores; - A `(ModelItem, str...)` tuple. Currently used sync ID throughout the code are: - `Account`: logged-in accounts; - `(Room, "")`: rooms a `user_id` account is part of; - `(Upload, "")`: ongoing or failed file uploads for a `user_id` account; - `(Member, "", "")`: members in the room `room_id` that account `user_id` is part of; - `(Event, "", "")`: state events and messages in the room `room_id` that account `user_id` is part of. clients: A dict containing the logged `MatrixClient` objects we manage. Each client represents a logged-in account, identified by its `user_id`. media_cache: A matrix media cache for downloaded files. """ def __init__(self) -> None: self.appdirs = AppDirs(appname=__app_name__, roaming=True) self.saved_accounts: Accounts = Accounts(self) self.ui_settings: UISettings = UISettings(self) self.ui_state: UIState = UIState(self) self.history: History = History(self) self.models: ModelStore = ModelStore() self.clients: Dict[str, MatrixClient] = {} 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(self.appdirs.user_cache_dir) self.media_cache: MediaCache = MediaCache(self, cache_dir) def __repr__(self) -> str: return f"{type(self).__name__}(clients={self.clients!r})" # Clients management async def login_client(self, user: str, password: str, device_id: Optional[str] = None, homeserver: str = "https://matrix.org", ) -> str: """Create and register a `MatrixClient`, login and return a user ID.""" client = MatrixClient( self, user=user, homeserver=homeserver, device_id=device_id, ) try: await client.login(password) except MatrixError: await client.close() raise self.clients[client.user_id] = client self.models["accounts"][client.user_id] = Account(client.user_id) return client.user_id async def resume_client(self, user_id: str, token: str, device_id: str, homeserver: str = "https://matrix.org") -> None: """Create and register a `MatrixClient` with known account details.""" client = MatrixClient( backend=self, user=user_id, homeserver=homeserver, device_id=device_id, ) self.clients[user_id] = client self.models["accounts"][user_id] = Account(user_id) await client.resume(user_id=user_id, token=token, device_id=device_id) 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, str]) -> str: await self.resume_client( user_id = user_id, token = info["token"], device_id = info["device_id"], homeserver = info["homeserver"], ) return user_id return await asyncio.gather(*( resume(uid, info) for uid, info in (await self.saved_accounts.read()).items() )) 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) await client.logout() await self.saved_accounts.delete(user_id) 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.syncing: 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) -> nio.ProfileGetResponse: """Cache and return the matrix profile of `user_id`.""" if user_id in self.profile_cache: return self.profile_cache[user_id] async with self.get_profile_locks[user_id]: client = 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) # General functions 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() return (settings, ui_state, history, theme) async def await_model_item( self, model_id: SyncId, item_id: Any, ) -> Dict[str, Any]: if isinstance(model_id, list): # when called from QML model_id = tuple(model_id) failures = 0 while True: try: return self.models[model_id][item_id].serialized except KeyError: if failures and failures % 300 == 0: log.warn( "Item %r not found in model %r after %ds", item_id, model_id, failures / 10, ) await asyncio.sleep(0.1) failures += 1