1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
19 class FilterResult : public classbase
27 FilterResult(const std::string free, const std::string &rea, const std::string &act, long gt) : freeform(free), reason(rea), action(act), gline_time(gt)
35 virtual ~FilterResult()
42 class FilterBase : public Module
44 cmd_filter* filtcommand;
46 FilterBase(InspIRCd* Me, const std::string &source);
47 virtual ~FilterBase();
48 virtual void Implements(char* List);
49 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status);
51 virtual FilterResult* FilterMatch(const std::string &text) = 0;
52 virtual bool DeleteFilter(const std::string &freeform) = 0;
53 virtual void SyncFilters(Module* proto, void* opaque) = 0;
55 virtual void SendFilter(Module* proto, void* opaque, FilterResult* iter);
56 virtual std::pair<bool, std::string> AddFilter(const std::string &freeform, const std::string &type, const std::string &reason, long duration) = 0;
57 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status);
58 virtual void OnRehash(const std::string ¶meter);
59 virtual Version GetVersion();
60 std::string EncodeFilter(FilterResult* filter);
61 FilterResult DecodeFilter(const std::string &data);
62 virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
63 virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
65 virtual int OnStats(char symbol, userrec* user, string_list &results) = 0;
68 class cmd_filter : public command_t
72 cmd_filter(FilterBase* f, InspIRCd* Me, const std::string &source) : command_t(Me, "FILTER", 'o', 1), Base(f)
74 this->source = source;
75 this->syntax = "<filter-definition> <type> [<gline-duration>] :<reason>";
78 CmdResult Handle(const char** parameters, int pcnt, userrec *user)
82 /* Deleting a filter */
83 if (Base->DeleteFilter(parameters[0]))
85 user->WriteServ("NOTICE %s :*** Deleted filter '%s'", user->nick, parameters[0]);
90 user->WriteServ("NOTICE %s :*** Filter '%s' not found on list.", user->nick, parameters[0]);
99 std::string freeform = parameters[0];
100 std::string type = parameters[1];
104 if ((type != "gline") && (type != "none") && (type != "block") && (type != "kill"))
106 user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', and 'kill'.", user->nick, freeform.c_str());
114 duration = ServerInstance->Duration(parameters[2]);
115 reason = parameters[3];
119 this->TooFewParams(user, " When setting a gline type filter, a gline duration must be specified as the third parameter.");
125 reason = parameters[2];
127 std::pair<bool, std::string> result = Base->AddFilter(freeform, type, reason, duration);
130 user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, reason: '%s'", user->nick, freeform.c_str(),
131 type.c_str(), (duration ? " duration: " : ""), (duration ? parameters[2] : ""),
137 user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick, freeform.c_str(), result.second.c_str());
143 this->TooFewParams(user, ".");
150 void TooFewParams(userrec* user, const std::string &extra_text)
152 user->WriteServ("NOTICE %s :*** Not enough parameters%s", user->nick, extra_text.c_str());
156 FilterBase::FilterBase(InspIRCd* Me, const std::string &source) : Module::Module(Me)
158 filtcommand = new cmd_filter(this, Me, source);
159 ServerInstance->AddCommand(filtcommand);
162 FilterBase::~FilterBase()
166 void FilterBase::Implements(char* List)
168 List[I_OnStats] = List[I_OnSyncOtherMetaData] = List[I_OnDecodeMetaData] = List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = List[I_OnRehash] = 1;
171 int FilterBase::OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status)
173 return OnUserPreNotice(user,dest,target_type,text,status);
176 int FilterBase::OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status)
178 /* Leave ulines alone */
179 if (ServerInstance->ULine(user->server))
182 FilterResult* f = this->FilterMatch(text);
185 std::string target = "";
186 if (target_type == TYPE_USER)
188 userrec* t = (userrec*)dest;
189 target = std::string(t->nick);
191 else if (target_type == TYPE_CHANNEL)
193 chanrec* t = (chanrec*)dest;
194 target = std::string(t->name);
196 if (f->action == "block")
198 ServerInstance->WriteOpers(std::string("FILTER: ")+user->nick+" had their notice filtered, target was "+target+": "+f->reason);
199 user->WriteServ("NOTICE "+std::string(user->nick)+" :Your notice has been filtered and opers notified: "+f->reason);
201 ServerInstance->Log(DEFAULT,"FILTER: "+std::string(user->nick)+std::string(" had their notice filtered, target was ")+target+": "+f->reason+" Action: "+f->action);
202 if (f->action == "kill")
204 userrec::QuitUser(ServerInstance,user,f->reason);
206 if (f->action == "gline")
208 if (ServerInstance->XLines->add_gline(f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), user->MakeHostIP()))
210 ServerInstance->XLines->apply_lines(APPLY_GLINES);
211 FOREACH_MOD(I_OnAddGLine,OnAddGLine(f->gline_time, NULL, f->reason, user->MakeHostIP()));
219 void FilterBase::OnRehash(const std::string ¶meter)
223 Version FilterBase::GetVersion()
225 return Version(1,1,0,2,VF_VENDOR|VF_COMMON,API_VERSION);
229 std::string FilterBase::EncodeFilter(FilterResult* filter)
231 std::ostringstream stream;
232 stream << filter->freeform << " " << filter->action << " " << filter->gline_time << " " << filter->reason;
236 FilterResult FilterBase::DecodeFilter(const std::string &data)
239 std::istringstream stream(data);
240 stream >> res.freeform;
241 stream >> res.action;
242 stream >> res.gline_time;
243 res.reason = stream.str();
247 void FilterBase::OnSyncOtherMetaData(Module* proto, void* opaque)
249 this->SyncFilters(proto, opaque);
252 void FilterBase::SendFilter(Module* proto, void* opaque, FilterResult* iter)
254 proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "filter", EncodeFilter(iter));
257 void FilterBase::OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
259 if ((target_type == TYPE_OTHER) && (extname == "filter"))
261 FilterResult data = DecodeFilter(extdata);
262 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time);