src/modules/m_rline.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 /* $ModDesc: RLINE: Regexp user banning. */
  24
  25 #include "inspircd.h"
  26 #include "m_regex.h"
  27 #include "xline.h"
  28
  29 static bool ZlineOnMatch = false;
  30 static bool added_zline = false;
  31
  32 class RLine : public XLine
  33 {
  34  public:
  35
  36         /** Create a R-Line.
  37          * @param s_time The set time
  38          * @param d The duration of the xline
  39          * @param src The sender of the xline
  40          * @param re The reason of the xline
  41          * @param regex Pattern to match with
  42          * @
  43          */
  44         RLine(time_t s_time, long d, std::string src, std::string re, std::string regexs, dynamic_reference<RegexFactory>& rxfactory)
  45                 : XLine(s_time, d, src, re, "R")
  46         {
  47                 matchtext = regexs;
  48
  49                 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
  50                  * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
  51                  */
  52                 regex = rxfactory->Create(regexs);
  53         }
  54
  55         /** Destructor
  56          */
  57         ~RLine()
  58         {
  59                 delete regex;
  60         }
  61
  62         bool Matches(User *u)
  63         {
  64                 if (u->exempt)
  65                         return false;
  66
  67                 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
  68                 return regex->Matches(compare);
  69         }
  70
  71         bool Matches(const std::string &compare)
  72         {
  73                 return regex->Matches(compare);
  74         }
  75
  76         void Apply(User* u)
  77         {
  78                 if (ZlineOnMatch)
  79                 {
  80                         ZLine* zl = new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, ServerInstance->Config->ServerName.c_str(), reason.c_str(), u->GetIPString());
  81                         if (ServerInstance->XLines->AddLine(zl, NULL))
  82                         {
  83                                 ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on *@%s%s%s: %s",
  84                                         zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? ServerInstance->TimeString(zl->expiry).c_str() : "", zl->reason.c_str());
  85                                 added_zline = true;
  86                         }
  87                         else
  88                                 delete zl;
  89                 }
  90                 DefaultApply(u, "R", false);
  91         }
  92
  93         void DisplayExpiry()
  94         {
  95                 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-line %s (set by %s %ld seconds ago)",
  96                         this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
  97         }
  98
  99         const char* Displayable()
 100         {
 101                 return matchtext.c_str();
 102         }
 103
 104         std::string matchtext;
 105
 106         Regex *regex;
 107 };
 108
 109
 110 /** An XLineFactory specialized to generate RLine* pointers
 111  */
 112 class RLineFactory : public XLineFactory
 113 {
 114  public:
 115         dynamic_reference<RegexFactory>& rxfactory;
 116         RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
 117         {
 118         }
 119
 120         /** Generate a RLine
 121          */
 122         XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
 123         {
 124                 if (!rxfactory)
 125                 {
 126                         ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
 127                         throw ModuleException("Regex engine not set or loaded!");
 128                 }
 129
 130                 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
 131         }
 132
 133         ~RLineFactory()
 134         {
 135         }
 136 };
 137
 138 /** Handle /RLINE
 139  * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
 140  */
 141 class CommandRLine : public Command
 142 {
 143         std::string rxengine;
 144         RLineFactory& factory;
 145
 146  public:
 147         CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
 148         {
 149                 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
 150         }
 151
 152         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 153         {
 154
 155                 if (parameters.size() >= 3)
 156                 {
 157                         // Adding - XXX todo make this respect <insane> tag perhaps..
 158
 159                         long duration = ServerInstance->Duration(parameters[1]);
 160                         XLine *r = NULL;
 161
 162                         try
 163                         {
 164                                 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 165                         }
 166                         catch (ModuleException &e)
 167                         {
 168                                 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
 169                         }
 170
 171                         if (r)
 172                         {
 173                                 if (ServerInstance->XLines->AddLine(r, user))
 174                                 {
 175                                         if (!duration)
 176                                         {
 177                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 178                                         }
 179                                         else
 180                                         {
 181                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 182                                                 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-line for %s to expire on %s: %s", user->nick.c_str(), parameters[0].c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), parameters[2].c_str());
 183                                         }
 184
 185                                         ServerInstance->XLines->ApplyLines();
 186                                 }
 187                                 else
 188                                 {
 189                                         delete r;
 190                                         user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
 191                                 }
 192                         }
 193                 }
 194                 else
 195                 {
 196                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 197                         {
 198                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
 199                         }
 200                         else
 201                         {
 202                                 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
 203                         }
 204                 }
 205
 206                 return CMD_SUCCESS;
 207         }
 208
 209         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 210         {
 211                 return ROUTE_LOCALONLY;
 212         }
 213 };
 214
 215 class ModuleRLine : public Module
 216 {
 217  private:
 218         dynamic_reference<RegexFactory> rxfactory;
 219         RLineFactory f;
 220         CommandRLine r;
 221         bool MatchOnNickChange;
 222
 223  public:
 224         ModuleRLine() : rxfactory(this, "regex"), f(rxfactory), r(this, f)
 225         {
 226         }
 227
 228         void init()
 229         {
 230                 OnRehash(NULL);
 231
 232                 ServerInstance->AddCommand(&r);
 233                 ServerInstance->XLines->RegisterFactory(&f);
 234
 235                 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer };
 236                 ServerInstance->Modules->Attach(eventlist, this, 5);
 237         }
 238
 239         virtual ~ModuleRLine()
 240         {
 241                 ServerInstance->XLines->DelAll("R");
 242                 ServerInstance->XLines->UnregisterFactory(&f);
 243         }
 244
 245         virtual Version GetVersion()
 246         {
 247                 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
 248         }
 249
 250         virtual void OnUserConnect(LocalUser* user)
 251         {
 252                 // Apply lines on user connect
 253                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 254
 255                 if (rl)
 256                 {
 257                         // Bang. :P
 258                         rl->Apply(user);
 259                 }
 260         }
 261
 262         virtual void OnRehash(User *user)
 263         {
 264                 ConfigReader Conf;
 265
 266                 MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
 267                 ZlineOnMatch = Conf.ReadFlag("rline", "zlineonmatch", 0);
 268                 std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
 269
 270                 if (newrxengine.empty())
 271                         rxfactory.SetProvider("regex");
 272                 else
 273                         rxfactory.SetProvider("regex/" + newrxengine);
 274                 if (!rxfactory)
 275                 {
 276                         ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
 277                 }
 278         }
 279
 280         virtual ModResult OnStats(char symbol, User* user, string_list &results)
 281         {
 282                 if (symbol != 'R')
 283                         return MOD_RES_PASSTHRU;
 284
 285                 ServerInstance->XLines->InvokeStats("R", 223, user, results);
 286                 return MOD_RES_DENY;
 287         }
 288
 289         virtual void OnUserPostNick(User *user, const std::string &oldnick)
 290         {
 291                 if (!IS_LOCAL(user))
 292                         return;
 293
 294                 if (!MatchOnNickChange)
 295                         return;
 296
 297                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 298
 299                 if (rl)
 300                 {
 301                         // Bang! :D
 302                         rl->Apply(user);
 303                 }
 304         }
 305
 306         virtual void OnBackgroundTimer(time_t curtime)
 307         {
 308                 if (added_zline)
 309                 {
 310                         added_zline = false;
 311                         ServerInstance->XLines->ApplyLines();
 312                 }
 313         }
 314
 315 };
 316
 317 MODULE_INIT(ModuleRLine)