2020-09-24 09:57:54 +10:00
|
|
|
# Copyright Mirage authors & contributors <https://github.com/mirukana/mirage>
|
2019-12-19 22:46:16 +11:00
|
|
|
# SPDX-License-Identifier: LGPL-3.0-or-later
|
|
|
|
|
2019-12-18 23:41:02 +11:00
|
|
|
"""User data and configuration files definitions."""
|
|
|
|
|
2019-07-19 10:30:41 +10:00
|
|
|
import asyncio
|
|
|
|
import json
|
2020-03-28 23:01:26 +11:00
|
|
|
import os
|
2020-04-01 20:08:08 +11:00
|
|
|
import platform
|
2020-10-05 18:06:07 +11:00
|
|
|
from collections.abc import MutableMapping
|
2019-09-11 07:28:16 +10:00
|
|
|
from dataclasses import dataclass, field
|
2019-07-19 10:30:41 +10:00
|
|
|
from pathlib import Path
|
2020-10-05 18:06:07 +11:00
|
|
|
from typing import TYPE_CHECKING, Any, ClassVar, Iterator, Optional, Tuple
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
import aiofiles
|
2020-10-05 18:06:07 +11:00
|
|
|
from watchgod import Change, awatch
|
2019-07-19 10:30:41 +10:00
|
|
|
|
2020-03-15 08:33:13 +11:00
|
|
|
import pyotherside
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
from .pyotherside_events import UserFileChanged
|
2019-07-23 17:14:02 +10:00
|
|
|
from .theme_parser import convert_to_qml
|
2020-03-13 19:35:51 +11:00
|
|
|
from .utils import atomic_write, dict_update_recursive
|
2019-07-19 10:30:41 +10:00
|
|
|
|
2020-02-12 07:22:05 +11:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from .backend import Backend
|
|
|
|
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class UserFile:
|
|
|
|
"""Base class representing a user config or data file."""
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2020-02-15 03:21:24 +11:00
|
|
|
create_missing: ClassVar[bool] = True
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2020-02-12 07:22:05 +11:00
|
|
|
backend: "Backend" = field(repr=False)
|
|
|
|
filename: str = field()
|
2019-07-19 10:30:41 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
data: Any = field(init=False, default_factory=dict)
|
|
|
|
_need_write: bool = field(init=False, default=False)
|
|
|
|
_wrote: bool = field(init=False, default=False)
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
_reader: Optional[asyncio.Future] = field(init=False, default=None)
|
|
|
|
_writer: Optional[asyncio.Future] = field(init=False, default=None)
|
2019-12-11 08:59:04 +11:00
|
|
|
|
|
|
|
def __post_init__(self) -> None:
|
2020-10-05 18:06:07 +11:00
|
|
|
try:
|
|
|
|
self.data, save = self.deserialized(self.path.read_text())
|
|
|
|
except FileNotFoundError:
|
|
|
|
self.data = self.default_data
|
|
|
|
self._need_write = self.create_missing
|
|
|
|
else:
|
|
|
|
if save:
|
|
|
|
self.save()
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
self._reader = asyncio.ensure_future(self._start_reader())
|
|
|
|
self._writer = asyncio.ensure_future(self._start_writer())
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2019-07-19 10:30:41 +10:00
|
|
|
@property
|
|
|
|
def path(self) -> Path:
|
2020-10-05 18:06:07 +11:00
|
|
|
"""Full path of the file, can exist or not exist."""
|
|
|
|
raise NotImplementedError()
|
2020-03-28 23:01:26 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def default_data(self) -> Any:
|
|
|
|
"""Default deserialized content to use if the file doesn't exist."""
|
|
|
|
raise NotImplementedError()
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def deserialized(self, data: str) -> Tuple[Any, bool]:
|
|
|
|
"""Return parsed data from file text and whether to call `save()`."""
|
|
|
|
return (data, False)
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def serialized(self) -> str:
|
|
|
|
"""Return text from `UserFile.data` that can be written to disk."""
|
|
|
|
raise NotImplementedError()
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def save(self) -> None:
|
|
|
|
"""Inform the disk writer coroutine that the data has changed."""
|
|
|
|
self._need_write = True
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async def set_data(self, data: Any) -> None:
|
|
|
|
"""Set `data` and call `save()`, conveniance method for QML."""
|
|
|
|
self.data = data
|
|
|
|
self.save()
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async def _start_reader(self) -> None:
|
|
|
|
"""Disk reader coroutine, watches for file changes to update `data`."""
|
2020-07-24 15:01:37 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
while not self.path.exists():
|
|
|
|
await asyncio.sleep(1)
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async for changes in awatch(self.path):
|
|
|
|
ignored = 0
|
2020-02-15 03:21:24 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
for change in changes:
|
|
|
|
if change[0] in (Change.added, Change.modified):
|
|
|
|
if self._need_write or self._wrote:
|
|
|
|
self._wrote = False
|
|
|
|
ignored += 1
|
|
|
|
continue
|
2020-02-15 03:21:24 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async with aiofiles.open(self.path) as file:
|
|
|
|
self.data, save = self.deserialized(await file.read())
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
if save:
|
|
|
|
self.save()
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
elif change[0] == Change.deleted:
|
|
|
|
self._wrote = False
|
|
|
|
self.data = self.default_data
|
|
|
|
self._need_write = self.create_missing
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
if changes and ignored < len(changes):
|
|
|
|
UserFileChanged(type(self), self.data)
|
2019-12-11 08:59:04 +11:00
|
|
|
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async def _start_writer(self) -> None:
|
|
|
|
"""Disk writer coroutine, update the file with a 1 second cooldown."""
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2019-12-11 08:59:04 +11:00
|
|
|
self.path.parent.mkdir(parents=True, exist_ok=True)
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2019-12-11 08:59:04 +11:00
|
|
|
while True:
|
2020-02-15 03:21:24 +11:00
|
|
|
await asyncio.sleep(1)
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
if self._need_write:
|
|
|
|
async with atomic_write(self.path) as (new, done):
|
|
|
|
await new.write(self.serialized())
|
|
|
|
done()
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
self._need_write = False
|
|
|
|
self._wrote = True
|
2020-02-15 03:21:24 +11:00
|
|
|
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@dataclass
|
|
|
|
class ConfigFile(UserFile):
|
|
|
|
"""A file that goes in the configuration directory, e.g. ~/.config/app."""
|
2019-07-19 10:30:41 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def path(self) -> Path:
|
|
|
|
return Path(
|
|
|
|
os.environ.get("MIRAGE_CONFIG_DIR") or
|
|
|
|
self.backend.appdirs.user_config_dir,
|
|
|
|
) / self.filename
|
2019-07-19 10:30:41 +10:00
|
|
|
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2019-07-19 10:30:41 +10:00
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class UserDataFile(UserFile):
|
|
|
|
"""A file that goes in the user data directory, e.g. ~/.local/share/app."""
|
2020-03-23 03:01:22 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def path(self) -> Path:
|
|
|
|
return Path(
|
|
|
|
os.environ.get("MIRAGE_DATA_DIR") or
|
|
|
|
self.backend.appdirs.user_data_dir,
|
|
|
|
) / self.filename
|
2020-03-23 03:01:22 +11:00
|
|
|
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@dataclass
|
|
|
|
class MappingFile(MutableMapping, UserFile):
|
|
|
|
"""A file manipulable like a dict. `data` must be a mutable mapping."""
|
|
|
|
def __getitem__(self, key: Any) -> Any:
|
|
|
|
return self.data[key]
|
2020-03-23 03:01:22 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def __setitem__(self, key: Any, value: Any) -> None:
|
|
|
|
self.data[key] = value
|
2020-03-23 03:01:22 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def __delitem__(self, key: Any) -> None:
|
|
|
|
del self.data[key]
|
2019-07-19 11:58:21 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def __iter__(self) -> Iterator:
|
|
|
|
return iter(self.data)
|
2019-07-19 11:58:21 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def __len__(self) -> int:
|
|
|
|
return len(self.data)
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2020-02-15 03:21:24 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@dataclass
|
|
|
|
class JSONFile(MappingFile):
|
|
|
|
"""A file stored on disk in the JSON format."""
|
2020-02-15 03:21:24 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def default_data(self) -> dict:
|
|
|
|
return {}
|
2020-07-24 15:01:37 +10:00
|
|
|
|
2020-02-15 03:21:24 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def deserialized(self, data: str) -> Tuple[dict, bool]:
|
|
|
|
"""Return parsed data from file text and whether to call `save()`.
|
2019-07-21 23:24:11 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
If the file has missing keys, the missing data will be merged to the
|
|
|
|
returned dict and the second tuple item will be `True`.
|
|
|
|
"""
|
2019-08-17 05:12:14 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
try:
|
|
|
|
loaded = json.loads(data)
|
|
|
|
except json.JSONDecodeError:
|
|
|
|
loaded = {}
|
2019-08-17 05:12:14 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
all_data = self.default_data.copy()
|
|
|
|
dict_update_recursive(all_data, loaded)
|
|
|
|
return (all_data, loaded != all_data)
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def serialized(self) -> str:
|
|
|
|
data = self.data
|
|
|
|
return json.dumps(data, indent=4, ensure_ascii=False, sort_keys=True)
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class Accounts(ConfigFile, JSONFile):
|
|
|
|
"""Config file for saved matrix accounts: user ID, access tokens, etc"""
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2019-07-19 10:30:41 +10:00
|
|
|
filename: str = "accounts.json"
|
|
|
|
|
|
|
|
async def any_saved(self) -> bool:
|
2020-10-05 18:06:07 +11:00
|
|
|
"""Return for QML whether there are any accounts saved on disk."""
|
|
|
|
return bool(self.data)
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
|
|
|
|
async def add(self, user_id: str) -> None:
|
2019-12-18 23:41:02 +11:00
|
|
|
"""Add an account to the config and write it on disk.
|
|
|
|
|
|
|
|
The account's details such as its access token are retrieved from
|
|
|
|
the corresponding `MatrixClient` in `backend.clients`.
|
|
|
|
"""
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
client = self.backend.clients[user_id]
|
|
|
|
account = self.backend.models["accounts"][user_id]
|
2019-07-19 10:30:41 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
self.update({
|
2019-07-19 10:30:41 +10:00
|
|
|
client.user_id: {
|
|
|
|
"homeserver": client.homeserver,
|
|
|
|
"token": client.access_token,
|
|
|
|
"device_id": client.device_id,
|
2020-04-06 05:04:40 +10:00
|
|
|
"enabled": True,
|
2020-07-10 06:06:14 +10:00
|
|
|
"presence": account.presence.value,
|
2020-07-17 06:09:14 +10:00
|
|
|
"status_msg": account.status_msg,
|
2020-07-11 00:59:26 +10:00
|
|
|
"order": account.order,
|
Big performance refactoring & various improvements
Instead of passing all sorts of events for the JS to handle and manually
add to different data models, we now handle everything we can in Python.
For any change, the python models send a sync event with their
contents (no more than 4 times per second) to JS, and the QSyncable
library's JsonListModel takes care of converting it to a QML ListModel
and sending the appropriate signals.
The SortFilterProxyModel library is not used anymore, the only case
where we need to filter/sort something now is when the user interacts
with the "Filter rooms" or "Filter members" fields. These cases are
handled by a simple JS function.
We now keep separated room and timeline models for different accounts,
the previous approach of sharing all the data we could between accounts
created a lot of complications (local echoes, decrypted messages
replacing others, etc).
The users's own account profile changes are now hidden in the timeline.
On startup, if all events for a room were only own profile changes, more
events will be loaded.
Any kind of image format supported by Qt is now handled by the
pyotherside image provider, instead of just PNG/JPG.
SVGs which previously caused errors are supported as well.
The typing members bar paddings/margins are fixed.
The behavior of the avatar/"upload a profile picture" overlay is fixed.
Config files read from disk are now cached (TODO: make them reloadable
again).
Pylint is not used anymore because of all its annoying false warnings
and lack of understanding for dataclasses, it is replaced by flake8 with
a custom config and various plugins.
Debug mode is now considered on if the program was compiled with
the right option, instead of taking an argument from CLI.
When on, C++ will set a flag in the Window QML component.
The loading screen is now unloaded after the UI is ready, where
previously it just stayed in the background invisible and wasted CPU.
The overall refactoring and improvements make us now able to handle
rooms with thousand of members and no lazy-loading, where previously
everything would freeze and simply scrolling up to load past events
in any room would block the UI for a few seconds.
2019-08-11 22:01:22 +10:00
|
|
|
},
|
2019-07-19 10:30:41 +10:00
|
|
|
})
|
2020-10-05 18:06:07 +11:00
|
|
|
self.save()
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async def set(
|
2020-07-10 06:06:14 +10:00
|
|
|
self,
|
2020-07-17 06:09:14 +10:00
|
|
|
user_id: str,
|
|
|
|
enabled: Optional[str] = None,
|
|
|
|
presence: Optional[str] = None,
|
|
|
|
order: Optional[int] = None,
|
|
|
|
status_msg: Optional[str] = None,
|
2020-07-10 06:06:14 +10:00
|
|
|
) -> None:
|
2020-07-12 07:11:04 +10:00
|
|
|
"""Update an account if found in the config file and write to disk."""
|
2020-07-10 06:06:14 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
if user_id not in self:
|
2020-07-12 07:11:04 +10:00
|
|
|
return
|
|
|
|
|
2020-07-12 04:36:30 +10:00
|
|
|
if enabled is not None:
|
2020-10-05 18:06:07 +11:00
|
|
|
self[user_id]["enabled"] = enabled
|
2020-07-12 04:36:30 +10:00
|
|
|
|
|
|
|
if presence is not None:
|
2020-10-05 18:06:07 +11:00
|
|
|
self[user_id]["presence"] = presence
|
2020-07-12 04:36:30 +10:00
|
|
|
|
|
|
|
if order is not None:
|
2020-10-05 18:06:07 +11:00
|
|
|
self[user_id]["order"] = order
|
2020-07-10 06:06:14 +10:00
|
|
|
|
2020-07-17 06:09:14 +10:00
|
|
|
if status_msg is not None:
|
2020-10-05 18:06:07 +11:00
|
|
|
self[user_id]["status_msg"] = status_msg
|
2020-07-17 06:09:14 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
self.save()
|
2020-07-10 06:06:14 +10:00
|
|
|
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
async def forget(self, user_id: str) -> None:
|
2019-12-18 23:41:02 +11:00
|
|
|
"""Delete an account from the config and write it on disk."""
|
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
self.pop(user_id, None)
|
|
|
|
self.save()
|
2019-07-19 10:30:41 +10:00
|
|
|
|
|
|
|
|
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class Settings(ConfigFile, JSONFile):
|
|
|
|
"""General config file for UI and backend settings"""
|
2019-12-18 23:41:02 +11:00
|
|
|
|
2019-07-25 10:02:31 +10:00
|
|
|
filename: str = "settings.json"
|
2019-07-19 11:58:21 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def default_data(self) -> dict:
|
2020-05-14 16:48:48 +10:00
|
|
|
def ctrl_or_osx_ctrl() -> str:
|
|
|
|
# Meta in Qt corresponds to Ctrl on OSX
|
|
|
|
return "Meta" if platform.system() == "Darwin" else "Ctrl"
|
|
|
|
|
2020-04-01 20:08:08 +11:00
|
|
|
def alt_or_cmd() -> str:
|
|
|
|
# Ctrl in Qt corresponds to Cmd on OSX
|
|
|
|
return "Ctrl" if platform.system() == "Darwin" else "Alt"
|
|
|
|
|
2019-07-19 11:58:21 +10:00
|
|
|
return {
|
2020-06-03 11:42:16 +10:00
|
|
|
"alertOnMentionForMsec": -1,
|
|
|
|
"alertOnMessageForMsec": 0,
|
2020-03-18 07:39:29 +11:00
|
|
|
"alwaysCenterRoomHeader": False,
|
2020-08-21 23:27:21 +10:00
|
|
|
# "autoHideScrollBarsAfterMsec": 2000,
|
2020-07-11 14:51:53 +10:00
|
|
|
"beUnavailableAfterSecondsIdle": 60 * 10,
|
2020-09-15 02:02:28 +10:00
|
|
|
"centerRoomListOnClick": False,
|
2020-03-29 02:04:43 +11:00
|
|
|
"compactMode": False,
|
2019-09-08 06:39:14 +10:00
|
|
|
"clearRoomFilterOnEnter": True,
|
2019-09-08 06:46:30 +10:00
|
|
|
"clearRoomFilterOnEscape": True,
|
2020-05-14 16:24:28 +10:00
|
|
|
"clearMemberFilterOnEscape": True,
|
2020-09-05 04:31:17 +10:00
|
|
|
"closeMinimizesToTray": False,
|
2020-05-21 14:42:23 +10:00
|
|
|
"collapseSidePanesUnderWindowWidth": 450,
|
2020-05-21 12:03:36 +10:00
|
|
|
"enableKineticScrolling": True,
|
2020-03-23 03:04:43 +11:00
|
|
|
"hideProfileChangeEvents": True,
|
|
|
|
"hideMembershipEvents": False,
|
2020-05-21 01:49:25 +10:00
|
|
|
"hideUnknownEvents": True,
|
2020-06-27 22:56:50 +10:00
|
|
|
"kineticScrollingMaxSpeed": 2500,
|
2020-07-14 19:46:48 +10:00
|
|
|
"kineticScrollingDeceleration": 1500,
|
2020-09-02 04:42:08 +10:00
|
|
|
"lexicalRoomSorting": False,
|
2020-06-02 08:57:17 +10:00
|
|
|
"markRoomReadMsecDelay": 200,
|
2020-05-17 04:28:29 +10:00
|
|
|
"maxMessageCharactersPerLine": 65,
|
2020-09-24 13:22:28 +10:00
|
|
|
"nonKineticScrollingSpeed": 1.0,
|
2020-05-17 04:36:00 +10:00
|
|
|
"ownMessagesOnLeftAboveWidth": 895,
|
2020-03-11 00:48:51 +11:00
|
|
|
"theme": "Midnight.qpl",
|
2019-07-23 17:14:02 +10:00
|
|
|
"writeAliases": {},
|
2020-09-02 04:19:40 +10:00
|
|
|
"zoom": 1.0,
|
2020-10-17 08:36:59 +11:00
|
|
|
"roomBookmarkIDs": {},
|
2020-09-02 04:19:40 +10:00
|
|
|
|
2019-09-18 06:30:04 +10:00
|
|
|
"media": {
|
|
|
|
"autoLoad": True,
|
|
|
|
"autoPlay": False,
|
|
|
|
"autoPlayGIF": True,
|
|
|
|
"autoHideOSDAfterMsec": 3000,
|
|
|
|
"defaultVolume": 100,
|
2020-07-22 14:14:15 +10:00
|
|
|
"openExternallyOnClick": False,
|
2019-09-18 06:30:04 +10:00
|
|
|
"startMuted": False,
|
|
|
|
},
|
2019-07-25 07:05:27 +10:00
|
|
|
"keys": {
|
2019-11-10 23:32:17 +11:00
|
|
|
"startPythonDebugger": ["Alt+Shift+D"],
|
2019-12-10 03:27:40 +11:00
|
|
|
"toggleDebugConsole": ["Alt+Shift+C", "F1"],
|
2019-08-24 01:02:22 +10:00
|
|
|
|
2020-07-15 06:51:01 +10:00
|
|
|
"zoomIn": ["Ctrl++"],
|
|
|
|
"zoomOut": ["Ctrl+-"],
|
|
|
|
"zoomReset": ["Ctrl+="],
|
|
|
|
"toggleCompactMode": ["Ctrl+Alt+C"],
|
|
|
|
"toggleHideRoomPane": ["Ctrl+Alt+R"],
|
2019-12-05 00:08:38 +11:00
|
|
|
|
2019-08-31 03:06:54 +10:00
|
|
|
"scrollUp": ["Alt+Up", "Alt+K"],
|
|
|
|
"scrollDown": ["Alt+Down", "Alt+J"],
|
2019-12-09 03:42:40 +11:00
|
|
|
"scrollPageUp": ["Alt+Ctrl+Up", "Alt+Ctrl+K", "PgUp"],
|
|
|
|
"scrollPageDown": ["Alt+Ctrl+Down", "Alt+Ctrl+J", "PgDown"],
|
2019-08-31 03:40:56 +10:00
|
|
|
"scrollToTop":
|
|
|
|
["Alt+Ctrl+Shift+Up", "Alt+Ctrl+Shift+K", "Home"],
|
|
|
|
"scrollToBottom":
|
|
|
|
["Alt+Ctrl+Shift+Down", "Alt+Ctrl+Shift+J", "End"],
|
2019-08-24 01:02:22 +10:00
|
|
|
|
2019-11-11 00:28:57 +11:00
|
|
|
"previousTab": ["Alt+Shift+Left", "Alt+Shift+H"],
|
|
|
|
"nextTab": ["Alt+Shift+Right", "Alt+Shift+L"],
|
|
|
|
|
2020-05-14 15:21:44 +10:00
|
|
|
"addNewAccount": ["Alt+Shift+A"],
|
|
|
|
"accountSettings": ["Alt+A"],
|
|
|
|
"addNewChat": ["Alt+C"],
|
|
|
|
"toggleFocusMainPane": ["Alt+F"],
|
|
|
|
"clearRoomFilter": ["Alt+Shift+F"],
|
2020-07-11 04:59:55 +10:00
|
|
|
"toggleCollapseAccount": ["Alt+O"],
|
2020-07-11 05:15:53 +10:00
|
|
|
|
|
|
|
"openPresenceMenu": ["Alt+P"],
|
|
|
|
"togglePresenceUnavailable": ["Alt+Ctrl+U", "Alt+Ctrl+A"],
|
|
|
|
"togglePresenceInvisible": ["Alt+Ctrl+I"],
|
|
|
|
"togglePresenceOffline": ["Alt+Ctrl+O"],
|
2020-05-14 15:21:44 +10:00
|
|
|
|
|
|
|
"goToLastPage": ["Ctrl+Tab"],
|
|
|
|
"goToPreviousAccount": ["Alt+Shift+N"],
|
|
|
|
"goToNextAccount": ["Alt+N"],
|
|
|
|
"goToPreviousRoom": ["Alt+Shift+Up", "Alt+Shift+K"],
|
|
|
|
"goToNextRoom": ["Alt+Shift+Down", "Alt+Shift+J"],
|
|
|
|
"goToPreviousUnreadRoom": ["Alt+Shift+U"],
|
|
|
|
"goToNextUnreadRoom": ["Alt+U"],
|
|
|
|
"goToPreviousMentionedRoom": ["Alt+Shift+M"],
|
|
|
|
"goToNextMentionedRoom": ["Alt+M"],
|
|
|
|
|
2020-05-14 16:48:48 +10:00
|
|
|
"focusAccountAtIndex": {
|
|
|
|
"01": f"{ctrl_or_osx_ctrl()}+1",
|
|
|
|
"02": f"{ctrl_or_osx_ctrl()}+2",
|
|
|
|
"03": f"{ctrl_or_osx_ctrl()}+3",
|
|
|
|
"04": f"{ctrl_or_osx_ctrl()}+4",
|
|
|
|
"05": f"{ctrl_or_osx_ctrl()}+5",
|
|
|
|
"06": f"{ctrl_or_osx_ctrl()}+6",
|
|
|
|
"07": f"{ctrl_or_osx_ctrl()}+7",
|
|
|
|
"08": f"{ctrl_or_osx_ctrl()}+8",
|
|
|
|
"09": f"{ctrl_or_osx_ctrl()}+9",
|
|
|
|
"10": f"{ctrl_or_osx_ctrl()}+0",
|
|
|
|
},
|
|
|
|
# On OSX, alt+numbers if used for symbols, use cmd instead
|
2020-03-23 05:07:49 +11:00
|
|
|
"focusRoomAtIndex": {
|
2020-04-01 20:08:08 +11:00
|
|
|
"01": f"{alt_or_cmd()}+1",
|
|
|
|
"02": f"{alt_or_cmd()}+2",
|
|
|
|
"03": f"{alt_or_cmd()}+3",
|
|
|
|
"04": f"{alt_or_cmd()}+4",
|
|
|
|
"05": f"{alt_or_cmd()}+5",
|
|
|
|
"06": f"{alt_or_cmd()}+6",
|
|
|
|
"07": f"{alt_or_cmd()}+7",
|
|
|
|
"08": f"{alt_or_cmd()}+8",
|
|
|
|
"09": f"{alt_or_cmd()}+9",
|
|
|
|
"10": f"{alt_or_cmd()}+0",
|
2020-03-23 05:07:49 +11:00
|
|
|
},
|
2019-09-09 01:49:47 +10:00
|
|
|
|
2020-07-21 12:58:02 +10:00
|
|
|
"unfocusOrDeselectAllMessages": ["Ctrl+D"],
|
|
|
|
"focusPreviousMessage": ["Ctrl+Up", "Ctrl+K"],
|
|
|
|
"focusNextMessage": ["Ctrl+Down", "Ctrl+J"],
|
|
|
|
"toggleSelectMessage": ["Ctrl+Space"],
|
|
|
|
"selectMessagesUntilHere": ["Ctrl+Shift+Space"],
|
|
|
|
"removeFocusedOrSelectedMessages": ["Ctrl+R", "Alt+Del"],
|
|
|
|
"replyToFocusedOrLastMessage": ["Ctrl+Q"], # Q → Quote
|
|
|
|
"debugFocusedMessage": ["Ctrl+Shift+D"],
|
|
|
|
"openMessagesLinksOrFiles": ["Ctrl+O"],
|
|
|
|
"openMessagesLinksOrFilesExternally": ["Ctrl+Shift+O"],
|
2020-07-21 13:28:07 +10:00
|
|
|
"copyFilesLocalPath": ["Ctrl+Shift+C"],
|
2020-07-21 12:58:02 +10:00
|
|
|
"clearRoomMessages": ["Ctrl+L"],
|
2020-03-27 19:49:01 +11:00
|
|
|
|
2020-03-18 08:09:00 +11:00
|
|
|
"sendFile": ["Alt+S"],
|
|
|
|
"sendFileFromPathInClipboard": ["Alt+Shift+S"],
|
2020-03-29 03:40:11 +11:00
|
|
|
"inviteToRoom": ["Alt+I"],
|
2020-03-29 03:50:09 +11:00
|
|
|
"leaveRoom": ["Alt+Escape"],
|
|
|
|
"forgetRoom": ["Alt+Shift+Escape"],
|
2020-03-18 07:52:14 +11:00
|
|
|
|
|
|
|
"toggleFocusRoomPane": ["Alt+R"],
|
2020-07-10 17:11:26 +10:00
|
|
|
|
|
|
|
"refreshDevices": ["Alt+R", "F5"],
|
|
|
|
"signOutCheckedOrAllDevices": ["Alt+S", "Delete"],
|
2020-07-21 11:34:00 +10:00
|
|
|
|
|
|
|
"imageViewer": {
|
|
|
|
"panLeft": ["H", "Left", "Alt+H", "Alt+Left"],
|
|
|
|
"panDown": ["J", "Down", "Alt+J", "Alt+Down"],
|
|
|
|
"panUp": ["K", "Up", "Alt+K", "Alt+Up"],
|
|
|
|
"panRight": ["L", "Right", "Alt+L", "Alt+Right"],
|
|
|
|
|
|
|
|
"zoomReset": ["Alt+Z", "=", "Ctrl+="],
|
2020-09-23 09:27:36 +10:00
|
|
|
"zoomOut": ["Shift+Z", "-", "Ctrl+-"],
|
|
|
|
"zoomIn": ["Z", "+", "Ctrl++"],
|
2020-07-21 11:34:00 +10:00
|
|
|
|
|
|
|
"rotateReset": ["Alt+R"],
|
2020-09-23 09:27:36 +10:00
|
|
|
"rotateLeft": ["Shift+R"],
|
|
|
|
"rotateRight": ["R"],
|
2020-07-21 11:34:00 +10:00
|
|
|
|
|
|
|
"resetSpeed": ["Alt+S"],
|
2020-09-23 09:27:36 +10:00
|
|
|
"previousSpeed": ["Shift+S"],
|
|
|
|
"nextSpeed": ["S"],
|
2020-07-21 11:34:00 +10:00
|
|
|
|
|
|
|
"pause": ["Space"],
|
|
|
|
"expand": ["E"],
|
|
|
|
"fullScreen": ["F", "F11", "Alt+Return", "Alt+Enter"],
|
|
|
|
"close": ["X", "Q"],
|
|
|
|
},
|
2019-07-25 07:05:27 +10:00
|
|
|
},
|
2019-07-19 11:58:21 +10:00
|
|
|
}
|
2019-07-21 20:05:01 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def deserialized(self, data: str) -> Tuple[dict, bool]:
|
|
|
|
dict_data, save = super().deserialized(data)
|
|
|
|
|
|
|
|
if "theme" in self and self["theme"] != dict_data["theme"]:
|
|
|
|
self.backend.theme = Theme(self.backend, dict_data["theme"])
|
|
|
|
UserFileChanged(Theme, self.backend.theme.data)
|
|
|
|
|
|
|
|
return (dict_data, save)
|
|
|
|
|
2019-07-21 20:05:01 +10:00
|
|
|
|
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class UIState(UserDataFile, JSONFile):
|
|
|
|
"""File used to save and restore the state of QML components."""
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2019-12-18 23:41:02 +11:00
|
|
|
filename: str = "state.json"
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def default_data(self) -> dict:
|
2019-07-21 20:05:01 +10:00
|
|
|
return {
|
2019-12-11 05:46:05 +11:00
|
|
|
"collapseAccounts": {},
|
|
|
|
"page": "Pages/Default.qml",
|
|
|
|
"pageProperties": {},
|
2019-07-21 20:05:01 +10:00
|
|
|
}
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def deserialized(self, data: str) -> Tuple[dict, bool]:
|
|
|
|
dict_data, save = super().deserialized(data)
|
|
|
|
|
|
|
|
for user_id, do in dict_data["collapseAccounts"].items():
|
|
|
|
self.backend.models["all_rooms"].set_account_collapse(user_id, do)
|
|
|
|
|
|
|
|
return (dict_data, save)
|
|
|
|
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2019-12-10 04:21:12 +11:00
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class History(UserDataFile, JSONFile):
|
2019-12-18 23:41:02 +11:00
|
|
|
"""File to save and restore lines typed by the user in QML components."""
|
2019-12-11 08:59:04 +11:00
|
|
|
|
2019-12-18 23:41:02 +11:00
|
|
|
filename: str = "history.json"
|
2019-12-10 04:21:12 +11:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def default_data(self) -> dict:
|
2019-12-10 04:21:12 +11:00
|
|
|
return {"console": []}
|
|
|
|
|
|
|
|
|
2019-07-23 17:14:02 +10:00
|
|
|
@dataclass
|
2020-10-05 18:06:07 +11:00
|
|
|
class Theme(UserDataFile):
|
2019-12-18 23:41:02 +11:00
|
|
|
"""A theme file defining the look of QML components."""
|
|
|
|
|
2020-02-15 03:21:24 +11:00
|
|
|
# Since it currently breaks at every update and the file format will be
|
|
|
|
# changed later, don't copy the theme to user data dir if it doesn't exist.
|
|
|
|
create_missing = False
|
|
|
|
|
2019-07-23 17:14:02 +10:00
|
|
|
@property
|
|
|
|
def path(self) -> Path:
|
2020-09-02 04:05:19 +10:00
|
|
|
data_dir = Path(
|
|
|
|
os.environ.get("MIRAGE_DATA_DIR") or
|
|
|
|
self.backend.appdirs.user_data_dir,
|
|
|
|
)
|
2020-03-15 08:33:13 +11:00
|
|
|
return data_dir / "themes" / self.filename
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
@property
|
|
|
|
def default_data(self) -> str:
|
2020-03-15 08:33:13 +11:00
|
|
|
path = f"src/themes/{self.filename}"
|
|
|
|
|
|
|
|
try:
|
|
|
|
byte_content = pyotherside.qrc_get_file_contents(path)
|
|
|
|
except ValueError:
|
|
|
|
# App was compiled without QRC
|
2020-10-05 18:06:07 +11:00
|
|
|
return convert_to_qml(Path(path).read_text())
|
2020-03-15 08:33:13 +11:00
|
|
|
else:
|
2020-10-05 18:06:07 +11:00
|
|
|
return convert_to_qml(byte_content.decode())
|
2019-07-23 17:14:02 +10:00
|
|
|
|
2020-10-05 18:06:07 +11:00
|
|
|
def deserialized(self, data: str) -> Tuple[str, bool]:
|
|
|
|
return (convert_to_qml(data), False)
|