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, unsigned 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, unsigned long duration, const std::string& source, const std::string& reason, const 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;
 151                         if (!InspIRCd::Duration(parameters[1], duration))
 152                         {
 153                                 user->WriteNotice("*** Invalid duration for R-line.");
 154                                 return CMD_FAILURE;
 155                         }
 156                         XLine *r = NULL;
 157
 158                         try
 159                         {
 160                                 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 161                         }
 162                         catch (ModuleException &e)
 163                         {
 164                                 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: " + e.GetReason());
 165                         }
 166
 167                         if (r)
 168                         {
 169                                 if (ServerInstance->XLines->AddLine(r, user))
 170                                 {
 171                                         if (!duration)
 172                                         {
 173                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 174                                         }
 175                                         else
 176                                         {
 177                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 178                                                 std::string timestr = InspIRCd::TimeString(c_requires_crap);
 179                                                 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());
 180                                         }
 181
 182                                         ServerInstance->XLines->ApplyLines();
 183                                 }
 184                                 else
 185                                 {
 186                                         delete r;
 187                                         user->WriteNotice("*** R-line for " + parameters[0] + " already exists.");
 188                                 }
 189                         }
 190                 }
 191                 else
 192                 {
 193                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 194                         {
 195                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
 196                         }
 197                         else
 198                         {
 199                                 user->WriteNotice("*** R-line " + parameters[0] + " not found in list, try /stats R.");
 200                         }
 201                 }
 202
 203                 return CMD_SUCCESS;
 204         }
 205
 206         RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
 207         {
 208                 if (IS_LOCAL(user))
 209                         return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
 210
 211                 return ROUTE_BROADCAST;
 212         }
 213 };
 214
 215 class ModuleRLine : public Module, public Stats::EventListener
 216 {
 217         dynamic_reference<RegexFactory> rxfactory;
 218         RLineFactory f;
 219         CommandRLine r;
 220         bool MatchOnNickChange;
 221         bool initing;
 222         RegexFactory* factory;
 223
 224  public:
 225         ModuleRLine()
 226                 : Stats::EventListener(this)
 227                 , rxfactory(this, "regex")
 228                 , f(rxfactory)
 229                 , r(this, f)
 230                 , initing(true)
 231         {
 232         }
 233
 234         void init() CXX11_OVERRIDE
 235         {
 236                 ServerInstance->XLines->RegisterFactory(&f);
 237         }
 238
 239         ~ModuleRLine()
 240         {
 241                 ServerInstance->XLines->DelAll("R");
 242                 ServerInstance->XLines->UnregisterFactory(&f);
 243         }
 244
 245         Version GetVersion() CXX11_OVERRIDE
 246         {
 247                 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
 248         }
 249
 250         ModResult OnUserRegister(LocalUser* user) CXX11_OVERRIDE
 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                         return MOD_RES_DENY;
 260                 }
 261                 return MOD_RES_PASSTHRU;
 262         }
 263
 264         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 265         {
 266                 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
 267
 268                 MatchOnNickChange = tag->getBool("matchonnickchange");
 269                 ZlineOnMatch = tag->getBool("zlineonmatch");
 270                 std::string newrxengine = tag->getString("engine");
 271
 272                 factory = rxfactory ? (rxfactory.operator->()) : NULL;
 273
 274                 if (newrxengine.empty())
 275                         rxfactory.SetProvider("regex");
 276                 else
 277                         rxfactory.SetProvider("regex/" + newrxengine);
 278
 279                 if (!rxfactory)
 280                 {
 281                         if (newrxengine.empty())
 282                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: No regex engine loaded - R-line functionality disabled until this is corrected.");
 283                         else
 284                                 ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-line functionality disabled until this is corrected.", newrxengine.c_str());
 285
 286                         ServerInstance->XLines->DelAll(f.GetType());
 287                 }
 288                 else if ((!initing) && (rxfactory.operator->() != factory))
 289                 {
 290                         ServerInstance->SNO->WriteToSnoMask('a', "Regex engine has changed, removing all R-lines.");
 291                         ServerInstance->XLines->DelAll(f.GetType());
 292                 }
 293
 294                 initing = false;
 295         }
 296
 297         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
 298         {
 299                 if (stats.GetSymbol() != 'R')
 300                         return MOD_RES_PASSTHRU;
 301
 302                 ServerInstance->XLines->InvokeStats("R", 223, stats);
 303                 return MOD_RES_DENY;
 304         }
 305
 306         void OnUserPostNick(User *user, const std::string &oldnick) CXX11_OVERRIDE
 307         {
 308                 if (!IS_LOCAL(user))
 309                         return;
 310
 311                 if (!MatchOnNickChange)
 312                         return;
 313
 314                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 315
 316                 if (rl)
 317                 {
 318                         // Bang! :D
 319                         rl->Apply(user);
 320                 }
 321         }
 322
 323         void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE
 324         {
 325                 if (added_zline)
 326                 {
 327                         added_zline = false;
 328                         ServerInstance->XLines->ApplyLines();
 329                 }
 330         }
 331
 332         void OnUnloadModule(Module* mod) CXX11_OVERRIDE
 333         {
 334                 // If the regex engine became unavailable or has changed, remove all R-lines.
 335                 if (!rxfactory)
 336                 {
 337                         ServerInstance->XLines->DelAll(f.GetType());
 338                 }
 339                 else if (rxfactory.operator->() != factory)
 340                 {
 341                         factory = rxfactory.operator->();
 342                         ServerInstance->XLines->DelAll(f.GetType());
 343                 }
 344         }
 345
 346         void Prioritize() CXX11_OVERRIDE
 347         {
 348                 Module* mod = ServerInstance->Modules->Find("m_cgiirc.so");
 349                 ServerInstance->Modules->SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, mod);
 350         }
 351 };
 352
 353 MODULE_INIT(ModuleRLine)