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         ~RLineFactory()
 136         {
 137         }
 138 };
 139
 140 /** Handle /RLINE
 141  * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
 142  */
 143 class CommandRLine : public Command
 144 {
 145         std::string rxengine;
 146         RLineFactory& factory;
 147
 148  public:
 149         CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator,"RLINE", 1, 3), factory(rlf)
 150         {
 151                 flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
 152         }
 153
 154         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 155         {
 156
 157                 if (parameters.size() >= 3)
 158                 {
 159                         // Adding - XXX todo make this respect <insane> tag perhaps..
 160
 161                         long duration = ServerInstance->Duration(parameters[1]);
 162                         XLine *r = NULL;
 163
 164                         try
 165                         {
 166                                 r = factory.Generate(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 167                         }
 168                         catch (ModuleException &e)
 169                         {
 170                                 ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
 171                         }
 172
 173                         if (r)
 174                         {
 175                                 if (ServerInstance->XLines->AddLine(r, user))
 176                                 {
 177                                         if (!duration)
 178                                         {
 179                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
 180                                         }
 181                                         else
 182                                         {
 183                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 184                                                 std::string timestr = ServerInstance->TimeString(c_requires_crap);
 185                                                 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());
 186                                         }
 187
 188                                         ServerInstance->XLines->ApplyLines();
 189                                 }
 190                                 else
 191                                 {
 192                                         delete r;
 193                                         user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
 194                                 }
 195                         }
 196                 }
 197                 else
 198                 {
 199                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
 200                         {
 201                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
 202                         }
 203                         else
 204                         {
 205                                 user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
 206                         }
 207                 }
 208
 209                 return CMD_SUCCESS;
 210         }
 211
 212         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 213         {
 214                 if (IS_LOCAL(user))
 215                         return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
 216
 217                 return ROUTE_BROADCAST;
 218         }
 219 };
 220
 221 class ModuleRLine : public Module
 222 {
 223  private:
 224         dynamic_reference<RegexFactory> rxfactory;
 225         RLineFactory f;
 226         CommandRLine r;
 227         bool MatchOnNickChange;
 228
 229  public:
 230         ModuleRLine() : rxfactory(this, "regex"), f(rxfactory), r(this, f)
 231         {
 232         }
 233
 234         void init()
 235         {
 236                 OnRehash(NULL);
 237
 238                 ServerInstance->Modules->AddService(r);
 239                 ServerInstance->XLines->RegisterFactory(&f);
 240
 241                 Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnStats, I_OnBackgroundTimer };
 242                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 243         }
 244
 245         virtual ~ModuleRLine()
 246         {
 247                 ServerInstance->XLines->DelAll("R");
 248                 ServerInstance->XLines->UnregisterFactory(&f);
 249         }
 250
 251         virtual Version GetVersion()
 252         {
 253                 return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR, rxfactory ? rxfactory->name : "");
 254         }
 255
 256         virtual void OnUserConnect(LocalUser* user)
 257         {
 258                 // Apply lines on user connect
 259                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 260
 261                 if (rl)
 262                 {
 263                         // Bang. :P
 264                         rl->Apply(user);
 265                 }
 266         }
 267
 268         virtual void OnRehash(User *user)
 269         {
 270                 ConfigTag* tag = ServerInstance->Config->ConfValue("rline");
 271
 272                 MatchOnNickChange = tag->getBool("matchonnickchange");
 273                 ZlineOnMatch = tag->getBool("zlineonmatch");
 274                 std::string newrxengine = tag->getString("engine");
 275
 276                 if (newrxengine.empty())
 277                         rxfactory.SetProvider("regex");
 278                 else
 279                         rxfactory.SetProvider("regex/" + newrxengine);
 280                 if (!rxfactory)
 281                 {
 282                         ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", newrxengine.c_str());
 283                 }
 284         }
 285
 286         virtual ModResult OnStats(char symbol, User* user, string_list &results)
 287         {
 288                 if (symbol != 'R')
 289                         return MOD_RES_PASSTHRU;
 290
 291                 ServerInstance->XLines->InvokeStats("R", 223, user, results);
 292                 return MOD_RES_DENY;
 293         }
 294
 295         virtual void OnUserPostNick(User *user, const std::string &oldnick)
 296         {
 297                 if (!IS_LOCAL(user))
 298                         return;
 299
 300                 if (!MatchOnNickChange)
 301                         return;
 302
 303                 XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
 304
 305                 if (rl)
 306                 {
 307                         // Bang! :D
 308                         rl->Apply(user);
 309                 }
 310         }
 311
 312         virtual void OnBackgroundTimer(time_t curtime)
 313         {
 314                 if (added_zline)
 315                 {
 316                         added_zline = false;
 317                         ServerInstance->XLines->ApplyLines();
 318                 }
 319         }
 320
 321 };
 322
 323 MODULE_INIT(ModuleRLine)