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                 LocalUser* lu = IS_LOCAL(u);
  65                 if (lu && lu->exempt)
  66                         return false;
  67
  68                 std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
  69                 return regex->Matches(compare);
  70         }
  71
  72         bool Matches(const std::string &compare)
  73         {
  74                 return regex->Matches(compare);
  75         }
  76
  77         void Apply(User* u)
  78         {
  79                 if (ZlineOnMatch)
  80                 {
  81                         ZLine* zl = new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, ServerInstance->Config->ServerName.c_str(), reason.c_str(), u->GetIPString());
  82                         if (ServerInstance->XLines->AddLine(zl, NULL))
  83                         {
  84                                 std::string timestr = ServerInstance->TimeString(zl->expiry);
  85                                 ServerInstance->SNO->WriteToSnoMask('x', "Z-line added due to R-line match on *@%s%s%s: %s",
  86                                         zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? timestr.c_str() : "", zl->reason.c_str());
  87                                 added_zline = true;
  88                         }
  89                         else
  90                                 delete zl;
  91                 }
  92                 DefaultApply(u, "R", false);
  93         }
  94
  95         void DisplayExpiry()
  96         {
  97                 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-line %s (set by %s %ld seconds ago)",
  98                         this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
  99         }
 100
 101         const char* Displayable()
 102         {
 103                 return matchtext.c_str();
 104         }
 105
 106         std::string matchtext;
 107
 108         Regex *regex;
 109 };
 110
 111
 112 /** An XLineFactory specialized to generate RLine* pointers
 113  */
 114 class RLineFactory : public XLineFactory
 115 {
 116  public:
 117         dynamic_reference<RegexFactory>& rxfactory;
 118         RLineFactory(dynamic_reference<RegexFactory>& rx) : XLineFactory("R"), rxfactory(rx)
 119         {
 120         }
 121
 122         /** Generate a RLine
 123          */
 124         XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
 125         {
 126                 if (!rxfactory)
 127                 {
 128                         ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
 129                         throw ModuleException("Regex engine not set or loaded!");
 130                 }
 131
 132                 return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory);
 133         }
 134 };
 135
 136 /** Handle /RLINE
 137  * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
 138  */
 139 class CommandRLine : public Command
 140 {
 141         std::string rxengine;
 142         RLineFactory& factory;
 143
 144  public:
 145         CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
 146         {
 147                 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
 148         }
 149
 150         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 151         {
 152
 153                 if (parameters.size() >= 3)
 154                 {
 155                         // Adding - XXX todo make this respect <insane> tag perhaps..
 156
 157                         unsigned long duration = InspIRCd::Duration(parameters[1]);
 158                         XLine *r = NULL;
 159
 160                         try
 161                         {
 162                                 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 163                         }
 164                         catch (ModuleException &e)
 165                         {
 166                                 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
 167                         }
 168
 169                         if (r)
 170                         {
 171                                 if (ServerInstance->XLines->AddLine(r, user))
 172                                 {
 173                                         if (!duration)
 174                                         {
 175                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 176                                         }
 177                                         else
 178                                         {
 179                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 180                                                 std::string timestr = ServerInstance->TimeString(c_requires_crap);
 181                                                 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());
 182                                         }
 183
 184                                         ServerInstance->XLines->ApplyLines();
 185                                 }
 186                                 else
 187                                 {
 188                                         delete r;
 189                                         user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
 190                                 }
 191                         }
 192                 }
 193                 else
 194                 {
 195                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 196                         {
 197                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
 198                         }
 199                         else
 200                         {
 201                                 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
 202                         }
 203                 }
 204
 205                 return CMD_SUCCESS;
 206         }
 207
 208         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 209         {
 210                 if (IS_LOCAL(user))
 211                         return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
 212
 213                 return ROUTE_BROADCAST;
 214         }
 215 };
 216
 217 class ModuleRLine : public Module
 218 {
 219         dynamic_reference<RegexFactory> rxfactory;
 220         RLineFactory f;
 221         CommandRLine r;
 222         bool MatchOnNickChange;
 223
 224  public:
 225         ModuleRLine() : rxfactory(this, "regex"), f(rxfactory), r(this, f)
 226         {
 227         }
 228
 229         void init()
 230         {
 231                 OnRehash(NULL);
 232
 233                 ServerInstance->Modules->AddService(r);
 234                 ServerInstance->XLines->RegisterFactory(&f);
 235
 236                 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer };
 237                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 238         }
 239
 240         virtual ~ModuleRLine()
 241         {
 242                 ServerInstance->XLines->DelAll("R");
 243                 ServerInstance->XLines->UnregisterFactory(&f);
 244         }
 245
 246         virtual Version GetVersion()
 247         {
 248                 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
 249         }
 250
 251         virtual void OnUserConnect(LocalUser* user)
 252         {
 253                 // Apply lines on user connect
 254                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 255
 256                 if (rl)
 257                 {
 258                         // Bang. :P
 259                         rl->Apply(user);
 260                 }
 261         }
 262
 263         virtual void OnRehash(User *user)
 264         {
 265                 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
 266
 267                 MatchOnNickChange = tag->getBool("matchonnickchange");
 268                 ZlineOnMatch = tag->getBool("zlineonmatch");
 269                 std::string newrxengine = tag->getString("engine");
 270
 271                 if (newrxengine.empty())
 272                         rxfactory.SetProvider("regex");
 273                 else
 274                         rxfactory.SetProvider("regex/" + newrxengine);
 275                 if (!rxfactory)
 276                 {
 277                         ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
 278                 }
 279         }
 280
 281         virtual ModResult OnStats(char symbol, User* user, string_list &results)
 282         {
 283                 if (symbol != 'R')
 284                         return MOD_RES_PASSTHRU;
 285
 286                 ServerInstance->XLines->InvokeStats("R", 223, user, results);
 287                 return MOD_RES_DENY;
 288         }
 289
 290         virtual void OnUserPostNick(User *user, const std::string &oldnick)
 291         {
 292                 if (!IS_LOCAL(user))
 293                         return;
 294
 295                 if (!MatchOnNickChange)
 296                         return;
 297
 298                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 299
 300                 if (rl)
 301                 {
 302                         // Bang! :D
 303                         rl->Apply(user);
 304                 }
 305         }
 306
 307         virtual void OnBackgroundTimer(time_t curtime)
 308         {
 309                 if (added_zline)
 310                 {
 311                         added_zline = false;
 312                         ServerInstance->XLines->ApplyLines();
 313                 }
 314         }
 315
 316 };
 317
 318 MODULE_INIT(ModuleRLine)