]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_silence.cpp
Convert WriteNumeric() calls to pass the parameters of the numeric as method parameters
[user/henk/code/inspircd.git] / src / modules / m_silence.cpp
index d9d55f14b2f0cff24cff262676af21b594242863..7d3b3f90ce091d20b2d07713a5664ad6c9fdc27d 100644 (file)
@@ -1,19 +1,27 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2005-2007 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2006 John Brooks <john.brooks@dereferenced.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "inspircd.h"
 
-/* $ModDesc: Provides support for the /SILENCE command */
+#include "inspircd.h"
 
 /* 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>
@@ -37,8 +45,8 @@
 // pair of hostmask and flags
 typedef std::pair<std::string, int> silenceset;
 
-// deque list of pairs
-typedef std::deque<silenceset> silencelist;
+// list of pairs
+typedef std::vector<silenceset> silencelist;
 
 // intmasks for flags
 static int SILENCE_PRIVATE     = 0x0001; /* p  private messages      */
@@ -53,11 +61,10 @@ static int SILENCE_EXCLUDE  = 0x0040; /* x  exclude this pattern  */
 class CommandSVSSilence : public Command
 {
  public:
-       CommandSVSSilence(InspIRCd* Instance) : Command(Instance,"SVSSILENCE", 0, 2)
+       CommandSVSSilence(Module* Creator) : Command(Creator,"SVSSILENCE", 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. */
+               TRANSLATE3(TR_NICK, TR_TEXT, TR_TEXT);
        }
 
        CmdResult Handle (const std::vector<std::string>& parameters, User *user)
@@ -69,7 +76,7 @@ class CommandSVSSilence : public Command
                 * 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))
+               if (!user->server->IsULine())
                        return CMD_FAILURE;
 
                User *u = ServerInstance->FindNick(parameters[0]);
@@ -78,22 +85,32 @@ class CommandSVSSilence : public Command
 
                if (IS_LOCAL(u))
                {
-                       ServerInstance->Parser->CallHandler("SILENCE", std::vector<std::string>(++parameters.begin(), parameters.end()), u);
+                       ServerInstance->Parser.CallHandler("SILENCE", std::vector<std::string>(parameters.begin() + 1, parameters.end()), u);
                }
 
                return CMD_SUCCESS;
        }
+
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       {
+               User* target = ServerInstance->FindNick(parameters[0]);
+               if (target)
+                       return ROUTE_OPT_UCAST(target->server);
+               return ROUTE_LOCALONLY;
+       }
 };
 
 class CommandSilence : public Command
 {
        unsigned int& maxsilence;
  public:
-       CommandSilence (InspIRCd* Instance, unsigned int &max) : Command(Instance,"SILENCE", 0, 0), maxsilence(max)
+       SimpleExtItem<silencelist> ext;
+       CommandSilence(Module* Creator, unsigned int &max) : Command(Creator, "SILENCE", 0),
+               maxsilence(max)
+               , ext("silence_list", ExtensionItem::EXT_USER, Creator)
        {
-               this->source = "m_silence_ext.so";
+               allow_empty_last_param = false;
                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)
@@ -101,25 +118,24 @@ class CommandSilence : public Command
                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);
+                       silencelist* sl = ext.get(user);
                        // 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());
+                                       std::string decomppattern = DecompPattern(c->second);
+                                       user->WriteNumeric(271, user->nick, c->first, decomppattern);
                                }
                        }
-                       user->WriteNumeric(272, "%s :End of Silence List",user->nick.c_str());
+                       user->WriteNumeric(272, "End of Silence List");
 
-                       return CMD_LOCALONLY;
+                       return CMD_SUCCESS;
                }
                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);
+                       std::string mask(parameters[0], 1);
                        char action = parameters[0][0];
                        // Default is private and notice so clients do not break
                        int pattern = CompilePattern("pn");
@@ -129,6 +145,12 @@ class CommandSilence : public Command
                                pattern = CompilePattern(parameters[1].c_str());
                        }
 
+                       if (pattern == 0)
+                       {
+                               user->WriteNotice("Bad SILENCE pattern");
+                               return CMD_INVALID;
+                       }
+
                        if (!mask.length())
                        {
                                // 'SILENCE +' or 'SILENCE -', assume *!*@*
@@ -139,9 +161,9 @@ class CommandSilence : public Command
 
                        if (action == '-')
                        {
+                               std::string decomppattern = DecompPattern(pattern);
                                // fetch their silence list
-                               silencelist* sl;
-                               user->GetExt("silence_list", sl);
+                               silencelist* sl = ext.get(user);
                                // does it contain any entries and does it exist?
                                if (sl)
                                {
@@ -152,56 +174,55 @@ class CommandSilence : public Command
                                                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());
+                                                       user->WriteNumeric(950, user->nick, InspIRCd::Format("Removed %s %s from silence list", mask.c_str(), decomppattern.c_str()));
                                                        if (!sl->size())
                                                        {
-                                                               delete sl;
-                                                               user->Shrink("silence_list");
+                                                               ext.unset(user);
                                                        }
                                                        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());
+                               user->WriteNumeric(952, user->nick, InspIRCd::Format("%s %s does not exist on your silence list", mask.c_str(), decomppattern.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.
+                               silencelist* sl = ext.get(user);
                                if (!sl)
                                {
                                        sl = new silencelist;
-                                       user->Extend("silence_list", sl);
+                                       ext.set(user, sl);
                                }
                                if (sl->size() > maxsilence)
                                {
-                                       user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick.c_str(), user->nick.c_str());
+                                       user->WriteNumeric(952, user->nick, "Your silence list is full");
                                        return CMD_FAILURE;
                                }
+
+                               std::string decomppattern = DecompPattern(pattern);
                                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());
+                                               user->WriteNumeric(952, user->nick, InspIRCd::Format("%s %s is already on your silence list", mask.c_str(), decomppattern.c_str()));
                                                return CMD_FAILURE;
                                        }
                                }
                                if (((pattern & SILENCE_EXCLUDE) > 0))
                                {
-                                       sl->push_front(silenceset(mask,pattern));
+                                       sl->insert(sl->begin(), 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());
+                               user->WriteNumeric(951, user->nick, InspIRCd::Format("Added %s %s to silence list", mask.c_str(), decomppattern.c_str()));
                                return CMD_SUCCESS;
                        }
                }
-               return CMD_LOCALONLY;
+               return CMD_SUCCESS;
        }
 
        /* turn the nice human readable pattern into a mask */
@@ -245,162 +266,114 @@ class CommandSilence : public Command
        std::string DecompPattern (const int pattern)
        {
                std::string out;
-               if ((pattern & SILENCE_PRIVATE) > 0)
+               if (pattern & SILENCE_PRIVATE)
                        out += ",privatemessages";
-               if ((pattern & SILENCE_CHANNEL) > 0)
+               if (pattern & SILENCE_CHANNEL)
                        out += ",channelmessages";
-               if ((pattern & SILENCE_INVITE) > 0)
+               if (pattern & SILENCE_INVITE)
                        out += ",invites";
-               if ((pattern & SILENCE_NOTICE) > 0)
+               if (pattern & SILENCE_NOTICE)
                        out += ",privatenotices";
-               if ((pattern & SILENCE_CNOTICE) > 0)
+               if (pattern & SILENCE_CNOTICE)
                        out += ",channelnotices";
-               if ((pattern & SILENCE_ALL) > 0)
+               if (pattern & SILENCE_ALL)
                        out = ",all";
-               if ((pattern & SILENCE_EXCLUDE) > 0)
+               if (pattern & SILENCE_EXCLUDE)
                        out += ",exclude";
-               return "<" + out.substr(1) + ">";
+               if (out.length())
+                       return "<" + out.substr(1) + ">";
+               else
+                       return "<none>";
        }
 
 };
 
 class ModuleSilence : public Module
 {
-       CommandSilence* cmdsilence;
-       CommandSVSSilence *cmdsvssilence;
        unsigned int maxsilence;
+       bool ExemptULine;
+       CommandSilence cmdsilence;
+       CommandSVSSilence cmdsvssilence;
  public:
 
-       ModuleSilence(InspIRCd* Me)
-               : Module(Me), maxsilence(32)
+       ModuleSilence()
+               : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
        {
-               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)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ConfigReader Conf(ServerInstance);
-               maxsilence = Conf.ReadInteger("silence", "maxentries", 0, true);
+               ConfigTag* tag = ServerInstance->Config->ConfValue("silence");
+
+               maxsilence = tag->getInt("maxentries", 32);
                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");
-               }
+               ExemptULine = tag->getBool("exemptuline", true);
        }
 
-       virtual void On005Numeric(std::string &output)
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               // we don't really have a limit...
-               output = output + " ESILENCE SILENCE=" + ConvToStr(maxsilence);
+               tokens["ESILENCE"];
+               tokens["SILENCE"] = ConvToStr(maxsilence);
        }
 
-       virtual void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
+       void BuildExemptList(MessageType message_type, Channel* chan, User* sender, CUList& exempt_list)
        {
                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++)
+               const Channel::MemberMap& ulist = chan->GetUsers();
+               for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
                {
                        if (IS_LOCAL(i->first))
                        {
-                               if (MatchPattern(i->first, sender, public_silence) == 1)
+                               if (MatchPattern(i->first, sender, public_silence) == MOD_RES_DENY)
                                {
-                                       exempt_list[i->first] = i->first->nick;
+                                       exempt_list.insert(i->first);
                                }
                        }
                }
        }
 
-       virtual int PreText(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
+       ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
        {
                if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
                {
-                       return MatchPattern((User*)dest, user, silence_type);
+                       return MatchPattern((User*)dest, user, ((msgtype == MSG_PRIVMSG) ? SILENCE_PRIVATE : SILENCE_NOTICE));
                }
                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, "");
-                       }
+                       BuildExemptList(msgtype, chan, user, exempt_list);
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       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)
+       ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout) CXX11_OVERRIDE
        {
                return MatchPattern(dest, source, SILENCE_INVITE);
        }
 
-       int MatchPattern(User* dest, User* source, int pattern)
+       ModResult MatchPattern(User* dest, User* source, int pattern)
        {
-               /* Server source */
-               if (!source || !dest)
-                       return 1;
+               if (ExemptULine && source->server->IsULine())
+                       return MOD_RES_PASSTHRU;
 
-               silencelist* sl;
-               dest->GetExt("silence_list", sl);
+               silencelist* sl = cmdsilence.ext.get(dest);
                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 (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
                        }
                }
-               return 0;
-       }
-
-       virtual ~ModuleSilence()
-       {
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
        }
 };