src/engine/eVoter.cpp File Reference

#include "rSDL.h"
#include "eVoter.h"
#include "tMemManager.h"
#include "tSysTime.h"
#include "tDirectories.h"
#include "uMenu.h"
#include "nConfig.h"
#include "nServerInfo.h"
#include "rConsole.h"
#include "ePlayer.h"
#include "eGrid.h"

Include dependency graph for eVoter.cpp:

Go to the source code of this file.

Classes
class	eVoteItem
class	eMenuItemVote
class	eVoteItemServerControlled
class	nMachineObserver
class	eVoteItemHarm
class	eVoteItemKick
class	eVoteItemHarmServerControlled
class	eVoteItemSuspend
class	eVoteItemKickServerControlled
class	eMenuItemKick
Enumerations
enum	Vote { Vote_Approve, Vote_Reject, Vote_DontMind }
Functions
static eVoter *	se_GetVoter (const nMessage &m)
static tAccessLevel	se_GetAccessLevel (int userID)
void	se_CancelAllVotes (std::istream &)
static void	se_HandleServerVoteChanged (nMessage &m)
static void	se_HandleNewServerVote (nMessage &m)
void	se_VoteKickUser (int user)
void	se_VoteKickPlayer (ePlayerNetID *p)
static void	se_HandleKickVote (nMessage &m)
static void	se_SendKick (ePlayerNetID *p)
static bool	se_KeepConsoleSmall ()
static void	se_Cleanup ()
Variables
static bool	se_useServerControlledKick = false
static nSettingItem< bool >	se_usc ("VOTE_USE_SERVER_CONTROLLED_KICK", se_useServerControlledKick)
static unsigned short	se_votingItemID = 0
static float	se_votingTimeout = 300.0f
static nSettingItem< float >	se_vt ("VOTING_TIMEOUT", se_votingTimeout)
static float	se_votingTimeoutPerVoter = 0.0f
static nSettingItem< float >	se_vtp ("VOTING_TIMEOUT_PER_VOTER", se_votingTimeoutPerVoter)
static float	se_votingStartDecay = 60.0f
static nSettingItem< float >	se_vsd ("VOTING_START_DECAY", se_votingStartDecay)
static float	se_votingDecay = 60.0f
static nSettingItem< float >	se_vd ("VOTING_DECAY", se_votingDecay)
static float	se_votingSpamIssue = 1.0f
static nSettingItem< float >	se_vsi ("VOTING_SPAM_ISSUE", se_votingSpamIssue)
static float	se_votingSpamReject = 5.0f
static nSettingItem< float >	se_vsr ("VOTING_SPAM_REJECT", se_votingSpamReject)
static bool	se_allowVoting = false
static tSettingItem< bool >	se_av ("ALLOW_VOTING", se_allowVoting)
static bool	se_allowVotingSpectator = false
static tSettingItem< bool >	se_avo ("ALLOW_VOTING_SPECTATOR", se_allowVotingSpectator)
static int	se_suspendRounds = 5
static tSettingItem< int >	se_sr ("VOTING_SUSPEND_ROUNDS", se_suspendRounds)
static int	se_minVoters = 3
static tSettingItem< int >	se_mv ("MIN_VOTERS", se_minVoters)
static int	se_votingBias = 0
static tSettingItem< int >	se_vb ("VOTING_BIAS", se_votingBias)
static int	se_votingBiasKick = 0
static tSettingItem< int >	se_vbKick ("VOTING_BIAS_KICK", se_votingBiasKick)
static int	se_votingBiasSuspend = 0
static tSettingItem< int >	se_vbSuspend ("VOTING_BIAS_SUSPEND", se_votingBiasSuspend)
static int	se_votingBiasInclude = 0
static tSettingItem< int >	se_vbInclude ("VOTING_BIAS_INCLUDE", se_votingBiasInclude)
static int	se_votingBiasCommand = 0
static tSettingItem< int >	se_vbCommand ("VOTING_BIAS_COMMAND", se_votingBiasCommand)
static int	se_votingPrivacy = 1
static tSettingItem< int >	se_vp ("VOTING_PRIVACY", se_votingPrivacy)
static int	se_maxVotes = 5
static tSettingItem< int >	se_maxVotesSI ("MAX_VOTES", se_maxVotes)
static int	se_maxVotesPerVoter = 2
static tSettingItem< int >	se_maxVotesPerVoterSI ("MAX_VOTES_PER_VOTER", se_maxVotesPerVoter)
static int	se_minTimeBetweenKicks = 300
static tSettingItem< int >	se_minTimeBetweenKicksSI ("VOTING_KICK_TIME", se_minTimeBetweenKicks)
static int	se_minTimeBetweenHarms = 180
static tSettingItem< int >	se_minTimeBetweenHarmsSI ("VOTING_HARM_TIME", se_minTimeBetweenHarms)
static int	se_votingMaturity = 300
static tSettingItem< int >	se_votingMaturitySI ("VOTING_MATURITY", se_votingMaturity)
static tConfItemFunc	se_cancelAllVotes_conf ("VOTES_CANCEL",&se_CancelAllVotes)
static nDescriptor	vote_handler (230, eVoteItem::GetControlMessage,"vote cast")
static nDescriptor	server_vote_expired_handler (233, se_HandleServerVoteChanged,"Server controlled vote expired")
static nDescriptor	new_server_vote_handler (232, se_HandleNewServerVote,"Server controlled vote")
static tString	se_voteKickToServer ("")
static int	se_voteKickToPort = 4534
static tSettingItem< tString >	se_voteKickToServerConf ("VOTE_KICK_TO_SERVER", se_voteKickToServer)
static tSettingItem< int >	se_voteKickToPortConf ("VOTE_KICK_TO_PORT", se_voteKickToPort)
static int	se_kickMinHarm = 0
static tSettingItem< int >	se_kickMinHarmSI ("VOTING_KICK_MINHARM", se_kickMinHarm)
static tString	se_voteKickReason ("")
static tConfItemLine	se_voteKickReasonConf ("VOTE_KICK_REASON", se_voteKickReason)
static nDescriptor	kill_vote_handler (231, se_HandleKickVote,"Kick vote")
static nSpamProtectionSettings	se_voteSpamProtection (50.0f,"SPAM_PROTECTION_VOTE", tOutput("$vote_spam_protection"))
static uMenu *	votingMenu = 0
static nCallbackLoginLogout	se_cleanup (se_Cleanup)

---

Enumeration Type Documentation

enum Vote

Enumerator:

Vote_Approve
Vote_Reject
Vote_DontMind

Definition at line 709 of file eVoter.cpp.

{
    Vote_Approve,
    Vote_Reject,
    Vote_DontMind
};

---

Function Documentation

void se_CancelAllVotes

(

std::istream &

)

Definition at line 669 of file eVoter.cpp.

References eVoteItem::GetItems(), GrowingArrayBase::Len(), nCLIENT, sn_ConsoleOut(), and sn_GetNetState().

{
    if ( sn_GetNetState() == nCLIENT )
    {
        return;
    }

    sn_ConsoleOut( tOutput( "$vote_cancel_all" ) );

    tList< eVoteItem > const & items = eVoteItem::GetItems();
    
    while ( items.Len() )
    {
        delete items(0);
    }
}

Here is the call graph for this function:

static void se_Cleanup

(

)

[static]

Definition at line 1915 of file eVoter.cpp.

References eVoteItem::CreateMessage(), eGrid::CurrentGrid(), uMenu::Exit(), eVoteItem::GetItems(), GrowingArrayBase::Len(), nCallbackLoginLogout::Login(), nMessage::Send(), nCallbackLoginLogout::User(), and votingMenu.

{
    if ( nCallbackLoginLogout::User() == 0 )
    {
        if ( votingMenu )
        {
            votingMenu->Exit();
        }

        if ( !nCallbackLoginLogout::Login() && eGrid::CurrentGrid() )
        {
            //                  uMenu::exitToMain = true;
        }

        // client login/logout: delete voting items
        const tList< eVoteItem >& list = eVoteItem::GetItems();
        while ( list.Len() > 0 )
        {
            delete list(0);
        }
    }
    else if ( nCallbackLoginLogout::Login() )
    {
        // new user: send pending voting items
        const tList< eVoteItem >& list = eVoteItem::GetItems();
        for ( int i = list.Len()-1; i >= 0; -- i)
        {
            eVoteItem* vote = list( i );
            nMessage* m = vote->CreateMessage();
            m->Send( nCallbackLoginLogout::User() );
        }
    }
}

Here is the call graph for this function:

static tAccessLevel se_GetAccessLevel

(

int

userID

)

[static]

Definition at line 166 of file eVoter.cpp.

References eAccessLevelHolder::GetAccessLevel(), GrowingArrayBase::Len(), nNetObject::Owner(), se_PlayerNetIDs, and tAccessLevel_Default.

Referenced by eVoteItem::CheckValid().

{
    tAccessLevel ret = tAccessLevel_Default;

    // scan players of given user ID
    for ( int i = se_PlayerNetIDs.Len()-1; i>=0; --i )
    {
        ePlayerNetID* p = se_PlayerNetIDs(i);
        
        if ( p->Owner() == userID )
        {
            if( p->GetAccessLevel() < ret )
            {
                ret = p->GetAccessLevel();
            }
        }
    }
    
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static eVoter* se_GetVoter

(

const nMessage &

m

)

[static]

Definition at line 159 of file eVoter.cpp.

References eVoter::GetVoter(), and nMessage::SenderID().

Referenced by eVoteItem::AcceptNewVote(), and eVoteItem::GetControlMessage().

{
    return eVoter::GetVoter( m.SenderID(), true );
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void se_HandleKickVote

(

nMessage &

m

)

[static]

Definition at line 1386 of file eVoter.cpp.

References eVoteItem::AcceptNewVote(), eVoteItem::FillFromMessage(), and tNEW.

{
    // accept message
    if ( eVoteItem::AcceptNewVote( m ) )
    {
        eVoteItemHarm* item = tNEW( eVoteItemKickServerControlled )( true, 0 );
        if ( !item->FillFromMessage( m ) )
        {
            delete item;
            return;
        }
    }
}

Here is the call graph for this function:

static void se_HandleNewServerVote

(

nMessage &

m

)

[static]

Definition at line 896 of file eVoter.cpp.

References eVoteItem::AcceptNewVote(), eVoteItem::FillFromMessage(), nCLIENT, sn_GetNetState(), and tNEW.

{
    if ( sn_GetNetState() != nCLIENT ||  eVoteItem::AcceptNewVote( m ) )
    {
        // accept message
        eVoteItem* item = tNEW( eVoteItemServerControlled )();
        if ( !item->FillFromMessage( m ) )
            delete item;
    }
}

Here is the call graph for this function:

static void se_HandleServerVoteChanged

(

nMessage &

m

)

[static]

Definition at line 891 of file eVoter.cpp.

References eVoteItemServerControlled::s_HandleChanged().

{
    eVoteItemServerControlled::s_HandleChanged( m );
}

Here is the call graph for this function:

static bool se_KeepConsoleSmall

(

)

[static]

Definition at line 1778 of file eVoter.cpp.

Referenced by eVoter::VotingMenu().

{
    return true;
}

Here is the caller graph for this function:

static void se_SendKick

(

ePlayerNetID *

p

)

[static]

Definition at line 1408 of file eVoter.cpp.

References eVoteItem::SendMessage().

Referenced by eMenuItemKick::Enter().

{
    eVoteItemKick kick( p );
    kick.SendMessage();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void se_VoteKickPlayer

(

ePlayerNetID *

p

)

Definition at line 981 of file eVoter.cpp.

References nNetObject::Owner(), and se_VoteKickUser().

Referenced by eVoteItemKick::DoExecute(), and eMenuItemKick::Enter().

{
    if ( !p )
    {
        return;
    }

    se_VoteKickUser( p->Owner() );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void se_VoteKickUser

(

int

user

)

Definition at line 952 of file eVoter.cpp.

References tString::Len(), se_voteKickReason, se_voteKickToPort, se_voteKickToServer, and sn_KickUser().

Referenced by eVoteItemKick::DoExecute(), and se_VoteKickPlayer().

{
    if ( user == 0 )
    {
        return;
    }

    tString reason;
    if ( se_voteKickReason.Len() >= 2 )
    {
        reason = se_voteKickReason;
    }
    else
    {
        reason = tOutput("$voted_kill_kick");
    }

    if ( se_voteKickToServer.Len() < 2 )
    {
        sn_KickUser( user, reason );
    }
    else
    {
        // kick player to default destination
        nServerInfoRedirect redirect( se_voteKickToServer, se_voteKickToPort );
        sn_KickUser( user, reason, 1, &redirect );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Variable Documentation

nDescriptor kill_vote_handler(231, se_HandleKickVote,"Kick vote") [static]

Referenced by eVoteItemHarm::DoGetDescriptor().

nDescriptor new_server_vote_handler(232, se_HandleNewServerVote,"Server controlled vote") [static]

Referenced by eVoteItemServerControlled::DoGetDescriptor().

bool se_allowVoting = false [static]

Definition at line 75 of file eVoter.cpp.

Referenced by eVoteItem::AcceptNewVote().

bool se_allowVotingSpectator = false [static]

Definition at line 78 of file eVoter.cpp.

Referenced by eVoter::GetVoter().

tSettingItem< bool > se_av("ALLOW_VOTING", se_allowVoting) [static]

tSettingItem< bool > se_avo("ALLOW_VOTING_SPECTATOR", se_allowVotingSpectator) [static]

tConfItemFunc se_cancelAllVotes_conf("VOTES_CANCEL",&se_CancelAllVotes) [static]

nCallbackLoginLogout se_cleanup(se_Cleanup) [static]

int se_kickMinHarm = 0 [static]

Definition at line 945 of file eVoter.cpp.

Referenced by eVoteItemKickServerControlled::DoCheckValid().

tSettingItem< int > se_kickMinHarmSI("VOTING_KICK_MINHARM", se_kickMinHarm) [static]

int se_maxVotes = 5 [static]

Definition at line 113 of file eVoter.cpp.

Referenced by eVoteItem::AcceptNewVote().

int se_maxVotesPerVoter = 2 [static]

Definition at line 117 of file eVoter.cpp.

Referenced by eVoteItem::AcceptNewVote().

tSettingItem< int > se_maxVotesPerVoterSI("MAX_VOTES_PER_VOTER", se_maxVotesPerVoter) [static]

tSettingItem< int > se_maxVotesSI("MAX_VOTES", se_maxVotes) [static]

int se_minTimeBetweenHarms = 180 [static]

Definition at line 125 of file eVoter.cpp.

Referenced by eVoteItemHarm::DoCheckValid().

tSettingItem< int > se_minTimeBetweenHarmsSI("VOTING_HARM_TIME", se_minTimeBetweenHarms) [static]

int se_minTimeBetweenKicks = 300 [static]

Definition at line 121 of file eVoter.cpp.

Referenced by eVoter::AllowNameChange(), and eVoteItemKick::DoCheckValid().

tSettingItem< int > se_minTimeBetweenKicksSI("VOTING_KICK_TIME", se_minTimeBetweenKicks) [static]

int se_minVoters = 3 [static]

Definition at line 85 of file eVoter.cpp.

Referenced by eVoteItem::AcceptNewVote().

tSettingItem< int > se_mv("MIN_VOTERS", se_minVoters) [static]

tSettingItem< int > se_sr("VOTING_SUSPEND_ROUNDS", se_suspendRounds) [static]

int se_suspendRounds = 5 [static]

Definition at line 82 of file eVoter.cpp.

Referenced by eVoteItemSuspend::DoExecute().

nSettingItem< bool > se_usc("VOTE_USE_SERVER_CONTROLLED_KICK", se_useServerControlledKick) [static]

bool se_useServerControlledKick = false [static]

Definition at line 48 of file eVoter.cpp.

tSettingItem< int > se_vb("VOTING_BIAS", se_votingBias) [static]

tSettingItem< int > se_vbCommand("VOTING_BIAS_COMMAND", se_votingBiasCommand) [static]

tSettingItem< int > se_vbInclude("VOTING_BIAS_INCLUDE", se_votingBiasInclude) [static]

tSettingItem< int > se_vbKick("VOTING_BIAS_KICK", se_votingBiasKick) [static]

tSettingItem< int > se_vbSuspend("VOTING_BIAS_SUSPEND", se_votingBiasSuspend) [static]

nSettingItem< float > se_vd("VOTING_DECAY", se_votingDecay) [static]

tString se_voteKickReason("") [static]

Referenced by se_VoteKickUser().

tConfItemLine se_voteKickReasonConf("VOTE_KICK_REASON", se_voteKickReason) [static]

int se_voteKickToPort = 4534 [static]

Definition at line 938 of file eVoter.cpp.

Referenced by se_VoteKickUser().

tSettingItem< int > se_voteKickToPortConf("VOTE_KICK_TO_PORT", se_voteKickToPort) [static]

tString se_voteKickToServer("") [static]

Referenced by se_VoteKickUser().

tSettingItem< tString > se_voteKickToServerConf("VOTE_KICK_TO_SERVER", se_voteKickToServer) [static]

nSpamProtectionSettings se_voteSpamProtection(50.0f,"SPAM_PROTECTION_VOTE", tOutput("$vote_spam_protection")) [static]

int se_votingBias = 0 [static]

Definition at line 89 of file eVoter.cpp.

Referenced by eVoteItem::Evaluate().

int se_votingBiasCommand = 0 [static]

Definition at line 105 of file eVoter.cpp.

int se_votingBiasInclude = 0 [static]

Definition at line 101 of file eVoter.cpp.

int se_votingBiasKick = 0 [static]

Definition at line 93 of file eVoter.cpp.

Referenced by eVoteItemKick::DoGetExtraBias().

int se_votingBiasSuspend = 0 [static]

Definition at line 97 of file eVoter.cpp.

Referenced by eVoteItemSuspend::DoGetExtraBias().

float se_votingDecay = 60.0f [static]

Definition at line 64 of file eVoter.cpp.

Referenced by eVoteItem::Evaluate().

unsigned short se_votingItemID = 0 [static]

Definition at line 53 of file eVoter.cpp.

int se_votingMaturity = 300 [static]

Definition at line 129 of file eVoter.cpp.

Referenced by eVoteItemHarm::DoCheckValid().

tSettingItem< int > se_votingMaturitySI("VOTING_MATURITY", se_votingMaturity) [static]

int se_votingPrivacy = 1 [static]

Definition at line 109 of file eVoter.cpp.

Referenced by eVoteItem::AcceptNewVote(), eVoteItem::DoGetDetails(), eVoteItem::FillFromMessage(), eVoteItem::GetControlMessage(), eVoter::HandleChat(), and eVoteItem::ReBroadcast().

float se_votingSpamIssue = 1.0f [static]

Definition at line 68 of file eVoter.cpp.

Referenced by eVoteItem::AcceptNewVote().

float se_votingSpamReject = 5.0f [static]

Definition at line 72 of file eVoter.cpp.

Referenced by eVoteItem::Evaluate().

float se_votingStartDecay = 60.0f [static]

Definition at line 61 of file eVoter.cpp.

Referenced by eVoteItem::Evaluate().

float se_votingTimeout = 300.0f [static]

Definition at line 54 of file eVoter.cpp.

Referenced by eVoteItem::Evaluate().

float se_votingTimeoutPerVoter = 0.0f [static]

Definition at line 58 of file eVoter.cpp.

Referenced by eVoteItem::Evaluate().

tSettingItem< int > se_vp("VOTING_PRIVACY", se_votingPrivacy) [static]

nSettingItem< float > se_vsd("VOTING_START_DECAY", se_votingStartDecay) [static]

nSettingItem< float > se_vsi("VOTING_SPAM_ISSUE", se_votingSpamIssue) [static]

nSettingItem< float > se_vsr("VOTING_SPAM_REJECT", se_votingSpamReject) [static]

nSettingItem< float > se_vt("VOTING_TIMEOUT", se_votingTimeout) [static]

nSettingItem< float > se_vtp("VOTING_TIMEOUT_PER_VOTER", se_votingTimeoutPerVoter) [static]

nDescriptor server_vote_expired_handler(233, se_HandleServerVoteChanged,"Server controlled vote expired") [static]

Referenced by eVoteItemServerControlled::SendChanged().

nDescriptor vote_handler(230, eVoteItem::GetControlMessage,"vote cast") [static]

Referenced by eVoteItem::Vote().

uMenu* votingMenu = 0 [static]

Definition at line 1784 of file eVoter.cpp.

Referenced by se_Cleanup(), and eVoter::VotingMenu().

---