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 "m_regex.h"
  26
  27 /* $ModDesc: Text (spam) filtering */
  28
  29 class ModuleFilter;
  30
  31 enum FilterFlags
  32 {
  33         FLAG_PART = 2,
  34         FLAG_QUIT = 4,
  35         FLAG_PRIVMSG = 8,
  36         FLAG_NOTICE = 16
  37 };
  38
  39 enum FilterAction
  40 {
  41         FA_GLINE,
  42         FA_BLOCK,
  43         FA_SILENT,
  44         FA_KILL,
  45         FA_NONE
  46 };
  47
  48 class FilterResult
  49 {
  50  public:
  51         std::string freeform;
  52         std::string reason;
  53         FilterAction action;
  54         long gline_time;
  55
  56         bool flag_no_opers;
  57         bool flag_part_message;
  58         bool flag_quit_message;
  59         bool flag_privmsg;
  60         bool flag_notice;
  61         bool flag_strip_color;
  62
  63         FilterResult(const std::string free, const std::string &rea, FilterAction act, long gt, const std::string &fla) :
  64                         freeform(free), reason(rea), action(act), gline_time(gt)
  65         {
  66                 this->FillFlags(fla);
  67         }
  68
  69         char FillFlags(const std::string &fl)
  70         {
  71                 flag_no_opers = flag_part_message = flag_quit_message = flag_privmsg =
  72                         flag_notice = flag_strip_color = false;
  73
  74                 for (std::string::const_iterator n = fl.begin(); n != fl.end(); ++n)
  75                 {
  76                         switch (*n)
  77                         {
  78                                 case 'o':
  79                                         flag_no_opers = true;
  80                                 break;
  81                                 case 'P':
  82                                         flag_part_message = true;
  83                                 break;
  84                                 case 'q':
  85                                         flag_quit_message = true;
  86                                 break;
  87                                 case 'p':
  88                                         flag_privmsg = true;
  89                                 break;
  90                                 case 'n':
  91                                         flag_notice = true;
  92                                 break;
  93                                 case 'c':
  94                                         flag_strip_color = true;
  95                                 break;
  96                                 case '*':
  97                                         flag_no_opers = flag_part_message = flag_quit_message =
  98                                                 flag_privmsg = flag_notice = flag_strip_color = true;
  99                                 break;
 100                                 default:
 101                                         return *n;
 102                                 break;
 103                         }
 104                 }
 105                 return 0;
 106         }
 107
 108         std::string GetFlags()
 109         {
 110                 std::string flags;
 111                 if (flag_no_opers)
 112                         flags.push_back('o');
 113                 if (flag_part_message)
 114                         flags.push_back('P');
 115                 if (flag_quit_message)
 116                         flags.push_back('q');
 117                 if (flag_privmsg)
 118                         flags.push_back('p');
 119                 if (flag_notice)
 120                         flags.push_back('n');
 121
 122                 /* Order is important here, 'c' must be the last char in the string as it is unsupported
 123                  * on < 2.0.10, and the logic in FillFlags() stops parsing when it ecounters an unknown
 124                  * character.
 125                  */
 126                 if (flag_strip_color)
 127                         flags.push_back('c');
 128
 129                 if (flags.empty())
 130                         flags.push_back('-');
 131
 132                 return flags;
 133         }
 134
 135         FilterResult()
 136         {
 137         }
 138 };
 139
 140 class CommandFilter : public Command
 141 {
 142  public:
 143         CommandFilter(Module* f)
 144                 : Command(f, "FILTER", 1, 5)
 145         {
 146                 flags_needed = 'o';
 147                 this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
 148         }
 149         CmdResult Handle(const std::vector<std::string>&, User*);
 150
 151         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 152         {
 153                 return ROUTE_BROADCAST;
 154         }
 155 };
 156
 157 class ImplFilter : public FilterResult
 158 {
 159  public:
 160         Regex* regex;
 161
 162         ImplFilter(ModuleFilter* mymodule, const std::string &rea, FilterAction act, long glinetime, const std::string &pat, const std::string &flgs);
 163 };
 164
 165
 166 class ModuleFilter : public Module
 167 {
 168  public:
 169         CommandFilter filtcommand;
 170         dynamic_reference<RegexFactory> RegexEngine;
 171
 172         std::vector<ImplFilter> filters;
 173         const char *error;
 174         int erroffset;
 175         int flags;
 176
 177         std::set<std::string> exemptfromfilter; // List of channel names excluded from filtering.
 178
 179         ModuleFilter();
 180         void init();
 181         ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
 182         FilterResult* FilterMatch(User* user, const std::string &text, int flags);
 183         bool DeleteFilter(const std::string &freeform);
 184         std::pair<bool, std::string> AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags);
 185         ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
 186         void OnRehash(User* user);
 187         Version GetVersion();
 188         std::string EncodeFilter(FilterResult* filter);
 189         FilterResult DecodeFilter(const std::string &data);
 190         void OnSyncNetwork(Module* proto, void* opaque);
 191         void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
 192         ModResult OnStats(char symbol, User* user, string_list &results);
 193         ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line);
 194         bool AppliesToMe(User* user, FilterResult* filter, int flags);
 195         void ReadFilters(ConfigReader &MyConf);
 196         static bool StringToFilterAction(const std::string& str, FilterAction& fa);
 197         static std::string FilterActionToString(FilterAction fa);
 198 };
 199
 200 CmdResult CommandFilter::Handle(const std::vector<std::string> &parameters, User *user)
 201 {
 202         if (parameters.size() == 1)
 203         {
 204                 /* Deleting a filter */
 205                 Module *me = creator;
 206                 if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
 207                 {
 208                         user->WriteServ("NOTICE %s :*** Removed filter '%s'", user->nick.c_str(), parameters[0].c_str());
 209                         ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
 210                         return CMD_SUCCESS;
 211                 }
 212                 else
 213                 {
 214                         user->WriteServ("NOTICE %s :*** Filter '%s' not found in list, try /stats s.", user->nick.c_str(), parameters[0].c_str());
 215                         return CMD_FAILURE;
 216                 }
 217         }
 218         else
 219         {
 220                 /* Adding a filter */
 221                 if (parameters.size() >= 4)
 222                 {
 223                         const std::string& freeform = parameters[0];
 224                         FilterAction type;
 225                         const std::string& flags = parameters[2];
 226                         unsigned int reasonindex;
 227                         long duration = 0;
 228
 229                         if (!ModuleFilter::StringToFilterAction(parameters[1], type))
 230                         {
 231                                 user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.", user->nick.c_str(), parameters[1].c_str());
 232                                 return CMD_FAILURE;
 233                         }
 234
 235                         if (type == FA_GLINE)
 236                         {
 237                                 if (parameters.size() >= 5)
 238                                 {
 239                                         duration = ServerInstance->Duration(parameters[3]);
 240                                         reasonindex = 4;
 241                                 }
 242                                 else
 243                                 {
 244                                         user->WriteServ("NOTICE %s :*** Not enough parameters: When setting a gline type filter, a gline duration must be specified as the third parameter.", user->nick.c_str());
 245                                         return CMD_FAILURE;
 246                                 }
 247                         }
 248                         else
 249                         {
 250                                 reasonindex = 3;
 251                         }
 252
 253                         Module *me = creator;
 254                         std::pair<bool, std::string> result = static_cast<ModuleFilter *>(me)->AddFilter(freeform, type, parameters[reasonindex], duration, flags);
 255                         if (result.first)
 256                         {
 257                                 user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, flags '%s', reason: '%s'", user->nick.c_str(), freeform.c_str(),
 258                                                 parameters[1].c_str(), (duration ? ", duration " : ""), (duration ? parameters[3].c_str() : ""),
 259                                                 flags.c_str(), parameters[reasonindex].c_str());
 260
 261                                 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" added filter '"+freeform+"', type '"+parameters[1]+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+parameters[reasonindex]);
 262
 263                                 return CMD_SUCCESS;
 264                         }
 265                         else
 266                         {
 267                                 user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick.c_str(), freeform.c_str(), result.second.c_str());
 268                                 return CMD_FAILURE;
 269                         }
 270                 }
 271                 else
 272                 {
 273                         user->WriteServ("NOTICE %s :*** Not enough parameters.", user->nick.c_str());
 274                         return CMD_FAILURE;
 275                 }
 276
 277         }
 278 }
 279
 280 bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
 281 {
 282         if ((filter->flag_no_opers) && IS_OPER(user))
 283                 return false;
 284         if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
 285                 return false;
 286         if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
 287                 return false;
 288         if ((iflags & FLAG_QUIT)   && (!filter->flag_quit_message))
 289                 return false;
 290         if ((iflags & FLAG_PART)   && (!filter->flag_part_message))
 291                 return false;
 292         return true;
 293 }
 294
 295 ModuleFilter::ModuleFilter() : filtcommand(this), RegexEngine(this, "regex")
 296 {
 297 }
 298
 299 void ModuleFilter::init()
 300 {
 301         ServerInstance->AddCommand(&filtcommand);
 302         Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncNetwork, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash };
 303         ServerInstance->Modules->Attach(eventlist, this, 7);
 304         OnRehash(NULL);
 305 }
 306
 307 ModResult ModuleFilter::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 308 {
 309         if (!IS_LOCAL(user))
 310                 return MOD_RES_PASSTHRU;
 311
 312         flags = FLAG_PRIVMSG;
 313         return OnUserPreNotice(user,dest,target_type,text,status,exempt_list);
 314 }
 315
 316 ModResult ModuleFilter::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 317 {
 318         /* Leave ulines alone */
 319         if ((ServerInstance->ULine(user->server)) || (!IS_LOCAL(user)))
 320                 return MOD_RES_PASSTHRU;
 321
 322         if (!flags)
 323                 flags = FLAG_NOTICE;
 324
 325         FilterResult* f = this->FilterMatch(user, text, flags);
 326         if (f)
 327         {
 328                 std::string target;
 329                 if (target_type == TYPE_USER)
 330                 {
 331                         User* t = (User*)dest;
 332                         target = t->nick;
 333                 }
 334                 else if (target_type == TYPE_CHANNEL)
 335                 {
 336                         Channel* t = (Channel*)dest;
 337                         if (exemptfromfilter.find(t->name) != exemptfromfilter.end())
 338                                 return MOD_RES_PASSTHRU;
 339
 340                         target = t->name;
 341                 }
 342                 if (f->action == FA_BLOCK)
 343                 {
 344                         ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason);
 345                         if (target_type == TYPE_CHANNEL)
 346                                 user->WriteNumeric(404, "%s %s :Message to channel blocked and opers notified (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str());
 347                         else
 348                                 user->WriteServ("NOTICE "+user->nick+" :Your message to "+target+" was blocked and opers notified: "+f->reason);
 349                 }
 350                 else if (f->action == FA_SILENT)
 351                 {
 352                         if (target_type == TYPE_CHANNEL)
 353                                 user->WriteNumeric(404, "%s %s :Message to channel blocked (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str());
 354                         else
 355                                 user->WriteServ("NOTICE "+user->nick+" :Your message to "+target+" was blocked: "+f->reason);
 356                 }
 357                 else if (f->action == FA_KILL)
 358                 {
 359                         ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
 360                 }
 361                 else if (f->action == FA_GLINE)
 362                 {
 363                         GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
 364                         if (ServerInstance->XLines->AddLine(gl,NULL))
 365                         {
 366                                 ServerInstance->XLines->ApplyLines();
 367                         }
 368                         else
 369                                 delete gl;
 370                 }
 371
 372                 ServerInstance->Logs->Log("FILTER",DEFAULT,"FILTER: "+ user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action));
 373                 return MOD_RES_DENY;
 374         }
 375         return MOD_RES_PASSTHRU;
 376 }
 377
 378 ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line)
 379 {
 380         if (validated && IS_LOCAL(user))
 381         {
 382                 flags = 0;
 383                 bool parting;
 384
 385                 if (command == "QUIT")
 386                 {
 387                         /* QUIT with no reason: nothing to do */
 388                         if (parameters.size() < 1)
 389                                 return MOD_RES_PASSTHRU;
 390
 391                         parting = false;
 392                         flags = FLAG_QUIT;
 393                 }
 394                 else if (command == "PART")
 395                 {
 396                         /* PART with no reason: nothing to do */
 397                         if (parameters.size() < 2)
 398                                 return MOD_RES_PASSTHRU;
 399
 400                         if (exemptfromfilter.find(parameters[0]) != exemptfromfilter.end())
 401                                 return MOD_RES_PASSTHRU;
 402
 403                         parting = true;
 404                         flags = FLAG_PART;
 405                 }
 406                 else
 407                         /* We're only messing with PART and QUIT */
 408                         return MOD_RES_PASSTHRU;
 409
 410                 FilterResult* f = this->FilterMatch(user, parameters[parting ? 1 : 0], flags);
 411                 if (!f)
 412                         /* PART or QUIT reason doesnt match a filter */
 413                         return MOD_RES_PASSTHRU;
 414
 415                 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
 416                 parameters[parting ? 1 : 0] = "Reason filtered";
 417
 418                 /* We're blocking, OR theyre quitting and its a KILL action
 419                  * (we cant kill someone whos already quitting, so filter them anyway)
 420                  */
 421                 if ((f->action == FA_BLOCK) || (((!parting) && (f->action == FA_KILL))) || (f->action == FA_SILENT))
 422                 {
 423                         return MOD_RES_PASSTHRU;
 424                 }
 425                 else
 426                 {
 427                         /* Are they parting, if so, kill is applicable */
 428                         if ((parting) && (f->action == FA_KILL))
 429                         {
 430                                 user->WriteServ("NOTICE %s :*** Your PART message was filtered: %s", user->nick.c_str(), f->reason.c_str());
 431                                 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
 432                         }
 433                         if (f->action == FA_GLINE)
 434                         {
 435                                 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
 436                                 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
 437                                 if (ServerInstance->XLines->AddLine(gl,NULL))
 438                                 {
 439                                         ServerInstance->XLines->ApplyLines();
 440                                 }
 441                                 else
 442                                         delete gl;
 443                         }
 444                         return MOD_RES_DENY;
 445                 }
 446         }
 447         return MOD_RES_PASSTHRU;
 448 }
 449
 450 void ModuleFilter::OnRehash(User* user)
 451 {
 452         ConfigReader MyConf;
 453         exemptfromfilter.clear();
 454         for (int index = 0; index < MyConf.Enumerate("exemptfromfilter"); ++index)
 455         {
 456                 std::string chan = MyConf.ReadValue("exemptfromfilter", "channel", index);
 457                 if (!chan.empty())
 458                         exemptfromfilter.insert(chan);
 459         }
 460         std::string newrxengine = "regex/" + MyConf.ReadValue("filteropts", "engine", 0);
 461         if (newrxengine == "regex/")
 462                 newrxengine = "regex";
 463         if (RegexEngine.GetProvider() == newrxengine)
 464                 return;
 465
 466         //ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change (was '%s', now '%s')", RegexEngine.GetProvider().c_str(), newrxengine.c_str());
 467         //ServerInstance->XLines->DelAll("R");
 468
 469         RegexEngine.SetProvider(newrxengine);
 470         if (!RegexEngine)
 471         {
 472                 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
 473         }
 474         ReadFilters(MyConf);
 475 }
 476
 477 Version ModuleFilter::GetVersion()
 478 {
 479         return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, RegexEngine ? RegexEngine->name : "");
 480 }
 481
 482 std::string ModuleFilter::EncodeFilter(FilterResult* filter)
 483 {
 484         std::ostringstream stream;
 485         std::string x = filter->freeform;
 486
 487         /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
 488         for (std::string::iterator n = x.begin(); n != x.end(); n++)
 489                 if (*n == ' ')
 490                         *n = '\7';
 491
 492         stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->gline_time << " :" << filter->reason;
 493         return stream.str();
 494 }
 495
 496 FilterResult ModuleFilter::DecodeFilter(const std::string &data)
 497 {
 498         std::string filteraction;
 499         FilterResult res;
 500         irc::tokenstream tokens(data);
 501         tokens.GetToken(res.freeform);
 502         tokens.GetToken(filteraction);
 503         if (!StringToFilterAction(filteraction, res.action))
 504                 throw ModuleException("Invalid action: " + filteraction);
 505
 506         std::string filterflags;
 507         tokens.GetToken(filterflags);
 508         char c = res.FillFlags(filterflags);
 509         if (c != 0)
 510                 throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
 511
 512         tokens.GetToken(res.gline_time);
 513         tokens.GetToken(res.reason);
 514
 515         /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
 516         for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
 517                 if (*n == '\7')
 518                         *n = ' ';
 519
 520         return res;
 521 }
 522
 523 void ModuleFilter::OnSyncNetwork(Module* proto, void* opaque)
 524 {
 525         for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); ++i)
 526         {
 527                 proto->ProtoSendMetaData(opaque, NULL, "filter", EncodeFilter(&(*i)));
 528         }
 529 }
 530
 531 void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
 532 {
 533         if ((target == NULL) && (extname == "filter"))
 534         {
 535                 try
 536                 {
 537                         FilterResult data = DecodeFilter(extdata);
 538                         this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.GetFlags());
 539                 }
 540                 catch (ModuleException& e)
 541                 {
 542                         ServerInstance->Logs->Log("m_filter", DEBUG, "Error when unserializing filter: " + std::string(e.GetReason()));
 543                 }
 544         }
 545 }
 546
 547 ImplFilter::ImplFilter(ModuleFilter* mymodule, const std::string &rea, FilterAction act, long glinetime, const std::string &pat, const std::string &flgs)
 548                 : FilterResult(pat, rea, act, glinetime, flgs)
 549 {
 550         if (!mymodule->RegexEngine)
 551                 throw ModuleException("Regex module implementing '"+mymodule->RegexEngine.GetProvider()+"' is not loaded!");
 552         regex = mymodule->RegexEngine->Create(pat);
 553 }
 554
 555 FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs)
 556 {
 557         static std::string stripped_text;
 558         stripped_text.clear();
 559
 560         for (std::vector<ImplFilter>::iterator index = filters.begin(); index != filters.end(); index++)
 561         {
 562                 FilterResult* filter = dynamic_cast<FilterResult*>(&(*index));
 563
 564                 /* Skip ones that dont apply to us */
 565                 if (!AppliesToMe(user, filter, flgs))
 566                         continue;
 567
 568                 if ((filter->flag_strip_color) && (stripped_text.empty()))
 569                 {
 570                         stripped_text = text;
 571                         InspIRCd::StripColor(stripped_text);
 572                 }
 573
 574                 //ServerInstance->Logs->Log("m_filter", DEBUG, "Match '%s' against '%s'", text.c_str(), index->freeform.c_str());
 575                 if (index->regex->Matches(filter->flag_strip_color ? stripped_text : text))
 576                 {
 577                         //ServerInstance->Logs->Log("m_filter", DEBUG, "MATCH");
 578                         return &*index;
 579                 }
 580                 //ServerInstance->Logs->Log("m_filter", DEBUG, "NO MATCH");
 581         }
 582         return NULL;
 583 }
 584
 585 bool ModuleFilter::DeleteFilter(const std::string &freeform)
 586 {
 587         for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
 588         {
 589                 if (i->freeform == freeform)
 590                 {
 591                         delete i->regex;
 592                         filters.erase(i);
 593                         return true;
 594                 }
 595         }
 596         return false;
 597 }
 598
 599 std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs)
 600 {
 601         for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
 602         {
 603                 if (i->freeform == freeform)
 604                 {
 605                         return std::make_pair(false, "Filter already exists");
 606                 }
 607         }
 608
 609         try
 610         {
 611                 filters.push_back(ImplFilter(this, reason, type, duration, freeform, flgs));
 612         }
 613         catch (ModuleException &e)
 614         {
 615                 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason());
 616                 return std::make_pair(false, e.GetReason());
 617         }
 618         return std::make_pair(true, "");
 619 }
 620
 621 bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa)
 622 {
 623         irc::string s(str.c_str());
 624
 625         if (s == "gline")
 626                 fa = FA_GLINE;
 627         else if (s == "block")
 628                 fa = FA_BLOCK;
 629         else if (s == "silent")
 630                 fa = FA_SILENT;
 631         else if (s == "kill")
 632                 fa = FA_KILL;
 633         else if (s == "none")
 634                 fa = FA_NONE;
 635         else
 636                 return false;
 637
 638         return true;
 639 }
 640
 641 std::string ModuleFilter::FilterActionToString(FilterAction fa)
 642 {
 643         switch (fa)
 644         {
 645                 case FA_GLINE:  return "gline";
 646                 case FA_BLOCK:  return "block";
 647                 case FA_SILENT: return "silent";
 648                 case FA_KILL:   return "kill";
 649                 default:                return "none";
 650         }
 651 }
 652
 653 void ModuleFilter::ReadFilters(ConfigReader &MyConf)
 654 {
 655         for (int index = 0; index < MyConf.Enumerate("keyword"); index++)
 656         {
 657                 this->DeleteFilter(MyConf.ReadValue("keyword", "pattern", index));
 658
 659                 std::string pattern = MyConf.ReadValue("keyword", "pattern", index);
 660                 std::string reason = MyConf.ReadValue("keyword", "reason", index);
 661                 std::string action = MyConf.ReadValue("keyword", "action", index);
 662                 std::string flgs = MyConf.ReadValue("keyword", "flags", index);
 663                 long gline_time = ServerInstance->Duration(MyConf.ReadValue("keyword", "duration", index));
 664                 if (flgs.empty())
 665                         flgs = "*";
 666
 667                 FilterAction fa;
 668                 if (!StringToFilterAction(action, fa))
 669                         fa = FA_NONE;
 670
 671                 try
 672                 {
 673                         filters.push_back(ImplFilter(this, reason, fa, gline_time, pattern, flgs));
 674                         ServerInstance->Logs->Log("m_filter", DEFAULT, "Regular expression %s loaded.", pattern.c_str());
 675                 }
 676                 catch (ModuleException &e)
 677                 {
 678                         ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason());
 679                 }
 680         }
 681 }
 682
 683 ModResult ModuleFilter::OnStats(char symbol, User* user, string_list &results)
 684 {
 685         if (symbol == 's')
 686         {
 687                 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
 688                 {
 689                         results.push_back(ServerInstance->Config->ServerName+" 223 "+user->nick+" :"+RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->gline_time)+" :"+i->reason);
 690                 }
 691                 for (std::set<std::string>::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i)
 692                 {
 693                         results.push_back(ServerInstance->Config->ServerName+" 223 "+user->nick+" :EXEMPT "+(*i));
 694                 }
 695         }
 696         return MOD_RES_PASSTHRU;
 697 }
 698
 699 MODULE_INIT(ModuleFilter)