src/modules/m_silence.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2005-2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2006 John Brooks <john.brooks@dereferenced.net>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #include "inspircd.h"
  25
  26 /* Improved drop-in replacement for the /SILENCE command
  27  * syntax: /SILENCE [+|-]<mask> <p|c|i|n|t|a|x> as in <privatemessage|channelmessage|invites|privatenotice|channelnotice|all|exclude>
  28  *
  29  * example that blocks all except private messages
  30  *  /SILENCE +*!*@* a
  31  *  /SILENCE +*!*@* px
  32  *
  33  * example that blocks all invites except from channel services
  34  *  /SILENCE +*!*@* i
  35  *  /SILENCE +chanserv!services@chatters.net ix
  36  *
  37  * example that blocks some bad dude from private, notice and inviting you
  38  *  /SILENCE +*!kiddie@lamerz.net pin
  39  *
  40  * TODO: possibly have add and remove check for existing host and only modify flags according to
  41  *       what's been changed instead of having to remove first, then add if you want to change
  42  *       an entry.
  43  */
  44
  45 // pair of hostmask and flags
  46 typedef std::pair<std::string, int> silenceset;
  47
  48 // list of pairs
  49 typedef std::vector<silenceset> silencelist;
  50
  51 // intmasks for flags
  52 static int SILENCE_PRIVATE      = 0x0001; /* p  private messages      */
  53 static int SILENCE_CHANNEL      = 0x0002; /* c  channel messages      */
  54 static int SILENCE_INVITE       = 0x0004; /* i  invites               */
  55 static int SILENCE_NOTICE       = 0x0008; /* n  notices               */
  56 static int SILENCE_CNOTICE      = 0x0010; /* t  channel notices       */
  57 static int SILENCE_ALL          = 0x0020; /* a  all, (pcint)          */
  58 static int SILENCE_EXCLUDE      = 0x0040; /* x  exclude this pattern  */
  59
  60
  61 class CommandSVSSilence : public Command
  62 {
  63  public:
  64         CommandSVSSilence(Module* Creator) : Command(Creator,"SVSSILENCE", 2)
  65         {
  66                 syntax = "<target> {[+|-]<mask> <p|c|i|n|t|a|x>}";
  67                 TRANSLATE3(TR_NICK, TR_TEXT, TR_TEXT);
  68         }
  69
  70         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
  71         {
  72                 /*
  73                  * XXX: thought occurs to me
  74                  * We may want to change the syntax of this command to
  75                  * SVSSILENCE <flagsora+> +<nick> -<nick> +<nick>
  76                  * style command so services can modify lots of entries at once.
  77                  * leaving it backwards compatible for now as it's late. -- w
  78                  */
  79                 if (!user->server->IsULine())
  80                         return CMD_FAILURE;
  81
  82                 User *u = ServerInstance->FindNick(parameters[0]);
  83                 if (!u)
  84                         return CMD_FAILURE;
  85
  86                 if (IS_LOCAL(u))
  87                 {
  88                         ServerInstance->Parser.CallHandler("SILENCE", std::vector<std::string>(parameters.begin() + 1, parameters.end()), u);
  89                 }
  90
  91                 return CMD_SUCCESS;
  92         }
  93
  94         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
  95         {
  96                 User* target = ServerInstance->FindNick(parameters[0]);
  97                 if (target)
  98                         return ROUTE_OPT_UCAST(target->server);
  99                 return ROUTE_LOCALONLY;
 100         }
 101 };
 102
 103 class CommandSilence : public Command
 104 {
 105         unsigned int& maxsilence;
 106  public:
 107         SimpleExtItem<silencelist> ext;
 108         CommandSilence(Module* Creator, unsigned int &max) : Command(Creator, "SILENCE", 0),
 109                 maxsilence(max)
 110                 , ext("silence_list", ExtensionItem::EXT_USER, Creator)
 111         {
 112                 allow_empty_last_param = false;
 113                 syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
 114         }
 115
 116         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 117         {
 118                 if (!parameters.size())
 119                 {
 120                         // no parameters, show the current silence list.
 121                         silencelist* sl = ext.get(user);
 122                         // if the user has a silence list associated with their user record, show it
 123                         if (sl)
 124                         {
 125                                 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 126                                 {
 127                                         std::string decomppattern = DecompPattern(c->second);
 128                                         user->WriteNumeric(271, "%s %s %s", user->nick.c_str(),c->first.c_str(), decomppattern.c_str());
 129                                 }
 130                         }
 131                         user->WriteNumeric(272, ":End of Silence List");
 132
 133                         return CMD_SUCCESS;
 134                 }
 135                 else if (parameters.size() > 0)
 136                 {
 137                         // one or more parameters, add or delete entry from the list (only the first parameter is used)
 138                         std::string mask(parameters[0], 1);
 139                         char action = parameters[0][0];
 140                         // Default is private and notice so clients do not break
 141                         int pattern = CompilePattern("pn");
 142
 143                         // if pattern supplied, use it
 144                         if (parameters.size() > 1) {
 145                                 pattern = CompilePattern(parameters[1].c_str());
 146                         }
 147
 148                         if (pattern == 0)
 149                         {
 150                                 user->WriteNotice("Bad SILENCE pattern");
 151                                 return CMD_INVALID;
 152                         }
 153
 154                         if (!mask.length())
 155                         {
 156                                 // 'SILENCE +' or 'SILENCE -', assume *!*@*
 157                                 mask = "*!*@*";
 158                         }
 159
 160                         ModeParser::CleanMask(mask);
 161
 162                         if (action == '-')
 163                         {
 164                                 std::string decomppattern = DecompPattern(pattern);
 165                                 // fetch their silence list
 166                                 silencelist* sl = ext.get(user);
 167                                 // does it contain any entries and does it exist?
 168                                 if (sl)
 169                                 {
 170                                         for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
 171                                         {
 172                                                 // search through for the item
 173                                                 irc::string listitem = i->first.c_str();
 174                                                 if (listitem == mask && i->second == pattern)
 175                                                 {
 176                                                         sl->erase(i);
 177                                                         user->WriteNumeric(950, "%s :Removed %s %s from silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
 178                                                         if (!sl->size())
 179                                                         {
 180                                                                 ext.unset(user);
 181                                                         }
 182                                                         return CMD_SUCCESS;
 183                                                 }
 184                                         }
 185                                 }
 186                                 user->WriteNumeric(952, "%s :%s %s does not exist on your silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
 187                         }
 188                         else if (action == '+')
 189                         {
 190                                 // fetch the user's current silence list
 191                                 silencelist* sl = ext.get(user);
 192                                 if (!sl)
 193                                 {
 194                                         sl = new silencelist;
 195                                         ext.set(user, sl);
 196                                 }
 197                                 if (sl->size() > maxsilence)
 198                                 {
 199                                         user->WriteNumeric(952, "%s :Your silence list is full",user->nick.c_str());
 200                                         return CMD_FAILURE;
 201                                 }
 202
 203                                 std::string decomppattern = DecompPattern(pattern);
 204                                 for (silencelist::iterator n = sl->begin(); n != sl->end();  n++)
 205                                 {
 206                                         irc::string listitem = n->first.c_str();
 207                                         if (listitem == mask && n->second == pattern)
 208                                         {
 209                                                 user->WriteNumeric(952, "%s :%s %s is already on your silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
 210                                                 return CMD_FAILURE;
 211                                         }
 212                                 }
 213                                 if (((pattern & SILENCE_EXCLUDE) > 0))
 214                                 {
 215                                         sl->insert(sl->begin(), silenceset(mask, pattern));
 216                                 }
 217                                 else
 218                                 {
 219                                         sl->push_back(silenceset(mask,pattern));
 220                                 }
 221                                 user->WriteNumeric(951, "%s :Added %s %s to silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
 222                                 return CMD_SUCCESS;
 223                         }
 224                 }
 225                 return CMD_SUCCESS;
 226         }
 227
 228         /* turn the nice human readable pattern into a mask */
 229         int CompilePattern(const char* pattern)
 230         {
 231                 int p = 0;
 232                 for (const char* n = pattern; *n; n++)
 233                 {
 234                         switch (*n)
 235                         {
 236                                 case 'p':
 237                                         p |= SILENCE_PRIVATE;
 238                                         break;
 239                                 case 'c':
 240                                         p |= SILENCE_CHANNEL;
 241                                         break;
 242                                 case 'i':
 243                                         p |= SILENCE_INVITE;
 244                                         break;
 245                                 case 'n':
 246                                         p |= SILENCE_NOTICE;
 247                                         break;
 248                                 case 't':
 249                                         p |= SILENCE_CNOTICE;
 250                                         break;
 251                                 case 'a':
 252                                 case '*':
 253                                         p |= SILENCE_ALL;
 254                                         break;
 255                                 case 'x':
 256                                         p |= SILENCE_EXCLUDE;
 257                                         break;
 258                                 default:
 259                                         break;
 260                         }
 261                 }
 262                 return p;
 263         }
 264
 265         /* turn the mask into a nice human readable format */
 266         std::string DecompPattern (const int pattern)
 267         {
 268                 std::string out;
 269                 if (pattern & SILENCE_PRIVATE)
 270                         out += ",privatemessages";
 271                 if (pattern & SILENCE_CHANNEL)
 272                         out += ",channelmessages";
 273                 if (pattern & SILENCE_INVITE)
 274                         out += ",invites";
 275                 if (pattern & SILENCE_NOTICE)
 276                         out += ",privatenotices";
 277                 if (pattern & SILENCE_CNOTICE)
 278                         out += ",channelnotices";
 279                 if (pattern & SILENCE_ALL)
 280                         out = ",all";
 281                 if (pattern & SILENCE_EXCLUDE)
 282                         out += ",exclude";
 283                 if (out.length())
 284                         return "<" + out.substr(1) + ">";
 285                 else
 286                         return "<none>";
 287         }
 288
 289 };
 290
 291 class ModuleSilence : public Module
 292 {
 293         unsigned int maxsilence;
 294         bool ExemptULine;
 295         CommandSilence cmdsilence;
 296         CommandSVSSilence cmdsvssilence;
 297  public:
 298
 299         ModuleSilence()
 300                 : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
 301         {
 302         }
 303
 304         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 305         {
 306                 ConfigTag* tag = ServerInstance->Config->ConfValue("silence");
 307
 308                 maxsilence = tag->getInt("maxentries", 32);
 309                 if (!maxsilence)
 310                         maxsilence = 32;
 311
 312                 ExemptULine = tag->getBool("exemptuline", true);
 313         }
 314
 315         void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
 316         {
 317                 tokens["ESILENCE"];
 318                 tokens["SILENCE"] = ConvToStr(maxsilence);
 319         }
 320
 321         void BuildExemptList(MessageType message_type, Channel* chan, User* sender, CUList& exempt_list)
 322         {
 323                 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
 324
 325                 const Channel::MemberMap& ulist = chan->GetUsers();
 326                 for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
 327                 {
 328                         if (IS_LOCAL(i->first))
 329                         {
 330                                 if (MatchPattern(i->first, sender, public_silence) == MOD_RES_DENY)
 331                                 {
 332                                         exempt_list.insert(i->first);
 333                                 }
 334                         }
 335                 }
 336         }
 337
 338         ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
 339         {
 340                 if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
 341                 {
 342                         return MatchPattern((User*)dest, user, ((msgtype == MSG_PRIVMSG) ? SILENCE_PRIVATE : SILENCE_NOTICE));
 343                 }
 344                 else if (target_type == TYPE_CHANNEL)
 345                 {
 346                         Channel* chan = (Channel*)dest;
 347                         BuildExemptList(msgtype, chan, user, exempt_list);
 348                 }
 349                 return MOD_RES_PASSTHRU;
 350         }
 351
 352         ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout) CXX11_OVERRIDE
 353         {
 354                 return MatchPattern(dest, source, SILENCE_INVITE);
 355         }
 356
 357         ModResult MatchPattern(User* dest, User* source, int pattern)
 358         {
 359                 if (ExemptULine && source->server->IsULine())
 360                         return MOD_RES_PASSTHRU;
 361
 362                 silencelist* sl = cmdsilence.ext.get(dest);
 363                 if (sl)
 364                 {
 365                         for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 366                         {
 367                                 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
 368                                         return (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
 369                         }
 370                 }
 371                 return MOD_RES_PASSTHRU;
 372         }
 373
 374         Version GetVersion() CXX11_OVERRIDE
 375         {
 376                 return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
 377         }
 378 };
 379
 380 MODULE_INIT(ModuleSilence)