CscIntelligencesDbService_8h_source.html

#ifndef CscIntelligencesDbService_H

#define CscIntelligencesDbService_H


#include <Configuration/CscKeyDirectories.h>

#include "CoreObjects/WebServices/CscWebServices.h"

#include "Communication/CscHttpClient.h"

#include "CscCommon.h"

#include <mutex>

#include <CoreObjects/WebServices/Auth/CoreAuthenticator.h>


using namespace conscience_core::bridging::webservices::auth;

using namespace conscience_core::communication::HTTP;

using std::mutex;


namespace conscience_core::bridging::webservices::intelligencesdb {


class CscIntelligenceData {

private:

    string id;

    unsigned long long serialNumber;

    string name;

    string description;

    int creationTimestampMillis;

    string authorUid;

    string lastModificationAuthorUid;


public:

    CscIntelligenceData(const string &id, unsigned long long serialNumber, const string &name, const string &description, const unsigned long long creationTimestampMillis, const string &authorUid, const string &lastModificationAuthorUid);


    const string &getId() const;

    unsigned long long getSerialNumber() const;

    const string &getName() const;

    const string &getDescription() const;

    unsigned long long getCreationTimestampMillis() const;

    const string &getAuthorUid() const;

    const string &getLastModificationAuthorUid() const;

    void setName(const string &newName);

    CscIntelligenceData *clone() const;

};


class CscKnowledgeItemData {

private:

    string id;

    string name;

    string commandString;

    int indexInScenario;


public:

    CscKnowledgeItemData(const string &id, const string &name, const string &commandString, int indexInScenario);

    CscKnowledgeItemData *clone();


    const string &getId() const;

    const string &getName() const;

    const string &getCommandString() const;

    int getIndexInScenario() const;


    void setIndexInScenario(int indexInScenario);

    void setName(const string &newName);

    void setCommandString(const string &newCommandString);


    void copyFrom(CscKnowledgeItemData *updatedKnowledgeItem);

};


class CscKnowledgeData {

private:

    string id;

    unsigned long long serialNumber;

    string name;

    string description;

    string uiTargetPanel;

    int uiIndexInPanel;

    int creationTimestampMillis;

    vector<CscKnowledgeItemData *> scenario;

    string authorUid;

    string lastModificationAuthorUid;


public:

    CscKnowledgeData(const string &id, unsigned long long serialNumber, const string &name, const string &description, const string &uiTargetPanel, const int &uiIndexInPanel, const unsigned long long creationTimestampMillis, const vector<CscKnowledgeItemData *> &scenario, const string &authorUid, const string &lastModificationAuthorUid);

    ~CscKnowledgeData();

    CscKnowledgeData *clone() const;


    const string &getId() const;

    unsigned long long getSerialNumber() const;

    const string &getName() const;

    const string &getDescription() const;

    const string &getUiTargetPanel() const;

    int getUiIndexInPanel() const;


    void setSerialNumber(unsigned long long newSerialNumber);

    void setName(const string &newName);

    void setDescription(const string &newDescription);

    void setUiTargetPanel(const string &uiTargetPanel);

    void setUiIndexInPanel(int index);


    unsigned long long getCreationTimestampMillis() const;


    const vector<CscKnowledgeItemData *> &getScenario() const;

    vector<string> getScenarioCommands() const;


    void copyFrom(CscKnowledgeData *updatedKnowledge);


    const string &getAuthorUid() const;

    const string &getLastModificationAuthorUid() const;

    void addScenarioItem(CscKnowledgeItemData *item);

    void updateScenarioItem(unsigned index, CscKnowledgeItemData *item, bool deletePreviousItem = true);

    void deleteScenarioItem(unsigned index);

    void insertScenarioItem(unsigned index, CscKnowledgeItemData *item);


    inline static const string LEFT_PANEL = "leftPanel";

    inline static const string RIGHT_PANEL = "rightPanel";


    string toString() const;

};


class CscIntelligencePublishData {

private:

    string id;

    string name;

    string description;

    unsigned long long creationDateTimeStamp;

    vector<unsigned char> image;

    vector<string> entityModelIds;

    string authorUid;


public:

    CscIntelligencePublishData(const string &id, const string &name, const string &description, const unsigned long long creationDateTimeStamp, const vector<unsigned char> &image, const vector<string> &entityModelIds, const string &authorUid);


    const string &getId() const;

    const string &getName() const;

    unsigned long long getCreationTimeStamp() const;

    const vector<unsigned char> &getImage() const;

    const vector<string> &getEntityModelIds() const;

    const string &getAuthorUid() const;


    ptr<CscJsonObject> toJson() const;

};


class CscKnowledgeItemPublishData {


private:

    string id;

    string name;

    string environmentInteractionCommandString;

    int indexInScenario;


public:

    CscKnowledgeItemPublishData(const string &id, const string &name, const string &environmentInteractionCommandString, int indexInScenario);


    const string &getId() const;

    const string &getName() const;

    const string &getEnvironmentInteractionCommandString() const;

    int getIndexInScenario() const;


    ptr<CscJsonObject> toJson() const;

};


class CscKnowledgePublishData {

private:

    string intelligenceId;

    string id;

    string name;

    string uiTargetPanel;

    int uiIndexInPanel;

    vector<CscKnowledgeItemPublishData *> scenarios;

    unsigned long long creationDateTimeStamp;

    vector<unsigned char> image;

    string authorUid;


public:

    CscKnowledgePublishData(const string &intelligenceId, const string &id, const string &name, const string &uiTargetPanel, int uiIndexInPanel, const vector<CscKnowledgeItemPublishData *> &scenarios, const unsigned long long creationDateTimeStamp, const vector<unsigned char> &image, const string &authorUid);

    virtual ~CscKnowledgePublishData();


    const string &getIntelligenceId() const;

    const string &getId() const;

    const string &getName() const;

    const string &getUiTargetPanel() const;

    int getUiIndexInPanel() const;

    const vector<CscKnowledgeItemPublishData *> &getScenarios() const;

    unsigned long long getCreationDateTimeStamp() const;

    const vector<unsigned char> &getImage() const;

    const string &getAuthorUid() const;


    ptr<CscJsonObject> toJson() const;

};


class UserCustomCommandCodePublishData {

private:

    string commandId;

    string authorUid;

    vector<unsigned char> knowledgeCodeInZipFile;


public:

    UserCustomCommandCodePublishData(const string &commandId, const string &authorUid, const vector<unsigned char> &knowledgeCodeInZipFile);


    const string &getCommandId() const;

    const string &getAuthorUid() const;

    const vector<unsigned char> &getKnowledgeCodeInZipFile() const;


    ptr<CscJsonObject> toJson() const;

};


class CscIntelligencesDbService {

public:

    static CscIntelligencesDbService *getInstance();


    vector<CscIntelligenceData *> getIntelligences(const optional<string> &entityModelId);


    fs::path getIntelligenceLogoPath(const string &intelligenceId, optional<fs::path> defaultIfNotFound = {});


    vector<CscKnowledgeData *> getKnowledgesByIntelligenceId(const string &intelligenceId);


    fs::path getKnowledgeLogoPath(const string &knowledgeId, optional<fs::path> defaultIfNotFound = {});


    fs::path getUserCustomCommandCodePath(const string &commandId);


    vector<string> getUserCustomCommandIds();


    void publishIntelligence(const CscIntelligencePublishData &intelligencePublishData);

    void updateIntelligence(const CscIntelligencePublishData &intelligenceUpdateData);

    void publishKnowledge(const CscKnowledgePublishData &knowledgePublishData);

    void updateKnowledge(const CscKnowledgePublishData &knowledgePublishData);

    void deleteKnowledge(const string &knowledgeId);

    void publishUserCustomCommandCode(const UserCustomCommandCodePublishData &userCustomCommandCodePublishData);


    vector<string> getCompatibleEntityModelIds(const string &intelligenceId);


    string intelligenceOrKnowledgeNameToTechnicalName(string name);

    CscIntelligenceData *findIntelligenceById(const vector<CscIntelligenceData *> &intelligences, string id);

    CscKnowledgeData *getKnowledgeById(const string &knowledgeId);


    vector<string> refreshIntelligencesLogos();


    vector<string> refreshKnowledgesLogos(const vector<string> &knowledgesIds);


    void setCacheEnabled(bool enabled);


private:

    unique_ptr<CscLogger> logger;

    inline static CscIntelligencesDbService *instance = nullptr;

    CscHttpClient &httpClient;

    const WebService &intelligencesDb;

    CscIntelligencesDbService();

    CscKeyDirectories *keyDirectories = CscKeyDirectories::getInstance();

    ptr<const CscAuthentication> getAuthentication() const;


    CscKnowledgeData *knowledgeJsonToData(ptr<CscJsonObjectReader> knowledgeJson);

    vector<CscKnowledgeData *> knowledgeJsonToData(const vector<ptr<CscJsonObjectReader>> &knowledgesJson);


    bool cacheEnabled = false;

    mutex cacheMutex;

    ptr<CscJsonObject> cache = nullptr;

    ptr<CscJsonObject> getCache();

    bool isCacheEnabledAndRefreshTimeNotExceeded(const string &refreshTimePropertyName);

    void clearCacheForIntelligence(const string &intelligenceUid);

    void clearCacheForKnowledge(const string &intelligenceUid, const string &knowledgeId);

};

}


#endif