/* * Copyright (C) 2018 Aetf * * 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 2 or (at your option) * version 3 of the License. * * 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 . */ #ifndef KEEPASSXC_FDOSECRETS_COLLECTION_H #define KEEPASSXC_FDOSECRETS_COLLECTION_H #include "fdosecrets/dbus/DBusClient.h" #include "fdosecrets/dbus/DBusObject.h" #include "core/EntrySearcher.h" class Database; class DatabaseWidget; class Entry; class Group; namespace FdoSecrets { class Item; class PromptBase; class Service; class Collection : public DBusObject { Q_OBJECT Q_CLASSINFO("D-Bus Interface", DBUS_INTERFACE_SECRET_COLLECTION_LITERAL) explicit Collection(Service* parent, DatabaseWidget* backend); public: /** * @brief Create a new instance of `Collection` * @param parent the owning Service * @param backend the widget containing the database * @return pointer to created instance, or nullptr when error happens. * This may be caused by * - DBus path registration error * - database has no exposed group */ static Collection* Create(Service* parent, DatabaseWidget* backend); Q_INVOKABLE DBUS_PROPERTY DBusResult items(QList& items) const; Q_INVOKABLE DBUS_PROPERTY DBusResult label(QString& label) const; Q_INVOKABLE DBusResult setLabel(const QString& label); Q_INVOKABLE DBUS_PROPERTY DBusResult locked(bool& locked) const; Q_INVOKABLE DBUS_PROPERTY DBusResult created(qulonglong& created) const; Q_INVOKABLE DBUS_PROPERTY DBusResult modified(qulonglong& modified) const; Q_INVOKABLE DBusResult remove(PromptBase*& prompt); Q_INVOKABLE DBusResult searchItems(const DBusClientPtr& client, const StringStringMap& attributes, QList& items); Q_INVOKABLE DBusResult createItem(const QVariantMap& properties, const Secret& secret, bool replace, Item*& item, PromptBase*& prompt); signals: void itemCreated(Item* item); void itemDeleted(Item* item); void itemChanged(Item* item); void collectionChanged(); void collectionAboutToDelete(); void collectionLockChanged(bool newLocked); void aliasAboutToAdd(const QString& alias); void aliasAdded(const QString& alias); void aliasRemoved(const QString& alias); void doneUnlockCollection(bool accepted); public: DBusResult setProperties(const QVariantMap& properties); bool isValid() const { return backend(); } DBusResult removeAlias(QString alias); DBusResult addAlias(QString alias); const QSet aliases() const; /** * A human readable name of the collection, available even if the db is locked * @return */ QString name() const; Group* exposedRootGroup() const; DatabaseWidget* backend() const; QString backendFilePath() const; Service* service() const; static EntrySearcher::SearchTerm attributeToTerm(const QString& key, const QString& value); public slots: // expose some methods for Prompt to use bool doLock(); // actually only closes database tab in KPXC bool doDelete(); // Async, finish signal doneUnlockCollection void doUnlock(); bool doDeleteEntry(Entry* entry); Item* doNewItem(const DBusClientPtr& client, QString itemPath); // Only delete from dbus, will remove self. Do not affect database in KPXC void removeFromDBus(); // force reload info from backend, potentially delete self bool reloadBackend(); private slots: void onDatabaseLockChanged(); void onDatabaseExposedGroupChanged(); // calls reloadBackend, delete self when error void reloadBackendOrDelete(); private: friend class DeleteCollectionPrompt; friend class CreateCollectionPrompt; void onEntryAdded(Entry* entry, bool emitSignal); void populateContents(); void connectGroupSignalRecursive(Group* group); void cleanupConnections(); bool backendLocked() const; /** * Check if the backend is a valid object, send error reply if not. * @return true if the backend is valid. */ DBusResult ensureBackend() const; /** * Ensure the database is unlocked, send error reply if locked. * @return true if the database is locked */ DBusResult ensureUnlocked() const; /** * Like mkdir -p, find or create the group by path, under m_exposedGroup * @param groupPath * @return created or found group */ Group* findCreateGroupByPath(const QString& groupPath); private: QPointer m_backend; QString m_backendPath; QPointer m_exposedGroup; QSet m_aliases; QList m_items; QMap m_entryToItem; }; } // namespace FdoSecrets #endif // KEEPASSXC_FDOSECRETS_COLLECTION_H