src/modules/m_silence_ext.cpp

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