APIServiceDB Class Reference

#include "APIServiceDB.h"

Public Member Functions
	APIServiceDB ()
bool	GetAccountIdFromUsername (std::string username, std::string *accountID)
	? More...
bool	GetAccountIdFromUserID (std::string userID, uint32 *accountID)
	? More...
bool	GetApiAccountInfoUsingAccountID (std::string accountID, uint32 *userID, std::string *apiFullKey, std::string *apiLimitedKey, uint32 *apiRole)
	? More...
bool	GetApiAccountInfoUsingUserID (std::string userID, std::string *apiFullKey, std::string *apiLimitedKey, uint32 *apiRole)
	? More...
bool	UpdateUserIdApiKeyDatabaseRow (uint32 userID, std::string apiFullKey, std::string apiLimitedKey)
	? More...
bool	InsertNewUserIdApiKeyInfoToDatabase (uint32 accountID, std::string apiFullKey, std::string apiLimitedKey, uint32 apiRole)
	? More...
bool	UpdateUserIdApiRole (uint32 userID, uint32 apiRole)
	? More...

Detailed Description

Definition at line 29 of file APIServiceDB.h.

Constructor & Destructor Documentation

APIServiceDB::APIServiceDB

(

)

Definition at line 30 of file APIServiceDB.cpp.

{
}

Member Function Documentation

bool APIServiceDB::GetAccountIdFromUserID	(	std::string	userID,
		uint32 *	accountID
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 60 of file APIServiceDB.cpp.

References DBQueryResult::GetRow(), DBResultRow::GetUInt(), sDatabase, and sLog.

Referenced by APIAccountManager::_AccountStatus(), and APIAccountManager::_Characters().

{
    DBQueryResult res;

    // Find accountID in 'accountapi' table using userID:
    if( !sDatabase.RunQuery(res,
        "SELECT"
        "    accountID "
        " FROM accountApi "
        " WHERE userID='%s'" , userID.c_str() ))
    {
        sLog.Error( "APIServiceDB::GetAccountIdFromUserID()", "Cannot find accountID for userID %s", userID.c_str() );
        return false;
    }

    DBResultRow row;
    if( !res.GetRow(row) )
    {
        sLog.Error( "APIServiceDB::GetAccountIdFromUserID()", "res.GetRow(row) failed for unknown reason." );
        return false;
    }

    *accountID = row.GetUInt(0);        // Grab accountID from the retrieved row from the 'accountapi' table
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool APIServiceDB::GetAccountIdFromUsername	(	std::string	username,
		std::string *	accountID
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 34 of file APIServiceDB.cpp.

References DBQueryResult::GetRow(), DBResultRow::GetText(), sDatabase, and sLog.

Referenced by APIAccountManager::_APIKeyRequest().

{
    DBQueryResult res;

    // Find accountID in 'account' table using accountName:
    if( !sDatabase.RunQuery(res,
        "SELECT"
        "    accountID "
        " FROM account "
        " WHERE accountName='%s'" , username.c_str() ))
    {
        sLog.Error( "APIServiceDB::GetAccountIdFromUsername()", "Cannot find accountID for username %s", username.c_str() );
        return false;
    }

    DBResultRow row;
    if( !res.GetRow(row) )
    {
        sLog.Error( "APIServiceDB::GetAccountIdFromUsername()", "res.GetRow(row) failed for unknown reason." );
        return false;
    }

    *accountID = row.GetText(0);        // Grab accountID from the retrieved row from the 'account' table
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool APIServiceDB::GetApiAccountInfoUsingAccountID	(	std::string	accountID,
		uint32 *	userID,
		std::string *	apiFullKey,
		std::string *	apiLimitedKey,
		uint32 *	apiRole
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 86 of file APIServiceDB.cpp.

References DBQueryResult::GetRow(), DBResultRow::GetText(), DBResultRow::GetUInt(), sDatabase, and sLog.

Referenced by APIAccountManager::_APIKeyRequest().

{
    DBQueryResult res;

    // Find userID, fullKey, limitedKey, and apiRole from 'accountApi' table using accountID obtained from 'account' table:
    if( !sDatabase.RunQuery(res,
        "SELECT"
        "    userID, fullKey, limitedKey, apiRole "
        " FROM accountApi "
        " WHERE accountID='%s'" , accountID.c_str() ))
    {
        sLog.Error( "APIServiceDB::GetApiAccountInfoUsingAccountID()", "Cannot find accountID '%s' in 'accountApi' table", accountID.c_str() );
        return false;
    }

    DBResultRow row;
    if( !res.GetRow(row) )
    {
        sLog.Error( "APIServiceDB::GetApiAccountInfoUsingAccountID()", "res.GetRow(row) failed for unknown reason." );
        return false;
    }

    *userID = row.GetUInt(0);            // Grab userID from retrieved row from the 'accountApi' table
    *apiFullKey = row.GetText(1);        // Grab Full API Key from retrieved row from the 'accountApi' table
    *apiLimitedKey = row.GetText(2);    // Grab Limited API Key from retrieved row from the 'accountApi' table
    *apiRole = row.GetUInt(3);            // Grab API Role from retrieved row from the 'accountApi' table
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool APIServiceDB::GetApiAccountInfoUsingUserID	(	std::string	userID,
		std::string *	apiFullKey,
		std::string *	apiLimitedKey,
		uint32 *	apiRole
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 116 of file APIServiceDB.cpp.

References DBQueryResult::GetRow(), DBResultRow::GetText(), DBResultRow::GetUInt(), sDatabase, and sLog.

Referenced by APIServiceManager::_AuthenticateFullAPIQuery(), and APIServiceManager::_AuthenticateLimitedAPIQuery().

{
    DBQueryResult res;

    // Find fullKey, limitedKey, and apiRole from 'accountApi' table using userID supplied from an API query string:
    if( !sDatabase.RunQuery(res,
        "SELECT"
        "    fullKey, limitedKey, apiRole "
        " FROM accountApi "
        " WHERE userID='%s'" , userID.c_str() ))
    {
        sLog.Error( "APIServiceDB::GetApiAccountInfoUsingUserID()", "Cannot find userID '%s' in 'accountApi' table", userID.c_str() );
        return false;
    }

    DBResultRow row;
    if( !res.GetRow(row) )
    {
        sLog.Error( "APIServiceDB::GetApiAccountInfoUsingUserID()", "res.GetRow(row) failed for unknown reason." );
        return false;
    }

    *apiFullKey = row.GetText(0);        // Grab Full API Key from retrieved row from the 'accountApi' table
    *apiLimitedKey = row.GetText(1);    // Grab Limited API Key from retrieved row from the 'accountApi' table
    *apiRole = row.GetUInt(2);            // Grab API Role from retrieved row from the 'accountApi' table
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool APIServiceDB::InsertNewUserIdApiKeyInfoToDatabase	(	uint32	accountID,
		std::string	apiFullKey,
		std::string	apiLimitedKey,
		uint32	apiRole
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 176 of file APIServiceDB.cpp.

References DBerror::c_str(), sDatabase, and sLog.

Referenced by APIAccountManager::_APIKeyRequest().

{
    // Check key lengths and report error and return if either are incorrect:
    if( apiLimitedKey.length() != 64 )
    {
        sLog.Error( "APIServiceDB::UpdateUserIdApiKeyDatabaseRow()", "limitedApiKey length != 64, but rather %u", apiLimitedKey.length() );
        return false;
    }

    if( apiFullKey.length() != 64 )
    {
        sLog.Error( "APIServiceDB::UpdateUserIdApiKeyDatabaseRow()", "fullApiKey length != 64, but rather %u", apiFullKey.length() );
        return false;
    }

    DBerror err;

    if( !sDatabase.RunQuery(err,
        "INSERT INTO"
        " accountApi ("
        "    accountID, fullKey, limitedKey, apiRole"
        " ) VALUES ("
        "    %u, '%s', '%s', %u"
        " )",
            accountID, apiFullKey.c_str(), apiLimitedKey.c_str(), apiRole
            ))
    {
        sLog.Error( "", "Error in query: %s.", err.c_str());
        return false;
    }
    else
        return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool APIServiceDB::UpdateUserIdApiKeyDatabaseRow	(	uint32	userID,
		std::string	apiFullKey,
		std::string	apiLimitedKey
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 144 of file APIServiceDB.cpp.

References DBerror::c_str(), sDatabase, and sLog.

Referenced by APIAccountManager::_APIKeyRequest().

{
    // Check key lengths and report error and return if either are incorrect:
    if( apiLimitedKey.length() != 64 )
    {
        sLog.Error( "APIServiceDB::UpdateUserIdApiKeyDatabaseRow()", "limitedApiKey length != 64, but rather %u", apiLimitedKey.length() );
        return false;
    }

    if( apiFullKey.length() != 64 )
    {
        sLog.Error( "APIServiceDB::UpdateUserIdApiKeyDatabaseRow()", "fullApiKey length != 64, but rather %u", apiFullKey.length() );
        return false;
    }

    // Update fullKey and limitedKey in the 'accountApi' table using userID:
    DBerror err;

    if( !sDatabase.RunQuery(err,
        "UPDATE"
        " accountApi"
        " SET fullKey = '%s', limitedKey = '%s'"
        " WHERE userID = %u",
        apiFullKey.c_str(), apiLimitedKey.c_str(), userID ))
    {
        sLog.Error( "", "Error in query: %s.", err.c_str());
        return false;
    }
    else
        return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool APIServiceDB::UpdateUserIdApiRole	(	uint32	userID,
		uint32	apiRole
	)

?

?

Parameters

[in]	?
[in]	?

Return values

?

Definition at line 210 of file APIServiceDB.cpp.

References DBerror::c_str(), sDatabase, and sLog.

{
    // Update fullKey and limitedKey in the 'accountApi' table using userID:
    DBerror err;

    if( !sDatabase.RunQuery(err,
        "UPDATE"
        " accountApi"
        " SET apiRole = %u"
        " WHERE userID = %u",
        apiRole, userID ))
    {
        sLog.Error( "", "Error in query: %s.", err.c_str());
        return false;
    }
    else
        return true;
}

Here is the call graph for this function:

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/apiserver/APIServiceDB.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/apiserver/APIServiceDB.cpp