No OneTemporary
Actions

Size

62 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/contents/ui/LoginPage.qml b/src/contents/ui/LoginPage.qml
	index fab6bfe..017555a 100644
	--- a/src/contents/ui/LoginPage.qml
	+++ b/src/contents/ui/LoginPage.qml
	@@ -1,111 +1,124 @@
	/*
	* This file is part of kazv.
	* SPDX-FileCopyrightText: 2020-2021 Tusooa Zhu <tusooa@kazv.moe>
	* SPDX-License-Identifier: AGPL-3.0-or-later
	*/

	import QtQuick 2.2
	import QtQuick.Layouts 1.1
	import QtQuick.Controls 2.15
	import org.kde.kirigami 2.8 as Kirigami

	Kirigami.Page {
	id: loginPage
	title: l10n.get('login-page-title')
	property var isSwitchingAccount: false
	+ property bool loading: loadingSession

	ColumnLayout {
	width: parent.width
	spacing: Kirigami.Units.largeSpacing

	ColumnLayout {
	id: restoreSessionPart
	width: parent.width
	spacing: Kirigami.Units.largeSpacing
	property var sessions: matrixSdk.allSessions().filter(s => s !== sessionNameFor(matrixSdk.userId, matrixSdk.deviceId))

	Label {
	text: l10n.get('login-page-existing-sessions-prompt')
	}

	ComboBox {
	id: sessionChooser
	Layout.fillWidth: true
	model: restoreSessionPart.sessions
	currentIndex: -1
	+ enabled: !loginPage.loading
	}

	Button {
	id: restoreButton
	text: l10n.get('login-page-restore-session-button')
	Layout.fillWidth: true
	- enabled: sessionChooser.currentIndex != -1
	+ enabled: sessionChooser.currentIndex != -1 && !loginPage.loading
	onClicked: {
	const sess = restoreSessionPart.sessions[sessionChooser.currentIndex];
	console.log('Selected session ', sess);
	loadSession(sess);
	}
	}

	Label {
	text: l10n.get('login-page-alternative-password-login-prompt')
	}
	visible: sessions.length > 0
	}

	Kirigami.FormLayout {
	TextField {
	id: userIdField
	objectName: 'userIdField'
	Layout.fillWidth: true
	placeholderText: l10n.get('login-page-userid-input-placeholder')
	Kirigami.FormData.label: l10n.get('login-page-userid-prompt')
	+ enabled: !loginPage.loading
	}

	Kirigami.PasswordField {
	id: passwordField
	objectName: 'passwordField'
	Layout.fillWidth: true
	Kirigami.FormData.label: l10n.get('login-page-password-prompt')
	+ enabled: !loginPage.loading
	}

	TextField {
	id: serverUrlField
	objectName: 'serverUrlField'
	Layout.fillWidth: true
	placeholderText: l10n.get('login-page-server-url-placeholder')
	Kirigami.FormData.label: l10n.get('login-page-server-url-prompt')
	+ enabled: !loginPage.loading
	}

	RowLayout {
	Layout.fillWidth: true

	property var loginButton: Button {
	id: loginButton
	objectName: 'loginButton'
	text: l10n.get('login-page-login-button')
	Layout.fillWidth: true
	onClicked: {
	console.log('Trying to login...')
	if (isSwitchingAccount) {
	matrixSdk.startNewSession();
	}
	matrixSdk.login(userIdField.text, passwordField.text, serverUrlField.text);
	console.log('Login job sent')
	}
	+ enabled: !loginPage.loading
	}

	property var closeButton: Button {
	id: closeButton
	text: l10n.get('login-page-close-button')
	Layout.fillWidth: true
	onClicked: {
	pageStack.removePage(loginPage);
	}
	+ enabled: !loginPage.loading
	}

	data: isSwitchingAccount ? [closeButton, loginButton] : [loginButton]
	}
	}
	+
	+ ProgressBar {
	+ visible: loginPage.loading
	+ indeterminate: true
	+ Layout.fillWidth: true
	+ }
	}
	}
	diff --git a/src/contents/ui/Main.qml b/src/contents/ui/Main.qml
	index d9aeda9..f8ff022 100644
	--- a/src/contents/ui/Main.qml
	+++ b/src/contents/ui/Main.qml
	@@ -1,365 +1,369 @@
	/*
	* This file is part of kazv.
	* SPDX-FileCopyrightText: 2020-2023 tusooa <tusooa@kazv.moe>
	* SPDX-License-Identifier: AGPL-3.0-or-later
	*/

	import QtQuick
	import org.kde.kirigami as Kirigami
	import QtQuick.Layouts
	import QtQuick.Controls
	import moe.kazv.mxc.kazv as MK

	import '.' as Kazv
	import 'shortcuts' as KazvShortcuts

	import 'l10n.js' as L10n

	Kirigami.ApplicationWindow {
	id: root

	property var kazvIOManager: MK.KazvIOManager {
	cacheDirectory: kazvConfig.cacheDirectory
	}

	+ property bool loadingSession: false
	+
	property var matrixSdk: MK.MatrixSdk {
	onLoginSuccessful: {
	switchToMainPage();
	recordLastSession();
	}
	onLoginFailed: {
	console.log("Login Failed");
	showPassiveNotification(l10n.get('login-page-request-failed-prompt', { errorCode, errorMsg }));
	}
	onDiscoverFailed: {
	console.log("Discover Failed");
	showPassiveNotification(l10n.get('login-page-discover-failed-enter-prompt', { errorCode, errorMsg }));
	}
	onSessionChanged: {
	console.log('session changed');
	reloadSdkVariables();
	}
	onLogoutSuccessful: {
	root.loggedIn = false;
	root.mainPage = Qt.createComponent("MainPage.qml").createObject(root);
	pageStack.clear();
	pushLoginPage();
	}
	onLogoutFailed: {
	console.warn('Logout failed');
	showPassiveNotification(l10n.get('logout-failed-prompt', { errorCode, errorMsg }));
	}
	+
	+ onLoadSessionFinished: (sessionName, res) => {
	+ root.loadingSession = false;
	+ if (res === MK.MatrixSdk.SessionLoadSuccess) {
	+ console.log('load session successful');
	+ switchToMainPage();
	+ recordLastSession();
	+ matrixSdk.getSpecVersions();
	+ } else {
	+ showPassiveNotification(getSessionLoadError(res, sessionName));
	+ }
	+ }
	}

	property var loggedIn: !!matrixSdk.token

	property var sdkVars: QtObject {
	property var roomList: matrixSdk.roomList()
	property var userGivenNicknameMap: matrixSdk.userGivenNicknameMap()
	property string currentRoomId: ''
	}

	property var l10nProvider: MK.L10nProvider {
	}

	property var kazvConfig: MK.KazvConfig {
	}

	function initializeL10n () {
	const availableLocales = l10nProvider.availableLocaleCodes();
	console.log('available locales:', availableLocales);
	const desiredLanguages = [Qt.uiLanguage];
	console.log('ui language is: ', desiredLanguages);
	const defaultLocale = 'en';

	const wantedLocales = L10n.negotiateLanguages(desiredLanguages, availableLocales, defaultLocale);

	console.log('wanted locales:', wantedLocales);

	const bundles = L10n.generateBundles(wantedLocales, l10nProvider.getFtlData(wantedLocales));
	const provider = new L10n.FluentProvider(bundles);

	return provider;
	}

	property var l10n: initializeL10n();

	property var confirmLogoutPopup: Kirigami.OverlaySheet {
	id: confirmLogoutPopup
	title: l10n.get('confirm-logout-popup-title')
	ColumnLayout {
	Label {
	Layout.fillWidth: true
	text: l10n.get('confirm-logout-popup-prompt')
	}
	RowLayout {
	Layout.fillWidth: true
	Layout.alignment: Qt.AlignCenter
	Button {
	text: l10n.get('confirm-logout-popup-accept-button')
	onClicked: {
	hardLogout();
	confirmLogoutPopup.close();
	}
	}
	Button {
	text: l10n.get('confirm-logout-popup-cancel-button')
	onClicked: confirmLogoutPopup.close();
	}
	}
	}
	}

	title: l10n.get('app-title')

	globalDrawer: Kirigami.GlobalDrawer {
	title: l10n.get('global-drawer-title')
	titleIcon: "applications-graphics"
	property var actionGroupName: 'global-drawer-actions'
	actions: [
	Kirigami.Action {
	objectName: 'switch-account'
	text: l10n.get('global-drawer-action-switch-account')
	icon.name: 'system-switch-user'
	onTriggered: switchAccount()
	},
	Kirigami.Action {
	objectName: 'hard-logout'
	text: l10n.get('global-drawer-action-hard-logout')
	icon.name: 'application-exit'
	onTriggered: confirmLogoutPopup.open()
	},
	Kirigami.Action {
	objectName: 'save'
	text: l10n.get('global-drawer-action-save-session')
	icon.name: 'document-save'
	onTriggered: {
	recordLastSession()
	matrixSdk.serializeToFile()
	}
	},
	Kirigami.Action {
	objectName: 'configure-shortcuts'
	text: l10n.get('global-drawer-action-configure-shortcuts')
	icon.name: 'configure-shortcuts'
	onTriggered: {
	pushActionSettingsPage();
	}
	},
	Kirigami.Action {
	objectName: 'settings'
	text: l10n.get('global-drawer-action-settings')
	icon.name: 'configure'
	onTriggered: {
	pushSettingsPage();
	}
	},
	Kirigami.Action {
	objectName: 'create-room'
	enabled: root.loggedIn
	icon.name: 'contact-new'
	text: l10n.get('global-drawer-action-create-room')
	onTriggered: {
	pushCreateRoomPage();
	}
	},
	Kirigami.Action {
	objectName: 'join-room'
	enabled: root.loggedIn
	text: l10n.get('global-drawer-action-join-room')
	icon.name: 'list-add-user'
	onTriggered: {
	pushJoinRoomPage();
	}
	},
	Kirigami.Action {
	objectName: 'aboutAction'
	text: l10n.get('global-drawer-action-about')
	icon.name: 'help-about'
	onTriggered: pageStack.pushDialogLayer(Qt.resolvedUrl('About.qml'))
	}
	]
	}

	contextDrawer: Kirigami.ContextDrawer {
	id: contextDrawer
	}

	property var actionCollection: KazvShortcuts.ActionCollection {
	id: globalActionCollection
	children: [
	root.globalDrawer,
	root.contextDrawer,
	]
	shortcutsConfig: kazvConfig
	}

	property var notifier: Kazv.Notifier {
	}

	pageStack.initialPage: Qt.resolvedUrl("LoginPage.qml")

	property var mainPage: Kazv.MainPage {}

	property var emptyPage: Kirigami.Page {
	title: l10n.get('empty-room-page-title')
	Label {
	text: l10n.get('empty-room-page-description')
	}
	}

	signal switchToRoomRequested(string roomId)
	property var pageManager: Kazv.PageManager {
	pageStack: root.pageStack
	sdkVars: root.sdkVars
	main: root
	}

	function activateRoomSettingsPage(room) {
	pageStack.push(Qt.resolvedUrl("room-settings/RoomSettingsPage.qml"), {
	room
	});
	}

	function activateRoomPinnedEventsPage(room) {
	pageStack.push(Qt.resolvedUrl('RoomPinnedEventsPage.qml'), {
	room
	});
	}

	function activateRoomInvitePage(room) {
	pageStack.push(Qt.resolvedUrl("room-settings/RoomInvitePage.qml"), {
	room
	});
	}

	function activateRoomStickerPacksPage(room) {
	pageStack.push(Qt.resolvedUrl("room-settings/RoomStickerPacksPage.qml"), {
	room
	});
	}

	function activateRoomStatePage(room) {
	pageStack.push(Qt.resolvedUrl("room-settings/RoomStatePage.qml"), {
	room
	});
	}

	function activateUserPage(user, room, userId) {
	pageStack.push(Qt.resolvedUrl("UserPage.qml"), {
	userId: userId \|\| user.userId,
	user,
	room
	});
	}

	function switchToMainPage() {
	pageStack.replace([root.mainPage])
	pageStack.currentIndex = 0
	}

	function switchToLoginPage() {
	pageStack.replace([Qt.resolvedUrl("LoginPage.qml")])
	pageStack.currentIndex = 0
	}

	function pushLoginPage() {
	pageStack.push(Qt.resolvedUrl("LoginPage.qml"), {
	isSwitchingAccount: true,
	});
	}

	function pushActionSettingsPage() {
	pageStack.push(Qt.resolvedUrl("ActionSettingsPage.qml"), {
	actionsToConfigure: globalActionCollection.allActions(),
	});
	}

	function pushSettingsPage() {
	pageStack.push(Qt.resolvedUrl("SettingsPage.qml"));
	}

	function pushCreateRoomPage() {
	pageStack.push(Qt.resolvedUrl("CreateRoomPage.qml"), {});
	}

	function pushJoinRoomPage() {
	pageStack.push(Qt.resolvedUrl("JoinRoomPage.qml"), {});
	}

	function sessionNameFor(userId, deviceId) {
	return userId + '/' + deviceId;
	}

	function getSessionLoadError(res, sessionName) {
	switch (res) {
	case MK.MatrixSdk.SessionNotFound:
	return l10n.get('session-load-failure-not-found', { sessionName });

	case MK.MatrixSdk.SessionFormatUnknown:
	return l10n.get('session-load-failure-format-unknown', { sessionName });

	case MK.MatrixSdk.SessionCannotBackup:
	return l10n.get('session-load-failure-cannot-backup', { sessionName });

	case MK.MatrixSdk.SessionLockFailed:
	return l10n.get('session-load-failure-lock-failed', { sessionName });

	case MK.MatrixSdk.SessionCannotOpenFile:
	return l10n.get('session-load-failure-cannot-open-file', { sessionName });

	case MK.MatrixSdk.SessionDeserializeFailed:
	return l10n.get('session-load-failure-deserialize-failed', { sessionName });

	default:
	console.error('loadSession: Encountered an unknown error code');
	}
	}

	function loadSession(sessionName) {
	- const res = matrixSdk.loadSession(sessionName);
	-
	- if (res === MK.MatrixSdk.SessionLoadSuccess) {
	- console.log('load session successful');
	- switchToMainPage();
	- recordLastSession();
	- matrixSdk.getSpecVersions();
	- } else {
	- showPassiveNotification(getSessionLoadError(res, sessionName));
	- }
	- return res;
	+ root.loadingSession = true;
	+ matrixSdk.loadSession(sessionName);
	}

	function loadLastSession() {
	console.log('last session is:', kazvConfig.lastSession);
	-
	return loadSession(kazvConfig.lastSession);
	}

	function recordLastSession() {
	kazvConfig.lastSession = sessionNameFor(matrixSdk.userId, matrixSdk.deviceId);
	}

	function reloadSdkVariables() {
	sdkVars.roomList = matrixSdk.roomList();
	sdkVars.userGivenNicknameMap = matrixSdk.userGivenNicknameMap();
	sdkVars.currentRoomId = '';
	}

	function switchAccount() {
	pushLoginPage();
	}

	function hardLogout() {
	matrixSdk.logout();
	}

	Component.onCompleted: {
	actionCollection.setupShortcuts();
	loadLastSession();
	}

	onClosing: {
	kazvIOManager.clearJobs()
	}
	}
	diff --git a/src/matrix-sdk.cpp b/src/matrix-sdk.cpp
	index 33c7b2e..11303fc 100644
	--- a/src/matrix-sdk.cpp
	+++ b/src/matrix-sdk.cpp
	@@ -1,895 +1,906 @@
	/*
	* This file is part of kazv.
	* SPDX-FileCopyrightText: 2020-2024 tusooa <tusooa@kazv.moe>
	* SPDX-License-Identifier: AGPL-3.0-or-later
	*/

	#include <kazv-defs.hpp>

	#include <boost/archive/text_oarchive.hpp>
	#include <boost/archive/text_iarchive.hpp>
	#include <fstream>
	#include <filesystem>
	#include <chrono>

	#include <QMutex>
	#include <QMutexLocker>
	#include <QtConcurrent>
	#include <QThreadPool>

	#include <KConfig>
	#include <KConfigGroup>

	#include <eventemitter/lagerstoreeventemitter.hpp>
	#include <client/sdk.hpp>
	#include <client/notification-handler.hpp>
	#include <crypto/base64.hpp>

	#include <zug/util.hpp>
	#include <lager/event_loop/qt.hpp>

	#include "matrix-sdk.hpp"
	#include "matrix-room-list.hpp"
	#include "matrix-promise.hpp"
	#include "matrix-event.hpp"
	#include "helper.hpp"
	#include "kazv-path-config.hpp"
	#include "kazv-version.hpp"
	#include "qt-json.hpp"
	#include "qt-rand-adapter.hpp"
	#include "qt-promise-handler.hpp"
	#include "qt-job-handler.hpp"
	#include "device-mgmt/matrix-device-list.hpp"
	#include "matrix-sticker-pack-list.hpp"
	#include "matrix-sticker-pack-list-p.hpp"
	#include "matrix-user-given-attrs-map.hpp"
	#include "kazv-log.hpp"
	#include "matrix-utils.hpp"
	#include "kazv-session-lock-guard.hpp"

	using namespace Qt::Literals::StringLiterals;
	using namespace Kazv;

	static const std::string clientName = "kazv";

	// Sdk with qt event loop, identity transform and no enhancers
	using SdkT =
	decltype(makeSdk(
	SdkModel{},
	detail::declref<JobInterface>(),
	detail::declref<EventInterface>(),
	QtPromiseHandler(detail::declref<QObject>()),
	zug::identity,
	withRandomGenerator(detail::declref<RandomInterface>())));

	struct QtEventLoop
	{
	QObject *m_obj;

	template<class Fn>
	void async(Fn &&) { throw std::runtime_error{"not implemented!"}; }

	template<class Fn>
	void post(Fn &&fn)
	{
	QMetaObject::invokeMethod(
	m_obj, std::forward<Fn>(fn), Qt::QueuedConnection
	);
	}

	void finish() {}
	void pause() { throw std::runtime_error{"not implemented!"}; }
	void resume() { throw std::runtime_error{"not implemented!"}; }
	};

	std::filesystem::path sessionDirForUserAndDeviceId(std::filesystem::path userDataDir, std::string userId, std::string deviceId)
	{
	auto encodedUserId = encodeBase64(userId, Base64Opts::urlSafe);
	auto sessionDir = userDataDir / "sessions"
	/ encodedUserId / deviceId;
	return sessionDir;
	}

	struct MatrixSdkPrivate
	{
	MatrixSdkPrivate(MatrixSdk *q, bool testing, std::unique_ptr<KazvSessionLockGuard> lockGuard);
	MatrixSdkPrivate(MatrixSdk *q, bool testing, SdkModel model, std::unique_ptr<KazvSessionLockGuard> lockGuard);
	bool testing;
	std::string userDataDir;
	std::unique_ptr<KazvSessionLockGuard> lockGuard;
	RandomInterface randomGenerator;
	QThread *thread;
	QObject *obj;
	QtJobHandler *jobHandler;
	LagerStoreEventEmitter ee;
	LagerStoreEventEmitter::Watchable watchable;
	SdkT sdk;
	QTimer saveTimer;

	using SecondaryRootT = decltype(sdk.createSecondaryRoot(std::declval<lager::with_qt_event_loop>()));
	SecondaryRootT secondaryRoot;
	Client clientOnSecondaryRoot;
	NotificationHandler notificationHandler;
	void runIoContext() {
	thread->start();
	}
	void stopIoContext() {
	thread->quit();
	}

	void maybeSerialize()
	{
	if (!testing) {
	serializeClientToFile(clientOnSecondaryRoot);
	}
	}

	void serializeClientToFile(Client c);
	};

	// Cleaning up notes:
	// 0. Callback functions may store the context for an indefinite time
	// 1. The QThread event loop can be stopped
	// 2. QtJobHandler::submit() should only happen in the primary event loop thread
	// 3. QtJobHandler lives in the primary event loop thread
	// 4. QtJobs live in the primary event loop thread
	// 5. Job callbacks are called in the primary event loop thread
	// 6. QtPromise::then() callbacks are called in the primary event loop thread
	// 7. When the QThread event loop stops, no more callbacks will be executed (there is nothing to post to)
	// 8. The QThread should stop before obj is deleted
	class CleanupHelper : public QObject
	{
	Q_OBJECT
	public:
	explicit CleanupHelper(std::unique_ptr<MatrixSdkPrivate> d)
	: oldD(std::move(d))
	{
	}

	std::unique_ptr<MatrixSdkPrivate> oldD;

	void cleanup()
	{
	qCInfo(kazvLog) << "start to clean up everything";
	oldD->clientOnSecondaryRoot.stopSyncing()
	.then([obj=oldD->obj, thread=oldD->thread](auto &&) {
	qCDebug(kazvLog) << "stopped syncing";
	QMetaObject::invokeMethod(obj, [thread]() {
	thread->quit();
	});
	});
	oldD->thread->wait();
	oldD->thread->deleteLater();
	// After the thread's event loop is finished, we can delete the root object
	oldD->obj->deleteLater();
	this->deleteLater();
	qCInfo(kazvLog) << "thread is done";
	}
	};

	void MatrixSdkPrivate::serializeClientToFile(Client c)
	{
	using namespace Kazv::CursorOp;
	auto userId = +c.userId();
	auto deviceId = +c.deviceId();
	if (userId.empty() \|\| deviceId.empty()) {
	qDebug() << "Not logged in, nothing to serialize";
	return;
	}

	using StdPath = std::filesystem::path;
	auto userDataDir = StdPath(this->userDataDir);
	auto sessionDir = sessionDirForUserAndDeviceId(userDataDir, userId, deviceId);

	auto storeFile = sessionDir / "store";
	auto storeFileNew = sessionDir / "store.new";

	auto metadataFile = sessionDir / "metadata";

	qDebug() << "storeFile=" << QString::fromStdString(storeFile.string());

	std::error_code err;
	if ((! std::filesystem::create_directories(sessionDir, err))
	&& err) {
	qDebug() << "Unable to create sessionDir";
	return;
	}

	if (!lockGuard) {
	try {
	lockGuard = std::make_unique<KazvSessionLockGuard>(sessionDir);
	} catch (const std::runtime_error &e) {
	qCWarning(kazvLog) << "Error locking session: " << e.what();
	return;
	}
	}

	try {
	auto storeStream = std::ofstream(storeFileNew);
	if (! storeStream) {
	qCWarning(kazvLog) << "Unable to open storeFile";
	return;
	}
	using OAr = boost::archive::text_oarchive;
	auto archive = OAr{storeStream};
	c.serializeTo(archive);
	} catch (const std::exception &e) {
	qCWarning(kazvLog) << "Cannot write to store file: " << e.what();
	return;
	}

	err.clear();
	std::filesystem::rename(storeFileNew, storeFile, err);
	if (err) {
	qCWarning(kazvLog) << "Cannot move storeFile into place: " << QString::fromStdString(err.message());
	return;
	}
	qDebug() << "Serialization done";


	// store metadata
	{
	KConfig metadata(QString::fromStdString(metadataFile.string()));
	KConfigGroup mdGroup(&metadata, u"Metadata"_s);
	mdGroup.writeEntry("kazvVersion", QString::fromStdString(kazvVersionString()));
	mdGroup.writeEntry("archiveFormat", "text");
	}
	}

	MatrixSdkPrivate::MatrixSdkPrivate(MatrixSdk *q, bool testing, std::unique_ptr<KazvSessionLockGuard> lockGuard)
	: testing(testing)
	, userDataDir{kazvUserDataDir().toStdString()}
	, lockGuard(std::move(lockGuard))
	, randomGenerator(QtRandAdapter{})
	, thread(new QThread())
	, obj(new QObject())
	, jobHandler(new QtJobHandler(obj))
	, ee{QtEventLoop{obj}}
	, watchable(ee.watchable())
	, sdk(makeDefaultSdkWithCryptoRandom(
	randomGenerator.generateRange<std::string>(makeDefaultSdkWithCryptoRandomSize()),
	static_cast<JobInterface &>(*jobHandler),
	static_cast<EventInterface &>(ee),
	QtPromiseHandler(*obj),
	zug::identity,
	withRandomGenerator(randomGenerator)))
	, secondaryRoot(sdk.createSecondaryRoot(QtEventLoop{q}))
	, clientOnSecondaryRoot(sdk.clientFromSecondaryRoot(secondaryRoot))
	, notificationHandler(clientOnSecondaryRoot.notificationHandler())
	{
	obj->moveToThread(thread);
	}

	MatrixSdkPrivate::MatrixSdkPrivate(MatrixSdk *q, bool testing, SdkModel model, std::unique_ptr<KazvSessionLockGuard> lockGuard)
	: testing(testing)
	, userDataDir{kazvUserDataDir().toStdString()}
	, lockGuard(std::move(lockGuard))
	, randomGenerator(QtRandAdapter{})
	, thread(new QThread())
	, obj(new QObject())
	, jobHandler(new QtJobHandler(obj))
	, ee{QtEventLoop{obj}}
	, watchable(ee.watchable())
	, sdk(makeSdk(
	model,
	static_cast<JobInterface &>(*jobHandler),
	static_cast<EventInterface &>(ee),
	QtPromiseHandler(*obj),
	zug::identity,
	withRandomGenerator(randomGenerator)))
	, secondaryRoot(sdk.createSecondaryRoot(QtEventLoop{q}, std::move(model)))
	, clientOnSecondaryRoot(sdk.clientFromSecondaryRoot(secondaryRoot))
	, notificationHandler(clientOnSecondaryRoot.notificationHandler())
	{
	obj->moveToThread(thread);
	}

	MatrixSdk::MatrixSdk(std::unique_ptr<MatrixSdkPrivate> d, QObject *parent)
	: QObject(parent)
	, m_userDataDir(kazvUserDataDir())
	, m_d(std::move(d))
	{
	init();
	connect(this, &MatrixSdk::trigger,
	this, [](KazvEvent e) {
	qDebug() << "receiving trigger:";
	if (std::holds_alternative<LoginSuccessful>(e)) {
	qDebug() << "Login successful";
	}
	});
	}

	void MatrixSdk::init()
	{
	LAGER_QT(serverUrl) = m_d->clientOnSecondaryRoot.serverUrl().xform(strToQt); Q_EMIT serverUrlChanged(serverUrl());
	LAGER_QT(userId) = m_d->clientOnSecondaryRoot.userId().xform(strToQt); Q_EMIT userIdChanged(userId());
	LAGER_QT(token) = m_d->clientOnSecondaryRoot.token().xform(strToQt); Q_EMIT tokenChanged(token());
	LAGER_QT(deviceId) = m_d->clientOnSecondaryRoot.deviceId().xform(strToQt); Q_EMIT deviceIdChanged(deviceId());
	LAGER_QT(specVersions) = m_d->clientOnSecondaryRoot.supportVersions(); Q_EMIT specVersionsChanged(specVersions());

	m_d->watchable.afterAll(
	[this](KazvEvent e) {
	Q_EMIT this->trigger(e);
	});

	m_d->watchable.after<LoginSuccessful>(
	[this](LoginSuccessful e) {
	Q_EMIT this->loginSuccessful(e);
	});

	m_d->watchable.after<LoginFailed>(
	[this](LoginFailed e) {
	Q_EMIT this->loginFailed(
	QString::fromStdString(e.errorCode),
	QString::fromStdString(e.error)
	);
	});

	m_d->watchable.after<ReceivingRoomTimelineEvent>(
	[this](ReceivingRoomTimelineEvent e) {
	Q_EMIT this->receivedMessage(
	QString::fromStdString(e.roomId),
	QString::fromStdString(e.event.id())
	);
	});

	connect(&m_d->saveTimer, &QTimer::timeout, &m_d->saveTimer, [m_d=m_d.get()]() {
	m_d->maybeSerialize();
	});
	const int saveIntervalMs = 1000 * 60 * 5;
	m_d->saveTimer.start(std::chrono::milliseconds{saveIntervalMs});
	}

	MatrixSdk::MatrixSdk(QObject *parent)
	: MatrixSdk(std::make_unique<MatrixSdkPrivate>(this, /* testing = */ false, std::unique_ptr<KazvSessionLockGuard>()), parent)
	{
	}

	MatrixSdk::MatrixSdk(SdkModel model, bool testing, QObject *parent)
	: MatrixSdk(std::make_unique<MatrixSdkPrivate>(this, testing, std::move(model), std::unique_ptr<KazvSessionLockGuard>()), parent)
	{
	}

	static void cleanupDPointer(std::unique_ptr<MatrixSdkPrivate> oldD)
	{
	oldD->saveTimer.disconnect();
	oldD->saveTimer.stop();

	auto helper = new CleanupHelper(std::move(oldD));
	helper->cleanup();
	}

	MatrixSdk::~MatrixSdk()
	{
	if (m_d) {
	serializeToFile();
	cleanupDPointer(std::move(m_d));
	}
	}

	QString MatrixSdk::mxcUriToHttp(QString mxcUri) const
	{
	return QString::fromStdString(m_d->clientOnSecondaryRoot.mxcUriToHttp(mxcUri.toStdString()));
	}

	QString MatrixSdk::mxcUriToHttpAuthenticatedV1(QString mxcUri) const
	{
	return QString::fromStdString(m_d->clientOnSecondaryRoot.mxcUriToHttpV1(mxcUri.toStdString()));
	}

	MatrixDeviceList *MatrixSdk::devicesOfUser(QString userId) const
	{
	return new MatrixDeviceList(m_d->clientOnSecondaryRoot.devicesOfUser(userId.toStdString()));
	}

	bool isIllFormatSpecVersion(const QString &version)
	{
	const bool isLegacy = version.startsWith(u"r"_s);
	if (isLegacy && version.split(u'.').size() == 3) {
	return false;
	}
	if (!isLegacy && version.split(u'.').size() == 2) {
	return false;
	}
	return true;
	}

	// Return true if v1 is at least as new as v2, false if v1 is older than v2
	// Return false if v1 or v2 is ill-format
	bool compareSpecVersion(QString v1, QString v2)
	{
	// Check parameters format
	if (isIllFormatSpecVersion(v1) \|\| isIllFormatSpecVersion(v2)) {
	return false;
	}

	const bool v1IsLegacy = v1.startsWith(u"r"_s);
	const bool v2IsLegacy = v2.startsWith(u"r"_s);
	if (v1IsLegacy != v2IsLegacy) {
	return v2IsLegacy;
	}

	v1.remove(0, 1);
	v2.remove(0, 1);
	auto v1VersionNumbers = v1.split(u'.');
	auto v2VersionNumbers = v2.split(u'.');

	for (int i = 0; i < v1VersionNumbers.size(); i++) {
	auto v1VerNum = v1VersionNumbers[i].toInt();
	auto v2VerNum = v2VersionNumbers[i].toInt();
	if (v1VerNum != v2VerNum) {
	return v1VerNum > v2VerNum;
	}
	}
	// v1 is equal to v2
	return true;
	}

	// Return true if version in the range [minVer, maxVer]
	// Return false if any parameter is ill-format
	bool compareSpecVersionRange(const QString &version,
	const QString &minVer, const QString &maxVer)
	{
	if (isIllFormatSpecVersion(version)
	\|\| isIllFormatSpecVersion(minVer)
	\|\| isIllFormatSpecVersion(maxVer)) {
	return false;
	}

	if (compareSpecVersion(version, minVer) && compareSpecVersion(maxVer, version)) {
	return true;
	}

	return false;
	}

	bool MatrixSdk::checkSpecVersion(QString version) const
	{
	return std::find_if(specVersions().begin(), specVersions().end(),
	[&version](auto v) {
	return compareSpecVersion(QString::fromStdString(v), version);
	}) != specVersions().end();
	}

	bool MatrixSdk::checkSpecVersionRange(QString minVer, QString maxVer) const
	{
	return std::find_if(specVersions().begin(), specVersions().end(),
	[&minVer, maxVer](auto v) {
	return compareSpecVersionRange(QString::fromStdString(v), minVer, maxVer);
	}) != specVersions().end();
	}

	std::string MatrixSdk::validateHomeserverUrl(const QString &url)
	{
	if (url.isEmpty()) {
	return std::string();
	}

	auto u = QUrl::fromUserInput(url);
	if (!u.isValid()) {
	return std::string();
	}

	if (u.scheme() == u"http"_s) {
	qCInfo(kazvLog) << "url" << u << "is http. Force switching to https.";
	u.setScheme(u"https"_s);
	} else if (u.scheme() != u"https"_s) {
	qCWarning(kazvLog) << "url" << u << "is not http/https.";
	return std::string();
	}

	return u.toString().toStdString();
	}

	void MatrixSdk::login(const QString &userId, const QString &password, const QString &homeserverUrl)
	{
	auto loginFunc = [userId, password](const Client &client, const std::string &serverUrl) {
	client.passwordLogin(
	serverUrl,
	userId.toStdString(),
	password.toStdString(),
	clientName
	);
	};

	auto validated = validateHomeserverUrl(homeserverUrl);
	if (!validated.empty()) {
	loginFunc(m_d->clientOnSecondaryRoot, validated);
	} else {
	m_d->clientOnSecondaryRoot
	.autoDiscover(userId.toStdString()) // autoDiscover() will dispatch GetVersionAction to get supported versions of the server
	.then([
	this,
	client=m_d->clientOnSecondaryRoot.toEventLoop(),
	userId,
	password,
	loginFunc
	](auto res) {
	if (!res.success()) {
	// FIXME use real error codes and msgs when available in libkazv
	Q_EMIT this->discoverFailed(u""_s, u""_s);
	return res;
	}

	auto serverUrl = res.dataStr("homeserverUrl");

	loginFunc(client, serverUrl);

	return res;
	});
	}

	m_d->runIoContext();
	}
	void MatrixSdk::logout()
	{
	m_d->clientOnSecondaryRoot.logout()
	.then([&] (EffectStatus stat) {
	if (stat.success()) {
	m_d->stopIoContext();
	Q_EMIT this->logoutSuccessful();
	} else {
	Q_EMIT this->logoutFailed(QString::fromStdString(stat.dataStr("errorCode")), QString::fromStdString(stat.dataStr("error")));
	}
	});
	}

	MatrixRoomList *MatrixSdk::roomList() const
	{
	return new MatrixRoomList(m_d->clientOnSecondaryRoot);
	}

	void MatrixSdk::emplace(std::optional<SdkModel> model, std::unique_ptr<KazvSessionLockGuard> lockGuard)
	{
	auto testing = m_d->testing;
	auto userDataDir = m_d->userDataDir;

	if (m_d) {
	cleanupDPointer(std::move(m_d));
	}

	m_d = (model.has_value()
	? std::make_unique<MatrixSdkPrivate>(this, testing, std::move(model.value()), std::move(lockGuard))
	: std::make_unique<MatrixSdkPrivate>(this, testing, std::move(lockGuard)));
	m_d->userDataDir = userDataDir;

	// Re-initialize lager-qt cursors and watchable connections
	init();

	m_d->runIoContext();

	m_d->clientOnSecondaryRoot.startSyncing();

	Q_EMIT sessionChanged();
	}

	QStringList MatrixSdk::allSessions() const
	{
	using StdPath = std::filesystem::path;
	auto userDataDir = StdPath(m_d->userDataDir);
	auto allSessionsDir = userDataDir / "sessions";

	QStringList sessionNames;

	try {
	for (const auto &p : std::filesystem::directory_iterator(allSessionsDir)) {
	if (p.is_directory()) {
	auto maybeEncodedUserId = p.path().filename().string();
	auto userId = decodeBase64(maybeEncodedUserId, Base64Opts::urlSafe);
	if (userId.empty() \|\| userId[0] != '@') {
	continue;
	}
	for (const auto &q : std::filesystem::directory_iterator(p.path())) {
	auto path = q.path();
	auto deviceId = path.filename().string();
	std::error_code err;
	if (std::filesystem::exists(path / "store", err)) {
	sessionNames.append(QString::fromStdString(userId + "/" + deviceId));
	}
	}
	}
	}
	} catch (const std::filesystem::filesystem_error &) {
	qDebug() << "sessionDir not available, ignoring";
	}

	return sessionNames;
	}

	void MatrixSdk::serializeToFile() const
	{
	m_d->maybeSerialize();
	}

	-auto MatrixSdk::loadSession(QString sessionName) -> LoadSessionResult
	+void MatrixSdk::loadSession(QString sessionName)
	{
	using StdPath = std::filesystem::path;
	- std::unique_ptr<KazvSessionLockGuard> lockGuard;
	- auto loadFromSession = [this, sessionName, &lockGuard](StdPath sessionDir) {
	+ auto loadFromSession = [this, sessionName](StdPath sessionDir, std::unique_ptr<KazvSessionLockGuard> lockGuard) {
	auto storeFile = sessionDir / "store";

	auto metadataFile = sessionDir / "metadata";

	if (! std::filesystem::exists(storeFile)) {
	qDebug() << "storeFile does not exist, skip loading session " << sessionName;
	- return SessionNotFound;
	+ Q_EMIT loadSessionFinished(sessionName, SessionNotFound);
	+ return;
	}

	if (std::filesystem::exists(metadataFile)) {
	KConfig metadata(QString::fromStdString(metadataFile.string()));
	KConfigGroup mdGroup(&metadata, u"Metadata"_s);
	auto format = mdGroup.readEntry(u"archiveFormat"_s);
	if (format != QStringLiteral("text")) {
	qDebug() << "Unknown archive format:" << format;
	- return SessionFormatUnknown;
	+ Q_EMIT loadSessionFinished(sessionName, SessionFormatUnknown);
	+ return;
	}
	auto version = mdGroup.readEntry(u"kazvVersion"_s);
	auto curVersion = kazvVersionString();
	if (version != QString::fromStdString(curVersion)) {
	qDebug() << "A different version from the current one, making a backup";
	std::error_code err;
	auto now = std::chrono::system_clock::now();
	auto backupName =
	std::to_string(std::chrono::duration_cast<std::chrono::seconds>(now.time_since_epoch()).count());
	auto backupDir = sessionDir / "backup" / backupName;
	if (! std::filesystem::create_directories(backupDir, err)
	&& err) {
	qDebug() << "Cannot create backup directory";
	- return SessionCannotBackup;
	+ Q_EMIT loadSessionFinished(sessionName, SessionCannotBackup);
	+ return;
	}
	std::filesystem::copy_file(storeFile, backupDir / "store");
	std::filesystem::copy_file(metadataFile, backupDir / "metadata");
	}
	}

	SdkModel model;
	try {
	auto storeStream = std::ifstream(storeFile);
	if (! storeStream) {
	qDebug() << "Unable to open storeFile";
	- return SessionCannotOpenFile;
	+ Q_EMIT loadSessionFinished(sessionName, SessionCannotOpenFile);
	+ return;
	}
	using IAr = boost::archive::text_iarchive;
	auto archive = IAr{storeStream};
	archive >> model;
	qDebug() << "Finished loading session";
	} catch (const std::exception &e) {
	qDebug() << "Error when loading session:" << QString::fromStdString(e.what());
	- return SessionDeserializeFailed;
	+ Q_EMIT loadSessionFinished(sessionName, SessionDeserializeFailed);
	+ return;
	}
	- emplace(std::move(model), std::move(lockGuard));
	- return SessionLoadSuccess;
	+ QMetaObject::invokeMethod(this, [this, model=std::move(model), lockGuard=std::move(lockGuard)]() mutable {
	+ emplace(std::move(model), std::move(lockGuard));
	+ });
	+ Q_EMIT loadSessionFinished(sessionName, SessionLoadSuccess);
	};

	qDebug() << "in loadSession(), sessionName=" << sessionName;
	auto userDataDir = StdPath(m_d->userDataDir);
	auto parts = sessionName.split(u'/');
	if (parts.size() == 2) {
	auto userId = parts[0].toStdString();
	auto deviceId = parts[1].toStdString();
	auto sessionDir = sessionDirForUserAndDeviceId(userDataDir, userId, deviceId);
	+ std::unique_ptr<KazvSessionLockGuard> lockGuard;
	try {
	lockGuard = std::make_unique<KazvSessionLockGuard>(sessionDir);
	} catch (const std::runtime_error &e) {
	qCWarning(kazvLog) << "Error locking session: " << e.what();
	- return SessionLockFailed;
	+ Q_EMIT loadSessionFinished(sessionName, SessionLockFailed);
	+ return;
	}
	- return loadFromSession(sessionDir);
	+ QThreadPool::globalInstance()->start([loadFromSession, sessionDir, lockGuard=std::move(lockGuard)]() mutable {
	+ loadFromSession(sessionDir, std::move(lockGuard));
	+ });
	+ return;
	}
	qDebug(kazvLog) << "no session found for" << sessionName;
	- return SessionNotFound;
	+ Q_EMIT loadSessionFinished(sessionName, SessionNotFound);
	}

	bool MatrixSdk::deleteSession(QString sessionName) {
	using StdPath = std::filesystem::path;
	qDebug() << "in deleteSession(), sessionName=" << sessionName;
	auto userDataDir = StdPath(kazvUserDataDir().toStdString());
	auto parts = sessionName.split(u'/');
	if (parts.size() == 2) {
	auto userId = parts[0].toStdString();
	auto deviceId = parts[1].toStdString();
	auto sessionDir = sessionDirForUserAndDeviceId(userDataDir, userId, deviceId);
	if (std::filesystem::exists(sessionDir)) {
	qCDebug(kazvLog) << "new path works";
	return std::filesystem::remove_all(sessionDir);
	}
	qCDebug(kazvLog) << "trying legacy path";
	auto legacySessionDir = userDataDir / "sessions" / userId / deviceId;
	if (std::filesystem::exists(legacySessionDir)) {
	qCDebug(kazvLog) << "legacy path works";
	return std::filesystem::remove_all(legacySessionDir);
	}
	}
	qDebug(kazvLog) << "no session found for" << sessionName;
	return false;
	}

	bool MatrixSdk::startNewSession()
	{
	emplace(std::nullopt, std::unique_ptr<KazvSessionLockGuard>());
	return true;
	}

	static std::optional<std::string> optMaybe(QString s)
	{
	if (s.isEmpty()) {
	return std::nullopt;
	} else {
	return s.toStdString();
	}
	}

	MatrixPromise *MatrixSdk::createRoom(
	bool isPrivate,
	const QString &name,
	const QString &alias,
	const QStringList &invite,
	bool isDirect,
	bool allowFederate,
	const QString &topic,
	const QJsonValue &powerLevelContentOverride,
	CreateRoomPreset preset,
	bool encrypted
	)
	{
	immer::array<Event> initialState;

	if (encrypted) {
	initialState = {Event{json{
	{"type", "m.room.encryption"},
	{"state_key", ""},
	{"content", {
	{"algorithm", "m.megolm.v1.aes-sha2"},
	}},
	}}};
	}

	return new MatrixPromise(m_d->clientOnSecondaryRoot.createRoom(
	isPrivate ? Kazv::RoomVisibility::Private : Kazv::RoomVisibility::Public,
	optMaybe(name),
	optMaybe(alias),
	qStringListToStdF(invite),
	isDirect,
	allowFederate,
	optMaybe(topic),
	nlohmann::json(powerLevelContentOverride),
	static_cast<Kazv::CreateRoomPreset>(preset),
	initialState
	));
	}

	MatrixPromise *MatrixSdk::joinRoom(const QString &idOrAlias, const QStringList &servers)
	{
	return new MatrixPromise(m_d->clientOnSecondaryRoot.joinRoom(
	idOrAlias.toStdString(),
	qStringListToStdF(servers)
	));
	}

	MatrixPromise *MatrixSdk::setDeviceTrustLevel(QString userId, QString deviceId, QString trustLevel)
	{
	return new MatrixPromise(
	m_d->clientOnSecondaryRoot.setDeviceTrustLevel(
	userId.toStdString(),
	deviceId.toStdString(),
	qStringToTrustLevelFunc(trustLevel)
	)
	);
	}

	MatrixPromise *MatrixSdk::getSelfProfile()
	{
	return new MatrixPromise(
	m_d->clientOnSecondaryRoot.getProfile(userId().toStdString())
	);
	}

	MatrixPromise *MatrixSdk::setDisplayName(QString displayName)
	{
	return new MatrixPromise(
	m_d->clientOnSecondaryRoot.setDisplayName(
	displayName.isEmpty() ? std::nullopt : std::optional<std::string>(displayName.toStdString())
	)
	);
	}

	MatrixPromise *MatrixSdk::setAvatarUrl(QString avatarUrl)
	{
	return new MatrixPromise(
	m_d->clientOnSecondaryRoot.setAvatarUrl(
	avatarUrl.isEmpty() ? std::nullopt : std::optional<std::string>(avatarUrl.toStdString())
	)
	);
	}

	void MatrixSdk::startThread()
	{
	m_d->runIoContext();
	}

	RandomInterface &MatrixSdk::randomGenerator() const
	{
	return m_d->randomGenerator;
	}

	bool MatrixSdk::shouldNotify(MatrixEvent *event) const
	{
	// Do not notify own event
	if (event->sender() == userId()) {
	return false;
	}
	return m_d->notificationHandler.handleNotification(event->underlyingEvent()).shouldNotify;
	}

	bool MatrixSdk::shouldPlaySound(MatrixEvent *event) const
	{
	return m_d->notificationHandler.handleNotification(event->underlyingEvent()).sound.has_value();
	}

	MatrixStickerPackList *MatrixSdk::stickerPackList() const
	{
	return new MatrixStickerPackList(m_d->clientOnSecondaryRoot);
	}

	MatrixEvent *MatrixSdk::stickerRoomsEvent() const
	{
	return new MatrixEvent(m_d->clientOnSecondaryRoot.accountData()[imagePackRoomsEventType][lager::lenses::or_default]);
	}

	MatrixPromise *MatrixSdk::updateStickerPack(MatrixStickerPackSource source)
	{
	if (source.source == MatrixStickerPackSource::AccountData) {
	auto eventJson = std::move(source.event).raw().get();
	eventJson["type"] = source.eventType;
	return sendAccountDataImpl(Event(std::move(eventJson)));
	} else if (source.source == MatrixStickerPackSource::RoomState) {
	auto eventJson = std::move(source.event).raw().get();
	eventJson["type"] = source.eventType;
	eventJson["state_key"] = source.stateKey;
	return new MatrixPromise(
	m_d->clientOnSecondaryRoot
	.room(source.roomId)
	.sendStateEvent(Event(std::move(eventJson))));
	} else {
	return 0;
	}
	}

	MatrixUserGivenAttrsMap *MatrixSdk::userGivenNicknameMap() const
	{
	return new MatrixUserGivenAttrsMap(
	userGivenNicknameMapFor(m_d->clientOnSecondaryRoot),
	[client=m_d->clientOnSecondaryRoot](json content) {
	return client.setAccountData(json{
	{"type", USER_GIVEN_NICKNAME_EVENT_TYPES[0]},
	{"content", std::move(content)},
	});
	}
	);
	}

	MatrixPromise *MatrixSdk::sendAccountData(const QString &type, const QJsonObject &content)
	{
	Event e = json{
	{"type", type.toStdString()},
	{"content", content},
	};
	return sendAccountDataImpl(std::move(e));
	}

	MatrixPromise *MatrixSdk::sendAccountDataImpl(Event event)
	{
	return new MatrixPromise(m_d->clientOnSecondaryRoot.setAccountData(event));
	}

	MatrixPromise *MatrixSdk::getSpecVersions()
	{
	return new MatrixPromise(m_d->clientOnSecondaryRoot.getVersions(LAGER_QT(serverUrl).get().toStdString()));
	}

	void MatrixSdk::setUserDataDir(const std::string &userDataDir)
	{
	m_d->userDataDir = userDataDir;
	}

	#include "matrix-sdk.moc"
	diff --git a/src/matrix-sdk.hpp b/src/matrix-sdk.hpp
	index 2074ef8..a2f2813 100644
	--- a/src/matrix-sdk.hpp
	+++ b/src/matrix-sdk.hpp
	@@ -1,315 +1,318 @@
	/*
	* This file is part of kazv.
	* SPDX-FileCopyrightText: 2020-2023 tusooa <tusooa@kazv.moe>
	* SPDX-License-Identifier: AGPL-3.0-or-later
	*/

	#pragma once
	#include <kazv-defs.hpp>

	#include <QObject>
	#include <QQmlEngine>
	#include <QString>

	#include <memory>
	#include <filesystem>

	#include <lager/extra/qt.hpp>

	#include <sdk-model.hpp>
	#include <random-generator.hpp>

	#include "meta-types.hpp"
	Q_MOC_INCLUDE("matrix-room-list.hpp")
	Q_MOC_INCLUDE("matrix-device-list.hpp")
	Q_MOC_INCLUDE("matrix-promise.hpp")
	Q_MOC_INCLUDE("matrix-event.hpp")
	Q_MOC_INCLUDE("matrix-sticker-pack-list.hpp")
	Q_MOC_INCLUDE("matrix-user-given-attrs-map.hpp")

	class MatrixRoomList;
	class MatrixDeviceList;
	class MatrixPromise;
	class MatrixSdkTest;
	class MatrixSdkSessionsTest;
	class MatrixEvent;
	class MatrixStickerPackList;
	class MatrixUserGivenAttrsMap;
	class KazvSessionLockGuard;

	struct MatrixSdkPrivate;

	std::filesystem::path sessionDirForUserAndDeviceId(std::filesystem::path userDataDir, std::string userId, std::string deviceId);

	class MatrixSdk : public QObject
	{
	Q_OBJECT
	QML_ELEMENT

	QString m_userDataDir;
	std::unique_ptr<MatrixSdkPrivate> m_d;

	/// @param d A dynamically allocated d-pointer, whose ownership
	/// will be transferred to this MatrixSdk.
	explicit MatrixSdk(std::unique_ptr<MatrixSdkPrivate> d, QObject *parent);

	void init();

	public:
	enum CreateRoomPreset {
	PrivateChat = Kazv::CreateRoomPreset::PrivateChat,
	PublicChat = Kazv::CreateRoomPreset::PublicChat,
	TrustedPrivateChat = Kazv::CreateRoomPreset::TrustedPrivateChat,
	};

	Q_ENUM(CreateRoomPreset);

	enum LoadSessionResult {
	/// Successfully loaded the session
	SessionLoadSuccess,
	/// There is no store file
	SessionNotFound,
	/// The format of the store file is not supported
	SessionFormatUnknown,
	/// The store file cannot be backed up
	SessionCannotBackup,
	/// Cannot grab the lock on the session file
	SessionLockFailed,
	/// Cannot open store file
	SessionCannotOpenFile,
	/// Cannot deserialize the store file
	SessionDeserializeFailed,
	};

	Q_ENUM(LoadSessionResult);

	enum MediaDownloadEndpointVersion {
	UnauthenticatedMediaV3, // Classical endpoint series
	AuthenticatedMediaV1, // Endpoints that needs authorization
	};

	Q_ENUM(MediaDownloadEndpointVersion);

	explicit MatrixSdk(QObject *parent = 0);
	~MatrixSdk() override;

	LAGER_QT_READER(QString, serverUrl);
	LAGER_QT_READER(QString, userId);
	LAGER_QT_READER(QString, token);
	LAGER_QT_READER(QString, deviceId);
	LAGER_QT_READER(immer::array<std::string>, specVersions); // The versions of the Matrix Spec supported by the server.

	Q_INVOKABLE MatrixRoomList *roomList() const;

	Q_INVOKABLE QString mxcUriToHttp(QString mxcUri) const;

	Q_INVOKABLE QString mxcUriToHttpAuthenticatedV1(QString mxcUri) const;

	Q_INVOKABLE MatrixDeviceList *devicesOfUser(QString userId) const;

	// Return true if version is at least as new as the spec version of server
	Q_INVOKABLE bool checkSpecVersion(QString version) const;

	// Return true if the spec version of server in the range [minVer, maxVer]
	Q_INVOKABLE bool checkSpecVersionRange(QString minVer, QString maxVer) const;

	Kazv::RandomInterface &randomGenerator() const;

	private:
	// Replaces the store with another one
	void emplace(std::optional<Kazv::SdkModel> model, std::unique_ptr<KazvSessionLockGuard> lockGuard);

	static std::string validateHomeserverUrl(const QString &url);

	Q_SIGNALS:
	void trigger(Kazv::KazvEvent e);

	void loginSuccessful(Kazv::KazvEvent e);
	void loginFailed(QString errorCode, QString errorMsg);
	void discoverFailed(QString errorCode, QString errorMsg);
	void logoutSuccessful();
	void logoutFailed(QString errorCode, QString errorMsg);

	void receivedMessage(QString roomId, QString eventId);

	void sessionChanged();

	+ void loadSessionFinished(QString sessionName, MatrixSdk::LoadSessionResult result);
	+
	public Q_SLOTS:
	void login(const QString &userId, const QString &password, const QString &homeserverUrl);
	void logout();

	/**
	* Serialize data to <AppDataDir>/sessions/<userid>/<deviceid>/
	*
	* If not logged in, do nothing.
	*/
	void serializeToFile() const;

	/**
	- * Load session at <AppDataDir>/sessions/<sessionName> .
	+ * Load session at <AppDataDir>/sessions/<sessionName> asynchronously.
	*
	- * @param sessionName A string in the form of <userid>/<deviceid> .
	+ * When the session is loaded or when there is an error, loadSessionFinished
	+ * will be called with the result.
	*
	- * @return true if successful, false otherwise.
	+ * @param sessionName A string in the form of <userid>/<deviceid> .
	*/
	- LoadSessionResult loadSession(QString sessionName);
	+ void loadSession(QString sessionName);

	/**
	* Delete session at <AppDataDir>/sessions/<sessionName> .
	*
	* @param sessionName A string in the form of <userid>/<deviceid> .
	*
	* @return true if successful, false otherwise.
	*/
	bool deleteSession(QString sessionName);

	/**
	* Start an empty session.
	*
	* The new session is not logged in, and need to call login().
	*
	* @return true if successful, false otherwise.
	*/
	bool startNewSession();

	/**
	* Get all saved sessions.
	*
	* @return A list of session names in the form of <userid>/<deviceid> .
	*/
	QStringList allSessions() const;

	/**
	* Create a new room.
	*
	* @param isPrivate Whether the room is private.
	* @param name The room's name.
	* @param alias The alias of the room.
	* @param invite List of matrix ids of users to invite.
	* @param isDirect Whether it is a direct message room.
	* @param allowFederate Whether to allow users on other servers to join.
	* @param topic The topic of the room.
	* @param powerLevelContentOverride The content to override m.room.power_levels event.
	* @param preset The preset to create the room with.
	* @param encrypted Whether to enable encryption for this room.
	*/
	MatrixPromise *createRoom(
	bool isPrivate,
	const QString &name,
	const QString &alias,
	const QStringList &invite,
	bool isDirect,
	bool allowFederate,
	const QString &topic,
	const QJsonValue &powerLevelContentOverride,
	CreateRoomPreset preset,
	bool encrypted
	);

	/**
	* Join a room.
	* @param idOrAlias The id or alias of the room to join.
	* @param servers The servers to use when joining the room.
	*/
	MatrixPromise *joinRoom(
	const QString &idOrAlias,
	const QStringList &servers
	);

	/**
	* Change the trust level of a device.
	*
	* @param userId The user id that owns the device.
	* @param deviceId The device id to set the trust level.
	* @param trustLevel The trust level.
	*
	* @return A MatrixPromise representing the progress.
	*/
	MatrixPromise *setDeviceTrustLevel(QString userId, QString deviceId, QString trustLevel);

	/**
	* Get the profile of the current user.
	*
	* @return A MatrixPromise representing the progress.
	*/
	MatrixPromise *getSelfProfile();

	/**
	* Set the display name of the current user.
	*
	* @return A MatrixPromise representing the progress.
	*/
	MatrixPromise *setDisplayName(QString displayName);

	/**
	* Set the avatar url of the current user.
	*
	* @return A MatrixPromise representing the progress.
	*/
	MatrixPromise *setAvatarUrl(QString avatarUrl);

	/**
	* Check if an event should be notified.
	*
	* @param event The event to check.
	* @return Whether `event` should be notified.
	*/
	bool shouldNotify(MatrixEvent *event) const;

	/**
	* Check if an event should be notified with sound.
	*
	* You should only call this method when `shouldNotify(event)`
	* returns true.
	*
	* @param event The event to check.
	* @return Whether `event` should be notified with sound.
	*/
	bool shouldPlaySound(MatrixEvent *event) const;

	/**
	* Get the sticker pack list for the current account.
	*
	* @return A list of sticker packs associated with the current account.
	*/
	MatrixStickerPackList *stickerPackList() const;

	/**
	* Get the sticker rooms account data event for the current account.
	*
	* @return A MatrixEvent representing the sticker rooms account data event.
	*/
	MatrixEvent *stickerRoomsEvent() const;

	/**
	* Update the sticker pack from source.
	*
	* @param source The source of the sticker pack to update.
	* @return A promise that resolves when the sticker pack is updated,
	* or when there is an error.
	*/
	MatrixPromise *updateStickerPack(MatrixStickerPackSource source);

	MatrixUserGivenAttrsMap *userGivenNicknameMap() const;

	MatrixPromise *sendAccountData(const QString &type, const QJsonObject &content);

	/**
	* Get all Matrix Spec versions supported by the server.
	* Use MatrixSdk::supportSpecVersion() to check if a version is supported.
	*/
	MatrixPromise *getSpecVersions();

	private:
	MatrixPromise *sendAccountDataImpl(Kazv::Event event);

	private: // Testing
	friend MatrixSdkTest;
	friend MatrixSdkSessionsTest;
	friend MatrixSdk *makeTestSdk(Kazv::SdkModel model);

	void setUserDataDir(const std::string &userDataDir);

	explicit MatrixSdk(Kazv::SdkModel model, bool testing = false, QObject *parent = 0);
	void startThread();
	};
	diff --git a/src/tests/matrix-sdk-session-loader.cpp b/src/tests/matrix-sdk-session-loader.cpp
	index 9fd9d67..6e8ae95 100644
	--- a/src/tests/matrix-sdk-session-loader.cpp
	+++ b/src/tests/matrix-sdk-session-loader.cpp
	@@ -1,26 +1,29 @@
	/*
	* This file is part of kazv.
	* SPDX-FileCopyrightText: 2024 tusooa <tusooa@kazv.moe>
	* SPDX-License-Identifier: AGPL-3.0-or-later
	*/

	#include <kazv-defs.hpp>
	#include <iostream>
	+#include <cstdlib>
	+#include <QCoreApplication>
	#include <QString>
	#include "matrix-sdk-sessions-test.hpp"

	-int main([[maybe_unused]] int argc, char *argv[])
	+int main(int argc, char *argv[])
	{
	std::string userDataDir = argv[1];
	std::string sessionName = argv[2];
	+ auto app = QCoreApplication(argc, argv);
	auto sdk = MatrixSdkSessionsTest::makeMatrixSdkImpl(userDataDir);
	- auto res = sdk->loadSession(QString::fromStdString(sessionName));
	- if (res != MatrixSdk::SessionLoadSuccess) {
	- std::cout << "cannot load session" << std::endl;
	- return res == MatrixSdk::SessionLockFailed ? 1 : 2;
	- }
	-
	- std::cout << "loaded session" << std::endl;
	- while (1) {}
	- return 0;
	+ QObject::connect(sdk.get(), &MatrixSdk::loadSessionFinished, [](auto, auto res) {
	+ if (res != MatrixSdk::SessionLoadSuccess) {
	+ std::cout << "cannot load session" << std::endl;
	+ std::exit(res == MatrixSdk::SessionLockFailed ? 1 : 2);
	+ }
	+ std::cout << "loaded session" << std::endl;
	+ });
	+ sdk->loadSession(QString::fromStdString(sessionName));
	+ return app.exec();
	}
	diff --git a/src/tests/matrix-sdk-sessions-test.cpp b/src/tests/matrix-sdk-sessions-test.cpp
	index 4c19e3d..5d164a6 100644
	--- a/src/tests/matrix-sdk-sessions-test.cpp
	+++ b/src/tests/matrix-sdk-sessions-test.cpp
	@@ -1,195 +1,201 @@
	/*
	* This file is part of kazv.
	* SPDX-FileCopyrightText: 2024 tusooa <tusooa@kazv.moe>
	* SPDX-License-Identifier: AGPL-3.0-or-later
	*/

	#include <kazv-defs.hpp>
	#include <kazv-platform.hpp>
	#include <memory>
	#include <filesystem>
	#include <fstream>
	#include <QObject>
	#include <QtTest>
	#include <QProcess>
	#include <QCoreApplication>
	#include <crypto/base64.hpp>
	#include "test-temp.hpp"
	#include "matrix-sdk-sessions-test.hpp"

	using namespace Qt::Literals::StringLiterals;
	using namespace Kazv;
	namespace Fs = std::filesystem;
	using StdPath = Fs::path;

	void MatrixSdkSessionsTest::initTestCase()
	{
	auto dir = StdPath(kazvTestTempDir()) / "sessions-test";
	m_userDataDir = dir.string();
	}

	void MatrixSdkSessionsTest::clearDir()
	{
	QVERIFY(!m_userDataDir.empty());
	std::error_code ec;
	Fs::remove_all(StdPath(m_userDataDir), ec);
	QVERIFY(!ec);
	}

	void MatrixSdkSessionsTest::init() { clearDir(); }

	void MatrixSdkSessionsTest::cleanup() { clearDir(); }

	void MatrixSdkSessionsTest::createSession(std::string userId, std::string deviceId)
	{
	auto sessionsDir = StdPath(m_userDataDir) / "sessions";
	SdkModel model;
	model.client.userId = userId;
	model.client.deviceId = deviceId;
	{
	auto sdk = makeMatrixSdk(model, /* testing = */ false);
	sdk->serializeToFile();
	}
	// Not ideal, but this is the only way to wait for
	// MatrixSdkPravite to be destroyed.
	QTest::qWait(100);
	}

	void MatrixSdkSessionsTest::testListSessions()
	{
	createSession("@mew:example.com", "device1");
	createSession("@mew:example.com", "device2");
	createSession("@mew2:example.com", "device3");

	auto sdk = makeMatrixSdk();
	QSet<QString> expected{
	QStringLiteral("@mew:example.com/device1"),
	QStringLiteral("@mew:example.com/device2"),
	QStringLiteral("@mew2:example.com/device3"),
	};

	auto sessionList = sdk->allSessions();
	auto sessionSet = QSet<QString>(sessionList.begin(), sessionList.end());
	QCOMPARE(sessionSet, expected);
	}

	void MatrixSdkSessionsTest::testListLegacySessions()
	{
	// This test cannot be run on Windows, because the file name
	// there cannot contain ':'.
	#if KAZV_IS_WINDOWS
	QSKIP("Skipping because there are no legacy sessions on Windows");
	#endif

	createSession("@mew:example.com", "device1");
	auto legacySession = StdPath(m_userDataDir) / "sessions" / "@mew3:example.com" / "device4";
	{
	std::ofstream s{legacySession / "store"};
	s << "";
	}
	auto sdk = makeMatrixSdk();

	QStringList expected{
	QStringLiteral("@mew:example.com/device1"),
	};

	QCOMPARE(sdk->allSessions(), expected);
	}

	void MatrixSdkSessionsTest::testLoadSession()
	{
	createSession("@mew:example.com", "device4");

	auto sdk = makeMatrixSdk();
	- auto res = sdk->loadSession(u"@mew:example.com/device4"_s);
	+ auto spy = QSignalSpy(sdk.get(), &MatrixSdk::loadSessionFinished);
	+ sdk->loadSession(u"@mew:example.com/device4"_s);
	+ spy.wait();
	+ auto res = spy.first().at(1);
	QCOMPARE(res, MatrixSdk::SessionLoadSuccess);
	QCOMPARE(sdk->userId(), QStringLiteral("@mew:example.com"));
	QCOMPARE(sdk->deviceId(), QStringLiteral("device4"));
	}

	void MatrixSdkSessionsTest::testSessionLock()
	{
	#if KAZV_IS_WINDOWS
	QSKIP("Skipping because session lock is not yet supported on Windows");
	#else
	createSession("@mew:example.com", "device5");

	auto program = QCoreApplication::applicationDirPath() + QStringLiteral("/matrix-sdk-session-loader");
	QProcess proc1;
	QStringList args{
	QString::fromStdString(m_userDataDir),
	QStringLiteral("@mew:example.com/device5"),
	};
	proc1.start(program, args);
	proc1.waitForReadyRead();
	auto line = proc1.readLine();
	QCOMPARE(line, QByteArray("loaded session\n"));

	QProcess proc2;
	proc2.start(program, args);
	auto res = proc2.waitForFinished();
	QVERIFY(res);
	QCOMPARE(proc2.exitStatus(), QProcess::NormalExit);
	QCOMPARE(proc2.exitCode(), 1);

	proc1.kill();
	#endif
	}

	void MatrixSdkSessionsTest::testSaveSessionFailure()
	{
	#if KAZV_IS_WINDOWS
	QSKIP("Skipping because session the condition cannot be easily satisfied on Windows");
	#endif

	auto userId = std::string("@mew:example.com");
	auto deviceId = std::string("device1");
	createSession(userId, deviceId);

	auto sessionDir = sessionDirForUserAndDeviceId(Fs::path(m_userDataDir), userId, deviceId);
	// there is store, metadata and lock under the sessionDir

	std::error_code err;
	// make the sessionDir readonly, so that new file cannot be created
	Fs::permissions(
	sessionDir,
	Fs::perms::owner_read \| Fs::perms::owner_exec,
	Fs::perm_options::replace,
	err);
	QVERIFY(!err);
	err.clear();

	// a model that is slightly different from the original one
	SdkModel model;
	model.client.userId = userId;
	model.client.deviceId = deviceId;
	model.client.serverUrl = "https://example.com";

	{
	auto sdk = makeMatrixSdk(model, /* testing = */ false);
	// this should fail
	sdk->serializeToFile();
	}
	// Not ideal, but this is the only way to wait for
	// MatrixSdkPravite to be destroyed.
	QTest::qWait(100);

	auto sdk = makeMatrixSdk();
	- auto res = sdk->loadSession(QString::fromStdString(userId + "/" + deviceId));
	+ auto spy = QSignalSpy(sdk.get(), &MatrixSdk::loadSessionFinished);
	+ sdk->loadSession(QString::fromStdString(userId + "/" + deviceId));
	+ spy.wait();
	+ auto res = spy.first().at(1);
	QCOMPARE(res, MatrixSdk::SessionLoadSuccess);
	// verify that the original data is kept
	QCOMPARE(sdk->serverUrl(), u""_s);

	// before cleaning up, add write permissions back so the files can be removed
	Fs::permissions(
	sessionDir,
	Fs::perms::owner_read \| Fs::perms::owner_write \| Fs::perms::owner_exec,
	Fs::perm_options::replace,
	err);
	QVERIFY(!err);
	err.clear();
	}

	#ifndef MATRIX_SDK_SESSIONS_TEST_NO_MAIN
	QTEST_MAIN(MatrixSdkSessionsTest)
	#endif

File Metadata

Mime Type: text/x-diff
Expires: Sun, Oct 11, 1:34 PM (1 d, 16 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1785825
Default Alt Text: (62 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions