fhq-server  v0.2.33
Documentation for fhq-server. FreeHackQuest is an open source platform for competitions of computer security.
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
CmdHandlerBase Class Referenceabstract

Api handler Base. More...

#include <cmd_handlers.h>

Inherited by CmdClassbookAddRecordHandler, CmdClassbookDeleteRecordHandler, CmdClassbookExportHandler, CmdClassbookHandler, CmdClassbookInfoHandler, CmdClassbookListHandler, CmdClassbookLocalizationAddRecordHandler, CmdClassbookLocalizationDeleteRecordHandler, CmdClassbookLocalizationInfoHandler, CmdClassbookLocalizationUpdateRecordHandler, CmdClassbookProposalAddRecordHandler, CmdClassbookProposalApproveHandler, CmdClassbookProposalDeleteRecordHandler, CmdClassbookProposalInfoHandler, CmdClassbookProposalListHandler, CmdClassbookProposalPrepareMergeRecordHandler, CmdClassbookProposalUpdateHandler, CmdClassbookUpdateRecordHandler, CmdHandlerAddHint, CmdHandlerAnswerList, CmdHandlerChatAddToBlackList, CmdHandlerChatAddToChat, CmdHandlerChatChangeOwner, CmdHandlerChatCreateGroupChat, CmdHandlerChatDeleteFromBlackList, CmdHandlerChatDeleteFromChat, CmdHandlerChatDeleteMessage, CmdHandlerChatEditMessage, CmdHandlerChatLastestMessages, CmdHandlerChatReadMessage, CmdHandlerChatSendMessage, CmdHandlerChatSendMessage_new, CmdHandlerChatShowDialogs, CmdHandlerCreateQuest, CmdHandlerDeleteHint, CmdHandlerEventAdd, CmdHandlerEventDelete, CmdHandlerEventInfo, CmdHandlerEventsList, CmdHandlerFeedbackAdd, CmdHandlerGameCreate, CmdHandlerGameDelete, CmdHandlerGameExport, CmdHandlerGameImport, CmdHandlerGameInfo, CmdHandlerGames, CmdHandlerGameUpdate, CmdHandlerGameUpdateLogo, CmdHandlerGetMap, CmdHandlerHints, CmdHandlerLeaksAdd, CmdHandlerLeaksBuy, CmdHandlerLeaksDelete, CmdHandlerLeaksList, CmdHandlerLeaksUpdate, CmdHandlerLogin, CmdHandlerLXDContainers, CmdHandlerLXDExec, CmdHandlerLXDFile, CmdHandlerLXDImportService, CmdHandlerLXDImportServiceFromZip, CmdHandlerLXDInfo, CmdHandlerLXDList, CmdHandlerLXDOpenPort, CmdHandlerLXDStartService, CmdHandlerMailInfo, CmdHandlerMailSend, CmdHandlerMailsList, CmdHandlerPublicInfo, CmdHandlerQuest, CmdHandlerQuestDelete, CmdHandlerQuestPass, CmdHandlerQuestProposal, CmdHandlerQuests, CmdHandlerQuestsFilesUpload, CmdHandlerQuestsProposalList, CmdHandlerQuestsSubjects, CmdHandlerQuestStatistics, CmdHandlerQuestsWriteUpsDelete, CmdHandlerQuestsWriteUpsList, CmdHandlerQuestsWriteUpsProposal, CmdHandlerQuestsWriteUpsUpdate, CmdHandlerQuestUpdate, CmdHandlerRegistration, CmdHandlerServerInfo, CmdHandlerServerSettings, CmdHandlerServerSettingsUpdate, CmdHandlerToken, CmdHandlerUpdateUserLocation, CmdHandlerUsefulLinksAdd, CmdHandlerUsefulLinksClicked, CmdHandlerUsefulLinksCommentAdd, CmdHandlerUsefulLinksCommentDelete, CmdHandlerUsefulLinksCommentList, CmdHandlerUsefulLinksDelete, CmdHandlerUsefulLinksList, CmdHandlerUsefulLinksRetrieve, CmdHandlerUsefulLinksTagAdd, CmdHandlerUsefulLinksTagDelete, CmdHandlerUsefulLinksTagList, CmdHandlerUsefulLinksUpdate, CmdHandlerUsefulLinksUserFavorite, CmdHandlerUsefulLinksUserFavoriteList, CmdHandlerUsefulLinksUserPropose, CmdHandlerUsefulLinksUserProposeApprove, CmdHandlerUsefulLinksUserUnfavorite, CmdHandlerUser, CmdHandlerUserChangePassword, CmdHandlerUserDelete, CmdHandlerUserResetPassword, CmdHandlerUsers, CmdHandlerUsersAdd, CmdHandlerUsersChangeEmail, CmdHandlerUsersChangeEmailVerification, CmdHandlerUsersInfo, CmdHandlerUserSkills, CmdHandlerUsersRegistration, CmdHandlerUsersRegistrationVerification, CmdHandlerUsersScoreboard, CmdHandlerUsersTokens, CmdHandlerUsersTokensDelete, CmdHandlerUserUpdate, and WJSCppCmdHandlerServerApi.

Public Member Functions

 CmdHandlerBase (const std::string &sCmd, const std::string &sDescription)
 
virtual std::string cmd ()
 
virtual std::string description ()
 
std::string activatedFromVersion ()
 
std::string deprecatedFromVersion ()
 
bool accessUnauthorized ()
 
bool accessUser ()
 
bool accessAdmin ()
 
bool checkAccess (ModelRequest *pRequest)
 
virtual const std::vector< CmdInputDef > & inputs ()
 
virtual void handle (ModelRequest *pRequest)=0
 

Protected Member Functions

void setAccessUnauthorized (bool bAccess)
 
void setAccessUser (bool bAccess)
 
void setAccessAdmin (bool bAccess)
 
void setActivatedFromVersion (const std::string &sActivatedFromVersion)
 
void setDeprecatedFromVersion (const std::string &sDeprecatedFromVersion)
 
CmdInputDef & requireStringParam (const std::string &sName, const std::string &sDescription)
 
CmdInputDef & optionalStringParam (const std::string &sName, const std::string &sDescription)
 
CmdInputDef & requireIntegerParam (const std::string &sName, const std::string &sDescription)
 
CmdInputDef & optionalIntegerParam (const std::string &sName, const std::string &sDescription)
 
CmdInputDef & requireBooleanParam (const std::string &sName, const std::string &sDescription)
 
CmdInputDef & optionalBooleanParam (const std::string &sName, const std::string &sDescription)
 

Protected Attributes

std::string TAG
 
std::string m_sCmd
 
std::string m_sDescription
 

Private Attributes

std::vector< CmdInputDef > m_vInputs
 
std::string m_sActivatedFromVersion
 
std::string m_sDeprecatedFromVersion
 
bool m_bAccessUnauthorized
 
bool m_bAccessUser
 
bool m_bAccessAdmin
 

Detailed Description

Api handler Base.

Constructor & Destructor Documentation

◆ CmdHandlerBase()

CmdHandlerBase::CmdHandlerBase ( const std::string &  sCmd,
const std::string &  sDescription 
)

Member Function Documentation

◆ accessAdmin()

bool CmdHandlerBase::accessAdmin ( )

◆ accessUnauthorized()

bool CmdHandlerBase::accessUnauthorized ( )

◆ accessUser()

bool CmdHandlerBase::accessUser ( )

◆ activatedFromVersion()

std::string CmdHandlerBase::activatedFromVersion ( )

◆ checkAccess()

bool CmdHandlerBase::checkAccess ( ModelRequest *  pRequest)

◆ cmd()

std::string CmdHandlerBase::cmd ( )
virtual

◆ deprecatedFromVersion()

std::string CmdHandlerBase::deprecatedFromVersion ( )

◆ description()

std::string CmdHandlerBase::description ( )
virtual

◆ handle()

virtual void CmdHandlerBase::handle ( ModelRequest *  pRequest)
pure virtual

Implemented in WJSCppCmdHandlerServerApi, CmdHandlerUsersTokensDelete, CmdHandlerUsersTokens, CmdClassbookHandler, CmdHandlerUsersChangeEmailVerification, CmdClassbookProposalUpdateHandler, CmdHandlerUsersChangeEmail, CmdClassbookProposalApproveHandler, CmdHandlerUsersRegistrationVerification, CmdClassbookProposalPrepareMergeRecordHandler, CmdHandlerUsersRegistration, CmdClassbookProposalListHandler, CmdHandlerQuestsFilesUpload, CmdHandlerUsers, CmdHandlerQuestsProposalList, CmdClassbookProposalInfoHandler, CmdHandlerUserDelete, CmdHandlerHints, CmdClassbookProposalDeleteRecordHandler, CmdHandlerUserUpdate, CmdHandlerDeleteHint, CmdHandlerUsefulLinksUserProposeApprove, CmdClassbookProposalAddRecordHandler, CmdHandlerUserSkills, CmdHandlerLXDStartService, CmdHandlerUsefulLinksUserPropose, CmdHandlerAnswerList, CmdHandlerUserResetPassword, CmdHandlerUsefulLinksTagDelete, CmdHandlerLXDImportServiceFromZip, CmdHandlerAddHint, CmdClassbookLocalizationUpdateRecordHandler, CmdHandlerUsefulLinksTagAdd, CmdHandlerUsersInfo, CmdHandlerLXDImportService, CmdHandlerQuestsSubjects, CmdHandlerUsefulLinksTagList, CmdHandlerUser, CmdClassbookLocalizationInfoHandler, CmdHandlerGames, CmdHandlerUsefulLinksCommentDelete, CmdHandlerQuestUpdate, CmdHandlerLXDOpenPort, CmdHandlerUsersAdd, CmdClassbookLocalizationDeleteRecordHandler, CmdHandlerUsefulLinksCommentAdd, CmdHandlerGameUpdateLogo, CmdHandlerQuestStatistics, CmdHandlerUsefulLinksCommentList, CmdHandlerUserChangePassword, CmdHandlerChatCreateGroupChat, CmdClassbookLocalizationAddRecordHandler, CmdHandlerChatDeleteFromBlackList, CmdHandlerLXDFile, CmdHandlerGameUpdate, CmdHandlerUsefulLinksClicked, CmdHandlerQuestProposal, CmdHandlerUpdateUserLocation, CmdHandlerChatAddToBlackList, CmdClassbookUpdateRecordHandler, CmdHandlerChatChangeOwner, CmdHandlerUsefulLinksUserUnfavorite, CmdHandlerLeaksBuy, CmdHandlerGameInfo, CmdHandlerLXDExec, CmdHandlerQuestDelete, CmdHandlerToken, CmdClassbookListHandler, CmdHandlerChatDeleteFromChat, CmdHandlerUsefulLinksUserFavorite, CmdHandlerChatAddToChat, CmdHandlerServerSettingsUpdate, CmdHandlerLeaksDelete, CmdHandlerGameImport, CmdHandlerCreateQuest, CmdClassbookInfoHandler, CmdHandlerLXDList, CmdHandlerRegistration, CmdHandlerChatDeleteMessage, CmdHandlerUsefulLinksUserFavoriteList, CmdHandlerEventsList, CmdHandlerChatEditMessage, CmdHandlerQuestsWriteUpsDelete, CmdHandlerServerSettings, CmdHandlerLeaksUpdate, CmdHandlerMailsList, CmdHandlerUsefulLinksUpdate, CmdHandlerGameExport, CmdHandlerQuestPass, CmdHandlerLogin, CmdHandlerChatShowDialogs, CmdHandlerLXDInfo, CmdClassbookExportHandler, CmdHandlerEventInfo, CmdHandlerQuestsWriteUpsUpdate, CmdHandlerChatReadMessage, CmdHandlerUsefulLinksDelete, CmdHandlerServerInfo, CmdHandlerGameDelete, CmdHandlerLeaksAdd, CmdHandlerMailSend, CmdHandlerGetMap, CmdHandlerChatLastestMessages, CmdHandlerQuest, CmdHandlerUsefulLinksAdd, CmdClassbookDeleteRecordHandler, CmdHandlerEventDelete, CmdHandlerQuestsWriteUpsProposal, CmdHandlerChatSendMessage_new, CmdHandlerUsefulLinksRetrieve, CmdHandlerLXDContainers, CmdHandlerGameCreate, CmdHandlerLeaksList, CmdHandlerMailInfo, CmdHandlerPublicInfo, CmdHandlerUsersScoreboard, CmdClassbookAddRecordHandler, CmdHandlerChatSendMessage, CmdHandlerQuests, CmdHandlerFeedbackAdd, CmdHandlerUsefulLinksList, CmdHandlerEventAdd, and CmdHandlerQuestsWriteUpsList.

◆ inputs()

const std::vector< CmdInputDef > & CmdHandlerBase::inputs ( )
virtual

◆ optionalBooleanParam()

CmdInputDef & CmdHandlerBase::optionalBooleanParam ( const std::string &  sName,
const std::string &  sDescription 
)
protected

◆ optionalIntegerParam()

CmdInputDef & CmdHandlerBase::optionalIntegerParam ( const std::string &  sName,
const std::string &  sDescription 
)
protected

◆ optionalStringParam()

CmdInputDef & CmdHandlerBase::optionalStringParam ( const std::string &  sName,
const std::string &  sDescription 
)
protected

◆ requireBooleanParam()

CmdInputDef & CmdHandlerBase::requireBooleanParam ( const std::string &  sName,
const std::string &  sDescription 
)
protected

◆ requireIntegerParam()

CmdInputDef & CmdHandlerBase::requireIntegerParam ( const std::string &  sName,
const std::string &  sDescription 
)
protected

◆ requireStringParam()

CmdInputDef & CmdHandlerBase::requireStringParam ( const std::string &  sName,
const std::string &  sDescription 
)
protected

◆ setAccessAdmin()

void CmdHandlerBase::setAccessAdmin ( bool  bAccess)
protected

◆ setAccessUnauthorized()

void CmdHandlerBase::setAccessUnauthorized ( bool  bAccess)
protected

◆ setAccessUser()

void CmdHandlerBase::setAccessUser ( bool  bAccess)
protected

◆ setActivatedFromVersion()

void CmdHandlerBase::setActivatedFromVersion ( const std::string &  sActivatedFromVersion)
protected

◆ setDeprecatedFromVersion()

void CmdHandlerBase::setDeprecatedFromVersion ( const std::string &  sDeprecatedFromVersion)
protected

Member Data Documentation

◆ m_bAccessAdmin

bool CmdHandlerBase::m_bAccessAdmin
private

◆ m_bAccessUnauthorized

bool CmdHandlerBase::m_bAccessUnauthorized
private

◆ m_bAccessUser

bool CmdHandlerBase::m_bAccessUser
private

◆ m_sActivatedFromVersion

std::string CmdHandlerBase::m_sActivatedFromVersion
private

◆ m_sCmd

std::string CmdHandlerBase::m_sCmd
protected

◆ m_sDeprecatedFromVersion

std::string CmdHandlerBase::m_sDeprecatedFromVersion
private

◆ m_sDescription

std::string CmdHandlerBase::m_sDescription
protected

◆ m_vInputs

std::vector<CmdInputDef> CmdHandlerBase::m_vInputs
private

◆ TAG

std::string CmdHandlerBase::TAG
protected
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13