/* -------------------------------------------------------------------------- */ /* Copyright 2002-2023, OpenNebula Project, OpenNebula Systems */ /* */ /* Licensed under the Apache License, Version 2.0 (the "License"); you may */ /* not use this file except in compliance with the License. You may obtain */ /* a copy of the License at */ /* */ /* http://www.apache.org/licenses/LICENSE-2.0 */ /* */ /* Unless required by applicable law or agreed to in writing, software */ /* distributed under the License is distributed on an "AS IS" BASIS, */ /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ /* See the License for the specific language governing permissions and */ /* limitations under the License. */ /* -------------------------------------------------------------------------- */ #ifndef CALLBACKABLE_H_ #define CALLBACKABLE_H_ #include #include #include #include #include /** * This class represents a SQL callback */ class Callbackable { public: Callbackable() : cb(nullptr) , arg(nullptr) , affected_rows(0) { } virtual ~Callbackable() = default; /** * Datatype for call back pointers */ typedef int (Callbackable::*Callback)(void *, int, char ** ,char **); /** * Set the callback function and custom arguments to be executed by the * next SQL command, and locks the mutex until unset_callback is called. * @param ptr to the callback function * @param arg custom arguments for the callback function */ void set_callback(Callback _cb, void * _arg = nullptr) { _mutex.lock(); cb = _cb; arg = _arg; } /** * Test if the CallBack is set for the object. * @return true if the callback is set */ virtual bool isCallBackSet() { return (cb != nullptr); } /** * Call the callback funcion set. This method must be called only if * isCallBackSet returns true. * @return the callback function return value. */ int do_callback(int num, char **values, char **names) { ++affected_rows; return (this->*cb)(arg, num, values, names); } /** * Unset the callback function. */ void unset_callback() { cb = nullptr; arg = nullptr; _mutex.unlock(); } /** * set affected rows variable */ void set_affected_rows(int num_rows) { affected_rows = num_rows; } /** * get affected rows variable */ int get_affected_rows() const { return affected_rows; } private: /** * SQL callback to be executed for each row result of an SQL statement */ Callback cb; /** * Custom arguments for the callback */ void * arg; /** * num of affected rows */ int affected_rows; /** * Mutex for locking the callback function. */ std::mutex _mutex; }; /* -------------------------------------------------------------------------- */ /* Classes to obtain values from a DB it support concurrent queries using */ /* different objects */ /* -------------------------------------------------------------------------- */ template class single_cb : public Callbackable { public: void set_callback(T * _value) { value = _value; Callbackable::set_callback( static_cast(&single_cb::callback)); } virtual int callback(void *nil, int num, char **values, char **names) { if ( values == 0 || values[0] == 0 || num != 1 ) { return -1; } std::istringstream iss(values[0]); iss >> *value; return 0; } private: T * value; }; /* -------------------------------------------------------------------------- */ template<> class single_cb : public Callbackable { public: void set_callback(std::string * _value) { value = _value; Callbackable::set_callback( static_cast(&single_cb::callback)); } virtual int callback(void *nil, int num, char **values, char **names) { if ( values == 0 || values[0] == 0 || num != 1 ) { return -1; } *value = values[0]; return 0; } private: std::string * value; }; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ template class set_cb : public Callbackable { public: void set_callback(std::set * _ids) { ids = _ids; Callbackable::set_callback( static_cast(&set_cb::callback)); }; int callback(void * nil, int num, char **values, char **names) { if ( num == 0 || values == 0 || values[0] == 0 ) { return -1; } std::istringstream iss(values[0]); T value; iss >> value; ids->insert(value); return 0; }; private: std::set * ids; }; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ template class vector_cb : public Callbackable { public: void set_callback(std::vector * _oids) { oids = _oids; Callbackable::set_callback( static_cast(&vector_cb::callback), 0); }; int callback(void * nil, int num, char **values, char **names) { if ( num == 0 || values == 0 || values[0] == 0 ) { return -1; } std::istringstream iss(values[0]); T value; iss >> value; oids->push_back(value); return 0; }; private: std::vector * oids; }; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ class string_cb : public Callbackable { public: string_cb(int _total):total_values(_total){}; void set_callback(std::string * _str) { str = _str; Callbackable::set_callback( static_cast(&string_cb::callback), 0); }; int callback(void * nil, int num, char **values, char **names) { if ( (!values[0]) || (num != total_values) ) { return -1; } for (int i=0; i < total_values; i++) { if ( values[i] != NULL ) { str->append(values[i]); } } return 0; }; private: int total_values; std::string * str; }; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ class stream_cb : public Callbackable { public: stream_cb(int _total): total_values(_total){}; void set_callback(std::ostringstream * _oss) { oss = _oss; Callbackable::set_callback( static_cast(&stream_cb::callback), 0); }; int callback(void * nil, int num, char **values, char **names) { if ( (!values[0]) || (num != total_values) ) { return -1; } for (int i=0; i < total_values; i++) { if ( values[i] != NULL ) { *oss << values[i]; } } return 0; }; private: int total_values; std::ostringstream * oss; }; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ class empty_cb : public Callbackable { public: void set_callback(Callback _cb, void * _arg = 0){}; bool isCallBackSet() override { return false; }; }; /* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */ template< template class Container, class T> class multiple_cb : public Callbackable { public: void set_callback(Container * _columns) { columns = _columns; Callbackable::set_callback( static_cast(&multiple_cb::callback), 0); }; int callback(void * nil, int num, char **values, char **names) { if ( num == 0 || values == 0 ) { return -1; } for (int i=0; i < num ; ++i) { if (values[i] == 0) { continue; } std::istringstream iss(values[i]); T value; iss >> value; columns->push_back(value); } return 0; }; private: Container * columns; }; #endif /*CALLBACKABLE_H_*/