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_silence.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"

/* $ModDesc: Provides support for the /SILENCE command */

/* Improved drop-in replacement for the /SILENCE command
 * syntax: /SILENCE [+|-]<mask> <p|c|i|n|t|a|x> as in <privatemessage|channelmessage|invites|privatenotice|channelnotice|all|exclude>
 *
 * example that blocks all except private messages
 *  /SILENCE +*!*@* a
 *  /SILENCE +*!*@* px
 *
 * example that blocks all invites except from channel services
 *  /SILENCE +*!*@* i
 *  /SILENCE +chanserv!services@chatters.net ix
 *
 * example that blocks some bad dude from private, notice and inviting you
 *  /SILENCE +*!kiddie@lamerz.net pin
 *
 * TODO: possibly have add and remove check for existing host and only modify flags according to
 *       what's been changed instead of having to remove first, then add if you want to change
 *       an entry.
 */

// pair of hostmask and flags
typedef std::pair<std::string, int> silenceset;

// deque list of pairs
typedef std::deque<silenceset> silencelist;

// intmasks for flags
static int SILENCE_PRIVATE      = 0x0001; /* p  private messages      */
static int SILENCE_CHANNEL      = 0x0002; /* c  channel messages      */
static int SILENCE_INVITE       = 0x0004; /* i  invites               */
static int SILENCE_NOTICE       = 0x0008; /* n  notices               */
static int SILENCE_CNOTICE      = 0x0010; /* t  channel notices       */
static int SILENCE_ALL          = 0x0020; /* a  all, (pcint)          */
static int SILENCE_EXCLUDE      = 0x0040; /* x  exclude this pattern  */


class CommandSVSSilence : public Command
{
 public:
        CommandSVSSilence(InspIRCd* Instance) : Command(Instance,"SVSSILENCE", 0, 2)
        {
                this->source = "m_silence.so";
                syntax = "<target> {[+|-]<mask> <p|c|i|n|t|a|x>}";
                TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
        }

        CmdResult Handle (const std::vector<std::string>& parameters, User *user)
        {
                /*
                 * XXX: thought occurs to me
                 * We may want to change the syntax of this command to
                 * SVSSILENCE <flagsora+> +<nick> -<nick> +<nick>
                 * style command so services can modify lots of entries at once.
                 * leaving it backwards compatible for now as it's late. -- w
                 */
                if (!ServerInstance->ULine(user->server))
                        return CMD_FAILURE;

                User *u = ServerInstance->FindNick(parameters[0]);
                if (!u)
                        return CMD_FAILURE;

                if (IS_LOCAL(u))
                {
                        ServerInstance->Parser->CallHandler("SILENCE", std::vector<std::string>(++parameters.begin(), parameters.end()), u);
                }

                return CMD_SUCCESS;
        }
};

class CommandSilence : public Command
{
        unsigned int& maxsilence;
 public:
        CommandSilence (InspIRCd* Instance, unsigned int &max) : Command(Instance,"SILENCE", 0, 0), maxsilence(max)
        {
                this->source = "m_silence_ext.so";
                syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
                TRANSLATE3(TR_TEXT, TR_TEXT, TR_END);
        }

        CmdResult Handle (const std::vector<std::string>& parameters, User *user)
        {
                if (!parameters.size())
                {
                        // no parameters, show the current silence list.
                        // Use Extensible::GetExt to fetch the silence list
                        silencelist* sl;
                        user->GetExt("silence_list", sl);
                        // if the user has a silence list associated with their user record, show it
                        if (sl)
                        {
                                for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
                                {
                                        user->WriteNumeric(271, "%s %s %s %s",user->nick.c_str(), user->nick.c_str(),c->first.c_str(), DecompPattern(c->second).c_str());
                                }
                        }
                        user->WriteNumeric(272, "%s :End of Silence List",user->nick.c_str());

                        return CMD_LOCALONLY;
                }
                else if (parameters.size() > 0)
                {
                        // one or more parameters, add or delete entry from the list (only the first parameter is used)
                        std::string mask = parameters[0].substr(1);
                        char action = parameters[0][0];
                        // Default is private and notice so clients do not break
                        int pattern = CompilePattern("pn");

                        // if pattern supplied, use it
                        if (parameters.size() > 1) {
                                pattern = CompilePattern(parameters[1].c_str());
                        }

                        if (!mask.length())
                        {
                                // 'SILENCE +' or 'SILENCE -', assume *!*@*
                                mask = "*!*@*";
                        }

                        ModeParser::CleanMask(mask);

                        if (action == '-')
                        {
                                // fetch their silence list
                                silencelist* sl;
                                user->GetExt("silence_list", sl);
                                // does it contain any entries and does it exist?
                                if (sl)
                                {
                                        for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
                                        {
                                                // search through for the item
                                                irc::string listitem = i->first.c_str();
                                                if (listitem == mask && i->second == pattern)
                                                {
                                                        sl->erase(i);
                                                        user->WriteNumeric(950, "%s %s :Removed %s %s from silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
                                                        if (!sl->size())
                                                        {
                                                                delete sl;
                                                                user->Shrink("silence_list");
                                                        }
                                                        return CMD_SUCCESS;
                                                }
                                        }
                                }
                                user->WriteNumeric(952, "%s %s :%s %s does not exist on your silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
                        }
                        else if (action == '+')
                        {
                                // fetch the user's current silence list
                                silencelist* sl;
                                user->GetExt("silence_list", sl);
                                // what, they dont have one??? WE'RE ALL GONNA DIE! ...no, we just create an empty one.
                                if (!sl)
                                {
                                        sl = new silencelist;
                                        user->Extend("silence_list", sl);
                                }
                                if (sl->size() > maxsilence)
                                {
                                        user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick.c_str(), user->nick.c_str());
                                        return CMD_FAILURE;
                                }
                                for (silencelist::iterator n = sl->begin(); n != sl->end();  n++)
                                {
                                        irc::string listitem = n->first.c_str();
                                        if (listitem == mask && n->second == pattern)
                                        {
                                                user->WriteNumeric(952, "%s %s :%s %s is already on your silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
                                                return CMD_FAILURE;
                                        }
                                }
                                if (((pattern & SILENCE_EXCLUDE) > 0))
                                {
                                        sl->push_front(silenceset(mask,pattern));
                                }
                                else
                                {
                                        sl->push_back(silenceset(mask,pattern));
                                }
                                user->WriteNumeric(951, "%s %s :Added %s %s to silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
                                return CMD_SUCCESS;
                        }
                }
                return CMD_LOCALONLY;
        }

        /* turn the nice human readable pattern into a mask */
        int CompilePattern(const char* pattern)
        {
                int p = 0;
                for (const char* n = pattern; *n; n++)
                {
                        switch (*n)
                        {
                                case 'p':
                                        p |= SILENCE_PRIVATE;
                                        break;
                                case 'c':
                                        p |= SILENCE_CHANNEL;
                                        break;
                                case 'i':
                                        p |= SILENCE_INVITE;
                                        break;
                                case 'n':
                                        p |= SILENCE_NOTICE;
                                        break;
                                case 't':
                                        p |= SILENCE_CNOTICE;
                                        break;
                                case 'a':
                                case '*':
                                        p |= SILENCE_ALL;
                                        break;
                                case 'x':
                                        p |= SILENCE_EXCLUDE;
                                        break;
                                default:
                                        break;
                        }
                }
                return p;
        }

        /* turn the mask into a nice human readable format */
        std::string DecompPattern (const int pattern)
        {
                std::string out;
                if ((pattern & SILENCE_PRIVATE) > 0)
                        out += ",privatemessages";
                if ((pattern & SILENCE_CHANNEL) > 0)
                        out += ",channelmessages";
                if ((pattern & SILENCE_INVITE) > 0)
                        out += ",invites";
                if ((pattern & SILENCE_NOTICE) > 0)
                        out += ",privatenotices";
                if ((pattern & SILENCE_CNOTICE) > 0)
                        out += ",channelnotices";
                if ((pattern & SILENCE_ALL) > 0)
                        out = ",all";
                if ((pattern & SILENCE_EXCLUDE) > 0)
                        out += ",exclude";
                return "<" + out.substr(1) + ">";
        }

};

class ModuleSilence : public Module
{
        CommandSilence* cmdsilence;
        CommandSVSSilence *cmdsvssilence;
        unsigned int maxsilence;
 public:

        ModuleSilence(InspIRCd* Me)
                : Module(Me), maxsilence(32)
        {
                OnRehash(NULL, "");
                cmdsilence = new CommandSilence(ServerInstance,maxsilence);
                cmdsvssilence = new CommandSVSSilence(ServerInstance);
                ServerInstance->AddCommand(cmdsilence);
                ServerInstance->AddCommand(cmdsvssilence);

                Implementation eventlist[] = { I_OnRehash, I_OnBuildExemptList, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnUserPreInvite };
                ServerInstance->Modules->Attach(eventlist, this, 7);
        }

        virtual void OnRehash(User* user, const std::string &parameter)
        {
                ConfigReader Conf(ServerInstance);
                maxsilence = Conf.ReadInteger("silence", "maxentries", 0, true);
                if (!maxsilence)
                        maxsilence = 32;
        }


        virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
        {
                // when the user quits tidy up any silence list they might have just to keep things tidy
                silencelist* sl;
                user->GetExt("silence_list", sl);
                if (sl)
                {
                        delete sl;
                        user->Shrink("silence_list");
                }
        }

        virtual void On005Numeric(std::string &output)
        {
                // we don't really have a limit...
                output = output + " ESILENCE SILENCE=" + ConvToStr(maxsilence);
        }

        virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
        {
                int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
                CUList *ulist;
                switch (status)
                {
                        case '@':
                                ulist = chan->GetOppedUsers();
                                break;
                        case '%':
                                ulist = chan->GetHalfoppedUsers();
                                break;
                        case '+':
                                ulist = chan->GetVoicedUsers();
                                break;
                        default:
                                ulist = chan->GetUsers();
                                break;
                }

                for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
                {
                        if (IS_LOCAL(i->first))
                        {
                                if (MatchPattern(i->first, sender, public_silence) == 1)
                                {
                                        exempt_list[i->first] = i->first->nick;
                                }
                        }
                }
        }

        virtual int PreText(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
        {
                if (!IS_LOCAL(user))
                        return 0;

                if (target_type == TYPE_USER)
                {
                        return MatchPattern((User*)dest, user, silence_type);
                }
                else if (target_type == TYPE_CHANNEL)
                {
                        Channel* chan = (Channel*)dest;
                        if (chan)
                        {
                                this->OnBuildExemptList((silence_type == SILENCE_PRIVATE ? MSG_PRIVMSG : MSG_NOTICE), chan, user, status, exempt_list, "");
                        }
                }
                return 0;
        }

        virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
        {
                return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_PRIVATE);
        }

        virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
        {
                return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_NOTICE);
        }

        virtual int OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout)
        {
                return MatchPattern(dest, source, SILENCE_INVITE);
        }

        int MatchPattern(User* dest, User* source, int pattern)
        {
                /* Server source */
                if (!source || !dest)
                        return 1;

                silencelist* sl;
                dest->GetExt("silence_list", sl);
                if (sl)
                {
                        for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
                        {
                                if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
                                        return !(((c->second & SILENCE_EXCLUDE) > 0));
                        }
                }
                return 0;
        }

        virtual ~ModuleSilence()
        {
        }

        virtual Version GetVersion()
        {
                return Version("$Id: m_silence.cpp 10291 2008-08-25 20:35:51Z w00t $", VF_COMMON | VF_VENDOR, API_VERSION);
        }
};

MODULE_INIT(ModuleSilence)