filter module (2.0 version)
|2.0 Documentation||3.0 Documentation|
|Return to the 2.0 Module List|
|Allows filtering of text from private and channel messages and notices, part messages and quit messages, for abuse prevention and realtime blocking of viruses and worms.|
| To use this module you should add the following tags to your Configuration file:
You should then create a filter.conf file, which contains filter entries. The filter.conf is a standard styled config file, containing tags formatted like the one below:
<keyword pattern="*qwerty*" reason="You qwertied!" action="gline" duration="1h6s" flags="pn">
The patterns used are standard glob patterns which match against any PRIVMSG, PART, QUIT or NOTICE command. The action variable can be one of three values:
|This module does not implement any extra user or channel modes.|
|This module implements no extended bans.|
/FILTER <filter-definition> [<action> <flags> [<gline-duration>] :<reason>]
This command will add a filter when more than one parameter is given, using the specified filter definition, action, gline duration (when the action is 'gline') and reason. When only one parameter is provided (the filter pattern) the provided filter will be removed. Note that if you remove a configuration-defined filter, it will re-appear at next rehash unless it is also removed from the config file.
The flags field is used to indicate what the filter affects:
The following command will generate a list of all filters set on the server specified(optional)
/stats s [servername]
| Please note that while glob patterns are faster to match than regular expressions (such a those used in unrealircd, etc) a large number of them can still impede performance (e.g. a hundred or more), and the more users you have, the less patterns you will be able to have without crippling your irc server. Filtering is always done locally, so if you have over 2000 users per server, consider other alternatives where possible.