Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModuleFilter Class Reference

Inheritance diagram for ModuleFilter:

[legend]Collaboration diagram for ModuleFilter:

[legend]List of all members.

Public Member Functions
	ModuleFilter (InspIRCd *Me)
virtual	~ModuleFilter ()
virtual FilterResult *	FilterMatch (userrec *user, const std::string &text, int flags)
virtual bool	DeleteFilter (const std::string &freeform)
virtual std::pair< bool, std::string >	AddFilter (const std::string &freeform, const std::string &type, const std::string &reason, long duration, const std::string &flags)
virtual void	SyncFilters (Module *proto, void *opaque)
virtual void	OnRehash (userrec *user, const std::string &parameter)
	Called on rehash.
virtual int	OnStats (char symbol, userrec *user, string_list &results)
	Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
Private Attributes
filter_t	filters

---

Detailed Description

Definition at line 25 of file m_filter.cpp.

---

Constructor & Destructor Documentation

ModuleFilter::ModuleFilter (  InspIRCd *  Me  )  [inline]

Definition at line 31 of file m_filter.cpp. References OnRehash(). : FilterBase(Me, "m_filter.so") { OnRehash(NULL,""); }

virtual ModuleFilter::~ModuleFilter (   )  [inline, virtual]

Definition at line 37 of file m_filter.cpp. { }

---

Member Function Documentation

virtual std::pair<bool, std::string> ModuleFilter::AddFilter (  const std::string &  freeform, const std::string &  type, const std::string &  reason, long  duration, const std::string &  flags )  [inline, virtual]

Implements FilterBase. Definition at line 76 of file m_filter.cpp. References filters. { if (filters.find(freeform) != filters.end()) { return std::make_pair(false, "Filter already exists"); } FilterResult* x = new FilterResult(freeform, reason, type, duration, flags); filters[freeform] = x; return std::make_pair(true, ""); }

virtual bool ModuleFilter::DeleteFilter (  const std::string &  freeform  )  [inline, virtual]

Implements FilterBase. Definition at line 65 of file m_filter.cpp. References filters. Referenced by OnRehash(). { if (filters.find(freeform) != filters.end()) { delete (filters.find(freeform))->second; filters.erase(filters.find(freeform)); return true; } return false; }

virtual FilterResult* ModuleFilter::FilterMatch (  userrec *  user, const std::string &  text, int  flags )  [inline, virtual]

Implements FilterBase. Definition at line 41 of file m_filter.cpp. References FilterBase::AppliesToMe(), filters, InspIRCd::MatchText(), and Module::ServerInstance. { for (filter_t::iterator index = filters.begin(); index != filters.end(); index++) { /* Skip ones that dont apply to us */ if (!FilterBase::AppliesToMe(user, index->second, flags)) continue; if (ServerInstance->MatchText(text,index->first)) { FilterResult* fr = index->second; if (index != filters.begin()) { std::string pat = index->first; filters.erase(index); filters.insert(filters.begin(), std::make_pair(pat,fr)); } return fr; } } return NULL; }

virtual void ModuleFilter::OnRehash (  userrec *  user, const std::string &  parameter )  [inline, virtual]

Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application. If a parameter is given, the core has done nothing. The module receiving the event can decide if this parameter has any relevence to it. Parameters: user  The user performing the rehash, if any -- if this is server initiated, the value of this variable will be NULL. parameter  The (optional) parameter given to REHASH from the user. Reimplemented from FilterBase. Definition at line 97 of file m_filter.cpp. References DELETE(), DeleteFilter(), InspIRCd::Duration(), filters, FilterBase::flags, ConfigReader::ReadValue(), and Module::ServerInstance. Referenced by ModuleFilter(). { ConfigReader* MyConf = new ConfigReader(ServerInstance); for (int index = 0; index < MyConf->Enumerate("keyword"); index++) { this->DeleteFilter(MyConf->ReadValue("keyword","pattern",index)); std::string pattern = MyConf->ReadValue("keyword","pattern",index); std::string reason = MyConf->ReadValue("keyword","reason",index); std::string do_action = MyConf->ReadValue("keyword","action",index); std::string flags = MyConf->ReadValue("keyword","flags",index); long gline_time = ServerInstance->Duration(MyConf->ReadValue("keyword","duration",index)); if (do_action.empty()) do_action = "none"; if (flags.empty()) flags = "*"; FilterResult* x = new FilterResult(pattern, reason, do_action, gline_time, flags); filters[pattern] = x; } DELETE(MyConf); }

virtual int ModuleFilter::OnStats (  char  symbol, userrec *  user, string_list &  results )  [inline, virtual]

Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Parameters: symbol  the symbol provided to /STATS user  the user issuing the /STATS command results  A string_list to append results into. You should put all your results into this string_list, rather than displaying them directly, so that your handler will work when remote STATS queries are received. Returns: 1 to block the /STATS from being processed by the core, 0 to allow it Implements FilterBase. Definition at line 120 of file m_filter.cpp. References InspIRCd::Config, ConvToStr(), filters, userrec::nick, Module::ServerInstance, and ServerConfig::ServerName. { if (symbol == 's') { std::string sn = ServerInstance->Config->ServerName; for (filter_t::iterator n = filters.begin(); n != filters.end(); n++) { results.push_back(sn+" 223 "+user->nick+" :GLOB:"+n->second->freeform+" "+n->second->flags+" "+n->second->action+" "+ConvToStr(n->second->gline_time)+" :"+n->second->reason); } } return 0; }

virtual void ModuleFilter::SyncFilters (  Module *  proto, void *  opaque )  [inline, virtual]

Implements FilterBase. Definition at line 89 of file m_filter.cpp. References filters, and FilterBase::SendFilter(). { for (filter_t::iterator n = filters.begin(); n != filters.end(); n++) { this->SendFilter(proto, opaque, n->second); } }

---

Member Data Documentation

filter_t ModuleFilter::filters [private]

Definition at line 28 of file m_filter.cpp. Referenced by AddFilter(), DeleteFilter(), FilterMatch(), OnRehash(), OnStats(), and SyncFilters().

---

The documentation for this class was generated from the following file:

• m_filter.cpp