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                 syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
 114                 TRANSLATE3(TR_TEXT, TR_TEXT, TR_END);
 115         }
 116
 117         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 118         {
 119                 if (!parameters.size())
 120                 {
 121                         // no parameters, show the current silence list.
 122                         silencelist* sl = ext.get(user);
 123                         // if the user has a silence list associated with their user record, show it
 124                         if (sl)
 125                         {
 126                                 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 127                                 {
 128                                         user->WriteNumeric(271, "%s %s %s %s",user->nick.c_str(), user->nick.c_str(),c->first.c_str(), DecompPattern(c->second).c_str());
 129                                 }
 130                         }
 131                         user->WriteNumeric(272, "%s :End of Silence List",user->nick.c_str());
 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].substr(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->WriteServ("NOTICE %s :Bad SILENCE pattern",user->nick.c_str());
 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                                 // fetch their silence list
 165                                 silencelist* sl = ext.get(user);
 166                                 // does it contain any entries and does it exist?
 167                                 if (sl)
 168                                 {
 169                                         for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
 170                                         {
 171                                                 // search through for the item
 172                                                 irc::string listitem = i->first.c_str();
 173                                                 if (listitem == mask && i->second == pattern)
 174                                                 {
 175                                                         sl->erase(i);
 176                                                         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());
 177                                                         if (!sl->size())
 178                                                         {
 179                                                                 ext.unset(user);
 180                                                         }
 181                                                         return CMD_SUCCESS;
 182                                                 }
 183                                         }
 184                                 }
 185                                 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());
 186                         }
 187                         else if (action == '+')
 188                         {
 189                                 // fetch the user's current silence list
 190                                 silencelist* sl = ext.get(user);
 191                                 if (!sl)
 192                                 {
 193                                         sl = new silencelist;
 194                                         ext.set(user, sl);
 195                                 }
 196                                 if (sl->size() > maxsilence)
 197                                 {
 198                                         user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick.c_str(), user->nick.c_str());
 199                                         return CMD_FAILURE;
 200                                 }
 201                                 for (silencelist::iterator n = sl->begin(); n != sl->end();  n++)
 202                                 {
 203                                         irc::string listitem = n->first.c_str();
 204                                         if (listitem == mask && n->second == pattern)
 205                                         {
 206                                                 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());
 207                                                 return CMD_FAILURE;
 208                                         }
 209                                 }
 210                                 if (((pattern & SILENCE_EXCLUDE) > 0))
 211                                 {
 212                                         sl->push_front(silenceset(mask,pattern));
 213                                 }
 214                                 else
 215                                 {
 216                                         sl->push_back(silenceset(mask,pattern));
 217                                 }
 218                                 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());
 219                                 return CMD_SUCCESS;
 220                         }
 221                 }
 222                 return CMD_SUCCESS;
 223         }
 224
 225         /* turn the nice human readable pattern into a mask */
 226         int CompilePattern(const char* pattern)
 227         {
 228                 int p = 0;
 229                 for (const char* n = pattern; *n; n++)
 230                 {
 231                         switch (*n)
 232                         {
 233                                 case 'p':
 234                                         p |= SILENCE_PRIVATE;
 235                                         break;
 236                                 case 'c':
 237                                         p |= SILENCE_CHANNEL;
 238                                         break;
 239                                 case 'i':
 240                                         p |= SILENCE_INVITE;
 241                                         break;
 242                                 case 'n':
 243                                         p |= SILENCE_NOTICE;
 244                                         break;
 245                                 case 't':
 246                                         p |= SILENCE_CNOTICE;
 247                                         break;
 248                                 case 'a':
 249                                 case '*':
 250                                         p |= SILENCE_ALL;
 251                                         break;
 252                                 case 'x':
 253                                         p |= SILENCE_EXCLUDE;
 254                                         break;
 255                                 default:
 256                                         break;
 257                         }
 258                 }
 259                 return p;
 260         }
 261
 262         /* turn the mask into a nice human readable format */
 263         std::string DecompPattern (const int pattern)
 264         {
 265                 std::string out;
 266                 if (pattern & SILENCE_PRIVATE)
 267                         out += ",privatemessages";
 268                 if (pattern & SILENCE_CHANNEL)
 269                         out += ",channelmessages";
 270                 if (pattern & SILENCE_INVITE)
 271                         out += ",invites";
 272                 if (pattern & SILENCE_NOTICE)
 273                         out += ",privatenotices";
 274                 if (pattern & SILENCE_CNOTICE)
 275                         out += ",channelnotices";
 276                 if (pattern & SILENCE_ALL)
 277                         out = ",all";
 278                 if (pattern & SILENCE_EXCLUDE)
 279                         out += ",exclude";
 280                 if (out.length())
 281                         return "<" + out.substr(1) + ">";
 282                 else
 283                         return "<none>";
 284         }
 285
 286 };
 287
 288 class ModuleSilence : public Module
 289 {
 290         unsigned int maxsilence;
 291         CommandSilence cmdsilence;
 292         CommandSVSSilence cmdsvssilence;
 293  public:
 294
 295         ModuleSilence()
 296                 : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
 297         {
 298                 OnRehash(NULL);
 299                 ServerInstance->AddCommand(&cmdsilence);
 300                 ServerInstance->AddCommand(&cmdsvssilence);
 301                 ServerInstance->Extensions.Register(&cmdsilence.ext);
 302
 303                 Implementation eventlist[] = { I_OnRehash, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnUserPreInvite };
 304                 ServerInstance->Modules->Attach(eventlist, this, 5);
 305         }
 306
 307         void OnRehash(User* user)
 308         {
 309                 ConfigReader Conf;
 310                 maxsilence = Conf.ReadInteger("silence", "maxentries", 0, true);
 311                 if (!maxsilence)
 312                         maxsilence = 32;
 313         }
 314
 315         void On005Numeric(std::string &output)
 316         {
 317                 // we don't really have a limit...
 318                 output = output + " ESILENCE SILENCE=" + ConvToStr(maxsilence);
 319         }
 320
 321         void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
 322         {
 323                 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
 324                 const UserMembList *ulist = chan->GetUsers();
 325
 326                 for (UserMembCIter 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 PreText(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
 339         {
 340                 if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
 341                 {
 342                         return MatchPattern((User*)dest, user, silence_type);
 343                 }
 344                 else if (target_type == TYPE_CHANNEL)
 345                 {
 346                         Channel* chan = (Channel*)dest;
 347                         if (chan)
 348                         {
 349                                 this->OnBuildExemptList((silence_type == SILENCE_PRIVATE ? MSG_PRIVMSG : MSG_NOTICE), chan, user, status, exempt_list, "");
 350                         }
 351                 }
 352                 return MOD_RES_PASSTHRU;
 353         }
 354
 355         ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 356         {
 357                 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_PRIVATE);
 358         }
 359
 360         ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 361         {
 362                 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_NOTICE);
 363         }
 364
 365         ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout)
 366         {
 367                 return MatchPattern(dest, source, SILENCE_INVITE);
 368         }
 369
 370         ModResult MatchPattern(User* dest, User* source, int pattern)
 371         {
 372                 /* Server source */
 373                 if (!source || !dest)
 374                         return MOD_RES_ALLOW;
 375
 376                 silencelist* sl = cmdsilence.ext.get(dest);
 377                 if (sl)
 378                 {
 379                         for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 380                         {
 381                                 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
 382                                         return (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
 383                         }
 384                 }
 385                 return MOD_RES_PASSTHRU;
 386         }
 387
 388         ~ModuleSilence()
 389         {
 390         }
 391
 392         Version GetVersion()
 393         {
 394                 return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
 395         }
 396 };
 397
 398 MODULE_INIT(ModuleSilence)