/* * nheko Copyright (C) 2017 Konstantinos Sideris * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #pragma once #include #include #include #include #include #include "RoomState.h" #include "Utils.h" struct SearchResult { QString user_id; QString display_name; }; Q_DECLARE_METATYPE(SearchResult) Q_DECLARE_METATYPE(QVector) //! Used to uniquely identify a list of read receipts. struct ReadReceiptKey { std::string event_id; std::string room_id; }; inline void to_json(json &j, const ReadReceiptKey &key) { j = json{{"event_id", key.event_id}, {"room_id", key.room_id}}; } inline void from_json(const json &j, ReadReceiptKey &key) { key.event_id = j.at("event_id").get(); key.room_id = j.at("room_id").get(); } //! UI info associated with a room. struct RoomInfo { //! The calculated name of the room. std::string name; //! The topic of the room. std::string topic; //! The calculated avatar url of the room. std::string avatar_url; //! Whether or not the room is an invite. bool is_invite = false; }; inline void to_json(json &j, const RoomInfo &info) { j["name"] = info.name; j["topic"] = info.topic; j["avatar_url"] = info.avatar_url; j["is_invite"] = info.is_invite; } inline void from_json(const json &j, RoomInfo &info) { info.name = j.at("name"); info.topic = j.at("topic"); info.avatar_url = j.at("avatar_url"); info.is_invite = j.at("is_invite"); } //! Basic information per member; struct MemberInfo { std::string name; std::string avatar_url; }; inline void to_json(json &j, const MemberInfo &info) { j["name"] = info.name; j["avatar_url"] = info.avatar_url; } inline void from_json(const json &j, MemberInfo &info) { info.name = j.at("name"); info.avatar_url = j.at("avatar_url"); } Q_DECLARE_METATYPE(RoomInfo) class Cache : public QObject { Q_OBJECT public: Cache(const QString &userId, QObject *parent = nullptr); static QHash DisplayNames; static QHash AvatarUrls; static std::string displayName(const std::string &room_id, const std::string &user_id); static QString displayName(const QString &room_id, const QString &user_id); static QString avatarUrl(const QString &room_id, const QString &user_id); static void removeDisplayName(const QString &room_id, const QString &user_id); static void removeAvatarUrl(const QString &room_id, const QString &user_id); static void insertDisplayName(const QString &room_id, const QString &user_id, const QString &display_name); static void insertAvatarUrl(const QString &room_id, const QString &user_id, const QString &avatar_url); //! Load saved data for the display names & avatars. void populateMembers(); std::vector joinedRooms(); QMap roomInfo(); //! Calculate & return the name of the room. QString getRoomName(lmdb::txn &txn, lmdb::dbi &statesdb, lmdb::dbi &membersdb); //! Retrieve the topic of the room if any. QString getRoomTopic(lmdb::txn &txn, lmdb::dbi &statesdb); //! Retrieve the room avatar's url if any. QString getRoomAvatarUrl(lmdb::txn &txn, lmdb::dbi &statesdb, lmdb::dbi &membersdb, const QString &room_id); void saveState(const mtx::responses::Sync &res); bool isInitialized() const; QString nextBatchToken() const; void deleteData(); void removeInvite(const std::string &room_id); void removeRoom(lmdb::txn &txn, const std::string &roomid); void removeRoom(const std::string &roomid); void removeRoom(const QString &roomid) { removeRoom(roomid.toStdString()); }; void setup(); bool isFormatValid(); void setCurrentFormat(); //! Adds a user to the read list for the given event. //! //! There should be only one user id present in a receipt list per room. //! The user id should be removed from any other lists. using Receipts = std::map>; void updateReadReceipt(lmdb::txn &txn, const std::string &room_id, const Receipts &receipts); //! Retrieve all the read receipts for the given event id and room. //! //! Returns a map of user ids and the time of the read receipt in milliseconds. using UserReceipts = std::multimap>; UserReceipts readReceipts(const QString &event_id, const QString &room_id); QByteArray image(const QString &url) const; void saveImage(const QString &url, const QByteArray &data); std::vector roomsWithStateUpdates(const mtx::responses::Sync &res); std::map getRoomInfo(const std::vector &rooms); std::map roomUpdates(const mtx::responses::Sync &sync) { return getRoomInfo(roomsWithStateUpdates(sync)); } QVector getAutocompleteMatches(const std::string &room_id, const std::string &query, std::uint8_t max_items = 5); private: //! Save an invited room. void saveInvite(lmdb::txn &txn, lmdb::dbi &statesdb, lmdb::dbi &membersdb, const mtx::responses::InvitedRoom &room); QString getInviteRoomName(lmdb::txn &txn, lmdb::dbi &statesdb, lmdb::dbi &membersdb); QString getInviteRoomTopic(lmdb::txn &txn, lmdb::dbi &statesdb); QString getInviteRoomAvatarUrl(lmdb::txn &txn, lmdb::dbi &statesdb, lmdb::dbi &membersdb); //! Remove a room from the cache. // void removeLeftRoom(lmdb::txn &txn, const std::string &room_id); template void saveStateEvents(lmdb::txn &txn, const lmdb::dbi &statesdb, const lmdb::dbi &membersdb, const std::string &room_id, const std::vector &events) { for (const auto &e : events) saveStateEvent(txn, statesdb, membersdb, room_id, e); } template void saveStateEvent(lmdb::txn &txn, const lmdb::dbi &statesdb, const lmdb::dbi &membersdb, const std::string &room_id, const T &event) { using namespace mtx::events; using namespace mtx::events::state; if (mpark::holds_alternative>(event)) { const auto e = mpark::get>(event); switch (e.content.membership) { // // We only keep users with invite or join membership. // case Membership::Invite: case Membership::Join: { auto display_name = e.content.display_name.empty() ? e.state_key : e.content.display_name; // Lightweight representation of a member. MemberInfo tmp{display_name, e.content.avatar_url}; lmdb::dbi_put(txn, membersdb, lmdb::val(e.state_key), lmdb::val(json(tmp).dump())); insertDisplayName(QString::fromStdString(room_id), QString::fromStdString(e.state_key), QString::fromStdString(display_name)); insertAvatarUrl(QString::fromStdString(room_id), QString::fromStdString(e.state_key), QString::fromStdString(e.content.avatar_url)); break; } default: { lmdb::dbi_del( txn, membersdb, lmdb::val(e.state_key), lmdb::val("")); removeDisplayName(QString::fromStdString(room_id), QString::fromStdString(e.state_key)); removeAvatarUrl(QString::fromStdString(room_id), QString::fromStdString(e.state_key)); break; } } return; } if (!isStateEvent(event)) return; mpark::visit( [&txn, &statesdb](auto e) { lmdb::dbi_put( txn, statesdb, lmdb::val(to_string(e.type)), lmdb::val(json(e).dump())); }, event); } template bool isStateEvent(const T &e) { using namespace mtx::events; using namespace mtx::events::state; return mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e); } template bool containsStateUpdates(const T &e) { using namespace mtx::events; using namespace mtx::events::state; return mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e); } bool containsStateUpdates(const mtx::events::collections::StrippedEvents &e) { using namespace mtx::events; using namespace mtx::events::state; return mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e) || mpark::holds_alternative>(e); } void saveInvites(lmdb::txn &txn, const std::map &rooms); //! Remove any saved invites that are not found in the input. void removeStaleInvites(lmdb::txn &txn, const std::map &curr); //! Sends signals for the rooms that are removed. void removeLeftRooms(lmdb::txn &txn, const std::map &rooms) { for (const auto &room : rooms) removeRoom(txn, room.first); } lmdb::dbi getInviteStatesDb(lmdb::txn &txn, const std::string &room_id) { return lmdb::dbi::open( txn, std::string(room_id + "/invite_state").c_str(), MDB_CREATE); } lmdb::dbi getInviteMembersDb(lmdb::txn &txn, const std::string &room_id) { return lmdb::dbi::open( txn, std::string(room_id + "/invite_members").c_str(), MDB_CREATE); } lmdb::dbi getStatesDb(lmdb::txn &txn, const std::string &room_id) { return lmdb::dbi::open(txn, std::string(room_id + "/state").c_str(), MDB_CREATE); } lmdb::dbi getMembersDb(lmdb::txn &txn, const std::string &room_id) { return lmdb::dbi::open(txn, std::string(room_id + "/members").c_str(), MDB_CREATE); } QString getDisplayName(const mtx::events::StateEvent &event) { if (!event.content.display_name.empty()) return QString::fromStdString(event.content.display_name); return QString::fromStdString(event.state_key); } void setNextBatchToken(lmdb::txn &txn, const std::string &token); void setNextBatchToken(lmdb::txn &txn, const QString &token); lmdb::env env_; lmdb::dbi syncStateDb_; lmdb::dbi roomsDb_; lmdb::dbi invitesDb_; lmdb::dbi mediaDb_; lmdb::dbi readReceiptsDb_; QString localUserId_; QString cacheDirectory_; };