DBcore Class Reference

#include "dbcore.h"

Inheritance diagram for DBcore:

Collaboration diagram for DBcore:

Public Types
enum	eStatus { Closed, Connected, Error }

Public Member Functions
	DBcore ()
	~DBcore ()
void	Close ()
void	Initialize (std::string host, std::string user, std::string password, std::string database, bool compress=false, bool SSL=false, int16 port=3306, bool socket=false, bool reconnect=false, bool profile=false)
bool	RunQuery (DBQueryResult &into, const char *query_fmt,...)
bool	RunQuery (DBerror &err, const char *query_fmt,...)
bool	RunQuery (DBerror &err, uint32 &affected_rows, const char *query_fmt,...)
bool	RunQueryLID (DBerror &err, uint32 &last_insert_id, const char *query_fmt,...)
int32	DoEscapeString (char *tobuf, const char *frombuf, int32 fromlen)
void	DoEscapeString (std::string &to, const std::string &from)
void	ping ()
eStatus	GetStatus () const
Public Member Functions inherited from Singleton< DBcore >
	Singleton ()
	Primary constructor. More...

Static Public Member Functions
static bool	IsSafeString (const char *str)
static bool	IsSafeString (std::string &s)
Static Public Member Functions inherited from Singleton< DBcore >
static DBcore &	get ()

Protected Member Functions
MYSQL *	getMySQL ()
void	Connect (uint *errnum=0, char *errbuf=0)
bool	Reconnect ()

Private Member Functions
bool	DoQuery_locked (DBerror &err, const char *query, int querylen, bool retry=true)

Private Attributes
MYSQL *	mysql
Mutex	MDatabase
eStatus	pStatus
bool	pCompress
bool	pProfile
bool	pReconnect
bool	pSocket
bool	pSSL
int16	pPort
std::string	pHost
std::string	pUser
std::string	pPassword
std::string	pDatabase

Additional Inherited Members
Static Protected Attributes inherited from Singleton< DBcore >
static std::shared_ptr< DBcore >	mInstance

Detailed Description

Definition at line 132 of file dbcore.h.

Member Enumeration Documentation

enum DBcore::eStatus

Enumerator
Closed
Connected
Error

Definition at line 136 of file dbcore.h.

{ Closed, Connected, Error };

Constructor & Destructor Documentation

DBcore::DBcore

(

)

Definition at line 49 of file dbcore.cpp.

References mysql.

: mysql(nullptr),
pSocket(false),
pStatus(Closed),
pReconnect(false),
pProfile(false)
{
    mysql_thread_init();    // this is for each thread used for db connections
    mysql = mysql_init(nullptr);
}

DBcore::~DBcore ( )

inline

Definition at line 139 of file dbcore.h.

{ /* do nothing here */ }

Member Function Documentation

void DBcore::Close

(

)

Definition at line 192 of file dbcore.cpp.

References Closed, mysql, and pStatus.

Referenced by Reconnect().

                   {
    pStatus = Closed;
    mysql_close(mysql);
    mysql_server_end();
    mysql_thread_end();   // this is for each thread used for db connections
}

Here is the caller graph for this function:

void DBcore::Connect ( uint *  errnum = 0, char *  errbuf = 0  )

protected

Definition at line 60 of file dbcore.cpp.

References DBerror::c_str(), Connected, Error, mysql, pCompress, pDatabase, pHost, pPassword, pPort, pReconnect, pSocket, pSSL, pStatus, pUser, DBerror::SetError(), sLog, and snprintf.

Referenced by Initialize(), and Reconnect().

{
    sLog.Cyan("          DB User", " %s", pUser.c_str());
    sLog.Cyan("         DataBase", " %s", pDatabase.c_str());

    // options should be called BEFORE mysql_real_connect()
    if (pSocket) {
        enum mysql_protocol_type prot_type = MYSQL_PROTOCOL_SOCKET;
        if (mysql_options(mysql, MYSQL_OPT_PROTOCOL, (void*)&prot_type) == 0) {
            sLog.Cyan("        DB Server", " Unix Socket Connection");
        } else {
            sLog.Error("        DB Server", " Unix Socket Connection Option Failed");
            enum mysql_protocol_type prot_type = MYSQL_PROTOCOL_TCP;
            if (mysql_options(mysql, MYSQL_OPT_PROTOCOL, (void*)&prot_type) == 0)
                sLog.Cyan("        DB Server", " %s:%d", pHost.c_str(), pPort);
            else
                sLog.Error("        DB Server", " TCP Connection Option Failed");
        }
    } else {
        enum mysql_protocol_type prot_type = MYSQL_PROTOCOL_TCP;
        if (mysql_options(mysql, MYSQL_OPT_PROTOCOL, (void*)&prot_type) == 0)
            sLog.Cyan("        DB Server", " %s:%d", pHost.c_str(), pPort);
        else
            sLog.Error("        DB Server", " TCP Connection Option Failed");
    }

    int32 flags = CLIENT_FOUND_ROWS; //2
    if (pCompress)
        flags |= CLIENT_COMPRESS; //32
    // sql-ssl  needs more info/settings to properly use....however, not needed when using socket under linux
    if (pSSL and !pSocket)
        flags |= CLIENT_SSL;
    sLog.Cyan("    Connect Flags", " %x", flags);
    /*
     *    unsigned int conn_timeout = 2;
     *    // not sure if this one will really be used here
     *    if (mysql_options(mysql, MYSQL_OPT_CONNECT_TIMEOUT, (void*)&conn_timeout) == 0) {
     *        if (conn_timeout > 60)
     *            sLog.Error(" DataBase Manager", "Connection Timeout set to %us", conn_timeout);
     *        else if (conn_timeout > 40)
     *            sLog.Yellow(" DataBase Manager", "Connection Timeout set to %us", conn_timeout);
     *        else if (conn_timeout > 30)
     *            sLog.Cyan(" DataBase Manager", "Connection Timeout set to %us", conn_timeout);
     *        else
     *            sLog.Green(" DataBase Manager", "Connection Timeout set to %us", conn_timeout);
} else
    sLog.Error(" DataBase Manager", "Connection Timeout Option Failed");
*/
    if (pReconnect) {
        my_bool reconnect = true;
        if (mysql_options(mysql, MYSQL_OPT_RECONNECT, (void*)&reconnect) == 0) // this will enable auto-reconnect...and render my Reconnect() worthless
            sLog.Green(" DataBase Manager", "DataBase AutoReconnect Enabled");
        else
            sLog.Error(" DataBase Manager", "DataBase AutoReconnect Option Failed");
    } else
        sLog.Yellow(" DataBase Manager", "DataBase AutoReconnect Disabled");

    if (mysql_real_connect(mysql, pHost.c_str(), pUser.c_str(), pPassword.c_str(), pDatabase.c_str(), pPort, 0, flags) == nullptr) {
        pStatus = Error;
        *errnum = mysql_errno(mysql);
        if (errbuf != nullptr)
            snprintf(errbuf, MYSQL_ERRMSG_SIZE, "#%i: %s", mysql_errno(mysql), mysql_error(mysql));
        DBerror err;
        err.SetError(*errnum, errbuf);
        sLog.Error( "       ServerInit", "Unable to connect to the database: %s", err.c_str() );
        return;
    } else {
        pStatus = Connected;
        //mysql_get_socket();
        sLog.Blue(" DataBase Manager", "DataBase Connected");
    }

    // Setup character set we wish to use
    if (mysql_set_character_set(mysql, "utf8") == 0)
        sLog.Cyan(" DataBase Manager", "DataBase Character set: %s", mysql_character_set_name(mysql));
}

Here is the call graph for this function:

Here is the caller graph for this function:

int32 DBcore::DoEscapeString	(	char *	tobuf,
		const char *	frombuf,
		int32	fromlen
	)

Definition at line 358 of file dbcore.cpp.

References mysql.

{
    return mysql_real_escape_string(mysql, tobuf, frombuf, fromlen);
}

void DBcore::DoEscapeString	(	std::string &	to,
		const std::string &	from
	)

Definition at line 363 of file dbcore.cpp.

References mysql.

{
    assert(mysql);
    uint32 len = (uint32)from.length();
    to.resize(len * 2);   // make enough room
    uint32 esc_len = mysql_real_escape_string(mysql, &to[0], from.c_str(), len);
    to.resize(esc_len + 1); // optional.
}

bool DBcore::DoQuery_locked ( DBerror &  err, const char *  query, int  querylen, bool  retry = true  )

private

Definition at line 308 of file dbcore.cpp.

References _log, DBerror::c_str(), DBerror::ClearError(), codelog, Connected, Error, DBerror::GetErrNo(), GetTimeUSeconds(), is_log_enabled, mysql, pProfile, pStatus, Reconnect(), DBerror::SetError(), and sProfiler.

Referenced by RunQuery(), and RunQueryLID().

{
    double profileStartTime = GetTimeUSeconds();

    if (mysql == nullptr) {
        pStatus = Error;
        codelog(DATABASE__ERROR, "DBCore - mysql = null");
        if (!Reconnect())
            return false;
    }

    if (pStatus != Connected) {
        codelog(DATABASE__ERROR, "DBCore - Status != Connected");
        _log(DATABASE__MESSAGE, "DBCore error detected.  Look for error msgs in logs prior to this point.");
        if (!Reconnect())
            return false;
    }

    if (is_log_enabled(DATABASE__QUERIES))
        _log(DATABASE__QUERIES, "DBcore Query - %s", query);

    if (mysql_real_query(mysql, query, querylen)) {
        uint num = mysql_errno(mysql);
        if (num > 0)
            pStatus = Error;

        // there are many correctable errors to check for
        if ((num == CR_SERVER_LOST) or (num == CR_SERVER_GONE_ERROR)) {
            _log(DATABASE__ERROR, "DBCore error - server lost or gone.");
            if (!Reconnect())
                return false;
        }

        if ((pStatus == Connected) and retry)
            return DoQuery_locked(err, query, querylen, retry);

        err.SetError(num, mysql_error(mysql));
        codelog(DATABASE__ERROR, "DBCore Query - #%u in '%s': %s", err.GetErrNo(), query, err.c_str());
        return false;
    }

    err.ClearError();

    if (pProfile)
        sProfiler.AddTime(9, GetTimeUSeconds() - profileStartTime);

    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

MYSQL* DBcore::getMySQL ( )

inlineprotected

Definition at line 170 of file dbcore.h.

References mysql.

{ return mysql; }

eStatus DBcore::GetStatus ( ) const

inline

Definition at line 167 of file dbcore.h.

References pStatus.

{ return pStatus; }

void DBcore::Initialize	(	std::string	host,
		std::string	user,
		std::string	password,
		std::string	database,
		bool	compress = false,
		bool	SSL = false,
		int16	port = 3306,
		bool	socket = false,
		bool	reconnect = false,
		bool	profile = false
	)

Definition at line 154 of file dbcore.cpp.

References Connect(), Connected, MDatabase, mysql, pCompress, pDatabase, pHost, pPassword, pPort, pProfile, pReconnect, pSocket, pSSL, pStatus, pUser, and sLog.

{
    if (mysql == nullptr)
        mysql = mysql_init(nullptr);    // try again
    if (mysql == nullptr) {
        sLog.Error( "       ServerInit", "Unable to connect to the database:  mysql_init returned null");
        return;
    }
    if (pStatus == Connected)
        return;

    pHost = host;
    pUser = user;
    pPassword = password;
    pDatabase = database;
    pPort = port;
    pSSL = SSL;
    pCompress = compress;
    pSocket = socket;
    pReconnect = reconnect;
    pProfile = profile;

    if (pHost.empty() or pUser.empty() or pPassword.empty() or pDatabase.empty()) {
        sLog.Error( "       ServerInit", "Unable to connect to the database:  required connect field(s) are empty.");
        return;
    }

    uint errnum = 0;
    char errbuf[1024];
    errbuf[0] = 0;

    MutexLock lock(MDatabase);

    Connect(&errnum, errbuf);
    sLog.Blue(" DataBase Manager", "DataBase Manager Initialized");
}

Here is the call graph for this function:

bool DBcore::IsSafeString ( const char *  str )

static

Definition at line 373 of file dbcore.cpp.

                                         {
    for(; *str != '\0'; str++) {
        switch(*str) {
            case '\'':
            case '\\':
                return false;
        }
    }
    return true;
}

bool DBcore::IsSafeString ( std::string &  s )

static

Definition at line 384 of file dbcore.cpp.

                                      {
    for (uint i = 0; i < s.length(); ++i) {
        switch (s[i]) {
            case '\'':
            case '\\':
                return false;
        }
    }
    return true;
}

void DBcore::ping

(

)

Definition at line 212 of file dbcore.cpp.

References MDatabase, mysql, Mutex::TryLock(), and Mutex::Unlock().

{
    // well, if it's locked, someone's using it. If someone's using it, it doesn't need a ping
    if ( MDatabase.TryLock() ) {
        mysql_ping(mysql);
        MDatabase.Unlock();
    }
}

Here is the call graph for this function:

bool DBcore::Reconnect ( )

protected

Definition at line 137 of file dbcore.cpp.

References _log, Close(), Connect(), Connected, MDatabase, mysql, and pStatus.

Referenced by DoQuery_locked().

{
    _log(DATABASE__MESSAGE, "DBCore attempting to recover...");
    Close();
    mysql = mysql_init(nullptr);
    uint errnum = 0;
    char errbuf[1024];
    errbuf[0] = 0;
    MutexLock lock(MDatabase);
    Connect(&errnum, errbuf);

    if (pStatus == Connected)
        _log(DATABASE__MESSAGE, "DBCore recovery successful.  Continuing.");

    return pStatus;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool DBcore::RunQuery	(	DBQueryResult &	into,
		const char *	query_fmt,
			...
	)

Definition at line 222 of file dbcore.cpp.

References codelog, DoQuery_locked(), DBQueryResult::error, MDatabase, mysql, DBerror::SetError(), DBQueryResult::SetResult(), EvE::traceStack(), and vsnprintf.

                                                                     {
    MutexLock lock(MDatabase);

    char query[4096];
    va_list vlist;
    va_start(vlist, query_fmt);
    int querylen = std::vsnprintf(query, 4096, query_fmt, vlist);
    va_end(vlist);

    if (!DoQuery_locked(into.error, query, querylen))
        return false;

    uint col_count = mysql_field_count(mysql);
    if (col_count == 0) {
        into.error.SetError(0xFFFF, "DBcore::RunQuery: No Result");
        codelog(DATABASE__ERROR, "DBCore::RunQuery: %s failed because it did not return a result", query);
        EvE::traceStack();
        return false;
    }

    into.SetResult(mysql_store_result(mysql), col_count);

    return true;
}

Here is the call graph for this function:

bool DBcore::RunQuery	(	DBerror &	err,
		const char *	query_fmt,
			...
	)

Definition at line 248 of file dbcore.cpp.

References args, DoQuery_locked(), MDatabase, and vasprintf().

                                                              {
    MutexLock lock(MDatabase);

    va_list args;
    va_start(args, query_fmt);
    char* query(nullptr);
    int querylen = vasprintf(&query, query_fmt, args);
    va_end(args);

    if (!DoQuery_locked(err, query, querylen)) {
        free(query);
        return false;
    }

    free(query);
    return true;
}

Here is the call graph for this function:

bool DBcore::RunQuery	(	DBerror &	err,
		uint32 &	affected_rows,
		const char *	query_fmt,
			...
	)

Definition at line 267 of file dbcore.cpp.

References args, DoQuery_locked(), MDatabase, mysql, and vasprintf().

                                                                                     {
    MutexLock lock(MDatabase);

    va_list args;
    va_start(args, query_fmt);
    char* query(nullptr);
    int querylen = vasprintf(&query, query_fmt, args);
    va_end(args);

    if (!DoQuery_locked(err, query, querylen)) {
        free(query);
        return false;
    }
    free(query);

    affected_rows = (uint32)mysql_affected_rows(mysql);

    return true;
}

Here is the call graph for this function:

bool DBcore::RunQueryLID	(	DBerror &	err,
		uint32 &	last_insert_id,
		const char *	query_fmt,
			...
	)

Definition at line 288 of file dbcore.cpp.

References args, DoQuery_locked(), MDatabase, mysql, and vasprintf().

                                                                                         {
    MutexLock lock(MDatabase);

    va_list args;
    va_start(args, query_fmt);
    char* query(nullptr);
    int querylen = vasprintf(&query, query_fmt, args);
    va_end(args);

    if (!DoQuery_locked(err, query, querylen)) {
        free(query);
        return false;
    }
    free(query);

    last_insert_id = (uint32)mysql_insert_id(mysql);

    return true;
}

Here is the call graph for this function:

Member Data Documentation

Mutex DBcore::MDatabase

private

Definition at line 182 of file dbcore.h.

Referenced by Initialize(), ping(), Reconnect(), RunQuery(), and RunQueryLID().

MYSQL* DBcore::mysql

private

Definition at line 181 of file dbcore.h.

Referenced by Close(), Connect(), DBcore(), DoEscapeString(), DoQuery_locked(), getMySQL(), Initialize(), ping(), Reconnect(), RunQuery(), and RunQueryLID().

bool DBcore::pCompress

private

Definition at line 185 of file dbcore.h.

Referenced by Connect(), and Initialize().

std::string DBcore::pDatabase

private

Definition at line 196 of file dbcore.h.

Referenced by Connect(), and Initialize().

std::string DBcore::pHost

private

Definition at line 193 of file dbcore.h.

Referenced by Connect(), and Initialize().

std::string DBcore::pPassword

private

Definition at line 195 of file dbcore.h.

Referenced by Connect(), and Initialize().

int16 DBcore::pPort

private

Definition at line 191 of file dbcore.h.

Referenced by Connect(), and Initialize().

bool DBcore::pProfile

private

Definition at line 186 of file dbcore.h.

Referenced by DoQuery_locked(), and Initialize().

bool DBcore::pReconnect

private

Definition at line 187 of file dbcore.h.

Referenced by Connect(), and Initialize().

bool DBcore::pSocket

private

Definition at line 188 of file dbcore.h.

Referenced by Connect(), and Initialize().

bool DBcore::pSSL

private

Definition at line 189 of file dbcore.h.

Referenced by Connect(), and Initialize().

eStatus DBcore::pStatus

private

Definition at line 183 of file dbcore.h.

Referenced by Close(), Connect(), DoQuery_locked(), GetStatus(), Initialize(), and Reconnect().

std::string DBcore::pUser

private

Definition at line 194 of file dbcore.h.

Referenced by Connect(), and Initialize().

---

The documentation for this class was generated from the following files:

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/database/dbcore.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/database/dbcore.cpp