src/modules/m_filter.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2004, 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2007 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 "xline.h"
  25 #include "modules/regex.h"
  26 #include "modules/server.h"
  27 #include "modules/shun.h"
  28 #include "modules/stats.h"
  29
  30 enum FilterFlags
  31 {
  32         FLAG_PART = 2,
  33         FLAG_QUIT = 4,
  34         FLAG_PRIVMSG = 8,
  35         FLAG_NOTICE = 16
  36 };
  37
  38 enum FilterAction
  39 {
  40         FA_GLINE,
  41         FA_ZLINE,
  42         FA_WARN,
  43         FA_BLOCK,
  44         FA_SILENT,
  45         FA_KILL,
  46         FA_SHUN,
  47         FA_NONE
  48 };
  49
  50 class FilterResult
  51 {
  52  public:
  53         Regex* regex;
  54         std::string freeform;
  55         std::string reason;
  56         FilterAction action;
  57         long duration;
  58         bool from_config;
  59
  60         bool flag_no_opers;
  61         bool flag_part_message;
  62         bool flag_quit_message;
  63         bool flag_privmsg;
  64         bool flag_notice;
  65         bool flag_strip_color;
  66
  67         FilterResult(dynamic_reference<RegexFactory>& RegexEngine, const std::string& free, const std::string& rea, FilterAction act, long gt, const std::string& fla, bool cfg)
  68                 : freeform(free)
  69                 , reason(rea)
  70                 , action(act)
  71                 , duration(gt)
  72                 , from_config(cfg)
  73         {
  74                 if (!RegexEngine)
  75                         throw ModuleException("Regex module implementing '"+RegexEngine.GetProvider()+"' is not loaded!");
  76                 regex = RegexEngine->Create(free);
  77                 this->FillFlags(fla);
  78         }
  79
  80         char FillFlags(const std::string &fl)
  81         {
  82                 flag_no_opers = flag_part_message = flag_quit_message = flag_privmsg =
  83                         flag_notice = flag_strip_color = false;
  84
  85                 for (std::string::const_iterator n = fl.begin(); n != fl.end(); ++n)
  86                 {
  87                         switch (*n)
  88                         {
  89                                 case 'o':
  90                                         flag_no_opers = true;
  91                                 break;
  92                                 case 'P':
  93                                         flag_part_message = true;
  94                                 break;
  95                                 case 'q':
  96                                         flag_quit_message = true;
  97                                 break;
  98                                 case 'p':
  99                                         flag_privmsg = true;
 100                                 break;
 101                                 case 'n':
 102                                         flag_notice = true;
 103                                 break;
 104                                 case 'c':
 105                                         flag_strip_color = true;
 106                                 break;
 107                                 case '*':
 108                                         flag_no_opers = flag_part_message = flag_quit_message =
 109                                                 flag_privmsg = flag_notice = flag_strip_color = true;
 110                                 break;
 111                                 default:
 112                                         return *n;
 113                                 break;
 114                         }
 115                 }
 116                 return 0;
 117         }
 118
 119         std::string GetFlags()
 120         {
 121                 std::string flags;
 122                 if (flag_no_opers)
 123                         flags.push_back('o');
 124                 if (flag_part_message)
 125                         flags.push_back('P');
 126                 if (flag_quit_message)
 127                         flags.push_back('q');
 128                 if (flag_privmsg)
 129                         flags.push_back('p');
 130                 if (flag_notice)
 131                         flags.push_back('n');
 132
 133                 /* Order is important here, 'c' must be the last char in the string as it is unsupported
 134                  * on < 2.0.10, and the logic in FillFlags() stops parsing when it ecounters an unknown
 135                  * character.
 136                  */
 137                 if (flag_strip_color)
 138                         flags.push_back('c');
 139
 140                 if (flags.empty())
 141                         flags.push_back('-');
 142
 143                 return flags;
 144         }
 145
 146         FilterResult()
 147         {
 148         }
 149 };
 150
 151 class CommandFilter : public Command
 152 {
 153  public:
 154         CommandFilter(Module* f)
 155                 : Command(f, "FILTER", 1, 5)
 156         {
 157                 flags_needed = 'o';
 158                 this->syntax = "<filter-definition> <action> <flags> [<duration>] :<reason>";
 159         }
 160         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
 161
 162         RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
 163         {
 164                 return ROUTE_BROADCAST;
 165         }
 166 };
 167
 168 class ModuleFilter : public Module, public ServerEventListener, public Stats::EventListener
 169 {
 170         typedef insp::flat_set<std::string, irc::insensitive_swo> ExemptTargetSet;
 171
 172         bool initing;
 173         bool notifyuser;
 174         RegexFactory* factory;
 175         void FreeFilters();
 176
 177  public:
 178         CommandFilter filtcommand;
 179         dynamic_reference<RegexFactory> RegexEngine;
 180
 181         std::vector<FilterResult> filters;
 182         int flags;
 183
 184         // List of channel names excluded from filtering.
 185         ExemptTargetSet exemptedchans;
 186
 187         // List of target nicknames excluded from filtering.
 188         ExemptTargetSet exemptednicks;
 189
 190         ModuleFilter();
 191         void init() CXX11_OVERRIDE;
 192         CullResult cull() CXX11_OVERRIDE;
 193         ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE;
 194         FilterResult* FilterMatch(User* user, const std::string &text, int flags);
 195         bool DeleteFilter(const std::string &freeform);
 196         std::pair<bool, std::string> AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags);
 197         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
 198         Version GetVersion() CXX11_OVERRIDE;
 199         std::string EncodeFilter(FilterResult* filter);
 200         FilterResult DecodeFilter(const std::string &data);
 201         void OnSyncNetwork(ProtocolInterface::Server& server) CXX11_OVERRIDE;
 202         void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE;
 203         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
 204         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
 205         void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
 206         bool AppliesToMe(User* user, FilterResult* filter, int flags);
 207         void ReadFilters();
 208         static bool StringToFilterAction(const std::string& str, FilterAction& fa);
 209         static std::string FilterActionToString(FilterAction fa);
 210 };
 211
 212 CmdResult CommandFilter::Handle(User* user, const Params& parameters)
 213 {
 214         if (parameters.size() == 1)
 215         {
 216                 /* Deleting a filter */
 217                 Module *me = creator;
 218                 if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
 219                 {
 220                         user->WriteNotice("*** Removed filter '" + parameters[0] + "'");
 221                         ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'f' : 'F', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
 222                         return CMD_SUCCESS;
 223                 }
 224                 else
 225                 {
 226                         user->WriteNotice("*** Filter '" + parameters[0] + "' not found in list, try /stats s.");
 227                         return CMD_FAILURE;
 228                 }
 229         }
 230         else
 231         {
 232                 /* Adding a filter */
 233                 if (parameters.size() >= 4)
 234                 {
 235                         const std::string& freeform = parameters[0];
 236                         FilterAction type;
 237                         const std::string& flags = parameters[2];
 238                         unsigned int reasonindex;
 239                         long duration = 0;
 240
 241                         if (!ModuleFilter::StringToFilterAction(parameters[1], type))
 242                         {
 243                                 if (ServerInstance->XLines->GetFactory("SHUN"))
 244                                         user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'zline', 'none', 'warn', 'block', 'silent', 'kill', and 'shun'.");
 245                                 else
 246                                         user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'zline', 'none', 'warn', 'block', 'silent', and 'kill'.");
 247                                 return CMD_FAILURE;
 248                         }
 249
 250                         if (type == FA_GLINE || type == FA_ZLINE || type == FA_SHUN)
 251                         {
 252                                 if (parameters.size() >= 5)
 253                                 {
 254                                         duration = InspIRCd::Duration(parameters[3]);
 255                                         reasonindex = 4;
 256                                 }
 257                                 else
 258                                 {
 259                                         user->WriteNotice("*** Not enough parameters: When setting a '" + parameters[1] + "' type filter, a duration must be specified as the third parameter.");
 260                                         return CMD_FAILURE;
 261                                 }
 262                         }
 263                         else
 264                         {
 265                                 reasonindex = 3;
 266                         }
 267
 268                         Module *me = creator;
 269                         std::pair<bool, std::string> result = static_cast<ModuleFilter *>(me)->AddFilter(freeform, type, parameters[reasonindex], duration, flags);
 270                         if (result.first)
 271                         {
 272                                 user->WriteNotice("*** Added filter '" + freeform + "', type '" + parameters[1] + "'" +
 273                                         (duration ? ", duration " +  parameters[3] : "") + ", flags '" + flags + "', reason: '" +
 274                                         parameters[reasonindex] + "'");
 275
 276                                 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'f' : 'F', "FILTER: "+user->nick+" added filter '"+freeform+"', type '"+parameters[1]+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+parameters[reasonindex]);
 277
 278                                 return CMD_SUCCESS;
 279                         }
 280                         else
 281                         {
 282                                 user->WriteNotice("*** Filter '" + freeform + "' could not be added: " + result.second);
 283                                 return CMD_FAILURE;
 284                         }
 285                 }
 286                 else
 287                 {
 288                         user->WriteNotice("*** Not enough parameters.");
 289                         return CMD_FAILURE;
 290                 }
 291
 292         }
 293 }
 294
 295 bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
 296 {
 297         if ((filter->flag_no_opers) && user->IsOper())
 298                 return false;
 299         if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
 300                 return false;
 301         if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
 302                 return false;
 303         if ((iflags & FLAG_QUIT)   && (!filter->flag_quit_message))
 304                 return false;
 305         if ((iflags & FLAG_PART)   && (!filter->flag_part_message))
 306                 return false;
 307         return true;
 308 }
 309
 310 ModuleFilter::ModuleFilter()
 311         : ServerEventListener(this)
 312         , Stats::EventListener(this)
 313         , initing(true)
 314         , filtcommand(this)
 315         , RegexEngine(this, "regex")
 316 {
 317 }
 318
 319 void ModuleFilter::init()
 320 {
 321         ServerInstance->SNO->EnableSnomask('f', "FILTER");
 322 }
 323
 324 CullResult ModuleFilter::cull()
 325 {
 326         FreeFilters();
 327         return Module::cull();
 328 }
 329
 330 void ModuleFilter::FreeFilters()
 331 {
 332         for (std::vector<FilterResult>::const_iterator i = filters.begin(); i != filters.end(); ++i)
 333                 delete i->regex;
 334
 335         filters.clear();
 336 }
 337
 338 ModResult ModuleFilter::OnUserPreMessage(User* user, const MessageTarget& msgtarget, MessageDetails& details)
 339 {
 340         // Leave remote users and servers alone
 341         if (!IS_LOCAL(user))
 342                 return MOD_RES_PASSTHRU;
 343
 344         flags = (details.type == MSG_PRIVMSG) ? FLAG_PRIVMSG : FLAG_NOTICE;
 345
 346         FilterResult* f = this->FilterMatch(user, details.text, flags);
 347         if (f)
 348         {
 349                 std::string target;
 350                 if (msgtarget.type == MessageTarget::TYPE_USER)
 351                 {
 352                         User* t = msgtarget.Get<User>();
 353                         // Check if the target nick is exempted, if yes, ignore this message
 354                         if (exemptednicks.count(t->nick))
 355                                 return MOD_RES_PASSTHRU;
 356
 357                         target = t->nick;
 358                 }
 359                 else if (msgtarget.type == MessageTarget::TYPE_CHANNEL)
 360                 {
 361                         Channel* t = msgtarget.Get<Channel>();
 362                         if (exemptedchans.count(t->name))
 363                                 return MOD_RES_PASSTHRU;
 364
 365                         target = t->name;
 366                 }
 367                 if (f->action == FA_WARN)
 368                 {
 369                         ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("WARNING: %s's message to %s matched %s (%s)",
 370                                 user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
 371                         return MOD_RES_PASSTHRU;
 372                 }
 373                 if (f->action == FA_BLOCK)
 374                 {
 375                         ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s had their message to %s filtered as it matched %s (%s)",
 376                                 user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
 377                         if (notifyuser)
 378                         {
 379                                 if (msgtarget.type == MessageTarget::TYPE_CHANNEL)
 380                                         user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked and opers notified (%s)", f->reason.c_str()));
 381                                 else
 382                                         user->WriteNotice("Your message to "+target+" was blocked and opers notified: "+f->reason);
 383                         }
 384                         else
 385                                 details.echo_original = true;
 386                 }
 387                 else if (f->action == FA_SILENT)
 388                 {
 389                         if (notifyuser)
 390                         {
 391                                 if (msgtarget.type == MessageTarget::TYPE_CHANNEL)
 392                                         user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked (%s)", f->reason.c_str()));
 393                                 else
 394                                         user->WriteNotice("Your message to "+target+" was blocked: "+f->reason);
 395                         }
 396                         else
 397                                 details.echo_original = true;
 398                 }
 399                 else if (f->action == FA_KILL)
 400                 {
 401                         ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was killed because their message to %s matched %s (%s)",
 402                                 user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
 403                         ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
 404                 }
 405                 else if (f->action == FA_SHUN && (ServerInstance->XLines->GetFactory("SHUN")))
 406                 {
 407                         Shun* sh = new Shun(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), user->GetIPString());
 408                         ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was shunned because their message to %s matched %s (%s)",
 409                                 user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
 410                         if (ServerInstance->XLines->AddLine(sh, NULL))
 411                         {
 412                                 ServerInstance->XLines->ApplyLines();
 413                         }
 414                         else
 415                                 delete sh;
 416                 }
 417                 else if (f->action == FA_GLINE)
 418                 {
 419                         GLine* gl = new GLine(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
 420                         ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was glined because their message to %s matched %s (%s)",
 421                                 user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
 422                         if (ServerInstance->XLines->AddLine(gl,NULL))
 423                         {
 424                                 ServerInstance->XLines->ApplyLines();
 425                         }
 426                         else
 427                                 delete gl;
 428                 }
 429                 else if (f->action == FA_ZLINE)
 430                 {
 431                         ZLine* zl = new ZLine(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), user->GetIPString());
 432                         ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was zlined because their message to %s matched %s (%s)",
 433                                 user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
 434                         if (ServerInstance->XLines->AddLine(zl,NULL))
 435                         {
 436                                 ServerInstance->XLines->ApplyLines();
 437                         }
 438                         else
 439                                 delete zl;
 440                 }
 441
 442                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action));
 443                 return MOD_RES_DENY;
 444         }
 445         return MOD_RES_PASSTHRU;
 446 }
 447
 448 ModResult ModuleFilter::OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated)
 449 {
 450         if (validated)
 451         {
 452                 flags = 0;
 453                 bool parting;
 454
 455                 if (command == "QUIT")
 456                 {
 457                         /* QUIT with no reason: nothing to do */
 458                         if (parameters.size() < 1)
 459                                 return MOD_RES_PASSTHRU;
 460
 461                         parting = false;
 462                         flags = FLAG_QUIT;
 463                 }
 464                 else if (command == "PART")
 465                 {
 466                         /* PART with no reason: nothing to do */
 467                         if (parameters.size() < 2)
 468                                 return MOD_RES_PASSTHRU;
 469
 470                         if (exemptedchans.count(parameters[0]))
 471                                 return MOD_RES_PASSTHRU;
 472
 473                         parting = true;
 474                         flags = FLAG_PART;
 475                 }
 476                 else
 477                         /* We're only messing with PART and QUIT */
 478                         return MOD_RES_PASSTHRU;
 479
 480                 FilterResult* f = this->FilterMatch(user, parameters[parting ? 1 : 0], flags);
 481                 if (!f)
 482                         /* PART or QUIT reason doesnt match a filter */
 483                         return MOD_RES_PASSTHRU;
 484
 485                 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
 486                 parameters[parting ? 1 : 0] = "Reason filtered";
 487
 488                 /* We're warning or blocking, OR theyre quitting and its a KILL action
 489                  * (we cant kill someone whos already quitting, so filter them anyway)
 490                  */
 491                 if ((f->action == FA_WARN) || (f->action == FA_BLOCK) || (((!parting) && (f->action == FA_KILL))) || (f->action == FA_SILENT))
 492                 {
 493                         return MOD_RES_PASSTHRU;
 494                 }
 495                 else
 496                 {
 497                         /* Are they parting, if so, kill is applicable */
 498                         if ((parting) && (f->action == FA_KILL))
 499                         {
 500                                 user->WriteNotice("*** Your PART message was filtered: " + f->reason);
 501                                 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
 502                         }
 503                         if (f->action == FA_GLINE)
 504                         {
 505                                 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
 506                                 GLine* gl = new GLine(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
 507                                 ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was glined because their %s message matched %s (%s)",
 508                                         user->nick.c_str(), command.c_str(), f->freeform.c_str(), f->reason.c_str()));
 509
 510                                 if (ServerInstance->XLines->AddLine(gl,NULL))
 511                                 {
 512                                         ServerInstance->XLines->ApplyLines();
 513                                 }
 514                                 else
 515                                         delete gl;
 516                         }
 517                         if (f->action == FA_ZLINE)
 518                         {
 519                                 ZLine* zl = new ZLine(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), user->GetIPString());
 520                                 ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was zlined because their %s message matched %s (%s)",
 521                                         user->nick.c_str(), command.c_str(), f->freeform.c_str(), f->reason.c_str()));
 522
 523                                 if (ServerInstance->XLines->AddLine(zl,NULL))
 524                                 {
 525                                         ServerInstance->XLines->ApplyLines();
 526                                 }
 527                                 else
 528                                         delete zl;
 529                         }
 530                         else if (f->action == FA_SHUN && (ServerInstance->XLines->GetFactory("SHUN")))
 531                         {
 532                                 /* Note: We shun *!*@IP so that if their host doesnt resolve the shun still applies. */
 533                                 Shun* sh = new Shun(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), user->GetIPString());
 534                                 ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was shunned because their %s message matched %s (%s)",
 535                                         user->nick.c_str(), command.c_str(), f->freeform.c_str(), f->reason.c_str()));
 536                                 if (ServerInstance->XLines->AddLine(sh, NULL))
 537                                 {
 538                                         ServerInstance->XLines->ApplyLines();
 539                                 }
 540                                 else
 541                                         delete sh;
 542                         }
 543                         return MOD_RES_DENY;
 544                 }
 545         }
 546         return MOD_RES_PASSTHRU;
 547 }
 548
 549 void ModuleFilter::ReadConfig(ConfigStatus& status)
 550 {
 551         ConfigTagList tags = ServerInstance->Config->ConfTags("exemptfromfilter");
 552         exemptedchans.clear();
 553         exemptednicks.clear();
 554
 555         for (ConfigIter i = tags.first; i != tags.second; ++i)
 556         {
 557                 ConfigTag* tag = i->second;
 558
 559                 // If "target" is not found, try the old "channel" key to keep compatibility with 2.0 configs
 560                 const std::string target = tag->getString("target", tag->getString("channel"));
 561                 if (!target.empty())
 562                 {
 563                         if (target[0] == '#')
 564                                 exemptedchans.insert(target);
 565                         else
 566                                 exemptednicks.insert(target);
 567                 }
 568         }
 569
 570         ConfigTag* tag = ServerInstance->Config->ConfValue("filteropts");
 571         std::string newrxengine = tag->getString("engine");
 572         notifyuser = tag->getBool("notifyuser", true);
 573
 574         factory = RegexEngine ? (RegexEngine.operator->()) : NULL;
 575
 576         if (newrxengine.empty())
 577                 RegexEngine.SetProvider("regex");
 578         else
 579                 RegexEngine.SetProvider("regex/" + newrxengine);
 580
 581         if (!RegexEngine)
 582         {
 583                 if (newrxengine.empty())
 584                         ServerInstance->SNO->WriteGlobalSno('f', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
 585                 else
 586                         ServerInstance->SNO->WriteGlobalSno('f', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
 587
 588                 initing = false;
 589                 FreeFilters();
 590                 return;
 591         }
 592
 593         if ((!initing) && (RegexEngine.operator->() != factory))
 594         {
 595                 ServerInstance->SNO->WriteGlobalSno('f', "Dumping all filters due to regex engine change");
 596                 FreeFilters();
 597         }
 598
 599         initing = false;
 600         ReadFilters();
 601 }
 602
 603 Version ModuleFilter::GetVersion()
 604 {
 605         return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, RegexEngine ? RegexEngine->name : "");
 606 }
 607
 608 std::string ModuleFilter::EncodeFilter(FilterResult* filter)
 609 {
 610         std::ostringstream stream;
 611         std::string x = filter->freeform;
 612
 613         /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
 614         for (std::string::iterator n = x.begin(); n != x.end(); n++)
 615                 if (*n == ' ')
 616                         *n = '\7';
 617
 618         stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->duration << " :" << filter->reason;
 619         return stream.str();
 620 }
 621
 622 FilterResult ModuleFilter::DecodeFilter(const std::string &data)
 623 {
 624         std::string filteraction;
 625         FilterResult res;
 626         irc::tokenstream tokens(data);
 627         tokens.GetMiddle(res.freeform);
 628         tokens.GetMiddle(filteraction);
 629         if (!StringToFilterAction(filteraction, res.action))
 630                 throw ModuleException("Invalid action: " + filteraction);
 631
 632         std::string filterflags;
 633         tokens.GetMiddle(filterflags);
 634         char c = res.FillFlags(filterflags);
 635         if (c != 0)
 636                 throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
 637
 638         std::string duration;
 639         tokens.GetMiddle(duration);
 640         res.duration = ConvToInt(duration);
 641
 642         tokens.GetTrailing(res.reason);
 643
 644         /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
 645         for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
 646                 if (*n == '\7')
 647                         *n = ' ';
 648
 649         return res;
 650 }
 651
 652 void ModuleFilter::OnSyncNetwork(ProtocolInterface::Server& server)
 653 {
 654         for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
 655         {
 656                 FilterResult& filter = *i;
 657                 if (filter.from_config)
 658                         continue;
 659
 660                 server.SendMetaData("filter", EncodeFilter(&filter));
 661         }
 662 }
 663
 664 void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
 665 {
 666         if ((target == NULL) && (extname == "filter"))
 667         {
 668                 try
 669                 {
 670                         FilterResult data = DecodeFilter(extdata);
 671                         this->AddFilter(data.freeform, data.action, data.reason, data.duration, data.GetFlags());
 672                 }
 673                 catch (ModuleException& e)
 674                 {
 675                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Error when unserializing filter: " + e.GetReason());
 676                 }
 677         }
 678 }
 679
 680 FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs)
 681 {
 682         static std::string stripped_text;
 683         stripped_text.clear();
 684
 685         for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
 686         {
 687                 FilterResult* filter = &*i;
 688
 689                 /* Skip ones that dont apply to us */
 690                 if (!AppliesToMe(user, filter, flgs))
 691                         continue;
 692
 693                 if ((filter->flag_strip_color) && (stripped_text.empty()))
 694                 {
 695                         stripped_text = text;
 696                         InspIRCd::StripColor(stripped_text);
 697                 }
 698
 699                 if (filter->regex->Matches(filter->flag_strip_color ? stripped_text : text))
 700                         return filter;
 701         }
 702         return NULL;
 703 }
 704
 705 bool ModuleFilter::DeleteFilter(const std::string &freeform)
 706 {
 707         for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
 708         {
 709                 if (i->freeform == freeform)
 710                 {
 711                         delete i->regex;
 712                         filters.erase(i);
 713                         return true;
 714                 }
 715         }
 716         return false;
 717 }
 718
 719 std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs)
 720 {
 721         for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
 722         {
 723                 if (i->freeform == freeform)
 724                 {
 725                         return std::make_pair(false, "Filter already exists");
 726                 }
 727         }
 728
 729         try
 730         {
 731                 filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs, false));
 732         }
 733         catch (ModuleException &e)
 734         {
 735                 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason().c_str());
 736                 return std::make_pair(false, e.GetReason());
 737         }
 738         return std::make_pair(true, "");
 739 }
 740
 741 bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa)
 742 {
 743         if (stdalgo::string::equalsci(str, "gline"))
 744                 fa = FA_GLINE;
 745         else if (stdalgo::string::equalsci(str, "zline"))
 746                 fa = FA_ZLINE;
 747         else if (stdalgo::string::equalsci(str, "warn"))
 748                 fa = FA_WARN;
 749         else if (stdalgo::string::equalsci(str, "block"))
 750                 fa = FA_BLOCK;
 751         else if (stdalgo::string::equalsci(str, "silent"))
 752                 fa = FA_SILENT;
 753         else if (stdalgo::string::equalsci(str, "kill"))
 754                 fa = FA_KILL;
 755         else if (stdalgo::string::equalsci(str, "shun") && (ServerInstance->XLines->GetFactory("SHUN")))
 756                 fa = FA_SHUN;
 757         else if (stdalgo::string::equalsci(str, "none"))
 758                 fa = FA_NONE;
 759         else
 760                 return false;
 761
 762         return true;
 763 }
 764
 765 std::string ModuleFilter::FilterActionToString(FilterAction fa)
 766 {
 767         switch (fa)
 768         {
 769                 case FA_GLINE:  return "gline";
 770                 case FA_ZLINE:  return "zline";
 771                 case FA_WARN:   return "warn";
 772                 case FA_BLOCK:  return "block";
 773                 case FA_SILENT: return "silent";
 774                 case FA_KILL:   return "kill";
 775                 case FA_SHUN:   return "shun";
 776                 default:                return "none";
 777         }
 778 }
 779
 780 void ModuleFilter::ReadFilters()
 781 {
 782         for (std::vector<FilterResult>::iterator filter = filters.begin(); filter != filters.end(); )
 783         {
 784                 if (filter->from_config)
 785                 {
 786                         ServerInstance->SNO->WriteGlobalSno('f', "FILTER: removing filter '" + filter->freeform + "' due to config rehash.");
 787                         delete filter->regex;
 788                         filter = filters.erase(filter);
 789                         continue;
 790                 }
 791
 792                 // The filter is not from the config.
 793                 filter++;
 794         }
 795
 796         ConfigTagList tags = ServerInstance->Config->ConfTags("keyword");
 797         for (ConfigIter i = tags.first; i != tags.second; ++i)
 798         {
 799                 std::string pattern = i->second->getString("pattern");
 800                 std::string reason = i->second->getString("reason");
 801                 std::string action = i->second->getString("action");
 802                 std::string flgs = i->second->getString("flags");
 803                 unsigned long duration = i->second->getDuration("duration", 10*60, 1);
 804                 if (flgs.empty())
 805                         flgs = "*";
 806
 807                 FilterAction fa;
 808                 if (!StringToFilterAction(action, fa))
 809                         fa = FA_NONE;
 810
 811                 try
 812                 {
 813                         filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, duration, flgs, true));
 814                         ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str());
 815                 }
 816                 catch (ModuleException &e)
 817                 {
 818                         ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason().c_str());
 819                 }
 820         }
 821 }
 822
 823 ModResult ModuleFilter::OnStats(Stats::Context& stats)
 824 {
 825         if (stats.GetSymbol() == 's')
 826         {
 827                 for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); i++)
 828                 {
 829                         stats.AddRow(223, RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->duration)+" :"+i->reason);
 830                 }
 831                 for (ExemptTargetSet::const_iterator i = exemptedchans.begin(); i != exemptedchans.end(); ++i)
 832                 {
 833                         stats.AddRow(223, "EXEMPT "+(*i));
 834                 }
 835                 for (ExemptTargetSet::const_iterator i = exemptednicks.begin(); i != exemptednicks.end(); ++i)
 836                 {
 837                         stats.AddRow(223, "EXEMPT "+(*i));
 838                 }
 839         }
 840         return MOD_RES_PASSTHRU;
 841 }
 842
 843 void ModuleFilter::OnUnloadModule(Module* mod)
 844 {
 845         // If the regex engine became unavailable or has changed, remove all filters
 846         if (!RegexEngine)
 847         {
 848                 FreeFilters();
 849         }
 850         else if (RegexEngine.operator->() != factory)
 851         {
 852                 factory = RegexEngine.operator->();
 853                 FreeFilters();
 854         }
 855 }
 856
 857 MODULE_INIT(ModuleFilter)