CrestApiFs.h

Go to the documentation of this file.

/*
   Copyright (C) 2019-2024 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef CRESTAPI_CRESFSAPI_H
#define CRESTAPI_CRESFSAPI_H
 
#include <string>
#include <map>
#include <list>
#include <iosfwd>
#include <cstdint>
#include "nlohmann/json.hpp"
#include <curl/curl.h>
#include <iostream>
#include <CrestApi/CrestModel.h>
#include <CrestApi/CrestApiBase.h>
 
namespace Crest
{
 
  class CrestFsClient : public CrestApiBase
  {
  private:
    std::string m_root_folder{};
    std::string m_data_folder{};
    std::map<std::string, nlohmann::json> m_data{};
    bool m_isRewrite{};
 
    // parameters for CREST file storage:
 
    inline static const std::string s_FS_TAG_PATH = "/tags";
    inline static const std::string s_FS_GLOBALTAG_PATH = "/globaltags";
    inline static const std::string s_FS_DATA_PATH = "/data";
 
    inline static const std::string s_FS_TAG_FILE = "/tag.json";
    inline static const std::string s_FS_IOV_FILE = "/iovs.json";
    inline static const std::string s_FS_TAGMETAINFO_FILE = "/tagmetainfo.json";
 
    inline static const std::string s_FS_META_FILE = "/meta.json";
    inline static const std::string s_FS_PALOAD_FILE = "/payload.json";
 
    inline static const std::string s_FS_GLOBALTAG_FILE = "/globaltag.json";
    inline static const std::string s_FS_MAP_FILE = "/maps.json";
 
    inline static const std::string s_FS_PATH = "";
 
    inline static const int s_FS_PREFIX_LENGTH = 3;
    std::string m_currentTag{};
 
    void checkFsException(const char *method_name);
 
    std::string getFileString(const std::string &path); // method to read file as a string
 
    void getFileList(const std::string &path);
 
    void flush();
 
  public:
 
    CrestFsClient(bool rewriteIfExists, const std::string &root_folder);
    
    ~CrestFsClient();
 
    // Overrides
    
    // GlobaTag methods
 
    void createGlobalTag(GlobalTagDto &globalTag) override;
 
    GlobalTagDto findGlobalTag(const std::string &name) override;
 
    GlobalTagSetDto listGlobalTags(const std::string &name, int size, int page, const std::string &sort) override;
 
    void removeGlobalTag(const std::string &name) override;
 
    // Tag methods
 
    void createTag(TagDto &tag) override;
 
    TagDto findTag(const std::string &name) override;
 
    TagSetDto listTags(const std::string &name, int size, int page, const std::string &sort) override;
 
    void removeTag(const std::string &name) override;
 
    int getSize(const std::string &tagname) override;
 
    // TagMeta methods
 
    void createTagMeta(TagMetaDto &tag) override;
 
    void updateTagMeta(TagMetaDto &tag) override;
 
    TagMetaDto findTagMeta(const std::string &name) override;
    
    // Iovs
 
    IovSetDto selectIovs(const std::string &name, uint64_t since, uint64_t until, long snapshot, int size, int page, const std::string &sort) override;
 
    IovSetDto selectGroups(const std::string &name, long snapshot, int size, int page, const std::string &sort) override;
 
    // GlobalTagMap methods
 
    void createGlobalTagMap(GlobalTagMapDto &globalTagMap) override;
 
    GlobalTagMapSetDto findGlobalTagMap(const std::string &name, const std::string &xCrestMapMode) override;
 
    void removeGlobalTagMap(const std::string &name, const std::string &record, const std::string &label, const std::string &tagname) override;
 
    
    // Payload methods
 
    void storeData(const std::string &tag,
                   const StoreSetDto &storeSetJson,
                     const std::string &payloadFormat="JSON",
                   const std::string &objectType="none",
                   const std::string &compressionType="none",
                   const std::string &version="1.0",
                   uint64_t endTime=-1) override;
 
    // Payload retrieval methods
 
    std::string getPayload(const std::string &hash) override;
 
    PayloadDto getPayloadMeta(const std::string &hash) override;
 
        std::string getCrestVersion() override;
 
    
  private:
    std::string getDateAndTime();
 
    std::string getFirstLetters(const std::string &str);
 
    // auxiliary methods to extract a single page of the data:
    nlohmann::json getPage(nlohmann::json data, int size, int page);
    std::vector<std::string> getVectorPage(const std::vector<std::string>& data, int size, int page);
 
    // auxiliary method to get folder names:
    std::vector<std::string> nameList(std::string & folder, bool ascending = true);
 
    // Auxiliary methods to build the path to the file.
    std::string buildPath(const std::string &path, const std::string &file);
 
    // Auxiliary methods to sort the JSON array by the key value:
    nlohmann::json sortJson(nlohmann::json js, const std::string & par, bool order);
    nlohmann::json sortIOVJson(nlohmann::json js, bool order);
    
    // auxiliary methods to check if the string corresponds to the mask:
    bool isMatch(const std::string& word, long unsigned int n, const std::string& pattern, long unsigned int m);
    bool isMatch(const std::string& word, const std::string& pattern);
 
    nlohmann::json findAllIovs(const std::string &tagname);
 
    void storePayloadDump(const std::string &tag,
                          uint64_t since,
                          const std::string &js,
                          const std::string &payloadFormat,
                          const std::string &objectType,
                          const std::string &compressionType,
                          const std::string &version,
                          const std::string &streamerInfo);
  };
 
} // namespace Crest
 
#endif // CRESTAPI_CRESTCLIENT_H