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

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

m_shun.cpp

Go to the documentation of this file.

#include "inspircd.h"
#include "xline.h"

/* $ModDesc: Provides the /shun command, which stops a user executing all commands except PING and PONG. */

class Shun : public XLine
{
public:
        std::string matchtext;

        Shun(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char *shunmask) : XLine(Instance, s_time, d, src, re, "SHUN")
        {
                this->matchtext = shunmask;
        }

        ~Shun()
        {
        }

        bool Matches(User *u)
        {
                if (InspIRCd::Match(u->GetFullHost(), matchtext) || InspIRCd::Match(u->GetFullRealHost(), matchtext))
                        return true;

                return false;
        }

        bool Matches(const std::string &s)
        {
                if (matchtext == s)
                        return true;
                return false;
        }

        void Apply(User *u)
        {
                if (!u->GetExt("shunned"))
                        u->Extend("shunned");
        }


        void DisplayExpiry()
        {
                ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed shun %s (set by %s %ld seconds ago)", this->matchtext.c_str(), this->source, this->duration);
        }

        const char* Displayable()
        {
                return matchtext.c_str();
        }
};

class ShunFactory : public XLineFactory
{
 public:
        ShunFactory(InspIRCd* Instance) : XLineFactory(Instance, "SHUN") { }

        XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
        {
                return new Shun(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
        }
};

//typedef std::vector<Shun> shunlist;

class cmd_shun : public Command
{
 private:
        InspIRCd *Srv;

 public:
        cmd_shun(InspIRCd* Me) : Command(Me, "SHUN", "o", 1, 3), Srv(Me)
        {
                this->source = "m_shun.so";
                this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
        }

        CmdResult Handle(const std::vector<std::string>& parameters, User *user)
        {
                /* syntax: SHUN nick!user@host time :reason goes here */
                /* 'time' is a human-readable timestring, like 2d3h2s. */

                if (parameters.size() == 1)
                {
                        if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SHUN", user))
                        {
                                ServerInstance->SNO->WriteToSnoMask('x',"%s Removed shun on %s.",user->nick.c_str(),parameters[0].c_str());
                        }
                        else
                        {
                                // XXX todo implement stats
                                user->WriteServ("NOTICE %s :*** Shun %s not found in list, try /stats s.",user->nick.c_str(),parameters[0].c_str());
                        }

                        return CMD_SUCCESS;
                }
                else if (parameters.size() >= 2)
                {
                        // Adding - XXX todo make this respect <insane> tag perhaps..
                        long duration = ServerInstance->Duration(parameters[1]);
                        Shun *r = NULL;

                        try
                        {
                                r = new Shun(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
                        }
                        catch (...)
                        {
                                ; // Do nothing. If we get here, the regex was fucked up, and they already got told it fucked up.
                        }

                        if (r)
                        {
                                if (ServerInstance->XLines->AddLine(r, user))
                                {
                                        if (!duration)
                                        {
                                                ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent shun for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
                                        }
                                        else
                                        {
                                                time_t c_requires_crap = duration + ServerInstance->Time();
                                                ServerInstance->SNO->WriteToSnoMask('x', "%s added timed shun for %s, expires on %s: %s", user->nick.c_str(), parameters[0].c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), parameters[2].c_str());
                                        }

                                        ServerInstance->XLines->ApplyLines();
                                }
                                else
                                {
                                        delete r;
                                        user->WriteServ("NOTICE %s :*** Shun for %s already exists", user->nick.c_str(), parameters[0].c_str());
                                }
                        }
                }

                return CMD_FAILURE;
        }
};

class ModuleShun : public Module
{
        cmd_shun* mycommand;
        ShunFactory *f;
        std::map<std::string, bool> ShunEnabledCommands;
        bool NotifyOfShun;

 public:
        ModuleShun(InspIRCd* Me) : Module(Me)
        {
                f = new ShunFactory(ServerInstance);
                ServerInstance->XLines->RegisterFactory(f);

                mycommand = new cmd_shun(ServerInstance);
                ServerInstance->AddCommand(mycommand);

                Implementation eventlist[] = { I_OnStats, I_OnPreCommand, I_OnUserConnect, I_OnRehash };
                ServerInstance->Modules->Attach(eventlist, this, 4);
                OnRehash(NULL, "");
        }

        virtual ~ModuleShun()
        {
                ServerInstance->XLines->DelAll("SHUN");
                ServerInstance->XLines->UnregisterFactory(f);
        }

        virtual int OnStats(char symbol, User* user, string_list& out)
        {
                if (symbol != 'S')
                        return 0;

                ServerInstance->XLines->InvokeStats("SHUN", 223, user, out);
                return 1;
        }

        virtual void OnRehash(User* user, const std::string &parameter)
        {
                ConfigReader MyConf(ServerInstance);
                std::string cmds = MyConf.ReadValue("shun", "enabledcommands", 0);

                if (cmds.empty())
                        cmds = "PING PONG QUIT";

                ShunEnabledCommands.clear();
                NotifyOfShun = true;

                std::stringstream dcmds(cmds);
                std::string thiscmd;

                while (dcmds >> thiscmd)
                {
                        ShunEnabledCommands[thiscmd] = true;
                }

                NotifyOfShun = MyConf.ReadFlag("shun", "notifyuser", "yes", 0);
        }

        virtual void OnUserConnect(User* user)
        {
                if (!IS_LOCAL(user))
                        return;

                // Apply lines on user connect
                XLine *rl = ServerInstance->XLines->MatchesLine("SHUN", user);

                if (rl)
                {
                        // Bang. :P
                        rl->Apply(user);
                }
        }

        virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User* user, bool validated, const std::string &original_line)
        {
                if (validated || !user->GetExt("shunned"))
                        return 0;

                if (!ServerInstance->XLines->MatchesLine("SHUN", user))
                {
                        /* The shun previously set on this user has expired or been removed */
                        user->Shrink("shunned");
                        return 0;
                }

                std::map<std::string, bool>::iterator i = ShunEnabledCommands.find(command);

                if (i == ShunEnabledCommands.end())
                {
                        user->WriteServ("NOTICE %s :*** Command %s not processed, as you have been blocked from issuing commands (SHUN)", user->nick.c_str(), command.c_str());
                        return 1;
                }

                if (command == "QUIT")
                {
                        /* Allow QUIT but dont show any quit message */
                        parameters.clear();
                }
                else if (command == "PART")
                {
                        /* same for PART */
                        parameters.clear();
                }

                return 1;
        }

        virtual Version GetVersion()
        {
                return Version("$Id: m_shun.cpp 10741 2008-10-28 16:11:20Z w00t $",VF_VENDOR|VF_COMMON,API_VERSION);
        }
};

MODULE_INIT(ModuleShun)