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 /* $ModDesc: Provides support for the /SILENCE command */
  27
  28 /* Improved drop-in replacement for the /SILENCE command
  29  * syntax: /SILENCE [+|-]<mask> <p|c|i|n|t|a|x> as in <privatemessage|channelmessage|invites|privatenotice|channelnotice|all|exclude>
  30  *
  31  * example that blocks all except private messages
  32  *  /SILENCE +*!*@* a
  33  *  /SILENCE +*!*@* px
  34  *
  35  * example that blocks all invites except from channel services
  36  *  /SILENCE +*!*@* i
  37  *  /SILENCE +chanserv!services@chatters.net ix
  38  *
  39  * example that blocks some bad dude from private, notice and inviting you
  40  *  /SILENCE +*!kiddie@lamerz.net pin
  41  *
  42  * TODO: possibly have add and remove check for existing host and only modify flags according to
  43  *       what's been changed instead of having to remove first, then add if you want to change
  44  *       an entry.
  45  */
  46
  47 // pair of hostmask and flags
  48 typedef std::pair<std::string, int> silenceset;
  49
  50 // deque list of pairs
  51 typedef std::deque<silenceset> silencelist;
  52
  53 // intmasks for flags
  54 static int SILENCE_PRIVATE      = 0x0001; /* p  private messages      */
  55 static int SILENCE_CHANNEL      = 0x0002; /* c  channel messages      */
  56 static int SILENCE_INVITE       = 0x0004; /* i  invites               */
  57 static int SILENCE_NOTICE       = 0x0008; /* n  notices               */
  58 static int SILENCE_CNOTICE      = 0x0010; /* t  channel notices       */
  59 static int SILENCE_ALL          = 0x0020; /* a  all, (pcint)          */
  60 static int SILENCE_EXCLUDE      = 0x0040; /* x  exclude this pattern  */
  61
  62
  63 class CommandSVSSilence : public Command
  64 {
  65  public:
  66         CommandSVSSilence(Module* Creator) : Command(Creator,"SVSSILENCE", 2)
  67         {
  68                 syntax = "<target> {[+|-]<mask> <p|c|i|n|t|a|x>}";
  69                 TRANSLATE4(TR_NICK, TR_TEXT, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
  70         }
  71
  72         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
  73         {
  74                 /*
  75                  * XXX: thought occurs to me
  76                  * We may want to change the syntax of this command to
  77                  * SVSSILENCE <flagsora+> +<nick> -<nick> +<nick>
  78                  * style command so services can modify lots of entries at once.
  79                  * leaving it backwards compatible for now as it's late. -- w
  80                  */
  81                 if (!ServerInstance->ULine(user->server))
  82                         return CMD_FAILURE;
  83
  84                 User *u = ServerInstance->FindNick(parameters[0]);
  85                 if (!u)
  86                         return CMD_FAILURE;
  87
  88                 if (IS_LOCAL(u))
  89                 {
  90                         ServerInstance->Parser->CallHandler("SILENCE", std::vector<std::string>(++parameters.begin(), parameters.end()), u);
  91                 }
  92
  93                 return CMD_SUCCESS;
  94         }
  95
  96         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
  97         {
  98                 User* target = ServerInstance->FindNick(parameters[0]);
  99                 if (target)
 100                         return ROUTE_OPT_UCAST(target->server);
 101                 return ROUTE_LOCALONLY;
 102         }
 103 };
 104
 105 class CommandSilence : public Command
 106 {
 107         unsigned int& maxsilence;
 108  public:
 109         SimpleExtItem<silencelist> ext;
 110         CommandSilence(Module* Creator, unsigned int &max) : Command(Creator, "SILENCE", 0),
 111                 maxsilence(max), ext("silence_list", Creator)
 112         {
 113                 allow_empty_last_param = false;
 114                 syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
 115                 TRANSLATE3(TR_TEXT, TR_TEXT, TR_END);
 116         }
 117
 118         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 119         {
 120                 if (!parameters.size())
 121                 {
 122                         // no parameters, show the current silence list.
 123                         silencelist* sl = ext.get(user);
 124                         // if the user has a silence list associated with their user record, show it
 125                         if (sl)
 126                         {
 127                                 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 128                                 {
 129                                         std::string decomppattern = DecompPattern(c->second);
 130                                         user->WriteNumeric(271, "%s %s %s %s",user->nick.c_str(), user->nick.c_str(),c->first.c_str(), decomppattern.c_str());
 131                                 }
 132                         }
 133                         user->WriteNumeric(272, "%s :End of Silence List",user->nick.c_str());
 134
 135                         return CMD_SUCCESS;
 136                 }
 137                 else if (parameters.size() > 0)
 138                 {
 139                         // one or more parameters, add or delete entry from the list (only the first parameter is used)
 140                         std::string mask = parameters[0].substr(1);
 141                         char action = parameters[0][0];
 142                         // Default is private and notice so clients do not break
 143                         int pattern = CompilePattern("pn");
 144
 145                         // if pattern supplied, use it
 146                         if (parameters.size() > 1) {
 147                                 pattern = CompilePattern(parameters[1].c_str());
 148                         }
 149
 150                         if (pattern == 0)
 151                         {
 152                                 user->WriteServ("NOTICE %s :Bad SILENCE pattern",user->nick.c_str());
 153                                 return CMD_INVALID;
 154                         }
 155
 156                         if (!mask.length())
 157                         {
 158                                 // 'SILENCE +' or 'SILENCE -', assume *!*@*
 159                                 mask = "*!*@*";
 160                         }
 161
 162                         ModeParser::CleanMask(mask);
 163
 164                         if (action == '-')
 165                         {
 166                                 std::string decomppattern = DecompPattern(pattern);
 167                                 // fetch their silence list
 168                                 silencelist* sl = ext.get(user);
 169                                 // does it contain any entries and does it exist?
 170                                 if (sl)
 171                                 {
 172                                         for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
 173                                         {
 174                                                 // search through for the item
 175                                                 irc::string listitem = i->first.c_str();
 176                                                 if (listitem == mask && i->second == pattern)
 177                                                 {
 178                                                         sl->erase(i);
 179                                                         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());
 180                                                         if (!sl->size())
 181                                                         {
 182                                                                 ext.unset(user);
 183                                                         }
 184                                                         return CMD_SUCCESS;
 185                                                 }
 186                                         }
 187                                 }
 188                                 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());
 189                         }
 190                         else if (action == '+')
 191                         {
 192                                 // fetch the user's current silence list
 193                                 silencelist* sl = ext.get(user);
 194                                 if (!sl)
 195                                 {
 196                                         sl = new silencelist;
 197                                         ext.set(user, sl);
 198                                 }
 199                                 if (sl->size() > maxsilence)
 200                                 {
 201                                         user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick.c_str(), user->nick.c_str());
 202                                         return CMD_FAILURE;
 203                                 }
 204
 205                                 std::string decomppattern = DecompPattern(pattern);
 206                                 for (silencelist::iterator n = sl->begin(); n != sl->end();  n++)
 207                                 {
 208                                         irc::string listitem = n->first.c_str();
 209                                         if (listitem == mask && n->second == pattern)
 210                                         {
 211                                                 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());
 212                                                 return CMD_FAILURE;
 213                                         }
 214                                 }
 215                                 if (((pattern & SILENCE_EXCLUDE) > 0))
 216                                 {
 217                                         sl->push_front(silenceset(mask,pattern));
 218                                 }
 219                                 else
 220                                 {
 221                                         sl->push_back(silenceset(mask,pattern));
 222                                 }
 223                                 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());
 224                                 return CMD_SUCCESS;
 225                         }
 226                 }
 227                 return CMD_SUCCESS;
 228         }
 229
 230         /* turn the nice human readable pattern into a mask */
 231         int CompilePattern(const char* pattern)
 232         {
 233                 int p = 0;
 234                 for (const char* n = pattern; *n; n++)
 235                 {
 236                         switch (*n)
 237                         {
 238                                 case 'p':
 239                                         p |= SILENCE_PRIVATE;
 240                                         break;
 241                                 case 'c':
 242                                         p |= SILENCE_CHANNEL;
 243                                         break;
 244                                 case 'i':
 245                                         p |= SILENCE_INVITE;
 246                                         break;
 247                                 case 'n':
 248                                         p |= SILENCE_NOTICE;
 249                                         break;
 250                                 case 't':
 251                                         p |= SILENCE_CNOTICE;
 252                                         break;
 253                                 case 'a':
 254                                 case '*':
 255                                         p |= SILENCE_ALL;
 256                                         break;
 257                                 case 'x':
 258                                         p |= SILENCE_EXCLUDE;
 259                                         break;
 260                                 default:
 261                                         break;
 262                         }
 263                 }
 264                 return p;
 265         }
 266
 267         /* turn the mask into a nice human readable format */
 268         std::string DecompPattern (const int pattern)
 269         {
 270                 std::string out;
 271                 if (pattern & SILENCE_PRIVATE)
 272                         out += ",privatemessages";
 273                 if (pattern & SILENCE_CHANNEL)
 274                         out += ",channelmessages";
 275                 if (pattern & SILENCE_INVITE)
 276                         out += ",invites";
 277                 if (pattern & SILENCE_NOTICE)
 278                         out += ",privatenotices";
 279                 if (pattern & SILENCE_CNOTICE)
 280                         out += ",channelnotices";
 281                 if (pattern & SILENCE_ALL)
 282                         out = ",all";
 283                 if (pattern & SILENCE_EXCLUDE)
 284                         out += ",exclude";
 285                 if (out.length())
 286                         return "<" + out.substr(1) + ">";
 287                 else
 288                         return "<none>";
 289         }
 290
 291 };
 292
 293 class ModuleSilence : public Module
 294 {
 295         unsigned int maxsilence;
 296         CommandSilence cmdsilence;
 297         CommandSVSSilence cmdsvssilence;
 298  public:
 299
 300         ModuleSilence()
 301                 : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
 302         {
 303         }
 304
 305         void init()
 306         {
 307                 OnRehash(NULL);
 308                 ServerInstance->Modules->AddService(cmdsilence);
 309                 ServerInstance->Modules->AddService(cmdsvssilence);
 310                 ServerInstance->Modules->AddService(cmdsilence.ext);
 311
 312                 Implementation eventlist[] = { I_OnRehash, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnUserPreInvite };
 313                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 314         }
 315
 316         void OnRehash(User* user)
 317         {
 318                 maxsilence = ServerInstance->Config->ConfValue("showwhois")->getInt("maxentries", 32);
 319                 if (!maxsilence)
 320                         maxsilence = 32;
 321         }
 322
 323         void On005Numeric(std::map<std::string, std::string>& tokens)
 324         {
 325                 tokens["ESILENCE"];
 326                 tokens["SILENCE"] = ConvToStr(maxsilence);
 327         }
 328
 329         void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
 330         {
 331                 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
 332                 const UserMembList *ulist = chan->GetUsers();
 333
 334                 for (UserMembCIter i = ulist->begin(); i != ulist->end(); i++)
 335                 {
 336                         if (IS_LOCAL(i->first))
 337                         {
 338                                 if (MatchPattern(i->first, sender, public_silence) == MOD_RES_DENY)
 339                                 {
 340                                         exempt_list.insert(i->first);
 341                                 }
 342                         }
 343                 }
 344         }
 345
 346         ModResult PreText(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
 347         {
 348                 if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
 349                 {
 350                         return MatchPattern((User*)dest, user, silence_type);
 351                 }
 352                 else if (target_type == TYPE_CHANNEL)
 353                 {
 354                         Channel* chan = (Channel*)dest;
 355                         if (chan)
 356                         {
 357                                 this->OnBuildExemptList((silence_type == SILENCE_PRIVATE ? MSG_PRIVMSG : MSG_NOTICE), chan, user, status, exempt_list, "");
 358                         }
 359                 }
 360                 return MOD_RES_PASSTHRU;
 361         }
 362
 363         ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 364         {
 365                 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_PRIVATE);
 366         }
 367
 368         ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 369         {
 370                 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_NOTICE);
 371         }
 372
 373         ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout)
 374         {
 375                 return MatchPattern(dest, source, SILENCE_INVITE);
 376         }
 377
 378         ModResult MatchPattern(User* dest, User* source, int pattern)
 379         {
 380                 /* Server source */
 381                 if (!source || !dest)
 382                         return MOD_RES_ALLOW;
 383
 384                 silencelist* sl = cmdsilence.ext.get(dest);
 385                 if (sl)
 386                 {
 387                         for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 388                         {
 389                                 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
 390                                         return (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
 391                         }
 392                 }
 393                 return MOD_RES_PASSTHRU;
 394         }
 395
 396         Version GetVersion()
 397         {
 398                 return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
 399         }
 400 };
 401
 402 MODULE_INIT(ModuleSilence)