Skip to content

Commit

Permalink
add createdNotAfter, createdNotBefore to list function
Browse files Browse the repository at this point in the history
  • Loading branch information
@wiechula @davidrohr
wiechula authored and davidrohr committed Oct 31, 2023
1 parent a935dc5 commit a3aef6c
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 39 deletions.
70 changes: 35 additions & 35 deletions CCDB/include/CCDB/CcdbApi.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,34 +121,34 @@ class CcdbApi //: public DatabaseInterface
static std::unique_ptr<std::vector<char>> createObjectImage(const void* obj, std::type_info const& tinfo, CcdbObjectInfo* info = nullptr);

/**
* Store into the CCDB a TFile containing the ROOT object.
*
* @param rootObject Raw pointer to the object to store.
* @param path The path where the object is going to be stored.
* @param metadata Key-values representing the metadata for this object.
* @param startValidityTimestamp Start of validity. If omitted, current timestamp is used.
* @param endValidityTimestamp End of validity. If omitted, current timestamp + 1 day is used.
* @return 0 -> ok,
* positive number -> curl error (https://curl.se/libcurl/c/libcurl-errors.html),
* -1 : object bigger than maxSize,
* -2 : curl initialization error
*/
* Store into the CCDB a TFile containing the ROOT object.
*
* @param rootObject Raw pointer to the object to store.
* @param path The path where the object is going to be stored.
* @param metadata Key-values representing the metadata for this object.
* @param startValidityTimestamp Start of validity. If omitted, current timestamp is used.
* @param endValidityTimestamp End of validity. If omitted, current timestamp + 1 day is used.
* @return 0 -> ok,
* positive number -> curl error (https://curl.se/libcurl/c/libcurl-errors.html),
* -1 : object bigger than maxSize,
* -2 : curl initialization error
*/
int storeAsTFile(const TObject* rootObject, std::string const& path, std::map<std::string, std::string> const& metadata,
long startValidityTimestamp = -1, long endValidityTimestamp = -1, std::vector<char>::size_type maxSize = 0 /*bytes*/) const;

/**
* Store into the CCDB a TFile containing an object of type T (which needs to have a ROOT dictionary)
*
* @param obj Raw pointer to the object to store.
* @param path The path where the object is going to be stored.
* @param metadata Key-values representing the metadata for this object.
* @param startValidityTimestamp Start of validity. If omitted, current timestamp is used.
* @param endValidityTimestamp End of validity. If omitted, current timestamp + 1 day is used.
* @return 0 -> ok,
* positive number -> curl error (https://curl.se/libcurl/c/libcurl-errors.html),
* -1 : object bigger than maxSize,
* -2 : curl initialization error
*/
* Store into the CCDB a TFile containing an object of type T (which needs to have a ROOT dictionary)
*
* @param obj Raw pointer to the object to store.
* @param path The path where the object is going to be stored.
* @param metadata Key-values representing the metadata for this object.
* @param startValidityTimestamp Start of validity. If omitted, current timestamp is used.
* @param endValidityTimestamp End of validity. If omitted, current timestamp + 1 day is used.
* @return 0 -> ok,
* positive number -> curl error (https://curl.se/libcurl/c/libcurl-errors.html),
* -1 : object bigger than maxSize,
* -2 : curl initialization error
*/
template <typename T>
int storeAsTFileAny(const T* obj, std::string const& path, std::map<std::string, std::string> const& metadata,
long startValidityTimestamp = -1, long endValidityTimestamp = -1, std::vector<char>::size_type maxSize = 0 /*bytes*/) const
Expand Down Expand Up @@ -235,7 +235,7 @@ class CcdbApi //: public DatabaseInterface
* @param returnFormat The format of the returned string -> one of "text/plain (default)", "application/json", "text/xml"
* @return The listing of folder and/or objects in the format requested
*/
std::string list(std::string const& path = "", bool latestOnly = false, std::string const& returnFormat = "text/plain") const;
std::string list(std::string const& path = "", bool latestOnly = false, std::string const& returnFormat = "text/plain", long createdNotAfter = -1, long createdNotBefore = -1) const;

/**
* Make a local snapshot of all valid objects, given a timestamp, of the CCDB under a given local path.
Expand All @@ -251,12 +251,12 @@ class CcdbApi //: public DatabaseInterface
bool isHostReachable() const;

/**
* Helper function to extract the list of sub-folders from a list reply into a vector container.
* Can be used to achieve full recursive traversal/listing of the CCDB.
*
* @param reply The reply that we got from a GET/browse sort of request.
* @return The vector of sub-folders.
*/
* Helper function to extract the list of sub-folders from a list reply into a vector container.
* Can be used to achieve full recursive traversal/listing of the CCDB.
*
* @param reply The reply that we got from a GET/browse sort of request.
* @return The vector of sub-folders.
*/
std::vector<std::string> parseSubFolders(std::string const& reply) const;

/**
Expand Down Expand Up @@ -581,9 +581,9 @@ class CcdbApi //: public DatabaseInterface
const std::string& createdNotAfter, const std::string& createdNotBefore, bool followRedirect, CurlWriteCallback writeCallback) const;

/**
* Initialize hostsPool
* @param hosts string with hosts separated by "," or ";"
*/
* Initialize hostsPool
* @param hosts string with hosts separated by "," or ";"
*/
void initHostsPool(std::string hosts);

std::string getHostUrl(int hostIndex) const;
Expand Down Expand Up @@ -650,4 +650,4 @@ typename std::enable_if<std::is_base_of<o2::conf::ConfigurableParam, T>::value,
} // namespace ccdb
} // namespace o2

#endif //PROJECT_CCDBAPI_H
#endif // PROJECT_CCDBAPI_H
15 changes: 11 additions & 4 deletions CCDB/src/CcdbApi.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
#include <boost/interprocess/sync/named_semaphore.hpp>
#include <regex>
#include <cstdio>
#include <string>

namespace o2::ccdb
{
Expand Down Expand Up @@ -434,8 +435,8 @@ string CcdbApi::getFullUrlForRetrieval(CURL* curl, const string& path, const map
}

/**
* Struct to store the data we will receive from the CCDB with CURL.
*/
* Struct to store the data we will receive from the CCDB with CURL.
*/
struct MemoryStruct {
char* memory;
unsigned int size;
Expand Down Expand Up @@ -1084,7 +1085,7 @@ size_t CurlWrite_CallbackFunc_StdString2(void* contents, size_t size, size_t nme
return size * nmemb;
}

std::string CcdbApi::list(std::string const& path, bool latestOnly, std::string const& returnFormat) const
std::string CcdbApi::list(std::string const& path, bool latestOnly, std::string const& returnFormat, long createdNotAfter, long createdNotBefore) const
{
CURL* curl;
CURLcode res = CURL_LAST;
Expand All @@ -1099,6 +1100,12 @@ std::string CcdbApi::list(std::string const& path, bool latestOnly, std::string
struct curl_slist* headers = nullptr;
headers = curl_slist_append(headers, (string("Accept: ") + returnFormat).c_str());
headers = curl_slist_append(headers, (string("Content-Type: ") + returnFormat).c_str());
if (createdNotAfter >= 0) {
headers = curl_slist_append(headers, ("If-Not-After: " + std::to_string(createdNotAfter)).c_str());
}
if (createdNotBefore >= 0) {
headers = curl_slist_append(headers, ("If-Not-Before: " + std::to_string(createdNotBefore)).c_str());
}
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

curlSetSSLOptions(curl);
Expand Down Expand Up @@ -1823,4 +1830,4 @@ CURLcode CcdbApi::CURL_perform(CURL* handle) const
return result;
}

} // namespace o2
} // namespace o2::ccdb

0 comments on commit a3aef6c

Please sign in to comment.