src/modules/m_silence.cpp

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