src/modules/m_rline.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 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 "inspircd.h"
  15 #include "m_regex.h"
  16 #include "xline.h"
  17
  18 static Module* rxengine = NULL;
  19 static Module* mymodule = NULL; /* Needed to let RLine send request! */
  20
  21 /* $ModDesc: RLINE: Regexp user banning. */
  22
  23 class RLine : public XLine
  24 {
  25  public:
  26
  27         /** Create a R-Line.
  28          * @param s_time The set time
  29          * @param d The duration of the xline
  30          * @param src The sender of the xline
  31          * @param re The reason of the xline
  32          * @param regex Pattern to match with
  33          * @
  34          */
  35         RLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* regexs) : XLine(Instance, s_time, d, src, re, "R")
  36         {
  37                 matchtext = regexs;
  38
  39                 if (!rxengine)
  40                 {
  41                         ServerInstance->SNO->WriteToSnoMask('x', "Cannot create regexes until engine is set to a loaded provider!");
  42                         throw ModuleException("Regex engine not set or loaded!");
  43                 }
  44
  45                 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
  46                  * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
  47                  */
  48                 regex = RegexFactoryRequest(mymodule, rxengine, regexs).Create();
  49         }
  50
  51         /** Destructor
  52          */
  53         ~RLine()
  54         {
  55                 delete regex;
  56         }
  57
  58         bool Matches(User *u)
  59         {
  60                 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
  61                 return regex->Matches(compare);
  62         }
  63
  64         bool Matches(const std::string &compare)
  65         {
  66                 return regex->Matches(compare);
  67         }
  68
  69         void Apply(User* u)
  70         {
  71                 DefaultApply(u, "R", true);
  72         }
  73
  74         void DisplayExpiry()
  75         {
  76                 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-Line %s (set by %s %ld seconds ago)", this->matchtext.c_str(), this->source, (long int)(ServerInstance->Time() - this->set_time));
  77         }
  78
  79         const char* Displayable()
  80         {
  81                 return matchtext.c_str();
  82         }
  83
  84         std::string matchtext;
  85
  86         Regex *regex;
  87 };
  88
  89
  90 /** An XLineFactory specialized to generate RLine* pointers
  91  */
  92 class RLineFactory : public XLineFactory
  93 {
  94  public:
  95         RLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "R")
  96         {
  97         }
  98
  99         /** Generate a RLine
 100          */
 101         XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
 102         {
 103                 return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
 104         }
 105
 106         ~RLineFactory()
 107         {
 108         }
 109 };
 110
 111 /** Handle /RLINE
 112  * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
 113  */
 114 class CommandRLine : public Command
 115 {
 116         std::string rxengine;
 117
 118  public:
 119         CommandRLine (InspIRCd* Instance) : Command(Instance,"RLINE", "o", 1, 3)
 120         {
 121                 this->source = "m_rline.so";
 122                 this->syntax = "<regex> [<rline-duration>] :<reason>";
 123         }
 124
 125         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 126         {
 127
 128                 if (parameters.size() >= 3)
 129                 {
 130                         // Adding - XXX todo make this respect <insane> tag perhaps..
 131
 132                         long duration = ServerInstance->Duration(parameters[1]);
 133                         RLine *r = NULL;
 134
 135                         try
 136                         {
 137                                 r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 138                         }
 139                         catch (ModuleException &e)
 140                         {
 141                                 ServerInstance->SNO->WriteToSnoMask('x',"Could not add RLINE: %s", e.GetReason());
 142                         }
 143
 144                         if (r)
 145                         {
 146                                 if (ServerInstance->XLines->AddLine(r, user))
 147                                 {
 148                                         if (!duration)
 149                                         {
 150                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 151                                         }
 152                                         else
 153                                         {
 154                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 155                                                 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-Line for %s, expires on %s: %s", user->nick.c_str(), parameters[0].c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), parameters[2].c_str());
 156                                         }
 157
 158                                         ServerInstance->XLines->ApplyLines();
 159                                 }
 160                                 else
 161                                 {
 162                                         delete r;
 163                                         user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
 164                                 }
 165                         }
 166                 }
 167                 else
 168                 {
 169                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 170                         {
 171                                 ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
 172                         }
 173                         else
 174                         {
 175                                 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
 176                         }
 177                 }
 178
 179                 return CMD_SUCCESS;
 180         }
 181 };
 182
 183 class ModuleRLine : public Module
 184 {
 185  private:
 186         CommandRLine *r;
 187         RLineFactory *f;
 188         bool MatchOnNickChange;
 189         std::string RegexEngine;
 190
 191  public:
 192         ModuleRLine(InspIRCd* Me) : Module(Me)
 193         {
 194                 mymodule = this;
 195                 OnRehash(NULL, "");
 196
 197                 Me->Modules->UseInterface("RegularExpression");
 198
 199                 // Create a new command
 200                 r = new CommandRLine(ServerInstance);
 201                 ServerInstance->AddCommand(r);
 202
 203                 f = new RLineFactory(ServerInstance);
 204                 ServerInstance->XLines->RegisterFactory(f);
 205
 206                 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule, I_OnStats };
 207                 ServerInstance->Modules->Attach(eventlist, this, 5);
 208
 209         }
 210
 211         virtual ~ModuleRLine()
 212         {
 213                 ServerInstance->Modules->DoneWithInterface("RegularExpression");
 214                 ServerInstance->XLines->DelAll("R");
 215                 ServerInstance->XLines->UnregisterFactory(f);
 216         }
 217
 218         virtual Version GetVersion()
 219         {
 220                 return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
 221         }
 222
 223         virtual void OnUserConnect(User* user)
 224         {
 225                 // Apply lines on user connect
 226                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 227
 228                 if (rl)
 229                 {
 230                         // Bang. :P
 231                         rl->Apply(user);
 232                 }
 233         }
 234
 235         virtual void OnRehash(User *user, const std::string &parameter)
 236         {
 237                 ConfigReader Conf(ServerInstance);
 238
 239                 MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
 240                 std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
 241
 242                 if (!RegexEngine.empty())
 243                 {
 244                         if (RegexEngine == newrxengine)
 245                                 return;
 246
 247                         ServerInstance->SNO->WriteToSnoMask('x', "Dumping all R-Lines due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
 248                         ServerInstance->XLines->DelAll("R");
 249                 }
 250                 rxengine = 0;
 251                 RegexEngine = newrxengine;
 252                 modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
 253                 if (ml)
 254                 {
 255                         for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
 256                         {
 257                                 if (RegexNameRequest(this, *i).Send() == newrxengine)
 258                                 {
 259                                         ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
 260                                         rxengine = *i;
 261                                 }
 262                         }
 263                 }
 264                 if (!rxengine)
 265                 {
 266                         ServerInstance->SNO->WriteToSnoMask('x', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
 267                 }
 268         }
 269
 270         virtual int OnStats(char symbol, User* user, string_list &results)
 271         {
 272                 if (symbol != 'R')
 273                         return 0;
 274
 275                 ServerInstance->XLines->InvokeStats("R", 223, user, results);
 276                 return 1;
 277         }
 278
 279         virtual void OnLoadModule(Module* mod, const std::string& name)
 280         {
 281                 if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
 282                 {
 283                         std::string rxname = RegexNameRequest(this, mod).Send();
 284                         if (rxname == RegexEngine)
 285                         {
 286                                 ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
 287                                 rxengine = mod;
 288                         }
 289                 }
 290         }
 291
 292         virtual void OnUserPostNick(User *user, const std::string &oldnick)
 293         {
 294                 if (!IS_LOCAL(user))
 295                         return;
 296
 297                 if (!MatchOnNickChange)
 298                         return;
 299
 300                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 301
 302                 if (rl)
 303                 {
 304                         // Bang! :D
 305                         rl->Apply(user);
 306                 }
 307         }
 308
 309 };
 310
 311 MODULE_INIT(ModuleRLine)
 312