Modules/1.1/censor
From the makers of InspIRCd.
censor module (InspIRCd-1.1 version)
| 1.1 Documentation | 1.2 Documentation | 2.0 Documentation | 2.1 Documentation |
| Return to the 1.1 Module List | |||
| Description
|
| Allows filtering of text from private and channel messages and notices, based on a set of patterns defined in the Configuration files. Unlike m_filter, this module is designed for users to control their channels where m_filter is designed for admins to control entire irc servers. |
| Configuration Tags
|
To use this module you should add the following tag to your Configuration file:
<include file="censor.conf"> You must then create a censor.conf file, which contains censor entries. The censor.conf is a standard styled config file, containing tags formatted like the one below: <badword text="shit" replace="poo"> The patterns used are search and replace operations which match against any PRIVMSG or NOTICE command from oper and user alike (no exceptions) to the channel or user that has mode +G set upon it. The text given will be replaced, and replacement does not diffrentiate between word boundaries, e.g. the example given above would replace 'shitake mushrooms' with pooake mushrooms'. You have been warned! NOTE: From 1.1 b5 onwards, you don't have to seperate out your filter definitions into a seperate file like this, although it keeps things tidy and is still recommended. |
| Modes
|
*User mode +G: Filters out censored words from private messages to a user
|
| Extended Bans (Extbans)
|
| This module implements no extended bans. |
| Commands
|
| This module adds no extra commands. |
| Special Notes
|
| Please note that while search and replace operations 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. |
