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 #include "inspircd.h"
  24 #include "modules/regex.h"
  25 #include "modules/stats.h"
  26 #include "xline.h"
  27
  28 static bool ZlineOnMatch = false;
  29 static bool added_zline = false;
  30
  31 class RLine : public XLine
  32 {
  33  public:
  34
  35         /** Create a R-Line.
  36          * @param s_time The set time
  37          * @param d The duration of the xline
  38          * @param src The sender of the xline
  39          * @param re The reason of the xline
  40          * @param regex Pattern to match with
  41          * @
  42          */
  43         RLine(time_t s_time, long d, const std::string& src, const std::string& re, const std::string& regexs, dynamic_reference<RegexFactory>& rxfactory)
  44                 : XLine(s_time, d, src, re, "R")
  45                 , matchtext(regexs)
  46         {
  47                 /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
  48                  * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
  49                  */
  50                 regex = rxfactory->Create(regexs);
  51         }
  52
  53         /** Destructor
  54          */
  55         ~RLine()
  56         {
  57                 delete regex;
  58         }
  59
  60         bool Matches(User* u) CXX11_OVERRIDE
  61         {
  62                 LocalUser* lu = IS_LOCAL(u);
  63                 if (lu && lu->exempt)
  64                         return false;
  65
  66                 const std::string host = u->nick + "!" + u->ident + "@" + u->GetRealHost() + " " + u->GetRealName();
  67                 const std::string ip = u->nick + "!" + u->ident + "@" + u->GetIPString() + " " + u->GetRealName();
  68                 return (regex->Matches(host) || regex->Matches(ip));
  69         }
  70
  71         bool Matches(const std::string& compare) CXX11_OVERRIDE
  72         {
  73                 return regex->Matches(compare);
  74         }
  75
  76         void Apply(User* u) CXX11_OVERRIDE
  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                                 std::string timestr = InspIRCd::TimeString(zl->expiry);
  84                                 ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on *@%s%s%s: %s",
  85                                         zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? timestr.c_str() : "", zl->reason.c_str());
  86                                 added_zline = true;
  87                         }
  88                         else
  89                                 delete zl;
  90                 }
  91                 DefaultApply(u, "R", false);
  92         }
  93
  94         const std::string& Displayable() CXX11_OVERRIDE
  95         {
  96                 return matchtext;
  97         }
  98
  99         std::string matchtext;
 100
 101         Regex *regex;
 102 };
 103
 104
 105 /** An XLineFactory specialized to generate RLine* pointers
 106  */
 107 class RLineFactory : public XLineFactory
 108 {
 109  public:
 110         dynamic_reference<RegexFactory>& rxfactory;
 111         RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
 112         {
 113         }
 114
 115         /** Generate a RLine
 116          */
 117         XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask) CXX11_OVERRIDE
 118         {
 119                 if (!rxfactory)
 120                 {
 121                         ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
 122                         throw ModuleException("Regex engine not set or loaded!");
 123                 }
 124
 125                 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
 126         }
 127 };
 128
 129 /** Handle /RLINE
 130  * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
 131  */
 132 class CommandRLine : public Command
 133 {
 134         std::string rxengine;
 135         RLineFactory& factory;
 136
 137  public:
 138         CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
 139         {
 140                 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
 141         }
 142
 143         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
 144         {
 145
 146                 if (parameters.size() >= 3)
 147                 {
 148                         // Adding - XXX todo make this respect <insane> tag perhaps..
 149
 150                         unsigned long duration = InspIRCd::Duration(parameters[1]);
 151                         XLine *r = NULL;
 152
 153                         try
 154                         {
 155                                 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 156                         }
 157                         catch (ModuleException &e)
 158                         {
 159                                 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: " + e.GetReason());
 160                         }
 161
 162                         if (r)
 163                         {
 164                                 if (ServerInstance->XLines->AddLine(r, user))
 165                                 {
 166                                         if (!duration)
 167                                         {
 168                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 169                                         }
 170                                         else
 171                                         {
 172                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 173                                                 std::string timestr = InspIRCd::TimeString(c_requires_crap);
 174                                                 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-line for %s to expire on %s: %s", user->nick.c_str(), parameters[0].c_str(), timestr.c_str(), parameters[2].c_str());
 175                                         }
 176
 177                                         ServerInstance->XLines->ApplyLines();
 178                                 }
 179                                 else
 180                                 {
 181                                         delete r;
 182                                         user->WriteNotice("*** R-Line for " + parameters[0] + " already exists");
 183                                 }
 184                         }
 185                 }
 186                 else
 187                 {
 188                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 189                         {
 190                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
 191                         }
 192                         else
 193                         {
 194                                 user->WriteNotice("*** R-Line " + parameters[0] + " not found in list, try /stats R.");
 195                         }
 196                 }
 197
 198                 return CMD_SUCCESS;
 199         }
 200
 201         RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
 202         {
 203                 if (IS_LOCAL(user))
 204                         return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
 205
 206                 return ROUTE_BROADCAST;
 207         }
 208 };
 209
 210 class ModuleRLine : public Module, public Stats::EventListener
 211 {
 212         dynamic_reference<RegexFactory> rxfactory;
 213         RLineFactory f;
 214         CommandRLine r;
 215         bool MatchOnNickChange;
 216         bool initing;
 217         RegexFactory* factory;
 218
 219  public:
 220         ModuleRLine()
 221                 : Stats::EventListener(this)
 222                 , rxfactory(this, "regex")
 223                 , f(rxfactory)
 224                 , r(this, f)
 225                 , initing(true)
 226         {
 227         }
 228
 229         void init() CXX11_OVERRIDE
 230         {
 231                 ServerInstance->XLines->RegisterFactory(&f);
 232         }
 233
 234         ~ModuleRLine()
 235         {
 236                 ServerInstance->XLines->DelAll("R");
 237                 ServerInstance->XLines->UnregisterFactory(&f);
 238         }
 239
 240         Version GetVersion() CXX11_OVERRIDE
 241         {
 242                 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
 243         }
 244
 245         ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
 246         {
 247                 // Apply lines on user connect
 248                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 249
 250                 if (rl)
 251                 {
 252                         // Bang. :P
 253                         rl->Apply(user);
 254                         return MOD_RES_DENY;
 255                 }
 256                 return MOD_RES_PASSTHRU;
 257         }
 258
 259         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 260         {
 261                 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
 262
 263                 MatchOnNickChange = tag->getBool("matchonnickchange");
 264                 ZlineOnMatch = tag->getBool("zlineonmatch");
 265                 std::string newrxengine = tag->getString("engine");
 266
 267                 factory = rxfactory ? (rxfactory.operator->()) : NULL;
 268
 269                 if (newrxengine.empty())
 270                         rxfactory.SetProvider("regex");
 271                 else
 272                         rxfactory.SetProvider("regex/" + newrxengine);
 273
 274                 if (!rxfactory)
 275                 {
 276                         if (newrxengine.empty())
 277                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-Line functionality disabled until this is corrected.");
 278                         else
 279                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
 280
 281                         ServerInstance->XLines->DelAll(f.GetType());
 282                 }
 283                 else if ((!initing) && (rxfactory.operator->() != factory))
 284                 {
 285                         ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-Lines");
 286                         ServerInstance->XLines->DelAll(f.GetType());
 287                 }
 288
 289                 initing = false;
 290         }
 291
 292         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
 293         {
 294                 if (stats.GetSymbol() != 'R')
 295                         return MOD_RES_PASSTHRU;
 296
 297                 ServerInstance->XLines->InvokeStats("R", 223, stats);
 298                 return MOD_RES_DENY;
 299         }
 300
 301         void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
 302         {
 303                 if (!IS_LOCAL(user))
 304                         return;
 305
 306                 if (!MatchOnNickChange)
 307                         return;
 308
 309                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 310
 311                 if (rl)
 312                 {
 313                         // Bang! :D
 314                         rl->Apply(user);
 315                 }
 316         }
 317
 318         void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
 319         {
 320                 if (added_zline)
 321                 {
 322                         added_zline = false;
 323                         ServerInstance->XLines->ApplyLines();
 324                 }
 325         }
 326
 327         void OnUnloadModule(Module* mod) CXX11_OVERRIDE
 328         {
 329                 // If the regex engine became unavailable or has changed, remove all rlines
 330                 if (!rxfactory)
 331                 {
 332                         ServerInstance->XLines->DelAll(f.GetType());
 333                 }
 334                 else if (rxfactory.operator->() != factory)
 335                 {
 336                         factory = rxfactory.operator->();
 337                         ServerInstance->XLines->DelAll(f.GetType());
 338                 }
 339         }
 340
 341         void Prioritize() CXX11_OVERRIDE
 342         {
 343                 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
 344                 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
 345         }
 346 };
 347
 348 MODULE_INIT(ModuleRLine)