src/modules/m_rline.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 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',"Expiring timed R-Line %s (set by %s %ld seconds ago)", this->matchtext.c_str(), this->source, this->duration);
  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.", user->nick.c_str(), parameters[0].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", user->nick.c_str(), parameters[0].c_str(),
 156                                                                 ServerInstance->TimeString(c_requires_crap).c_str());
 157                                         }
 158
 159                                         ServerInstance->XLines->ApplyLines();
 160                                 }
 161                                 else
 162                                 {
 163                                         delete r;
 164                                         user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
 165                                 }
 166                         }
 167                 }
 168                 else
 169                 {
 170                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 171                         {
 172                                 ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
 173                         }
 174                         else
 175                         {
 176                                 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
 177                         }
 178                 }
 179
 180                 return CMD_SUCCESS;
 181         }
 182 };
 183
 184 class ModuleRLine : public Module
 185 {
 186  private:
 187         CommandRLine *r;
 188         RLineFactory *f;
 189         bool MatchOnNickChange;
 190         std::string RegexEngine;
 191
 192  public:
 193         ModuleRLine(InspIRCd* Me) : Module(Me)
 194         {
 195                 mymodule = this;
 196                 OnRehash(NULL, "");
 197
 198                 Me->Modules->UseInterface("RegularExpression");
 199
 200                 // Create a new command
 201                 r = new CommandRLine(ServerInstance);
 202                 ServerInstance->AddCommand(r);
 203
 204                 f = new RLineFactory(ServerInstance);
 205                 ServerInstance->XLines->RegisterFactory(f);
 206
 207                 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule, I_OnStats };
 208                 ServerInstance->Modules->Attach(eventlist, this, 5);
 209
 210         }
 211
 212         virtual ~ModuleRLine()
 213         {
 214                 ServerInstance->Modules->DoneWithInterface("RegularExpression");
 215                 ServerInstance->XLines->DelAll("R");
 216                 ServerInstance->XLines->UnregisterFactory(f);
 217         }
 218
 219         virtual Version GetVersion()
 220         {
 221                 return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
 222         }
 223
 224         virtual void OnUserConnect(User* user)
 225         {
 226                 // Apply lines on user connect
 227                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 228
 229                 if (rl)
 230                 {
 231                         // Bang. :P
 232                         rl->Apply(user);
 233                 }
 234         }
 235
 236         virtual void OnRehash(User *user, const std::string &parameter)
 237         {
 238                 ConfigReader Conf(ServerInstance);
 239
 240                 MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
 241                 std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
 242
 243                 if (!RegexEngine.empty())
 244                 {
 245                         if (RegexEngine == newrxengine)
 246                                 return;
 247
 248                         ServerInstance->SNO->WriteToSnoMask('x', "Dumping all R-Lines due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
 249                         ServerInstance->XLines->DelAll("R");
 250                 }
 251                 rxengine = 0;
 252                 RegexEngine = newrxengine;
 253                 modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
 254                 if (ml)
 255                 {
 256                         for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
 257                         {
 258                                 if (RegexNameRequest(this, *i).Send() == newrxengine)
 259                                 {
 260                                         ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
 261                                         rxengine = *i;
 262                                 }
 263                         }
 264                 }
 265                 if (!rxengine)
 266                 {
 267                         ServerInstance->SNO->WriteToSnoMask('x', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
 268                 }
 269         }
 270
 271         virtual int OnStats(char symbol, User* user, string_list &results)
 272         {
 273                 if (symbol != 'R')
 274                         return 0;
 275
 276                 ServerInstance->XLines->InvokeStats("R", 223, user, results);
 277                 return 1;
 278         }
 279
 280         virtual void OnLoadModule(Module* mod, const std::string& name)
 281         {
 282                 if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
 283                 {
 284                         std::string rxname = RegexNameRequest(this, mod).Send();
 285                         if (rxname == RegexEngine)
 286                         {
 287                                 ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
 288                                 rxengine = mod;
 289                         }
 290                 }
 291         }
 292
 293         virtual void OnUserPostNick(User *user, const std::string &oldnick)
 294         {
 295                 if (!IS_LOCAL(user))
 296                         return;
 297
 298                 if (!MatchOnNickChange)
 299                         return;
 300
 301                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 302
 303                 if (rl)
 304                 {
 305                         // Bang! :D
 306                         rl->Apply(user);
 307                 }
 308         }
 309
 310 };
 311
 312 MODULE_INIT(ModuleRLine)
 313