eVoter Class Reference

#include <eVoter.h>

Inheritance diagram for eVoter:

[legend]

Collaboration diagram for eVoter:

[legend]

List of all members.

Public Member Functions
	eVoter (nMachine &machine)
	~eVoter ()
void	PlayerChanged ()
	call when a player changed (logged in or changed name). He'll be blocked from issuing kick votes for a while.
void	Spam (int user, REAL spamLevel, tOutput const &message)
bool	IsSpamming (int user)
void	RemoveFromGame ()
tString	Name (int senderID=-1) const
REAL	Age () const
	how long does this voter exist?
bool	AllowNameChange () const
	determines whether the player belonging to this voter should be allowed to change names
int	HarmCount () const
	returns the number of harmful votes against this player
Static Public Member Functions
static void	KickMenu ()
static void	VotingMenu ()
static eVoter *	GetVoter (int ID, bool complain=false)
static eVoter *	GetVoter (nMachine &machine)
static bool	VotingPossible ()
static void	HandleChat (ePlayerNetID *p, std::istream &message)
	handles player "/vote" command.
Protected Member Functions
virtual void	OnDestroy ()
	called when machine gets destroyed
Private Attributes
nMachine &	machine_
nSpamProtection	votingSpam_
tJUST_CONTROLLED_PTR< eVoter >	selfReference_
	reference to self
int	harmCount_
	counts the number of harmful votes issued against this player
double	lastHarmVote_
	the last time a harmful vote was issued for this player
double	lastKickVote_
	the last time a kick vote was issued for this player
double	lastNameChangePreventor_
	the last time something happened that should prevent the voter from changing names
double	lastChange_
	the last time a player assigned to this voter changed
Static Private Attributes
static tList< eVoter >	voters_
Friends
class	eVoteItem
class	eVoteItemHarm
class	eVoteItemKick

---

Detailed Description

Definition at line 55 of file eVoter.h.

---

Constructor & Destructor Documentation

eVoter::eVoter

(

nMachine &

machine

)

Definition at line 1653 of file eVoter.cpp.

References tSysTimeFloat(), and eVoteItem::voters_.

        : nMachineDecorator( machine ), machine_( machine ), votingSpam_( se_voteSpamProtection )
{
    selfReference_ = this;
    voters_.Add( this );
    harmCount_ = 0;
    lastKickVote_ = -1E+40;
    lastHarmVote_ = -1E+40;
    lastNameChangePreventor_ = -1E+40;
    lastChange_ = tSysTimeFloat();
}

Here is the call graph for this function:

eVoter::~eVoter

(

)

Definition at line 1665 of file eVoter.cpp.

References tList< T, MALLOC, REFERENCE >::Remove(), and voters_.

{
    voters_.Remove( this );
}

Here is the call graph for this function:

---

Member Function Documentation

void eVoter::PlayerChanged

(

void

)

call when a player changed (logged in or changed name). He'll be blocked from issuing kick votes for a while.

Definition at line 2019 of file eVoter.cpp.

References lastChange_, and tSysTimeFloat().

Referenced by ePlayerNetID::CreateVoter().

{
    this->lastChange_ = tSysTimeFloat();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eVoter::Spam	(	int	user,
		REAL	spamLevel,
		tOutput const &	message
	)

Definition at line 1670 of file eVoter.cpp.

References nSpamProtection::CheckSpam(), nSERVER, sn_GetNetState(), and votingSpam_.

Referenced by eVoteItem::AcceptNewVote().

{
    if ( sn_GetNetState() == nSERVER )
        votingSpam_.CheckSpam( spamLevel, user, message );
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool eVoter::IsSpamming

(

int

user

)

Definition at line 1676 of file eVoter.cpp.

References nSpamProtection::CheckSpam(), nSpamProtection::Level_Ok, nSERVER, sn_GetNetState(), and votingSpam_.

Referenced by eVoteItem::AcceptNewVote().

{
    if ( sn_GetNetState() == nSERVER )
    {
        return nSpamProtection::Level_Ok != votingSpam_.CheckSpam( 0.0f, user, tOutput("$spam_vote_kick_issue") );
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eVoter::RemoveFromGame

(

void

)

Definition at line 1733 of file eVoter.cpp.

References eVoteItem::GetItems(), tListItemBase::Len(), tList< T, MALLOC, REFERENCE >::Remove(), tCONTROLLED_PTR, and voters_.

{
    tCONTROLLED_PTR( eVoter ) keeper( this );

    voters_.Remove( this );

    // remove from items
    for ( int i = eVoteItem::GetItems().Len()-1; i>=0; --i )
    {
        eVoteItem::GetItems()( i )->RemoveVoterCompletely( this );
    }
}

Here is the call graph for this function:

void eVoter::KickMenu

(

)

[static]

Definition at line 1746 of file eVoter.cpp.

References uMenu::Enter(), ePlayerNetID::IsHuman(), GrowingArrayBase::Len(), se_PlayerNetIDs, and tNEW.

Referenced by ePlayerNetID::PoliceMenu().

{
    uMenu menu( "$player_police_kick_text" );

    int size = se_PlayerNetIDs.Len();
    eMenuItemKick** items = tNEW( eMenuItemKick* )[ size ];

    int i;
    for ( i = size-1; i>=0; --i )
    {
        ePlayerNetID* player = se_PlayerNetIDs[ i ];
        if ( player->IsHuman() )
        {
            items[i] = tNEW( eMenuItemKick )( &menu, player );
        }
        else
        {
            items[i] = 0;
        }
    }

    menu.Enter();

    for ( i = size - 1; i>=0; --i )
    {
        if( items[i] )
            delete items[i];
    }
    delete[] items;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eVoter::VotingMenu

(

)

[static]

Definition at line 1786 of file eVoter.cpp.

References uMenu::Enter(), eVoteItem::GetItems(), GrowingArrayBase::Len(), se_KeepConsoleSmall(), tNEW, votingMenu, and VotingPossible().

Referenced by MainMenu(), and sg_VoteMenuIdle().

{
    static bool recursion = false;
    if ( ! recursion )
    {

        // expire old items
        if ( !VotingPossible() )
            return;

#ifndef DEDICATED
        rSmallConsoleCallback SmallConsole( se_KeepConsoleSmall );

        // count items
        int size = eVoteItem::GetItems().Len();
        if ( size == 0 )
            return;

        // fill menu
        uMenu menu( "$voting_menu_text" );

        eMenuItemVote** items = tNEW( eMenuItemVote* )[ size ];

        int i;
        for ( i = size-1; i>=0; --i )
        {
            items[i] = tNEW( eMenuItemVote )( &menu, eVoteItem::GetItems()( i ) );
        }

        // enter menu
        recursion = true;
        votingMenu = &menu;
        menu.Enter();
        votingMenu = 0;
        recursion = false;

        for ( i = size - 1; i>=0; --i )
        {
            delete items[i];
        }
        delete[] items;

        // expire old items
        VotingPossible();
#endif
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

eVoter * eVoter::GetVoter	(	int	ID,
		bool	complain = false
	)			[static]

Definition at line 1850 of file eVoter.cpp.

References nMachine::GetMachine(), ePlayerNetID::IsSpectating(), GrowingArrayBase::Len(), NULL, nNetObject::Owner(), se_allowVotingSpectator, se_PlayerNetIDs, and sn_ConsoleOut().

Referenced by eVoteItem::AcceptNewVote(), eVoteItem::CheckValid(), ePlayerNetID::CreateVoter(), eVoteItemKick::DoCheckValid(), eVoteItemHarm::DoCheckValid(), Name(), eVoteItem::ReBroadcast(), and se_GetVoter().

{
    // the server has no voter
#ifdef DEDICATED
    if ( ID == 0 )
        return NULL;
#endif

    // see if there is a real player on the specified ID
    if ( !se_allowVotingSpectator )
    {
        bool player = false;
        for ( int i = se_PlayerNetIDs.Len()-1; i>=0; --i )
        {
            ePlayerNetID* p = se_PlayerNetIDs(i);
            if ( p->Owner() == ID && !p->IsSpectating() )
                player = true;
        }
        if (!player)
        {
            if ( complain )
            {
                tOutput message("$vote_disabled_spectator");
                sn_ConsoleOut( message, ID );
            }
            return NULL;
        }
    }

    // get machine from network subsystem
    nMachine & machine = nMachine::GetMachine( ID );

    return GetVoter( machine );
}

Here is the call graph for this function:

Here is the caller graph for this function:

eVoter * eVoter::GetVoter

(

nMachine &

machine

)

[static]

Definition at line 1885 of file eVoter.cpp.

References tList< T, MALLOC, REFERENCE >::Add(), nMachine::GetDecorators(), lastKickVote_, lastNameChangePreventor_, tListMember::ListID(), tListItem< T >::Next(), tNEW, and voters_.

{
    // iterate through the machine's decorators, find a voter
    nMachineDecorator * run = machine.GetDecorators();
    while ( run )
    {
        eVoter * voter = dynamic_cast< eVoter * >( run );
        if ( voter )
        {
            // reinsert voter into lists
            if ( voter->ListID() < 0 )
            {
                voters_.Add( voter );
                voter->lastKickVote_ = -1E30;
                voter->lastNameChangePreventor_ = -1E30;
            }

            // return result
            return voter;
        }

        run = run->Next();
    }

    // create new voter
    return tNEW(eVoter)( machine );
}

Here is the call graph for this function:

bool eVoter::VotingPossible

(

)

[static]

Definition at line 1834 of file eVoter.cpp.

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

Referenced by MainMenu(), and VotingMenu().

{
    // expire old items
    for ( int i = eVoteItem::GetItems().Len()-1; i>=0; --i )
    {
        eVoteItem::GetItems()( i )->Evaluate();
    }

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

    return eVoteItem::GetItems().Len() > 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eVoter::HandleChat	(	ePlayerNetID *	p,
		std::istream &	message
	)			[static]

handles player "/vote" command.

Parameters:

	p	the player chatting
	message	the rest of the message after "/vote"

Parameters:

message

handles player "/vote" command.

Definition at line 2033 of file eVoter.cpp.

References eVoteItem::AcceptNewVote(), eVoteItem::CheckValid(), ePlayerNetID::FindPlayerByName(), eAccessLevelHolder::GetAccessLevel(), ePlayerNetID::GetVoter(), nNetObject::Owner(), tString::ReadLine(), eVoteItem::ReBroadcast(), se_votingPrivacy, nCurrentSenderID::SetID(), sn_ConsoleOut(), tNEW, tToLower(), and eVoteItem::Update().

{
    // cloak the ID of the sener for privacy
    nCurrentSenderID cloak;
    if ( se_votingPrivacy > 1 )
        cloak.SetID(0);

    if ( !p )
    {
        return;
    }

    // read command part (kick, remove, include)
    tString command;
    message >> command;
    tToLower( command );

    eVoter * voter = p->GetVoter();
    if ( !eVoteItem::AcceptNewVote( voter, p->Owner() ) )
    {
        return;
    }

    eVoteItem * item = 0;

    if ( command == "kick" )
    {
        tString name;
        name.ReadLine( message );
        ePlayerNetID * toKick = ePlayerNetID::FindPlayerByName( name, p );
        if ( toKick )
        {
            // accept message
            item = tNEW( eVoteItemKickServerControlled )( false, toKick );
        }
    }
    else if ( command == "suspend" )
    {
        tString name;
        name.ReadLine( message );
        ePlayerNetID * toSuspend = ePlayerNetID::FindPlayerByName( name, p );
        if ( toSuspend )
        {
            // accept message
            item = tNEW( eVoteItemSuspend )( toSuspend );
        }
    }
#ifdef KRAWALL_SERVER
    else if ( command == "include" )
    {
        tString file;
        file.ReadLine( message );
        {
            // accept message
            item = tNEW( eVoteItemInclude )( file, p->GetAccessLevel() );
        }
    }
    else if ( command == "command" )
    {
        tString console;
        console.ReadLine( message );
        {
            // accept message
            item = tNEW( eVoteItemCommand )( console, p->GetAccessLevel() );
        }
    }
#endif
    else
    {
#ifdef KRAWALL_SERVER
        sn_ConsoleOut( tOutput("$vote_unknown_command", command, "suspend, kick, include, command" ), p->Owner() );
#else
        sn_ConsoleOut( tOutput("$vote_unknown_command", command, "suspend, kick" ), p->Owner() );
#endif
    }

    // nothing created
    if ( !item )
    {
        return;
    }

    // let item check its validity
    if ( !item->CheckValid( p->Owner() ) )
    {
        delete item;
        return;
    }

    // no objection? Broadcast it to everyone.
    item->Update();
    item->ReBroadcast( p->Owner() );
}

Here is the call graph for this function:

tString eVoter::Name

(

int

senderID = -1

)

const

Parameters:

senderID

the ID of the network user ( default: take any )

Returns:

the name of the voter ( all players of that IP )

Definition at line 1988 of file eVoter.cpp.

References nMachine::GetIP(), ePlayerNetID::GetName(), GetVoter(), tString::Len(), GrowingArrayBase::Len(), machine_, nNetObject::Owner(), and se_PlayerNetIDs.

{
    tString name;

    // collect the names of all players associated with this voter
    for ( int i = se_PlayerNetIDs.Len()-1; i>=0; --i )
    {
        ePlayerNetID* p = se_PlayerNetIDs(i);
        if ( eVoter::GetVoter( p->Owner() ) == this && ( senderID < 0 || p->Owner() == senderID ) )
        {
            if ( name.Len() > 1 )
                name << ", ";
            name << p->GetName();
        }
    }

    if ( name.Len() < 2 )
        name = machine_.GetIP();

    return name;
}

Here is the call graph for this function:

REAL eVoter::Age

(

)

const

how long does this voter exist?

Returns:

the last change to players on this voter in seconds

Definition at line 1712 of file eVoter.cpp.

References lastChange_, and tSysTimeFloat().

{
    return tSysTimeFloat() - lastChange_;
}

Here is the call graph for this function:

bool eVoter::AllowNameChange

(

void

)

const

determines whether the player belonging to this voter should be allowed to change names

Returns:

true if the players belonging to this voter should be allowed to rename

Definition at line 1728 of file eVoter.cpp.

References lastNameChangePreventor_, se_minTimeBetweenKicks, and tSysTimeFloat().

{
    return tSysTimeFloat() > this->lastNameChangePreventor_ + se_minTimeBetweenKicks;
}

Here is the call graph for this function:

int eVoter::HarmCount

(

)

const [inline]

returns the number of harmful votes against this player

Definition at line 85 of file eVoter.h.

References harmCount_.

Referenced by eVoteItemKickServerControlled::DoCheckValid().

    {
        return harmCount_;
    }

Here is the caller graph for this function:

void eVoter::OnDestroy

(

void

)

[protected, virtual]

called when machine gets destroyed

Reimplemented from nMachineDecorator.

Definition at line 1695 of file eVoter.cpp.

References selfReference_.

{
    tJUST_CONTROLLED_PTR< eVoter > keepAlive( this );
    selfReference_ = 0;
}

---

Friends And Related Function Documentation

friend class eVoteItem [friend]

Definition at line 57 of file eVoter.h.

friend class eVoteItemHarm [friend]

Definition at line 58 of file eVoter.h.

friend class eVoteItemKick [friend]

Definition at line 59 of file eVoter.h.

---

Member Data Documentation

nMachine& eVoter::machine_ [private]

Definition at line 95 of file eVoter.h.

Referenced by eVoteItemHarm::DoCheckValid(), and Name().

tList< eVoter > eVoter::voters_ [static, private]

Definition at line 96 of file eVoter.h.

Referenced by eVoteItem::AcceptNewVote(), eVoteItem::Evaluate(), eVoteItem::GetStats(), GetVoter(), RemoveFromGame(), and ~eVoter().

nSpamProtection eVoter::votingSpam_ [private]

Definition at line 97 of file eVoter.h.

Referenced by IsSpamming(), and Spam().

tJUST_CONTROLLED_PTR< eVoter > eVoter::selfReference_ [private]

reference to self

Definition at line 98 of file eVoter.h.

Referenced by OnDestroy().

int eVoter::harmCount_ [private]

counts the number of harmful votes issued against this player

Definition at line 99 of file eVoter.h.

Referenced by eVoteItemHarm::DoCheckValid(), and HarmCount().

double eVoter::lastHarmVote_ [private]

the last time a harmful vote was issued for this player

Definition at line 100 of file eVoter.h.

Referenced by eVoteItemHarm::DoCheckValid().

double eVoter::lastKickVote_ [private]

the last time a kick vote was issued for this player

Definition at line 101 of file eVoter.h.

Referenced by eVoteItemKick::DoCheckValid(), and GetVoter().

double eVoter::lastNameChangePreventor_ [private]

the last time something happened that should prevent the voter from changing names

Definition at line 102 of file eVoter.h.

Referenced by AllowNameChange(), eVoteItemKick::DoCheckValid(), eVoteItemHarm::DoCheckValid(), and GetVoter().

double eVoter::lastChange_ [private]

the last time a player assigned to this voter changed

Definition at line 103 of file eVoter.h.

Referenced by Age(), eVoteItemHarm::DoCheckValid(), and PlayerChanged().

---

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

• src/engine/eVoter.h
• src/engine/eVoter.cpp

---