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://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 #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, std::string src, std::string re, std::string regexs)
  36                 : XLine(Instance, s_time, d, src, re, "R")
  37         {
  38                 matchtext = regexs;
  39
  40                 if (!rxengine)
  41                 {
  42                         ServerInstance->SNO->WriteToSnoMask('x', "Cannot create regexes until engine is set to a loaded provider!");
  43                         throw ModuleException("Regex engine not set or loaded!");
  44                 }
  45
  46                 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
  47                  * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
  48                  */
  49                 regex = RegexFactoryRequest(mymodule, rxengine, regexs).Create();
  50         }
  51
  52         /** Destructor
  53          */
  54         ~RLine()
  55         {
  56                 delete regex;
  57         }
  58
  59         bool Matches(User *u)
  60         {
  61                 if (u->exempt)
  62                         return false;
  63
  64                 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
  65                 return regex->Matches(compare);
  66         }
  67
  68         bool Matches(const std::string &compare)
  69         {
  70                 return regex->Matches(compare);
  71         }
  72
  73         void Apply(User* u)
  74         {
  75                 DefaultApply(u, "R", true);
  76         }
  77
  78         void DisplayExpiry()
  79         {
  80                 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-Line %s (set by %s %ld seconds ago)",
  81                         this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
  82         }
  83
  84         const char* Displayable()
  85         {
  86                 return matchtext.c_str();
  87         }
  88
  89         std::string matchtext;
  90
  91         Regex *regex;
  92 };
  93
  94
  95 /** An XLineFactory specialized to generate RLine* pointers
  96  */
  97 class RLineFactory : public XLineFactory
  98 {
  99  public:
 100         RLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "R")
 101         {
 102         }
 103
 104         /** Generate a RLine
 105          */
 106         XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
 107         {
 108                 return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
 109         }
 110
 111         ~RLineFactory()
 112         {
 113         }
 114 };
 115
 116 /** Handle /RLINE
 117  * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
 118  */
 119 class CommandRLine : public Command
 120 {
 121         std::string rxengine;
 122
 123  public:
 124         CommandRLine (InspIRCd* Instance, Module* Creator) : Command(Instance, Creator,"RLINE", "o", 1, 3)
 125         {
 126                 this->syntax = "<regex> [<rline-duration>] :<reason>";
 127         }
 128
 129         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 130         {
 131
 132                 if (parameters.size() >= 3)
 133                 {
 134                         // Adding - XXX todo make this respect <insane> tag perhaps..
 135
 136                         long duration = ServerInstance->Duration(parameters[1]);
 137                         RLine *r = NULL;
 138
 139                         try
 140                         {
 141                                 r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 142                         }
 143                         catch (ModuleException &e)
 144                         {
 145                                 ServerInstance->SNO->WriteToSnoMask('x',"Could not add RLINE: %s", e.GetReason());
 146                         }
 147
 148                         if (r)
 149                         {
 150                                 if (ServerInstance->XLines->AddLine(r, user))
 151                                 {
 152                                         if (!duration)
 153                                         {
 154                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 155                                         }
 156                                         else
 157                                         {
 158                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 159                                                 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());
 160                                         }
 161
 162                                         ServerInstance->XLines->ApplyLines();
 163                                 }
 164                                 else
 165                                 {
 166                                         delete r;
 167                                         user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
 168                                 }
 169                         }
 170                 }
 171                 else
 172                 {
 173                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 174                         {
 175                                 ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
 176                         }
 177                         else
 178                         {
 179                                 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
 180                         }
 181                 }
 182
 183                 return CMD_SUCCESS;
 184         }
 185 };
 186
 187 class ModuleRLine : public Module
 188 {
 189  private:
 190         CommandRLine r;
 191         RLineFactory f;
 192         bool MatchOnNickChange;
 193         std::string RegexEngine;
 194
 195  public:
 196         ModuleRLine(InspIRCd* Me) : Module(Me), r(Me, this), f(Me)
 197         {
 198                 mymodule = this;
 199                 OnRehash(NULL);
 200
 201                 Me->Modules->UseInterface("RegularExpression");
 202
 203                 ServerInstance->AddCommand(&r);
 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)
 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