src/modules/m_filter.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 using namespace std;
  18
  19 // Message and notice filtering using glob patterns
  20 // a module based on the original work done by Craig Edwards in 2003
  21 // for the chatspike network.
  22
  23 #include <stdio.h>
  24 #include <string>
  25 #include "users.h"
  26 #include "channels.h"
  27 #include "modules.h"
  28 #include "helperfuncs.h"
  29
  30 /* $ModDesc: An enhanced version of the unreal m_filter.so used by chatspike.net */
  31
  32 class Filter : public classbase
  33 {
  34  public:
  35         std::string reason;
  36         std::string action;
  37 };
  38
  39 typedef std::map<std::string,Filter*> filter_t;
  40
  41 class FilterException : public ModuleException
  42 {
  43  public:
  44         virtual const char* GetReason()
  45         {
  46                 return "Could not find <filter file=\"\"> definition in your config file!";
  47         }
  48 };
  49
  50 class ModuleFilter : public Module
  51 {
  52  Server *Srv;
  53  filter_t filters;
  54
  55  public:
  56         ModuleFilter(Server* Me)
  57                 : Module::Module(Me)
  58         {
  59                 // read the configuration file on startup.
  60                 // it is perfectly valid to set <filter file> to the value of the
  61                 // main config file, then append your <keyword> tags to the bottom
  62                 // of the main config... but rather messy. That's why the capability
  63                 // of using a seperate config file is provided.
  64                 Srv = Me;
  65                 OnRehash("");
  66         }
  67
  68         virtual ~ModuleFilter()
  69         {
  70         }
  71
  72         void Implements(char* List)
  73         {
  74                 List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = List[I_OnRehash] = 1;
  75         }
  76
  77         // format of a config entry is <keyword pattern="*glob*" reason="Some reason here" action="kill/block">
  78
  79         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status)
  80         {
  81                 return OnUserPreNotice(user,dest,target_type,text,status);
  82         }
  83
  84         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status)
  85         {
  86                 std::string text2 = text+" ";
  87                 for (filter_t::iterator index = filters.begin(); index != filters.end(); index++)
  88                 {
  89                         if ((Srv->MatchText(text2,index->first)) || (Srv->MatchText(text,index->first)))
  90                         {
  91                                 Filter* f = (Filter*)index->second;
  92                                 std::string target = "";
  93
  94                                 if (target_type == TYPE_USER)
  95                                 {
  96                                         userrec* t = (userrec*)dest;
  97                                         target = std::string(t->nick);
  98                                 }
  99                                 else if (target_type == TYPE_CHANNEL)
 100                                 {
 101                                         chanrec* t = (chanrec*)dest;
 102                                         target = std::string(t->name);
 103                                 }
 104
 105                                 if (f->action == "block")
 106                                 {
 107                                         Srv->SendOpers(std::string("FILTER: ")+std::string(user->nick)+
 108                                                         std::string(" had their notice filtered, target was ")+
 109                                                         target+": "+f->reason);
 110                                         user->WriteServ("NOTICE "+std::string(user->nick)+
 111                                                         " :Your notice has been filtered and opers notified: "+f->reason);
 112                                 }
 113                                 Srv->Log(DEFAULT,std::string("FILTER: ")+std::string(user->nick)+
 114                                                 std::string(" had their notice filtered, target was ")+
 115                                                 target+": "+f->reason+" Action: "+f->action);
 116
 117                                 if (f->action == "kill")
 118                                 {
 119                                         userrec::QuitUser(user,f->reason);
 120                                 }
 121                                 return 1;
 122                         }
 123                 }
 124                 return 0;
 125         }
 126
 127         virtual void OnRehash(const std::string &parameter)
 128         {
 129                 // reload our config file on rehash - we must destroy and re-allocate the classes
 130                 // to call the constructor again and re-read our data.
 131                 ConfigReader* Conf = new ConfigReader;
 132                 std::string filterfile = Conf->ReadValue("filter","file",0);
 133                 // this automatically re-reads the configuration file into the class
 134                 ConfigReader* MyConf = new ConfigReader(filterfile);
 135                 if ((filterfile == "") || (!MyConf->Verify()))
 136                 {
 137                         // bail if the user forgot to create a config file
 138                         FilterException e;
 139                         throw(e);
 140                 }
 141                 for (filter_t::iterator n = filters.begin(); n != filters.end(); n++)
 142                 {
 143                         DELETE(n->second);
 144                 }
 145                 filters.clear();
 146                 for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
 147                 {
 148                         std::string pattern = MyConf->ReadValue("keyword","pattern",index);
 149                         std::string reason = MyConf->ReadValue("keyword","reason",index);
 150                         std::string do_action = MyConf->ReadValue("keyword","action",index);
 151                         if (do_action == "")
 152                                 do_action = "none";
 153                         Filter* x = new Filter;
 154                         x->reason = reason;
 155                         x->action = do_action;
 156                         filters[pattern] = x;
 157                 }
 158                 Srv->Log(DEFAULT,std::string("m_filter: read configuration from ")+filterfile);
 159                 DELETE(Conf);
 160                 DELETE(MyConf);
 161         }
 162
 163         virtual Version GetVersion()
 164         {
 165                 // This is version 2 because version 1.x is the unreleased unrealircd module
 166                 return Version(2,0,0,2,VF_VENDOR);
 167         }
 168
 169 };
 170
 171 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 172
 173 class ModuleFilterFactory : public ModuleFactory
 174 {
 175  public:
 176         ModuleFilterFactory()
 177         {
 178         }
 179
 180         ~ModuleFilterFactory()
 181         {
 182         }
 183
 184         virtual Module * CreateModule(Server* Me)
 185         {
 186                 return new ModuleFilter(Me);
 187         }
 188
 189 };
 190
 191
 192 extern "C" void * init_module( void )
 193 {
 194         return new ModuleFilterFactory;
 195 }
 196