4.9 KiB
The MessageParser plugin
Administration
messageparser remove [<channel>] [--id] <regexp>]
Removes the trigger for <regexp> from the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. If option --id specified, will retrieve by regexp id, not content.
messageparser add [<channel>] <regexp> <action>
Associates <regexp> with <action>. <channel> is only necessary if the message isn't sent on the channel itself. Action is echoed upon regexp match, with variables $1, $2, etc. being interpolated from the regexp match groups.
messageparser lock [<channel>] <regexp>
Locks the <regexp> so that it cannot be removed or overwritten to. <channel> is only necessary if the message isn't sent in the channel itself.
messageparser unlock [<channel>] <regexp>
Unlocks the entry associated with <regexp> so that it can be removed or overwritten. <channel> is only necessary if the message isn't sent in the channel itself.
messageparser vacuum [<channel>]
Vacuums the database for <channel>. See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html <channel> is only necessary if the message isn't sent in the channel itself. First check if user has the required capability specified in plugin config requireVacuumCapability.
User commands
messageparser show [<channel>] [--id] <regexp>
Looks up the value of <regexp> in the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. If option --id specified, will retrieve by regexp id, not content.
messageparser rank [<channel>]
Returns a list of top-ranked regexps, sorted by usage count (rank). The number of regexps returned is set by the rankListLength registry value. <channel> is only necessary if the message isn't sent in the channel itself.
messageparser info [<channel>] [--id] <regexp>
Display information about <regexp> in the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. If option --id specified, will retrieve by regexp id, not content.
messageparser list [<channel>]
Lists regexps present in the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. Regexp ID listed in paretheses.
Configuration
supybot.plugins.MessageParser.enable
Default value: True
Determines whether the message parser is enabled. If enabled, will trigger on regexps added to the regexp db.
supybot.plugins.MessageParser.keepRankInfo
Default value: True
Determines whether we keep updating the usage count for each regexp, for popularity ranking.
supybot.plugins.MessageParser.listSeparator
Default value: ,
Determines the separator used between regexps when shown by the list command.
supybot.plugins.MessageParser.rankListLength
Default value: 20
Determines the number of regexps returned by the triggerrank command.
supybot.plugins.MessageParser.requireManageCapability
Default value: admin; channel,op
Determines the capabilities required (if any) to manage the regexp database, including add, remove, lock, unlock. Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability.
supybot.plugins.MessageParser.requireVacuumCapability
Default value: admin
Determines the capability required (if any) to vacuum the database.
supybot.plugins.MessageParser.public
Default value: True
Determines whether this plugin is publicly visible.