database.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2025 QuasarApp.
 * Distributed under the lgplv3 software license, see the accompanying
 * Everyone is permitted to copy and distribute verbatim copies
 * of this license document, but changing it is not allowed.
*/
 
#ifndef QH_DATABASE_H
#define QH_DATABASE_H
 
#include "dbobjectsrequest.h"
#include "dbpatch.h"
#include "isqldb.h"
#include <dbobject.h>
#include <hostaddress.h>
 
 
namespace QH {
 
namespace PKG {
class WebSocket;
class ISubscribableData;
}
 
class ISqlDB;
class SqlDBWriter;
class DbAddress;
class NodeId;
class iObjectProvider;
class AbstractNodeInfo;

class HEARTSHARED_EXPORT DataBase: public QObject
{
    Q_OBJECT
public:
 
    DataBase(QObject * ptr = nullptr);
    ~DataBase();

    virtual bool initSqlDb( QString DBparamsFile = "",
                            ISqlDB * cache = nullptr,
                            SqlDBWriter* writer = nullptr);

    bool isSqlInited() const;

    bool run();

    virtual bool run(const QString &localNodeName);

    void stop();

    virtual QVariantMap defaultDbParams() const;

    QString dbLocation() const;

    QVariant getDBAttribute(const QString& key, const QVariant& defaultVal);

    bool setDBAttribute(const QString& key, const QVariant& newValue);
 
signals:

    void sigObjectChanged(const QSharedPointer<QH::PKG::DBObject> &obj);

    void sigObjectDeleted(const QH::DbAddress& obj);
 
protected:

    QString backUp(int version) const;

    const QString &localNodeName() const;

    void setLocalNodeName(const QString &newLocalNodeName);

    virtual void initDefaultDbObjects(ISqlDB *cache, SqlDBWriter *writer);

    ISqlDB* db() const;

    virtual bool welcomeAddress(AbstractNodeInfo *node);

    virtual QStringList SQLSources() const;

    virtual QSet<QString> systemTables() const;

    virtual void objectRemoved(const DbAddress& address);

    virtual void objectChanged(const QSharedPointer<PKG::DBObject>& obj);

    virtual const DBPatchMap dbPatches() const;

    void addDBPatch(const DBPatch& patch);

    virtual bool upgradeDataBase();

    virtual void onBeforeDBUpgrade(int currentVerion, int tergetVersion) const;
 

    template <class Object, class Id, class Setter>
    QSharedPointer<Object> getById(const Id& id, Setter setter, bool ifNotExistsCreate = false) {
        if (auto&& database = db()) {
            auto&& request = QSharedPointer<Object>::create();
            (*request.*setter)(id);
 
            if (auto&& result = database->getObject(*request)) {
                return result;
            }
 
            if (ifNotExistsCreate)
                return request;
        }
 
        return nullptr;
    };

    template <class Object, class Id, class Setter>
    bool deleteById(const Id& id, Setter setter) {
        if (auto&& database = db()) {
            auto&& request = QSharedPointer<Object>::create();
            (*request.*setter)(id);
            return database->deleteObject(request);
        }
 
        return false;
    };

    template <class Object>
    bool saveObj(const Object& obj) {
        if (auto&& database = db()) {
            return database->replaceObject(obj);
        }
 
        return false;
    };

    template <class Object>
    bool insertObj(const Object& obj, const QWeakPointer<unsigned int>& resultId = {}) {
        if (auto&& database = db()) {
            return database->insertObject(obj, !resultId.isNull(), resultId);
        }
 
        return false;
    };

    template<class Object>
    QList<QSharedPointer<Object>> getAll(const QString& table, const QString& condition = "") const {
        QH::PKG::DBObjectsRequest<Object> request(table, condition);
 
        auto&& response = db()->getObject(request);
        if (!response) {
            return {};
        }
 
        return response->data();
    }
 
private:
    bool workWithSubscribe(const PKG::WebSocket &rec,
                           const QVariant &clientOrNodeid,
                           const AbstractNodeInfo *sender);
 
 
    bool isForbidenTable(const QString& table);
 
    ISqlDB *_db = nullptr;
    unsigned short _targetDBVersion = 0;
    DBPatchMap _dbPatches;
    QString _localNodeName;
    friend class DataBaseNode;
 
};
 
 
}
 
Q_DECLARE_METATYPE(QSharedPointer<QH::PKG::DBObject>)
#endif // QH_DATABASE_H