shaba/one
1
0
Fork 0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-22 13:33:52 +03:00
Code Releases Wiki Activity
05d147c524
one/include/PoolSQL.h
Tino Vázquez 05d147c524
M #-: Bump version 6.10.0 
Also bump copyright year to 2024
2024-07-29 14:27:11 +02:00

480 lines
15 KiB
C++
Raw Blame History

/* -------------------------------------------------------------------------- */
/* Copyright 2002-2024, 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 POOL_SQL_H_
#define POOL_SQL_H_
#include <string>
#include <memory>
#include "SqlDB.h"
#include "PoolObjectSQL.h"
#include "PoolSQLCache.h"
/**
* PoolSQL class. Provides a base class to implement persistent generic pools.
* The PoolSQL provides a synchronization mechanism (mutex) to operate in
* multithreaded applications. Any modification or access function to the pool
* SHOULD block the mutex.
*/
class PoolSQL
{
public:
/**
* Initializes the oid counter. This function sets lastOID to
* the last used Object identifier by querying the corresponding database
* table. This function SHOULD be called before any pool related function.
* @param _db a pointer to the database
* @param _table the name of the table supporting the pool (to set the oid
* counter). If null the OID counter is not updated.
*/
PoolSQL(SqlDB * _db, const char * _table);
virtual ~PoolSQL();
/**
* Allocates a new object, writting it in the pool database. No memory is
* allocated for the object.
* @param objsql an initialized ObjectSQL
* @return the oid assigned to the object or -1 in case of failure
*/
virtual int allocate(
PoolObjectSQL *objsql,
std::string& error_str);
/**
* Gets an object from the pool (if needed the object is loaded from the
* database). The object is locked, other threads can't access the same
* object. The lock is released by destructor.
* @param oid the object unique identifier
* @return a pointer to the object, nullptr in case of failure
*/
template<typename T>
std::unique_ptr<T> get(int oid)
{
if ( oid < 0 )
{
return nullptr;
}
std::mutex * object_lock = cache.lock_line(oid);
std::unique_ptr<T> objectsql(static_cast<T *>(create()));
objectsql->oid = oid;
objectsql->ro = false;
objectsql->_mutex = object_lock;
int rc = objectsql->select(db);
if ( rc != 0 )
{
return nullptr;
}
return objectsql;
}
/**
* Gets a read only object from the pool (if needed the object is loaded from the
* database). No object lock, other threads may work with the same object.
* @param oid the object unique identifier
* @return a pointer to the object, nullptr in case of failure
*/
template<typename T>
std::unique_ptr<T> get_ro(int oid)
{
if ( oid < 0 )
{
return nullptr;
}
std::unique_ptr<T> objectsql(static_cast<T *>(create()));
objectsql->oid = oid;
objectsql->ro = true;
int rc = objectsql->select(db);
if ( rc != 0 )
{
return nullptr;
}
return objectsql;
}
/**
* Check if there is an object with the same for a given user
* @param name of object
* @param ouid of user
*
* @return oid of the object if it exists, -1 otherwise
*/
int exist(const std::string& name, int ouid)
{
return PoolObjectSQL::select_oid(db, table.c_str(), name, ouid);
}
int exist(const std::string& name)
{
return PoolObjectSQL::select_oid(db, table.c_str(), name, -1);
}
int exist(int oid)
{
return PoolObjectSQL::exist(db, table.c_str(), oid);
}
void exist(const std::string& id_str, std::set<int>& id_list);
/**
* Finds a set objects that satisfies a given condition
* @param oids a vector with the oids of the objects.
* @param the name of the DB table.
* @param where condition in SQL format.
*
* @return 0 on success
*/
virtual int search(
std::vector<int>& oids,
const char * table,
const std::string& where);
/**
* List the objects in the pool
* @param oids a vector with the oids of the objects.
* @param table the name of the DB table.
*
* @return 0 on success
*/
int list(
std::vector<int>& oids,
const char * table)
{
return search(oids, table, "");
}
/**
* Updates the object's data in the data base. The object mutex SHOULD be
* locked.
* @param objsql a pointer to the object
*
* @return 0 on success.
*/
virtual int update(
PoolObjectSQL * objsql)
{
return objsql->update(db);
};
/**
* Drops the object's data in the data base. The object mutex SHOULD be
* locked.
* @param objsql a pointer to the object
* @param error_msg Error reason, if any
* @return 0 on success, -1 DB error
*/
virtual int drop(PoolObjectSQL * objsql, std::string& error_msg)
{
int rc = objsql->drop(db);
if ( rc != 0 )
{
error_msg = "SQL DB error";
return -1;
}
return 0;
};
/**
* Dumps the pool in XML format. A filter can be also added to the
* query
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
* @param desc descending order of pool elements
*
* @return 0 on success
*/
int dump(std::string& oss, const std::string& where, bool desc)
{
return dump(oss, where, 0, -1, desc);
}
/**
* Dumps the pool in XML format. A filter and limit can be also added
* to the query
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
* @param sid first element used for pagination
* @param eid last element used for pagination, -1 to disable
* @param desc descending order of pool elements
*
* @return 0 on success
*/
virtual int dump(std::string& oss, const std::string& where,
int sid, int eid,
bool desc) = 0;
/**
* Dumps the pool in extended XML format
* A filter and limit can be also added to the query
* @param oss the output stream to dump the pool contents
* @param where filter for the objects, defaults to all
* @param sid first element used for pagination
* @param eid last element used for pagination, -1 to disable
* @param desc descending order of pool elements
*
* @return 0 on success
*/
virtual int dump_extended(std::string& oss,
const std::string& where,
int sid,
int eid,
bool desc)
{
return dump(oss, where, sid, eid, desc);
}
// -------------------------------------------------------------------------
// Function to generate dump filters
// -------------------------------------------------------------------------
/**
* Creates a filter for those objects (oids) or objects owned by a given
* group that an user can access based on the ACL rules
* @param uid the user id
* @param user_groups Set of group IDs that the user is part of
* @param auth_object object type
* @param all returns if the user can access all objects
* @param disable_all_acl e.g. NET\*
* @param disable_cluster_acl e.g. NET/%100
* @param disable_group_acl e.g. NET/@102
* @param filter the resulting filter string
*
*/
static void acl_filter(int uid,
const std::set<int>& user_groups,
PoolObjectSQL::ObjectType auth_object,
bool& all,
bool disable_all_acl,
bool disable_cluster_acl,
bool disable_group_acl,
std::string& filter);
/**
* Creates a filter for the objects owned by a given user/group
* @param uid the user id
* @param gid the primary group of the user
* @param user_groups Set of group IDs that the user is part of
* @param filter_flag query type (ALL, MINE, GROUP)
* @param all user can access all objects
* @param filter the resulting filter string
*/
static void usr_filter(int uid,
int gid,
const std::set<int>& user_groups,
int filter_flag,
bool all,
const std::string& acl_str,
std::string& filter);
/**
* Creates a filter for a given set of objects based on their id
* @param start_id first id
* @param end_id last id
* @param filter the resulting filter string
*/
static void oid_filter(int start_id,
int end_id,
std::string& filter);
/**
* This function returns a legal SQL string that can be used in an SQL
* statement. The string is encoded to an escaped SQL string, taking into
* account the current character set of the connection.
* @param str the string to be escaped
* @return a valid SQL string or NULL in case of failure
*/
char * escape_str(const std::string& str)
{
return db->escape_str(str);
}
/**
* Frees a previously scaped string
* @param str pointer to the str
*/
void free_str(char * str)
{
db->free_str(str);
}
/**
* Return true if feature is supported
*/
bool supports(SqlDB::SqlFeature ft)
{
return db->supports(ft);
}
protected:
/**
* Gets an object from the pool (if needed the object is loaded from the
* database). The object is locked, other threads can't access the same
* object. The lock is released by destructor.
* @param name of the object
* @param uid id of owner
*
* @return a pointer to the object, 0 in case of failure
*/
template<typename T>
std::unique_ptr<T> get(const std::string& name, int uid)
{
int oid = PoolObjectSQL::select_oid(db, table.c_str(), name, uid);
if ( oid == -1 )
{
return nullptr;
}
return get<T>(oid);
}
/**
* Gets a read only object from the pool (if needed the object is loaded from the
* database).
* @param name of the object
* @param uid id of owner
*
* @return a pointer to the object, 0 in case of failure
*/
template<typename T>
std::unique_ptr<T> get_ro(const std::string& name, int uid)
{
int oid = PoolObjectSQL::select_oid(db, table.c_str(), name, uid);
if ( oid == -1 )
{
return nullptr;
}
return get_ro<T>(oid);
}
/**
* Pointer to the database.
*/
SqlDB * db;
/**
* Dumps the pool in XML format. A filter and limit can be also added
* to the query
* @param oss the output stream to dump the pool contents
* @param elem_name Name of the root xml pool name
* @param table Pool table name
* @param where filter for the objects, defaults to all
* @param start_id first element used for pagination
* @param end_id last element used for pagination, -1 to disable
* @param desc descending order of pool elements
*
* @return 0 on success
*/
int dump(std::string& oss,
const std::string& elem_name,
const std::string& column,
const char * table,
const std::string& where,
int start_id,
int end_id,
bool desc);
/**
* Dumps the pool in XML format. A filter can be also added to the
* query
* @param oss the output stream to dump the pool contents
* @param elem_name Name of the root xml pool name
* @param table Pool table name
* @param where filter for the objects, defaults to all
* @param desc descending order of pool elements
*
* @return 0 on success
*/
int dump(std::string& oss,
const std::string& elem_name,
const char * table,
const std::string& where,
bool desc)
{
return dump(oss, elem_name, "body", table, where, 0, -1, desc);
}
/**
* Dumps the output of the custom sql query into an xml
*
* @param oss The output stream to dump the xml contents
* @param root_elem_name Name of the root xml element name
* @param sql_query The SQL query to execute
*
* @return 0 on success
*/
int dump(std::string& oss,
const std::string& root_elem_name,
std::ostringstream& sql_query);
/* ---------------------------------------------------------------------- */
/* Interface to access the lastOID assigned by the pool */
/* ---------------------------------------------------------------------- */
/**
* Gets the value of the last identifier assigned by the pool
* @return the lastOID of the pool
*/
int get_lastOID();
/**
* Sets the lastOID of the pool and updates the control database
* @param _lastOID for the pool
*/
void set_lastOID(int _lastOID);
private:
std::mutex _mutex;
/**
* Tablename for this pool
*/
std::string table;
/**
* The pool cache is implemented with a Map of SQL object pointers,
* using the OID as key.
*/
PoolSQLCache cache;
/**
* Factory method, must return an ObjectSQL pointer to an allocated pool
* specific object.
*/
virtual PoolObjectSQL * create() = 0;
};
#endif /*POOL_SQL_H_*/
View Git Blame Copy Permalink