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                                         if (sl->size())
 121                                         {
 122                                                 for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
 123                                                 {
 124                                                         // search through for the item
 125                                                         irc::string listitem = i->first.c_str();
 126                                                         if (listitem == mask && i->second == pattern)
 127                                                         {
 128                                                                 sl->erase(i);
 129                                                                 user->WriteServ("950 %s %s :Removed %s %s from silence list",user->nick, user->nick, mask.c_str(), DecompPattern(pattern).c_str());
 130                                                                 break;
 131                                                         }
 132                                                 }
 133                                         }
 134                                         else
 135                                         {
 136                                                 // tidy up -- if a user's list is empty, theres no use having it
 137                                                 // hanging around in the user record.
 138                                                 DELETE(sl);
 139                                                 user->Shrink("silence_list");
 140                                         }
 141                                 }
 142                         }
 143                         else if (action == '+')
 144                         {
 145                                 // fetch the user's current silence list
 146                                 silencelist* sl;
 147                                 user->GetExt("silence_list", sl);
 148                                 // what, they dont have one??? WE'RE ALL GONNA DIE! ...no, we just create an empty one.
 149                                 if (!sl)
 150                                 {
 151                                         sl = new silencelist;
 152                                         user->Extend("silence_list", sl);
 153                                 }
 154                                 for (silencelist::iterator n = sl->begin(); n != sl->end();  n++)
 155                                 {
 156                                         irc::string listitem = n->first.c_str();
 157                                         if (listitem == mask && n->second == pattern)
 158                                         {
 159                                                 user->WriteServ("952 %s %s :%s %s is already on your silence list",user->nick, user->nick, mask.c_str(), DecompPattern(pattern).c_str());
 160                                                 return CMD_SUCCESS;
 161                                         }
 162                                 }
 163                                 if (((pattern & SILENCE_EXCLUDE) > 0))
 164                                 {
 165                                         sl->push_front(silenceset(mask,pattern));
 166                                 }
 167                                 else
 168                                 {
 169                                         sl->push_back(silenceset(mask,pattern));
 170                                 }
 171                                 user->WriteServ("951 %s %s :Added %s %s to silence list",user->nick, user->nick, mask.c_str(), DecompPattern(pattern).c_str());
 172                                 return CMD_SUCCESS;
 173                         }
 174                 }
 175                 return CMD_SUCCESS;
 176         }
 177
 178         /* turn the nice human readable pattern into a mask */
 179         int CompilePattern(const char* pattern)
 180         {
 181                 int p = 0;
 182                 for (const char* n = pattern; *n; n++)
 183                 {
 184                         switch (*n)
 185                         {
 186                                 case 'p':
 187                                         p |= SILENCE_PRIVATE;
 188                                         break;
 189                                 case 'c':
 190                                         p |= SILENCE_CHANNEL;
 191                                         break;
 192                                 case 'i':
 193                                         p |= SILENCE_INVITE;
 194                                         break;
 195                                 case 'n':
 196                                         p |= SILENCE_NOTICE;
 197                                         break;
 198                                 case 't':
 199                                         p |= SILENCE_CNOTICE;
 200                                         break;
 201                                 case 'a':
 202                                         p |= SILENCE_ALL;
 203                                         break;
 204                                 case 'x':
 205                                         p |= SILENCE_EXCLUDE;
 206                                         break;
 207                                 default:
 208                                         break;
 209                         }
 210                 }
 211                 return p;
 212         }
 213
 214         /* turn the mask into a nice human readable format */
 215         std::string DecompPattern (const int pattern)
 216         {
 217                 std::string out;
 218                 if ((pattern & SILENCE_PRIVATE) > 0)
 219                         out += ",privatemessages";
 220                 if ((pattern & SILENCE_CHANNEL) > 0)
 221                         out += ",channelmessages";
 222                 if ((pattern & SILENCE_INVITE) > 0)
 223                         out += ",invites";
 224                 if ((pattern & SILENCE_NOTICE) > 0)
 225                         out += ",privatenotices";
 226                 if ((pattern & SILENCE_CNOTICE) > 0)
 227                         out += ",channelnotices";
 228                 if ((pattern & SILENCE_ALL) > 0)
 229                         out = ",all";
 230                 if ((pattern & SILENCE_EXCLUDE) > 0)
 231                         out += ",exclude";
 232                 return "<" + out.substr(1) + ">";
 233         }
 234
 235 };
 236
 237 class ModuleSilence : public Module
 238 {
 239
 240         cmd_silence* mycommand;
 241  public:
 242
 243         ModuleSilence(InspIRCd* Me)
 244                 : Module::Module(Me)
 245         {
 246
 247                 mycommand = new cmd_silence(ServerInstance);
 248                 ServerInstance->AddCommand(mycommand);
 249         }
 250
 251         void Implements(char* List)
 252         {
 253                 List[I_OnBuildExemptList] = List[I_OnUserQuit] = List[I_On005Numeric] = List[I_OnUserPreNotice] = List[I_OnUserPreMessage] = List[I_OnUserPreInvite] = 1;
 254         }
 255
 256         virtual void OnUserQuit(userrec* user, const std::string &reason)
 257         {
 258                 // when the user quits tidy up any silence list they might have just to keep things tidy
 259                 silencelist* sl;
 260                 user->GetExt("silence_list", sl);
 261                 if (sl)
 262                 {
 263                         DELETE(sl);
 264                         user->Shrink("silence_list");
 265                 }
 266         }
 267
 268         virtual void On005Numeric(std::string &output)
 269         {
 270                 // we don't really have a limit...
 271                 output = output + " ESILENCE SILENCE=999";
 272         }
 273
 274         virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list)
 275         {
 276                 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
 277                 CUList *ulist;
 278                 switch (status)
 279                 {
 280                         case '@':
 281                                 ulist = chan->GetOppedUsers();
 282                                 break;
 283                         case '%':
 284                                 ulist = chan->GetHalfoppedUsers();
 285                                 break;
 286                         case '+':
 287                                 ulist = chan->GetVoicedUsers();
 288                                 break;
 289                         default:
 290                                 ulist = chan->GetUsers();
 291                                 break;
 292                 }
 293
 294                 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
 295                 {
 296                         if (IS_LOCAL(i->second))
 297                         {
 298                                 if (MatchPattern(i->second, sender, public_silence) == 1)
 299                                 {
 300                                         exempt_list[i->second] = i->second;
 301                                 }
 302                         }
 303                 }
 304         }
 305
 306         virtual int PreText(userrec* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
 307         {
 308                 if (!IS_LOCAL(user))
 309                         return 0;
 310
 311                 if (target_type == TYPE_USER)
 312                 {
 313                         return MatchPattern((userrec*)dest, user, silence_type);
 314                 }
 315                 else if (target_type == TYPE_CHANNEL)
 316                 {
 317                         chanrec* chan = (chanrec*)dest;
 318                         if (chan)
 319                         {
 320                                 this->OnBuildExemptList((silence_type == SILENCE_PRIVATE ? MSG_PRIVMSG : MSG_NOTICE), chan, user, status, exempt_list);
 321                         }
 322                 }
 323                 return 0;
 324         }
 325
 326         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 327         {
 328                 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_PRIVATE);
 329         }
 330
 331         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 332         {
 333                 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_NOTICE);
 334         }
 335
 336         virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel)
 337         {
 338                 return MatchPattern(dest, source, SILENCE_INVITE);
 339         }
 340
 341         int MatchPattern(userrec* dest, userrec* source, int pattern)
 342         {
 343                 silencelist* sl;
 344                 dest->GetExt("silence_list", sl);
 345                 if (sl)
 346                 {
 347                         for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
 348                         {
 349                                 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (ServerInstance->MatchText(source->GetFullHost(), c->first)))
 350                                         return !(((c->second & SILENCE_EXCLUDE) > 0));
 351                         }
 352                 }
 353                 return 0;
 354         }
 355
 356         virtual ~ModuleSilence()
 357         {
 358         }
 359
 360         virtual Version GetVersion()
 361         {
 362                 return Version(1,1,0,1,VF_VENDOR,API_VERSION);
 363         }
 364 };
 365
 366
 367 class ModuleSilenceFactory : public ModuleFactory
 368 {
 369  public:
 370         ModuleSilenceFactory()
 371         {
 372         }
 373
 374         ~ModuleSilenceFactory()
 375         {
 376         }
 377
 378         virtual Module * CreateModule(InspIRCd* Me)
 379         {
 380                 return new ModuleSilence(Me);
 381         }
 382
 383 };
 384
 385
 386 extern "C" void * init_module( void )
 387 {
 388         return new ModuleSilenceFactory;
 389 }
 390