APIAccountManager Class Reference

??? More...

#include "APIAccountManager.h"

Inheritance diagram for APIAccountManager:

Collaboration diagram for APIAccountManager:

Public Member Functions
	APIAccountManager (const PyServiceMgr &services)
std::tr1::shared_ptr< std::string >	ProcessCall (const APICommandCall *pAPICommandCall)
Public Member Functions inherited from APIServiceManager
	APIServiceManager (const PyServiceMgr &services)
PyServiceMgr &	services ()
std::tr1::shared_ptr< std::string >	BuildErrorXMLResponse (std::string errorCode, std::string errorMessage)

Protected Member Functions
std::tr1::shared_ptr< std::string >	_APIKeyRequest (const APICommandCall *pAPICommandCall)
std::tr1::shared_ptr< std::string >	_Characters (const APICommandCall *pAPICommandCall)
std::tr1::shared_ptr< std::string >	_AccountStatus (const APICommandCall *pAPICommandCall)
std::string	_GenerateAPIKey ()
Protected Member Functions inherited from APIServiceManager
bool	_AuthenticateUserNamePassword (std::string userName, std::string password)
bool	_AuthenticateFullAPIQuery (std::string userID, std::string apiKey)
bool	_AuthenticateLimitedAPIQuery (std::string userID, std::string apiKey)
void	_BuildXMLHeader ()
void	_CloseXMLHeader (uint32 cacheStyle)
void	_BuildXMLRowSet (std::string name, std::string key, const std::vector< std::string > *columns)
void	_CloseXMLRowSet ()
void	_BuildXMLRow (const std::vector< std::string > *columns)
void	_BuildXMLTag (std::string name)
void	_BuildXMLTag (std::string name, const std::vector< std::pair< std::string, std::string > > *params)
void	_BuildXMLTag (std::string name, const std::vector< std::pair< std::string, std::string > > *params, std::string value)
void	_CloseXMLTag ()
void	_BuildSingleXMLTag (std::string name, std::string param)
void	_BuildErrorXMLTag (std::string code, std::string param)
std::tr1::shared_ptr< std::string >	_GetXMLDocumentString ()

Protected Attributes
APIAccountDB	m_accountDB
Protected Attributes inherited from APIServiceManager
APIServiceDB	m_db
PyServiceMgr	m_services
TiXmlDocument	_XmlDoc
TiXmlElement *	_pXmlDocOuterTag
std::string	_CurrentRowSetColumnString
std::stack< TiXmlElement * > *	_pXmlElementStack

Static Protected Attributes
static std::string	m_hexCharMap

Detailed Description

???

??? ??? ???

Author

Aknor Jaden

Date

July 2011

Definition at line 44 of file APIAccountManager.h.

Constructor & Destructor Documentation

APIAccountManager::APIAccountManager

(

const PyServiceMgr &

services

)

Definition at line 32 of file APIAccountManager.cpp.

: APIServiceManager(services)
{
}

Member Function Documentation

std::tr1::shared_ptr< std::string > APIAccountManager::_AccountStatus ( const APICommandCall *  pAPICommandCall )

protected

Definition at line 268 of file APIAccountManager.cpp.

References APIServiceManager::_BuildSingleXMLTag(), APIServiceManager::_BuildXMLHeader(), APIServiceManager::_BuildXMLTag(), APIServiceManager::_CloseXMLHeader(), APIServiceManager::_CloseXMLTag(), APIServiceManager::_GetXMLDocumentString(), APIServiceManager::BuildErrorXMLResponse(), APIServiceDB::GetAccountIdFromUserID(), APIAccountDB::GetAccountInfo(), m_accountDB, APIServiceManager::m_db, EVEAPI::CacheStyles::Short, and sLog.

Referenced by ProcessCall().

{
    sLog.Error( "APIAccountManager::_AccountStatus()", "TODO: Insert code to validate userID and apiKey" );

    if( pAPICommandCall->find( "userid" ) == pAPICommandCall->end() )
    {
        sLog.Error( "APIAccountManager::_AccountStatus()", "ERROR: No 'userID' parameter found in call argument list - exiting with error" );
        return BuildErrorXMLResponse( "106", "Must provide userID parameter for authentication." );
    }

    uint32 accountID = 0;
    std::vector<std::string> accountInfoList;

    if( !(m_db.GetAccountIdFromUserID( pAPICommandCall->find( "userid" )->second, &accountID )) )
    {
        sLog.Error( "APIAccountManager::_AccountStatus()", "ERROR: Could not find 'accountID' in 'accountApi' table - exiting with error" );
        return BuildErrorXMLResponse( "106", "Must provide userID parameter for authentication." );
    }

    if( !(m_accountDB.GetAccountInfo( accountID, accountInfoList )) )
    {
        sLog.Error( "APIAccountManager::_AccountStatus()", "ERROR: Could not find 'accountID' in 'account' table; there is an invalid 'accountID' referenced by api account 'userID' = %s - exiting with error", pAPICommandCall->find( "userid" )->second.c_str() );
        return BuildErrorXMLResponse( "106", "Must provide userID parameter for authentication." );
    }

    _BuildXMLHeader();
    {
        _BuildXMLTag( "result" );
        {
            _BuildSingleXMLTag( "paidUntil", "2100-12-31 12:00:00" );
            _BuildSingleXMLTag( "createDate", "2000-01-01 12:00:00" );
            _BuildSingleXMLTag( "logonCount", accountInfoList.at(2) );
            _BuildSingleXMLTag( "logonMinutes", "1000" );
        }
        _CloseXMLTag(); // close tag "result"
    }
    _CloseXMLHeader( EVEAPI::CacheStyles::Short );

    return _GetXMLDocumentString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::tr1::shared_ptr< std::string > APIAccountManager::_APIKeyRequest ( const APICommandCall *  pAPICommandCall )

protected

Definition at line 65 of file APIAccountManager.cpp.

References APIServiceManager::_AuthenticateUserNamePassword(), APIServiceManager::_BuildSingleXMLTag(), APIServiceManager::_BuildXMLHeader(), APIServiceManager::_CloseXMLHeader(), _GenerateAPIKey(), APIServiceManager::_GetXMLDocumentString(), APIServiceManager::BuildErrorXMLResponse(), APIServiceDB::GetAccountIdFromUsername(), APIServiceDB::GetApiAccountInfoUsingAccountID(), APIServiceDB::InsertNewUserIdApiKeyInfoToDatabase(), itoa(), EVEAPI::CacheStyles::Long, APIServiceManager::m_db, EVEAPI::Roles::Player, sLog, APIServiceDB::UpdateUserIdApiKeyDatabaseRow(), Win32Time_Day, Win32TimeNow(), and Win32TimeToString().

Referenced by ProcessCall().

{
    bool status = false;
    uint32 userID, apiRole;
    std::string username;
    std::string password;
    std::string keyType;
    std::string action;
    std::string apiLimitedKey;
    std::string apiFullKey;
    std::string accountID;
    std::string keyTag;

    sLog.Debug("APIAccountManager::_APIKeyRequest()", "EVEmu API - Account Service Manager - CALL: APIKeyRequest.xml.aspx");

    // 1: Decode arguments:
    if( pAPICommandCall->find( "username" ) != pAPICommandCall->end() )
        username = pAPICommandCall->find( "username" )->second;
    else
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: No 'username' parameter found in call argument list - exiting with error" );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    if( pAPICommandCall->find( "password" ) != pAPICommandCall->end() )
        password = pAPICommandCall->find( "password" )->second;
    else
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: No 'password' parameter found in call argument list - exiting with error" );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    if( pAPICommandCall->find( "keytype" ) != pAPICommandCall->end() )
        keyType = pAPICommandCall->find( "keytype" )->second;
    else
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: No 'keytype' parameter found in call argument list - exiting with error" );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    if( keyType != "full" )
        if( keyType != "limited" )
        {
            sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: 'keytype' parameter has invalid value '%s' - exiting with error", keyType.c_str() );
            return BuildErrorXMLResponse( "203", "Authentication failure." );
        }

    if( pAPICommandCall->find( "action" ) != pAPICommandCall->end() )
        action = pAPICommandCall->find( "action" )->second;
    else
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: No 'action' parameter found in call argument list - exiting with error" );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    if( action != "new" )
        if( action != "get" )
        {
            sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: 'action' parameter has invalid value '%s' - exiting with error", action.c_str() );
            return BuildErrorXMLResponse( "203", "Authentication failure." );
        }

    // 2: Authenticate the username and password against the account table:
    status = _AuthenticateUserNamePassword( username, password );
    if( !status )
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: username='%s' password='%s' does not authenticate.", username.c_str(), password.c_str() );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }
    // 2a: Get accountID using username, now that it's been validated:
    status = m_db.GetAccountIdFromUsername( username, &accountID );
    if( !status )
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: username='%s' cannot be found in 'account' table.", username.c_str() );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    // 3: Determine if this account's userID exists:
    status = m_db.GetApiAccountInfoUsingAccountID( accountID, &userID, &apiFullKey, &apiLimitedKey, &apiRole );

    // 4: Generate new random 64-character hexadecimal API Keys:
    // Write new API Key to database if key request 'action' is 'new':
    if( !status )
    {
        // 4a: If userID does not exist for this accountID, then insert a new row into the 'accountApi' table regardless of 'get' or 'new':
        apiLimitedKey = _GenerateAPIKey();
        apiFullKey = _GenerateAPIKey();
        status = m_db.InsertNewUserIdApiKeyInfoToDatabase( atol(accountID.c_str()), apiFullKey, apiLimitedKey, EVEAPI::Roles::Player );
    }

    if( action == "new" )
        if( keyType == "limited" )
            apiLimitedKey = _GenerateAPIKey();
        else //if( keyType == "full" )
            apiFullKey = _GenerateAPIKey();

    if( action == "new" )
    {
        if( status )
            // 4b: If userID already exists, generate new API keys and write them back to the database under that userID:
            status = m_db.UpdateUserIdApiKeyDatabaseRow( userID, apiFullKey, apiLimitedKey );
    }

    // 5: Build XML document to return to API client:
    userID = 0;
    apiFullKey = "";
    apiLimitedKey = "";
    apiRole = 0;
    //status = m_db.GetAccountIdFromUsername( username, &accountID );

    status = m_db.GetApiAccountInfoUsingAccountID( accountID, &userID, &apiFullKey, &apiLimitedKey, &apiRole );
    if( !status )
    {
        sLog.Error( "APIAccountManager::_APIKeyRequest()", "ERROR: username='%s' cannot be found in 'account' table.", username.c_str() );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    // 6: Return the userID and the API key requested in the xml structure:
    _BuildXMLHeader();
    {
        _BuildSingleXMLTag( "userID", std::string(itoa(userID)) );
        if( keyType == "full" )
        {
            keyTag = "apiFullKey";
            _BuildSingleXMLTag( keyTag, apiFullKey );
        }
        else
        {
            keyTag = "apiLimitedKey";
            _BuildSingleXMLTag( keyTag, apiLimitedKey );
        }
        _BuildSingleXMLTag( "expiresOn", Win32TimeToString(Win32TimeNow() + 180*Win32Time_Day) );
    }
    _CloseXMLHeader( EVEAPI::CacheStyles::Long );

    return _GetXMLDocumentString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::tr1::shared_ptr< std::string > APIAccountManager::_Characters ( const APICommandCall *  pAPICommandCall )

protected

Definition at line 203 of file APIAccountManager.cpp.

References APIServiceManager::_BuildXMLHeader(), APIServiceManager::_BuildXMLRow(), APIServiceManager::_BuildXMLRowSet(), APIServiceManager::_BuildXMLTag(), APIServiceManager::_CloseXMLHeader(), APIServiceManager::_CloseXMLRowSet(), APIServiceManager::_CloseXMLTag(), APIServiceManager::_GetXMLDocumentString(), APIServiceManager::BuildErrorXMLResponse(), APIServiceDB::GetAccountIdFromUserID(), APIAccountDB::GetCharactersList(), EVEAPI::CacheStyles::Long, m_accountDB, APIServiceManager::m_db, and sLog.

Referenced by ProcessCall().

{

    sLog.Error( "APIAccountManager::_Characters()", "TODO: Insert code to validate userID and apiKey" );

    sLog.Debug("APIAccountManager::_Characters()", "EVEmu API - Account Service Manager - CALL: Characters.xml.aspx");

    if( pAPICommandCall->find( "userid" ) == pAPICommandCall->end() )
    {
        sLog.Error( "APIAccountManager::_Characters()", "ERROR: No 'userID' parameter found in call argument list - exiting with error" );
        return BuildErrorXMLResponse( "106", "Must provide userID parameter for authentication." );
    }

    uint32 status = 0;
    uint32 accountID = 0;
    std::vector<std::string> charIDList;
    std::vector<std::string> charNameList;
    std::vector<std::string> charCorpIDList;
    std::vector<std::string> charCorpNameList;

    std::string userID = pAPICommandCall->find( "userid" )->second;

    status = m_db.GetAccountIdFromUserID( userID, &accountID );
    if( !status )
    {
        sLog.Error( "APIAccountManager::_Characters()", "ERROR: userID='%s' cannot be found in 'accountApi' table.", userID.c_str() );
        return BuildErrorXMLResponse( "203", "Authentication failure." );
    }

    if( !( m_accountDB.GetCharactersList(accountID, charIDList, charNameList, charCorpIDList, charCorpNameList) ) )
    {
        sLog.Error( "APIAccountManager::_Characters()", "ERROR: m_accountDB.GetCharactersList() call failed for unknown reason - exiting with error" );
        BuildErrorXMLResponse( "9999", "EVEmu API Server: Account Manager - Characters.xml.aspx STUB" );
    }

    std::vector<std::string> rowset;
    _BuildXMLHeader();
    {
        _BuildXMLTag( "result" );
        {
            rowset.push_back("name");
            rowset.push_back("characterID");
            rowset.push_back("corporationName");
            rowset.push_back("corporationID");
            _BuildXMLRowSet( "characters", "characterID", &rowset );
            {
                for(uint32 i=0; i<charIDList.size(); i++)
                {
                    rowset.clear();
                    rowset.push_back(charNameList.at(i));
                    rowset.push_back(charIDList.at(i));
                    rowset.push_back(charCorpNameList.at(i));
                    rowset.push_back(charCorpIDList.at(i));
                    _BuildXMLRow( &rowset );
                }
            }
            _CloseXMLRowSet();  // close rowset "characters"
        }
        _CloseXMLTag(); // close tag "result"
    }
    _CloseXMLHeader( EVEAPI::CacheStyles::Long );

    return _GetXMLDocumentString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string APIAccountManager::_GenerateAPIKey ( )

protected

Definition at line 309 of file APIAccountManager.cpp.

References key(), m_hexCharMap, and MakeRandomInt().

Referenced by _APIKeyRequest().

{
    std::string key = "";

    for( int i=0; i<64; i++ )
        key += m_hexCharMap.substr(static_cast<uint16>(MakeRandomInt(0, 15)), 1);

    return key;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::tr1::shared_ptr< std::string > APIAccountManager::ProcessCall ( const APICommandCall *  pAPICommandCall )

virtual

Reimplemented from APIServiceManager.

Definition at line 37 of file APIAccountManager.cpp.

References _AccountStatus(), _APIKeyRequest(), _Characters(), APIServiceManager::BuildErrorXMLResponse(), and sLog.

{
    sLog.Debug("APIAccountManager::ProcessCall()", "EVEmu API - Account Service Manager");

    if( pAPICommandCall->find( "servicehandler" ) == pAPICommandCall->end() )
    {
        sLog.Error( "APIAccountManager::ProcessCall()", "Cannot find 'servicehandler' specifier in pAPICommandCall packet" );
        return std::tr1::shared_ptr<std::string>(new std::string(""));
    }

    if( pAPICommandCall->find( "servicehandler" )->second == "APIKeyRequest.xml.aspx" )
        return _APIKeyRequest(pAPICommandCall);
    else if( pAPICommandCall->find( "servicehandler" )->second == "Characters.xml.aspx" )
        return _Characters(pAPICommandCall);
    else if( pAPICommandCall->find( "servicehandler" )->second == "AccountStatus.xml.aspx" )
        return _AccountStatus(pAPICommandCall);
    //else if( pAPICommandCall->find( "servicehandler" )->second == "TODO.xml.aspx" )
    //    return _TODO(pAPICommandCall);
    else
    {
        sLog.Error("APIAccountManager::ProcessCall()", "EVEmu API - Account Service Manager - ERROR: Cannot resolve '%s' as a valid service query for Admin Service Manager",
            pAPICommandCall->find("servicehandler")->second.c_str() );
        return std::tr1::shared_ptr<std::string>(new std::string(""));
    }

    return BuildErrorXMLResponse( "9999", "EVEmu API Server: Account Manager - Unknown call." );
}

Here is the call graph for this function:

Member Data Documentation

APIAccountDB APIAccountManager::m_accountDB

protected

Definition at line 61 of file APIAccountManager.h.

Referenced by _AccountStatus(), and _Characters().

std::string APIAccountManager::m_hexCharMap

staticprotected

Definition at line 62 of file APIAccountManager.h.

Referenced by _GenerateAPIKey().

---

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

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