Generic Base Class used to derive classes for specific service handlers (character, corporation, etc) More...

#include "APIServiceManager.h"

Inheritance diagram for APIServiceManager:

Collaboration diagram for APIServiceManager:

Public Member Functions
	APIServiceManager (const PyServiceMgr &services)

PyServiceMgr &	services ()

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

std::tr1::shared_ptr< std::string >	BuildErrorXMLResponse (std::string errorCode, std::string errorMessage)

Protected Member Functions
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
APIServiceDB	m_db

PyServiceMgr	m_services

TiXmlDocument	_XmlDoc

TiXmlElement *	_pXmlDocOuterTag

std::string	_CurrentRowSetColumnString

std::stack< TiXmlElement * > *	_pXmlElementStack

Detailed Description

Generic Base Class used to derive classes for specific service handlers (character, corporation, etc)

This class implements basic functions to build the xml documents needed to be returned from the specific service handlers for the API Server. It is used as the base class for polymorphism container in APIServer::GetXML() call to route the API Command Call package to the appropriate service handler using the service category.

Author: Aknor Jaden

Date: July 2011

Definition at line 73 of file APIServiceManager.h.

Constructor & Destructor Documentation

APIServiceManager::APIServiceManager ( const PyServiceMgr & services )

Definition at line 30 of file APIServiceManager.cpp.

References _CurrentRowSetColumnString, _pXmlDocOuterTag, and _pXmlElementStack.

 : m_services(services)
 {
     _pXmlDocOuterTag = NULL;
     _pXmlElementStack = NULL;
     _CurrentRowSetColumnString = "";
 }

Member Function Documentation

bool APIServiceManager::_AuthenticateFullAPIQuery	(	std::string	userID,
		std::string	apiKey
	)

protected

Definition at line 162 of file APIServiceManager.cpp.

References APIServiceDB::GetApiAccountInfoUsingUserID(), and m_db.

 {
     std::string apiFullKey;
     std::string apiLimitedKey;
     uint32 apiRole;
 
     bool status = m_db.GetApiAccountInfoUsingUserID(userID, &apiFullKey, &apiLimitedKey, &apiRole);
 
     if( (apiKey.compare( apiFullKey )) && (status) )
         return true;
     else
         return false;
 }

Here is the call graph for this function:

bool APIServiceManager::_AuthenticateLimitedAPIQuery	(	std::string	userID,
		std::string	apiKey
	)

protected

Definition at line 176 of file APIServiceManager.cpp.

References APIServiceDB::GetApiAccountInfoUsingUserID(), and m_db.

 {
     std::string apiFullKey;
     std::string apiLimitedKey;
     uint32 apiRole;
 
     bool status = m_db.GetApiAccountInfoUsingUserID(userID, &apiFullKey, &apiLimitedKey, &apiRole);
 
     if( (apiKey.compare( apiLimitedKey )) && (status) )
         return true;
     else
         return false;
 }

Here is the call graph for this function:

bool APIServiceManager::_AuthenticateUserNamePassword	(	std::string	userName,
		std::string	password
	)

protected

Definition at line 142 of file APIServiceManager.cpp.

References PasswordModule::GeneratePassHash(), and services().

Referenced by APIAccountManager::_APIKeyRequest().

 {
     // Query account info
     AccountInfo account_info;
     if( !services().serviceDB().GetAccountInformation(
             username.c_str(), 
             password.c_str(),
             account_info ) )
         return false;
 
     // Compute pass hash
     std::string passHash;
     if( !PasswordModule::GeneratePassHash(
             username, password, passHash ) )
         return false;
 
     // Compare the hashes
     return passHash == account_info.hash;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void APIServiceManager::_BuildErrorXMLTag	(	std::string	code,
		std::string	param
	)

protected

Definition at line 316 of file APIServiceManager.cpp.

References _pXmlDocOuterTag, and _pXmlElementStack.

Referenced by BuildErrorXMLResponse(), and ProcessCall().

 {
     TiXmlElement * error = new TiXmlElement( "error" );
     error->SetAttribute( "code", code.c_str() );
     error->LinkEndChild( new TiXmlText( param.c_str() ));
 
     if( _pXmlElementStack->empty() )
         _pXmlDocOuterTag->LinkEndChild( error );
     else
         _pXmlElementStack->top()->LinkEndChild( error );
 }

Here is the caller graph for this function:

void APIServiceManager::_BuildSingleXMLTag	(	std::string	name,
		std::string	param
	)

protected

Definition at line 305 of file APIServiceManager.cpp.

References _pXmlDocOuterTag, and _pXmlElementStack.

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_APIKeyRequest(), APICharacterManager::_CharacterSheet(), _CloseXMLHeader(), APIServerManager::_ServerStatus(), and APICharacterManager::_SkillInTraining().

 {
     TiXmlElement * tag = new TiXmlElement( name.c_str() );
     tag->LinkEndChild( new TiXmlText( value.c_str() ));
 
     if( _pXmlElementStack->empty() )
         _pXmlDocOuterTag->LinkEndChild( tag );
     else
         _pXmlElementStack->top()->LinkEndChild( tag );
 }

Here is the caller graph for this function:

void APIServiceManager::_BuildXMLHeader ( )

protected

Definition at line 190 of file APIServiceManager.cpp.

References _pXmlDocOuterTag, _pXmlElementStack, _XmlDoc, currentTime, Win32TimeNow(), and Win32TimeToString().

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_APIKeyRequest(), APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), APIServerManager::_ServerStatus(), APICharacterManager::_SkillInTraining(), APICharacterManager::_SkillQueue(), BuildErrorXMLResponse(), and ProcessCall().

 {
     // Build header at beginning of XML document, so clear existing xml document
     _XmlDoc.Clear();
     // object pointed to by '_pXmlDocOuterTag' is automatically deleted by the TinyXML system with the above call
     if( _pXmlElementStack != NULL )
     {
         delete _pXmlElementStack;
         _pXmlElementStack = NULL;
     }
     _pXmlElementStack = new std::stack<TiXmlElement *>();
 
     TiXmlDeclaration * decl = new TiXmlDeclaration( "1.0", "UTF-8", "" );
     _XmlDoc.LinkEndChild( decl );
 
     _pXmlDocOuterTag = new TiXmlElement( "eveapi" );
     _XmlDoc.LinkEndChild( _pXmlDocOuterTag );
     _pXmlDocOuterTag->SetAttribute( "version", "2" );
 
     TiXmlElement * currentTime = new TiXmlElement( "currentTime" );
     currentTime->LinkEndChild( new TiXmlText( Win32TimeToString(Win32TimeNow()).c_str() ));
     _pXmlDocOuterTag->LinkEndChild( currentTime );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void APIServiceManager::_BuildXMLRow ( const std::vector< std::string > * columns )

protected

Definition at line 259 of file APIServiceManager.cpp.

References _CurrentRowSetColumnString, and _pXmlElementStack.

Referenced by APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), and APICharacterManager::_SkillQueue().

 {
     TiXmlElement * row = new TiXmlElement( "row" );
 
     std::vector<std::string>::const_iterator current, end;
     std::string column_string = _CurrentRowSetColumnString;
     std::string column_name;
     int pos=0;
     int pos2=0;
     current = columns->begin();
     end = columns->end();
     for(; current != end; ++current)
     {
         pos = column_string.find_first_of(",");
         column_name = column_string.substr(0,pos);
         column_string = column_string.substr(pos+1);
         row->SetAttribute( column_name.c_str(), current->c_str() );
     }
     _pXmlElementStack->top()->LinkEndChild( row );
 }

Here is the caller graph for this function:

void APIServiceManager::_BuildXMLRowSet	(	std::string	name,
		std::string	key,
		const std::vector< std::string > *	columns
	)

protected

Definition at line 233 of file APIServiceManager.cpp.

References _CurrentRowSetColumnString, and _pXmlElementStack.

Referenced by APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), and APICharacterManager::_SkillQueue().

 {
     TiXmlElement * rowset = new TiXmlElement( "rowset" );
 
     std::vector<std::string>::const_iterator current, end;
     rowset->SetAttribute( "name", name.c_str() );
     rowset->SetAttribute( "key", key.c_str() );
     current = columns->begin();
     end = columns->end();
     _CurrentRowSetColumnString = *current;
     ++current;
     for(; current != end; ++current)
     {
         _CurrentRowSetColumnString += ",";
         _CurrentRowSetColumnString += *current;
     }
     rowset->SetAttribute( "columns", _CurrentRowSetColumnString.c_str() );
 
     _pXmlElementStack->push( rowset );
 }

Here is the caller graph for this function:

void APIServiceManager::_BuildXMLTag ( std::string name )

protected

Definition at line 280 of file APIServiceManager.cpp.

References _pXmlElementStack.

Referenced by APIAccountManager::_AccountStatus(), _BuildXMLTag(), APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), APIServerManager::_ServerStatus(), APICharacterManager::_SkillInTraining(), and APICharacterManager::_SkillQueue().

 {
     TiXmlElement * tag = new TiXmlElement( name.c_str() );
     _pXmlElementStack->push( tag );
 }

Here is the caller graph for this function:

void APIServiceManager::_BuildXMLTag	(	std::string	name,
		const std::vector< std::pair< std::string, std::string > > *	params
	)

protected

Definition at line 286 of file APIServiceManager.cpp.

References _pXmlElementStack.

 {
     TiXmlElement * tag = new TiXmlElement( name.c_str() );
 
     std::vector<std::pair<std::string, std::string> >::const_iterator current, end;
     current = params->begin();
     end = params->end();
     for(; current != end; ++current)
         tag->SetAttribute( current->first.c_str(), current->second.c_str() );
 
     _pXmlElementStack->push( tag );
 }

void APIServiceManager::_BuildXMLTag	(	std::string	name,
		const std::vector< std::pair< std::string, std::string > > *	params,
		std::string	value
	)

protected

Definition at line 299 of file APIServiceManager.cpp.

References _BuildXMLTag(), and _pXmlElementStack.

 {
     _BuildXMLTag( name, params );
     _pXmlElementStack->top()->LinkEndChild( new TiXmlText( value.c_str() ));
 }

Here is the call graph for this function:

void APIServiceManager::_CloseXMLHeader ( uint32 cacheStyle )

protected

Definition at line 214 of file APIServiceManager.cpp.

References _BuildSingleXMLTag(), EVEAPI::CacheStyles::Long, EVEAPI::CacheStyles::Modified, EVEAPI::CacheStyles::Short, Win32Time_Minute, Win32TimeNow(), and Win32TimeToString().

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_APIKeyRequest(), APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), APIServerManager::_ServerStatus(), APICharacterManager::_SkillInTraining(), APICharacterManager::_SkillQueue(), BuildErrorXMLResponse(), and ProcessCall().

 {
     switch( cacheStyle )
     {
         case EVEAPI::CacheStyles::Long:
             // 2 hour cache timer
             _BuildSingleXMLTag( "cachedUntil", Win32TimeToString(Win32TimeNow() + 120*Win32Time_Minute).c_str() );
             break;
         case EVEAPI::CacheStyles::Short:
             // 5 minute cache timer
             _BuildSingleXMLTag( "cachedUntil", Win32TimeToString(Win32TimeNow() + 5*Win32Time_Minute).c_str() );
             break;
         case EVEAPI::CacheStyles::Modified:
             // 15 minute cache timer
             _BuildSingleXMLTag( "cachedUntil", Win32TimeToString(Win32TimeNow() + 15*Win32Time_Minute).c_str() );
             break;
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void APIServiceManager::_CloseXMLRowSet ( )

protected

Definition at line 254 of file APIServiceManager.cpp.

References _CloseXMLTag().

Referenced by APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), and APICharacterManager::_SkillQueue().

 {
     _CloseXMLTag();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void APIServiceManager::_CloseXMLTag ( )

protected

Definition at line 328 of file APIServiceManager.cpp.

References _pXmlDocOuterTag, and _pXmlElementStack.

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), _CloseXMLRowSet(), APIServerManager::_ServerStatus(), APICharacterManager::_SkillInTraining(), and APICharacterManager::_SkillQueue().

 {
     if( _pXmlElementStack->empty() )
         return;
 
     TiXmlElement * _pTopElement = _pXmlElementStack->top();
     _pXmlElementStack->pop();
 
     if( _pXmlElementStack->empty() )
         _pXmlDocOuterTag->LinkEndChild( _pTopElement );
     else
     {
         TiXmlElement * _pNextTopElement = _pXmlElementStack->top();
         _pNextTopElement->LinkEndChild( _pTopElement );
     }
 }

Here is the caller graph for this function:

std::tr1::shared_ptr< std::string > APIServiceManager::_GetXMLDocumentString ( )

protected

Definition at line 345 of file APIServiceManager.cpp.

References _XmlDoc.

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_APIKeyRequest(), APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), APIServerManager::_ServerStatus(), APICharacterManager::_SkillInTraining(), APICharacterManager::_SkillQueue(), BuildErrorXMLResponse(), and ProcessCall().

 {
     TiXmlPrinter xmlPrinter;
     _XmlDoc.Accept( &xmlPrinter );
 
     return std::tr1::shared_ptr<std::string>(new std::string(xmlPrinter.CStr()));
 }

Here is the caller graph for this function:

std::tr1::shared_ptr< std::string > APIServiceManager::BuildErrorXMLResponse	(	std::string	errorCode,
		std::string	errorMessage
	)

Definition at line 131 of file APIServiceManager.cpp.

References _BuildErrorXMLTag(), _BuildXMLHeader(), _CloseXMLHeader(), _GetXMLDocumentString(), and EVEAPI::CacheStyles::Modified.

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_APIKeyRequest(), APIAccountManager::_Characters(), APICharacterManager::_CharacterSheet(), APICharacterManager::_SkillInTraining(), APICharacterManager::_SkillQueue(), APIActiveObjectManager::ProcessCall(), APIAccountManager::ProcessCall(), and APICharacterManager::ProcessCall().

 {
     _BuildXMLHeader();
     {
         _BuildErrorXMLTag( errorCode, errorMessage );
     }
     _CloseXMLHeader( EVEAPI::CacheStyles::Modified );
 
     return _GetXMLDocumentString();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Reimplemented in APIAccountManager, APICharacterManager, APIActiveObjectManager, APIAdminManager, APICorporationManager, APIEveSystemManager, APIMapManager, and APIServerManager.

Definition at line 38 of file APIServiceManager.cpp.

References _BuildErrorXMLTag(), _BuildXMLHeader(), _CloseXMLHeader(), _GetXMLDocumentString(), EVEAPI::CacheStyles::Modified, and sLog.

 {
     sLog.Debug("APIServiceManager::ProcessCall()", "EVEmu API - Default Service Manager");
 
     // EXAMPLE OF USING ALL FEATURES OF THE INHERITED APISERVICEMANAGER XML BUILDING HELPER FUNCTIONS:
     /*
     std::vector<std::string> rowset;
     _BuildXMLHeader();
     {
         _BuildErrorXMLTag( "500", "EVEmu: Invalid Service Manager Specified." );
 
         _BuildXMLTag( "attributes" );
         {
             _BuildXMLTag( "Aknor_Jaden" );
             {
                 _BuildSingleXMLTag( "intelligence", "6" );
                 _BuildSingleXMLTag( "memory", "4" );
                 _BuildSingleXMLTag( "charisma", "7" );
                 _BuildSingleXMLTag( "perception", "12" );
                 _BuildSingleXMLTag( "willpower", "10" );
             }
             _CloseXMLTag(); // close "Aknor_Jaden" tag
         }
         _CloseXMLTag(); // close "attributes" tag
 
         rowset.push_back("typeID");
         rowset.push_back("skillpoints");
         rowset.push_back("level");
         rowset.push_back("published");
         _BuildXMLRowSet( "skills", "typeID", &rowset );
         {
             rowset.clear();
             rowset.push_back("3431");
             rowset.push_back("8000");
             rowset.push_back("3");
             rowset.push_back("1");
             _BuildXMLRow( &rowset );
             rowset.clear();
             rowset.push_back("3413");
             rowset.push_back("8000");
             rowset.push_back("3");
             rowset.push_back("1");
             _BuildXMLRow( &rowset );
             rowset.clear();
             rowset.push_back("21059");
             rowset.push_back("500");
             rowset.push_back("1");
             rowset.push_back("1");
             _BuildXMLRow( &rowset );
             rowset.clear();
             rowset.push_back("3416");
             rowset.push_back("8000");
             rowset.push_back("3");
             rowset.push_back("1");
             _BuildXMLRow( &rowset );
             rowset.clear();
             rowset.push_back("3445");
             rowset.push_back("512000");
             rowset.push_back("5");
             rowset.push_back("0");
             _BuildXMLRow( &rowset );
         }
         _CloseXMLRowSet();  // close rowset "skils"
 
         _BuildXMLTag( "attributeEnhancers" );
         {
             _BuildXMLTag( "memoryBonus" );
             {
                 _BuildSingleXMLTag( "augmentatorName", "Memory Augmentation - Basic" );
                 _BuildSingleXMLTag( "augmentatorValue", "3" );
             }
             _CloseXMLTag(); // close tag "memoryBonus"
             _BuildXMLTag( "perceptionBonus" );
             {
                 _BuildSingleXMLTag( "augmentatorName", "Ocular Filter - Basic" );
                 _BuildSingleXMLTag( "augmentatorValue", "5" );
             }
             _CloseXMLTag(); // close tag "perceptionBonus"
         }
         _CloseXMLTag(); // close tag "attributeEnhancers"
     }
     _CloseXMLHeader( API_CACHE_STYLE_MODIFIED );
     */
 
     _BuildXMLHeader();
     {
         _BuildErrorXMLTag( "500", "EVEmu: Invalid Service Manager Specified." );
     }
     _CloseXMLHeader( EVEAPI::CacheStyles::Modified );
 
     return _GetXMLDocumentString();
 }

Here is the call graph for this function:

PyServiceMgr& APIServiceManager::services ( )

inline

Definition at line 77 of file APIServiceManager.h.

References m_services.

Referenced by _AuthenticateUserNamePassword(), and APIServerManager::_ServerStatus().

77 { return m_services; }

APIServiceManager::m_services

PyServiceMgr m_services

Definition: APIServiceManager.h:103

Here is the caller graph for this function:

Member Data Documentation

std::string APIServiceManager::_CurrentRowSetColumnString

protected

Definition at line 107 of file APIServiceManager.h.

Referenced by _BuildXMLRow(), _BuildXMLRowSet(), and APIServiceManager().

TiXmlElement* APIServiceManager::_pXmlDocOuterTag

protected

Definition at line 106 of file APIServiceManager.h.

Referenced by _BuildErrorXMLTag(), _BuildSingleXMLTag(), _BuildXMLHeader(), _CloseXMLTag(), and APIServiceManager().

std::stack<TiXmlElement *>* APIServiceManager::_pXmlElementStack

protected

Definition at line 108 of file APIServiceManager.h.

Referenced by _BuildErrorXMLTag(), _BuildSingleXMLTag(), _BuildXMLHeader(), _BuildXMLRow(), _BuildXMLRowSet(), _BuildXMLTag(), _CloseXMLTag(), and APIServiceManager().

TiXmlDocument APIServiceManager::_XmlDoc

protected

Definition at line 105 of file APIServiceManager.h.

Referenced by _BuildXMLHeader(), and _GetXMLDocumentString().

APIServiceDB APIServiceManager::m_db

protected

Definition at line 102 of file APIServiceManager.h.

Referenced by APIAccountManager::_AccountStatus(), APIAccountManager::_APIKeyRequest(), _AuthenticateFullAPIQuery(), _AuthenticateLimitedAPIQuery(), and APIAccountManager::_Characters().

PyServiceMgr APIServiceManager::m_services

protected

Definition at line 103 of file APIServiceManager.h.

Referenced by services().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation