]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_silence.cpp
Automatically register ServiceProviders created by modules
[user/henk/code/inspircd.git] / src / modules / m_silence.cpp
index 4ff26aca625ab29ee05eb0c49d54fcc77c3697d9..02005367df05121c7300bc52d0690c183d006145 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 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"
-#include "wildcard.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  */
+
 
-// This typedef holds a silence list. Each user may or may not have a
-// silencelist, if a silence list is empty for a user, he/she does not
-// have one of these structures associated with their user record.
-typedef std::map<irc::string, time_t> silencelist;
+class CommandSVSSilence : public Command
+{
+ public:
+       CommandSVSSilence(Module* Creator) : Command(Creator,"SVSSILENCE", 2)
+       {
+               syntax = "<target> {[+|-]<mask> <p|c|i|n|t|a|x>}";
+               TRANSLATE3(TR_NICK, TR_TEXT, TR_TEXT);
+       }
+
+       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;
+       }
+
+       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", Creator)
        {
-               this->source = "m_silence.so";
-               syntax = "{[+|-]<mask>}";
-               TRANSLATE2(TR_TEXT, TR_END);
+               allow_empty_last_param = false;
+               syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
        }
 
-       CmdResult Handle (const char* const* parameters, int pcnt, User *user)
+       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
        {
-               if (!pcnt)
+               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 :%lu",user->nick, user->nick, c->first.c_str(), (unsigned long)c->second);
+                                       std::string decomppattern = DecompPattern(c->second);
+                                       user->WriteNumeric(271, "%s %s %s %s",user->nick.c_str(), user->nick.c_str(),c->first.c_str(), decomppattern.c_str());
                                }
                        }
-                       user->WriteNumeric(272, "%s :End of Silence List",user->nick);
+                       user->WriteNumeric(272, "%s :End of Silence List",user->nick.c_str());
 
                        return CMD_SUCCESS;
                }
-               else if (pcnt > 0)
+               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] + 1;
-                       char action = *parameters[0];
-                       
+                       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 (pattern == 0)
+                       {
+                               user->WriteNotice("Bad SILENCE pattern");
+                               return CMD_INVALID;
+                       }
+
                        if (!mask.length())
                        {
                                // 'SILENCE +' or 'SILENCE -', assume *!*@*
                                mask = "*!*@*";
                        }
-                       
+
                        ModeParser::CleanMask(mask);
 
                        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)
                                {
-                                       silencelist::iterator i = sl->find(mask.c_str());
-                                       if (i != sl->end())
+                                       for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
                                        {
-                                               sl->erase(i);
-                                               user->WriteNumeric(950, "%s %s :Removed %s from silence list",user->nick, user->nick, mask.c_str());
-                                               if (!sl->size())
+                                               // search through for the item
+                                               irc::string listitem = i->first.c_str();
+                                               if (listitem == mask && i->second == pattern)
                                                {
-                                                       // tidy up -- if a user's list is empty, theres no use having it
-                                                       // hanging around in the user record.
-                                                       delete sl;
-                                                       user->Shrink("silence_list");
+                                                       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.c_str());
+                                                       if (!sl->size())
+                                                       {
+                                                               ext.unset(user);
+                                                       }
+                                                       return CMD_SUCCESS;
                                                }
                                        }
-                                       else
-                                               user->WriteNumeric(952, "%s %s :%s does not exist on your silence list",user->nick, user->nick, mask.c_str());
                                }
+                               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.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);
                                }
-                               silencelist::iterator n = sl->find(mask.c_str());
-                               if (n != sl->end())
+                               if (sl->size() > maxsilence)
                                {
-                                       user->WriteNumeric(952, "%s %s :%s is already on your silence list",user->nick, user->nick, mask.c_str());
+                                       user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick.c_str(), user->nick.c_str());
                                        return CMD_FAILURE;
                                }
-                               if (sl->size() >= maxsilence)
+
+                               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.c_str());
+                                               return CMD_FAILURE;
+                                       }
+                               }
+                               if (((pattern & SILENCE_EXCLUDE) > 0))
                                {
-                                       user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick, user->nick, mask.c_str());
-                                       return CMD_FAILURE;
+                                       sl->push_front(silenceset(mask,pattern));
                                }
-                               sl->insert(std::make_pair<irc::string, time_t>(mask.c_str(), ServerInstance->Time()));
-                               user->WriteNumeric(951, "%s %s :Added %s to silence list",user->nick, user->nick, mask.c_str());
+                               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.c_str());
                                return CMD_SUCCESS;
                        }
                }
                return CMD_SUCCESS;
        }
+
+       /* 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)
+                       out += ",privatemessages";
+               if (pattern & SILENCE_CHANNEL)
+                       out += ",channelmessages";
+               if (pattern & SILENCE_INVITE)
+                       out += ",invites";
+               if (pattern & SILENCE_NOTICE)
+                       out += ",privatenotices";
+               if (pattern & SILENCE_CNOTICE)
+                       out += ",channelnotices";
+               if (pattern & SILENCE_ALL)
+                       out = ",all";
+               if (pattern & SILENCE_EXCLUDE)
+                       out += ",exclude";
+               if (out.length())
+                       return "<" + out.substr(1) + ">";
+               else
+                       return "<none>";
+       }
+
 };
 
 class ModuleSilence : public Module
 {
-       
-       CommandSilence* mycommand;
        unsigned int maxsilence;
+       CommandSilence cmdsilence;
+       CommandSVSSilence cmdsvssilence;
  public:
-       ModuleSilence(InspIRCd* Me)
-               : Module(Me), maxsilence(32)
+
+       ModuleSilence()
+               : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
        {
-               OnRehash(NULL, "");
-               mycommand = new CommandSilence(ServerInstance, maxsilence);
-               ServerInstance->AddCommand(mycommand);
-               Implementation eventlist[] = { I_OnRehash, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
-               ServerInstance->Modules->Attach(eventlist, this, 5);
        }
 
-
-       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);
+               maxsilence = ServerInstance->Config->ConfValue("showwhois")->getInt("maxentries", 32);
                if (!maxsilence)
                        maxsilence = 32;
        }
 
-       virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
+       void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               // when the user quits tidy up any silence list they might have just to keep things tidy
-               // and to prevent a HONKING BIG MEMORY LEAK!
-               silencelist* sl;
-               user->GetExt("silence_list", sl);
-               if (sl)
-               {
-                       delete sl;
-                       user->Shrink("silence_list");
-               }
+               tokens["ESILENCE"];
+               tokens["SILENCE"] = ConvToStr(maxsilence);
        }
 
-       virtual void On005Numeric(std::string &output)
+       void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
        {
-               // we don't really have a limit...
-               output = output + " SILENCE=" + ConvToStr(maxsilence);
-       }
-       
-       virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
-       {
-               // im not sure how unreal's silence operates but ours is sensible. It blocks notices and
-               // privmsgs from people on the silence list, directed privately at the user.
-               // channel messages are unaffected (ever tried to follow the flow of conversation in
-               // a channel when you've set an ignore on the two most talkative people?)
-               if ((target_type == TYPE_USER) && (IS_LOCAL(user)))
+               int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
+               const UserMembList *ulist = chan->GetUsers();
+
+               for (UserMembCIter i = ulist->begin(); i != ulist->end(); i++)
                {
-                       User* u = (User*)dest;
-                       silencelist* sl;
-                       u->GetExt("silence_list", sl);
-                       if (sl)
+                       if (IS_LOCAL(i->first))
                        {
-                               for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
+                               if (MatchPattern(i->first, sender, public_silence) == MOD_RES_DENY)
                                {
-                                       if (match(user->GetFullHost(), c->first.c_str()))
-                                       {
-                                               return 1;
-                                       }
+                                       exempt_list.insert(i->first);
                                }
                        }
                }
-               return 0;
        }
 
-       virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+       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, ((msgtype == MSG_PRIVMSG) ? SILENCE_PRIVATE : SILENCE_NOTICE));
+               }
+               else if (target_type == TYPE_CHANNEL)
+               {
+                       Channel* chan = (Channel*)dest;
+                       if (chan)
+                       {
+                               this->OnBuildExemptList(msgtype, chan, user, status, exempt_list, "");
+                       }
+               }
+               return MOD_RES_PASSTHRU;
+       }
+
+       ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout) CXX11_OVERRIDE
        {
-               return OnUserPreNotice(user,dest,target_type,text,status,exempt_list);
+               return MatchPattern(dest, source, SILENCE_INVITE);
        }
 
-       virtual ~ModuleSilence()
+       ModResult MatchPattern(User* dest, User* source, int pattern)
        {
+               /* Server source */
+               if (!source || !dest)
+                       return MOD_RES_ALLOW;
+
+               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) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
+                       }
+               }
+               return MOD_RES_PASSTHRU;
        }
-       
-       virtual Version GetVersion()
+
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
        }
 };