database.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021 Tobias Fella <fella@posteo.de>
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <QtCore/QObject>
#include <QtSql/QSqlQuery>
#include <QtCore/QVector>
 
#include <QtCore/QHash>
 
#include "e2ee/e2ee_common.h"
 
namespace Quotient {
 
class QOlmAccount;
class QOlmSession;
class QOlmInboundGroupSession;
class QOlmOutboundGroupSession;
 
class QUOTIENT_API Database
{
public:
    Database(const QString& userId, const QString& deviceId,
             PicklingKey&& picklingKey);
 
    int version();
    void transaction();
    void commit();
    QSqlQuery execute(const QString &queryString);
    void execute(QSqlQuery &query);
    QSqlDatabase database() const;
    QSqlQuery prepareQuery(const QString& queryString) const;
 
    void storeOlmAccount(const QOlmAccount& olmAccount);
    std::optional<OlmErrorCode> setupOlmAccount(QOlmAccount &olmAccount);
    void clear();
    void saveOlmSession(const QByteArray& senderKey, const QOlmSession& session,
                        const QDateTime& timestamp);
    std::unordered_map<QByteArray, std::vector<QOlmSession>> loadOlmSessions();
    std::unordered_map<QByteArray, QOlmInboundGroupSession> loadMegolmSessions(
        const QString& roomId);
    void saveMegolmSession(const QString& roomId,
                           const QOlmInboundGroupSession& session,
                           const QByteArray& senderKey,
                           const QByteArray& senderClaimedEdKey);
    void addGroupSessionIndexRecord(const QString& roomId,
                                    const QString& sessionId, uint32_t index,
                                    const QString& eventId, qint64 ts);
    std::pair<QString, qint64> groupSessionIndexRecord(const QString& roomId,
                                                       const QString& sessionId,
                                                       qint64 index);
    void clearRoomData(const QString& roomId);
    void setOlmSessionLastReceived(const QByteArray& sessionId,
                                   const QDateTime& timestamp);
    std::optional<QOlmOutboundGroupSession> loadCurrentOutboundMegolmSession(const QString& roomId);
    void saveCurrentOutboundMegolmSession(
        const QString& roomId, const QOlmOutboundGroupSession& session);
    void updateOlmSession(const QByteArray& senderKey,
                          const QOlmSession& session);
 
    // Returns a map UserId -> [DeviceId] that have not received key yet
    QMultiHash<QString, QString> devicesWithoutKey(
        const QString& roomId, QMultiHash<QString, QString> devices,
        const QByteArray& sessionId);
    // 'devices' contains tuples {userId, deviceId, curveKey}
    void setDevicesReceivedKey(
        const QString& roomId,
        const QVector<std::tuple<QString, QString, QString>>& devices,
        const QByteArray& sessionId, uint32_t index);
 
    bool isSessionVerified(const QString& edKey);
    void setSessionVerified(const QString& edKeyId);
    void setMasterKeyVerified(const QString& masterKey);
 
    QString edKeyForKeyId(const QString& userId, const QString& edKeyId);
    void storeEncrypted(const QString& name, const QByteArray& key);
    QByteArray loadEncrypted(const QString& name);
 
    QString userSigningPublicKey();
    QString selfSigningPublicKey();
 
    QString edKeyForMegolmSession(const QString& sessionId);
    QString senderKeyForMegolmSession(const QString& sessionId);
 
private:
    void migrateTo1();
    void migrateTo2();
    void migrateTo3();
    void migrateTo4();
    void migrateTo5();
    void migrateTo6();
    void migrateTo7();
    void migrateTo8();
    void migrateTo9();
    void migrateTo10();
 
    QString m_userId;
    QString m_deviceId;
    PicklingKey m_picklingKey;
};
} // namespace Quotient