Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » 1_1_stable » src » modules

m_svshold.cpp

Go to the documentation of this file.

/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
 * See: http://www.inspircd.org/wiki/index.php/Credits
 *
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

#include "inspircd.h"
#include <algorithm>
#include "users.h"
#include "channels.h"
#include "modules.h"
#include "configreader.h"

/* $ModDesc: Implements SVSHOLD. Like Q:Lines, but can only be added/removed by Services. */

class SVSHold : public classbase
{
public:
        std::string nickname;
        std::string set_by;
        time_t set_on;
        long length;
        std::string reason;

        SVSHold()
        {
        }

        SVSHold(const std::string &nn, const std::string &sb, const time_t so, const long ln, const std::string &rs) : nickname(nn), set_by(sb), set_on(so), length(ln), reason(rs)
        {
        }
};


bool SVSHoldComp(const SVSHold* ban1, const SVSHold* ban2);

typedef std::vector<SVSHold*> SVSHoldlist;
typedef std::map<irc::string, SVSHold*> SVSHoldMap;

/* SVSHolds is declared here, as our type is right above. Don't try move it. */
SVSHoldlist SVSHolds;
SVSHoldMap HoldMap;

class cmd_svshold : public command_t
{
 public:
        cmd_svshold(InspIRCd* Me) : command_t(Me, "SVSHOLD", 'o', 1)
        {
                this->source = "m_svshold.so";
                this->syntax = "<nickname> [<duration> :<reason>]";
        }

        CmdResult Handle(const char** parameters, int pcnt, userrec *user)
        {
                /* syntax: svshold nickname time :reason goes here */
                /* 'time' is a human-readable timestring, like 2d3h2s. */

                if (!ServerInstance->ULine(user->server))
                {
                        /* don't allow SVSHOLD from non-ulined clients */
                        return CMD_FAILURE;
                }

                if (pcnt == 1)
                {
                        SVSHoldMap::iterator n = HoldMap.find(parameters[0]);
                        if (n != HoldMap.end())
                        {
                                /* form: svshold nickname removes a hold. */
                                for (SVSHoldlist::iterator iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
                                {
                                        if (parameters[0] == assign((*iter)->nickname))
                                        {
                                                unsigned long remaining = 0;
                                                if ((*iter)->length)
                                                {
                                                        remaining = ((*iter)->set_on + (*iter)->length) - ServerInstance->Time();
                                                        user->WriteServ( "386 %s %s :Removed SVSHOLD with %lu seconds left before expiry (%s)", user->nick, (*iter)->nickname.c_str(), remaining, (*iter)->reason.c_str());
                                                }
                                                else
                                                {
                                                        user->WriteServ( "386 %s %s :Removed permanent SVSHOLD (%s)", user->nick, (*iter)->nickname.c_str(), (*iter)->reason.c_str());
                                                }
                                                SVSHolds.erase(iter);
                                                break;
                                        }
                                }

                                HoldMap.erase(n);
                                delete n->second;
                        }
                }
                else if (pcnt >= 2)
                {
                        /* full form to add a SVSHold */
                        if (ServerInstance->IsNick(parameters[0]))
                        {
                                // parameters[0] = w00t
                                // parameters[1] = 1h3m2s
                                // parameters[2] = Registered nickname
                                
                                /* Already exists? */
                                if (HoldMap.find(parameters[0]) != HoldMap.end())
                                {
                                        user->WriteServ( "385 %s %s :SVSHOLD already exists", user->nick, parameters[0]);
                                        return CMD_FAILURE;
                                }

                                long length = ServerInstance->Duration(parameters[1]);
                                std::string reason = (pcnt > 2) ? parameters[2] : "No reason supplied";
                                
                                SVSHold* S = new SVSHold(parameters[0], user->nick, ServerInstance->Time(), length, reason);
                                SVSHolds.push_back(S);
                                HoldMap[parameters[0]] = S;

                                std::sort(SVSHolds.begin(), SVSHolds.end(), SVSHoldComp);

                                if(length > 0)
                                {
                                        user->WriteServ( "385 %s %s :Added %lu second SVSHOLD (%s)", user->nick, parameters[0], length, reason.c_str());
                                }
                                else
                                {
                                        user->WriteServ( "385 %s %s :Added permanent SVSHOLD on %s (%s)", user->nick, parameters[0], parameters[0], reason.c_str());
                                }
                        }
                        else
                        {
                                /* as this is primarily a Services command, do not provide an error */
                                return CMD_FAILURE;
                        }
                }

                return CMD_SUCCESS;
        }
};

bool SVSHoldComp(const SVSHold* ban1, const SVSHold* ban2)
{
        return ((ban1->set_on + ban1->length) < (ban2->set_on + ban2->length));
}

class ModuleSVSHold : public Module
{
        cmd_svshold *mycommand;
        

 public:
        ModuleSVSHold(InspIRCd* Me) : Module(Me)
        {
                mycommand = new cmd_svshold(Me);
                ServerInstance->AddCommand(mycommand);
        }

        void Implements(char* List)
        {
                List[I_OnUserPreNick] = List[I_OnSyncOtherMetaData] = List[I_OnDecodeMetaData] = List[I_OnStats] = 1;
        }
        
        virtual int OnStats(char symbol, userrec* user, string_list &results)
        {
                ExpireBans();
        
                if(symbol == 'S')
                {
                        for(SVSHoldlist::iterator iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
                        {
                                unsigned long remaining = ((*iter)->set_on + (*iter)->length) - ServerInstance->Time();
                                results.push_back(std::string(ServerInstance->Config->ServerName)+" 210 "+user->nick+" "+(*iter)->nickname.c_str()+" "+(*iter)->set_by+" "+ConvToStr((*iter)->set_on)+" "+ConvToStr((*iter)->length)+" "+ConvToStr(remaining)+" :"+(*iter)->reason);
                        }
                }
                
                return 0;
        }

        virtual int OnUserPreNick(userrec *user, const std::string &newnick)
        {
                ExpireBans();
        
                /* check SVSHolds in here, and apply as necessary. */
                SVSHoldMap::iterator n = HoldMap.find(assign(newnick));
                if (n != HoldMap.end())
                {
                        user->WriteServ( "432 %s %s :Reserved nickname: %s", user->nick, newnick.c_str(), n->second->reason.c_str());
                        return 1;
                }
                return 0;
        }
        
        virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable)
        {
                for(SVSHoldMap::iterator iter = HoldMap.begin(); iter != HoldMap.end(); iter++)
                {
                        proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "SVSHold", EncodeSVSHold(iter->second));
                }
        }

        virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
        {
                if((target_type == TYPE_OTHER) && (extname == "SVSHold"))
                {
                        SVSHold* S = DecodeSVSHold(extdata); /* NOTE: Allocates a new SVSHold* */
                        if (HoldMap.find(assign(S->nickname)) == HoldMap.end())
                        {
                                SVSHolds.push_back(S);
                                HoldMap[assign(S->nickname)] = S;
                                std::sort(SVSHolds.begin(), SVSHolds.end(), SVSHoldComp);
                        }
                        else
                        {
                                delete S;
                        }
                }
        }

        virtual ~ModuleSVSHold()
        {
        }
        
        virtual Version GetVersion()
        {
                return Version(1, 1, 0, 1, VF_COMMON | VF_VENDOR, API_VERSION);
        }

        std::string EncodeSVSHold(const SVSHold* ban)
        {
                std::ostringstream stream;      
                stream << ban->nickname << " " << ban->set_by << " " << ban->set_on << " " << ban->length << " :" << ban->reason;
                return stream.str();    
        }

        SVSHold* DecodeSVSHold(const std::string &data)
        {
                SVSHold* res = new SVSHold();
                int set_on;
                irc::tokenstream tokens(data);
                tokens.GetToken(res->nickname);
                tokens.GetToken(res->set_by);
                tokens.GetToken(set_on);
                res->set_on = set_on;
                tokens.GetToken(res->length);
                tokens.GetToken(res->reason);
                return res;
        }

        void ExpireBans()
        {
                SVSHoldlist::iterator iter,safeiter;
                for (iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
                {
                        /* 0 == permanent, don't mess with them! -- w00t */
                        if ((*iter)->length != 0)
                        {
                                if ((*iter)->set_on + (*iter)->length <= ServerInstance->Time())
                                {
                                        ServerInstance->Log(DEBUG, "m_svshold.so: hold on %s expired, removing...", (*iter)->nickname.c_str());
                                        HoldMap.erase(assign((*iter)->nickname));
                                        delete *iter;
                                        safeiter = iter;
                                        --iter;
                                        SVSHolds.erase(safeiter);
                                }
                        }
                }
        }
};

MODULE_INIT(ModuleSVSHold)