wm-bot - Meta
wm-bot
(Redirected from WM-Bot)
wm-bot is an IRC bot that is being used in several Wikimedia IRC channels, particularly developer channels. This page documents the bot. Right now the bot is running on Libera.
WM-Bot
The bot is designed to have separate configuration for each channel, so that anyone can get it on their channel and have their own database. The bot is maintained by the user who brought it to the channel, so anyone can configure it as they want.
Support
In case you need any help with this bot, please contact one of its operators:
Or—fill in a ticket: [1]
Getting bot to the channel
Note: Channels inactive for more than a year are subject to having the bot removed from the channel
In case you are a Wikimedia or Miraheze user with a Wikimedia or Miraheze cloak and you want to use this bot in a Wikimedia or Miraheze related channel, you can just join #wm-botconnect, where you can type:
@add #nameofchannelyouwant
This make the bot join your channel and give you admin permissions for that channel.
However, there may be some exceptional situations:
Bot will not join
Bot is probably banned or stuck in some way. For example if you invite a bot and then use freenode's /remove command (which isn't compliant with IRC standards anyway so it makes sense the bot doesn't know it) the bot will still think it's in the channel. You can try to make it part the channel from #wm-bot by calling @part #channel. You will require to be identified with either a Wikimedia or Miraheze IRC cloak, otherwise the bot will ignore your request.
Bot will not give you admin rights
If the bot was in the channel previously and removed using @part command, it will still have the same ACL so that you won't get admin rights. Instead, the same people as before will have it. You can always contact some of the bot operators to help you in this situation.
User access
Admin
Admin has access to all commands, the user who bring the bot to channel is always made admin unless the bot was previously parted (in that case the previous access list is preserved). This user level can be granted to anyone else using the @trustadd command (see below).
Trusted
Trusted users have access to most of the commands
If you are a trusted or admin you can use command @trustadd to insert more people to access list
User list
User list can be controlled using following commands
@trusted
Display list of users for current channel
@trusted (channel) displays the trust list for (channel)
@trustadd regex level
Add regex to defined level, level being one of admin, trusted. Example:
@trustadd .*@wikipedia/John trusted
Optionally, you can add a channel name to the end of the command. This will add the regex to the trust list in the specified channel. This can only be done by users with root permissions.
@trustdel regex
Delete regex, you can only delete users from same or lower access level
Optionally, you can add a channel name to the end of the command. This will delete the regex from the trust list in the specified channel. This can only be done by users with root permissions.
Recent changes feed for WMF wikis
wm-bot supports a relay of recent changes feed directly to any channel, below is a list of commands which you can use in order to set up the bot
Wiki code examples
  • fr.wikipedia.org
  • meta.wikimedia.org
  • commons.wikimedia.org
  • www.wikidata.org
  • outreach.wikimedia.org
  • wikimania.wikimedia.org
  • incubator.wikimedia.org
@recentchanges-off
Requires admin rights, this command has no parameters
Disables a feed of recent changes of Wikimedia wikis in current channel. The database of pages you configured will be preserved.
@recentchanges-on
Requires admin rights, this command has no parameters
Enables a feed of recent changes in current channel, you can select certain pages on selected wikis to be watched.

@RC- wiki page
Requires trusted rights, this command has 2 parameters
Removes a page from list of recent changes, affects only current channel.
Example: @RC- en.wikipedia.org User:Test_page
@RC+ wiki page
Requires trusted rights, this command has 2 parameters
Insert a page to a feed, example @RC+ de.wikipedia.org User:Test_page would make it report changes to de.wikipedia.org/wiki/User:Test_page directly to channel.
Additionally, @RC+ de.wikipedia.org User:Test_page/* would make it report changes to any subpages (but not the primary page) of de.wikipedia.org/wiki/User:Test_page directly to channel. Note that the * wildcard can only be used on the end of the string.
Infobot
See a list of existing commands for each channel, in https://wm-bot.wmcloud.org/dump/systemdata.htm (Libera) or https://wm-bot.wmflabs.org/dump/systemdata.htm (freenode (historical))
Infobot can be controlled by trusted users using following commands:
<@petan> !key is some data <wm-bot> Key was added! <@petan> !key <wm-bot> some data <@petan> !key del <wm-bot> Deleted key <@petan> !key is this is $1 <wm-bot> Key was added! <@petan> !key 1 <wm-bot> this is 1 <@petan> !google is https://www.google.com/search?q=$url_encoded_* <wm-bot> Key was added <@petan> !google some special symbols % 6 7#%#$%@ <wm-bot> https://www.google.com/search?q=some+special+symbols+%#25+6+7%#23%#25%#23%#24%#25%#40 <@petan> !google some special symbols % 6 7#%#$%@ | addshore <wm-bot> addshore: https://www.google.com/search?q=some+special+symbols+%#25+6+7%#23%#25%#23%#24%#25%#40 <petan> !highfive act highfives $infobot_nick! <wm-bot> Key was added <petan> !highfive * wm-bot highfives petan!
Aliases
You can create an alias by typing !key alias key2 so that !key would display value of key2.
The aliases have lower priority than keys so you can overwrite an alias with key (it's possible to create both)
Command !key unalias removes it
Variables
VariableResponse
$infobot_nickNick of user who trigger the key
$infobot_hostHostname of user who trigger the key
$1 - $9Parameters one at a time
$*All parameters in one shot
$url_encoded_1 - $url_encoded_9URL encoded parameters one at a time
$url_encoded_*All parameters in one shot and URL encoded
$wiki_encoded_1 - $wiki_encoded_9Wiki encoded parameters one at a time (same as {{URLENCODE: $1 - $9|WIKI}})
$wiki_encoded_*All parameters in one shot and wiki encoded (same as {{URLENCODE: $1 - $9|WIKI}})
@regsearch <regex>
Search regular expression in all values
@search <word>
Search key names and values for given word
Private message commands
You can send a private command to wm-bot like this:
/msg wm-bot @command parameter
@notify
This command let you know when specified user becomes active or online. You can use this even on users who aren't registered on the server or even on users who are online, but not active currently.
Example: @notify hashar
@seen
@seen user
Tell you when user was last seen
All labs commands
See help for @labs-*
Channel commands
@add
Require admin rights
Insert a bot to another channel (@add #example)
@info
Doesn't require any permission
Link to HTML dump of database and channel info (no parameters)
Statistics
@statistics-on
Create a table of channel use statistics to be included in the HTML dump accessible with @info
@statistics-off
Stop measuring channel use statistics to be included in the HTML dump accessible with @info
(off by default)
@notify
For example if I was waiting for hashar, I could just send a private message
@notify hashar
to wm-bot and he would send me a private message whenever hashar appeared or spoke somewhere. It works even on users who are already online but idle – he then pings you when the user stops being idle.
You can also use this command to send a message to target user when they appear online (as well as notifying you)
@notify petan Hello, cool bot!
Infobot commands
@infobot-on
Requires admin rights
Turn on infobot for current channel
@infobot-off
Requires admin rights
Disable infobot on current channel
@infobot-link
Requires admin rights
Create a link to infobot db of different channel, this allows you to share infobot with other channels. If you link channel A to channel B's db, the local db of channel A will be no longer accessible, but will not be deleted. If you unlink the channel db, local db will be accessible again.
Example: @infobot-link #mediawiki will make a bot use db of #mediawiki, instead of local db.
Syntax: @infobot-link #channel
@infobot-share-on
Requires admin rights
Enable shared infobot, this is necessary to execute on the channel you want to share the db of with other channels.
@infobot-share-trust-
Requires admin rights
Remove a channel from trusted relation. This channel will no longer have access to shared db.
@infobot-share-trust+
Requires admin rights
Insert a channel to db, that means this channel will be allowed to access the shared db for reading and writing.
example: @infobot-share-trust+ #test
this allows #test to link to infobot db of the channel where you triggered this command and to read and write into it, based on own access list.
@infobot-share-off
Requires admin rights
Disable shared infobot
@infobot-ignore+
Requires trusted right
Insert a new string to ignore list of infobot, for example
@infobot-ignore+ seen
makes the bot ignore any commands !seen in a channel
@infobot-ignore-
Requires trusted right
This command remove an ignored key from list, syntax: @infobot-ignore- <item>
@infobot-detail
Doesn't require any rights
Syntax: @infobot-detail <key>
Display information about key
@infobot-set-raw
Requires trusted right
Make the key "raw" that means, all special words, $1, $2... will be displayed as they are, instead of converting to specific values, the | symbol is ignored in such a key. Only special word that is respected is $url_encoded_* and $*
@infobot-unset-raw
Require trusted right
Syntax: @infobot-unset-raw <key>
This command undo the @infobot-set-raw
@infobot-recovery
Requires admin right
example: @infobot-recovery previousdb
Recovers a snapshot—be careful as this operation removes the current database without asking, it's useful to create a snapshot before recovering some other so that you can restore the current db in case something go wrong.
@infobot-snapshot
Requires admin right
example: @infobot-snapshot previousdb
Creates a snapshot of current db, it is a bit clone of a database that can be restored anytime to its current status.
@infobot-snapshot-rm
Requires admin right
example: @infobot-snapshot-rm previousdb
Removes a snapshot
@infobot-snapshot-ls
List all snapshots for current channel
Seen
@seenrx
Requires trusted right
Tell you when user matching regex was last seen
Example: @seenrx ^[Pp]etan$
@seen
Tell you when the specified user was last seen, case-insensitive and doesn't support wild cards.
Example: @seen petan
@seen-on
Requires admin right
Turn on the seen for the current channel
@seen-off
Requires admin right
Turn off the seen for the current channel
rss feed
@rss+
Requires trusted right
Insert a new item, syntax: @rss+ <name> <url>
example: @rss+ bbc https://bbc.co.uk/rss.xml
@rss-
Requires trusted right
Remove an item
syntax: @rss- <name>
@rss-on
Requires admin right
Enable RSS feed
@rss-off
Requires admin right
Disable rss feed, doesn't remove the DB
@rss-setstyle
Requires admin right
Direct method of configuring RSS feeds also obtainable by using @configure style-rss
Please note, there must be no spaces (wrong: key = value bla bla correct: key=value bla bla)
List of variables for style-rss:
Examples:
@rss-setstyle Bugzilla [bugzilla] $bugzilla_resolution $title ($bugzilla_severity $bugzilla_priority assignee: $bugzilla_assignee created by: $author) - $link @rss-setstyle gerrit [gerrit $name] $title - Diff: $link
Channel logs
@logon
Requires admin right
Start to generate public logs for current channel
By default, this feature is disabled, no channels the bot is invited to are logged, unless you enable it
Channels with logging and their logs can be found on https://wm-bot.wmcloud.org/logs/ (Libera) or https://wm-bot.wmflabs.org/logs/ (freenode)
@logoff
Requires admin rights
Disable logs
Configuration and help
@help
Display help
You can also type @help <command> to display 1 line help for the command
@language
Requires admin rights
Change the language for the channel—this will change the language bot will speak for all users in the channel
Example: @language en
Languages:
@configure
Requires admin rights
Change various keys
KeyTypeWhat is it
infobot-auto-completeboolenable autocompletion so that typing !k would display value of !key should there be no other key starting with identical char (default is false)
infobot-helpboolProvide a help for infobot in case you type a nonexistent key
infobot-caseboolwhether keys are case sensitive (default is true) - that allows you to create !key as well as !Key. Turning it off (by setting false) will hide the keys that were created later
infobot-sortedboolsort the infobot in html
logs-no-write-databooldisable writing of logs to storage, this is obsolete feature and shouldn't be ever used
suppress-warningsbooldoesn't send any errors to channel
ignore-unknownbooldoesn't parse input from users who aren't in trust list, that disable all bot features from users who aren't trusted
respond-messageboolsend a message to user who attempt to speak to bot
infobot-trim-white-space-in-nameboolremove white space
respond-waitintdelay to wait between responses from response message
recent-changes-templatestring
This is the message template for rc item
variables:contains
$wikiName of the wiki
$urlThe URL to the index.php for the language the edit was found on. (doesn't work for "all" wikis bugzilla:49874#c3)
$usernameUsername of the editor
$encoded_usernameURL encoded username
$encoded_wiki_usernameSame as $encoded_username only replaces spaces with _ instead of + and preserves :/() characters
$linkrevision ID of the edit
$pageverbose page name
$encoded_pageURL encoded page name
$encoded_wiki_pageSame as $encoded_page except replaces spaces with _ instead of + and preserves :/() characters
$summaryEdit summary
$fullurlReturns $url?title=$encoded_wiki_page for new pages
Returns $url?diff=$link for edited pages
$actionreturns created or modified depending on if it is a new page or not
$flagsmarked as minor or bot edit
null<default value>: Change on $wiki a page $page was modified, changed by $username, link: $url?diff=$link edit: $summary
style-rssstringmessage template for rss item (variables: $name $author $title $link $description)
default-link-wikistringThe default wiki to use as the base for links created using @link or @linkie-on (default: en") (complete list of known and acceptable wikis can be found on GitHub)
The current value of the content of a key can be retrieved like:
@configure recent-changes-template
Note: Returns Value of recent-changes-template is: <default value> if not set.
Examples:
@configure ignore-unknown=true
Please note, there must be no spaces (wrong: key = value bla bla correct: key=value bla bla)
List of variables for style-rss:
Examples:
@rss-setstyle Bugzilla [bugzilla] $bugzilla_resolution $title ($bugzilla_severity $bugzilla_priority assignee: $bugzilla_assignee created by: $author) - $link @rss-setstyle gerrit [gerrit $name] $title - Diff: $link
@part
Requires admin rights
Part current channel preserving the configuration and database
@whoami
Display your user level
@suppress-on
Requires admin rights
Disable output to a channel
@suppress-off
Requires admin rights
Enable output to a channel
@drop
Requires admin rights
Leave channel and remove the configuration, logs and db. The data can't be recovered once removed, so please don't use this command in case you want to keep logs.
@rc-ping
Display time of last recent change logged
Linkie (wiki link)
@link
Turns the last line of wikilinks in the channel to actual links using the default wiki specified in the default-link-wiki parameter of @configure.
@linkie-on
Requires admin rights
Turns on the automatic linker in the channel using the default wiki specified in the default-link-wiki parameter of @configure.
When linker is on, every wiki link similar to [[page]] will be translated to url
@linkie-off
Requires admin rights
Turns off the automatic linker in the channel.
Labs
@labs-resolve
Resolve instance ID / name / FQDN
@labs-info
Provide info for instance
@labs-project-users
List users in a project
@labs-project-instances
List instances in project
@labs-user
Display info about user
Relay of messages from scripts and other tools
Useful if you need to send a message to any IRC channel from Wikimedia labs
@relay-on
Requires admin rights
This command is useful if you need to send a message to any IRC channel from Wikimedia Cloud Services/Toolforge, but you don't want to create a bot for that. If you enable relay, anyone on Cloud Services/Toolforge will be able to send a TCP message to wm-bot.wm-bot.wmcloud.org:64835 in format of:
#channel message is here
And a bot will relay it to your channel
Simple shell script to relay "hello world" to channel #wm-bot
#!/bin/sh echo "#wm-bot hello world" | wm-bot.wm-bot.wmcloud.org 64835 64835 -w0
@relay-off
Requires admin rights
Turn off a relay
@token-on
Requires admin rights
Generate a token for your channel which needs to be provided in a message in order to relay it, example:
#channel TOKEN message is here
@token-off
Requires admin rights
Disable token
Network bridge
It's possible to bridge messages between freenode and libera for channels with same name, there are 2 conditions:
@bridge-on
Requires admin rights
Will relay all messages that don't start with ! or @ to other side, you can also create one-way bridge if you don't run this command on second network
@bridge-off
Requires admin rights
Stop sending messages to other side
Operator tools - channel maintenance tool
@optools-on
Requires admin
Enable optools - that let you execute @kb @jb and @kick in a channel, these commands require channel to be registered and bot needs to have +o in chanserv
@optools-off
Requires admin
Disable optools
@optools-permanent-on
Requires admin
Bot will not deop itself after op action
@optools-permanent-off
Requires admin
Bot will deop itself after op action
@kb
Requires admin
@kb user <reason>
Kickban a user from the channel
@jb
Requires admin
@jb user
Set a redirect ban. This is supposed to be used for people who join flood channel because of temporary connection issues
@q
Requires admin
@q user
Quiet a user
@unkb
Requires admin
@unkb user
Removes a ban of user -- bugzilla:53600 "@unkb can't unban user kicked from channel"
@unq
Requires admin
@unq user
Removes a quiet from user
@kick
Requires admin
@kick user <reason>
Kick user from a channel
GitHub
Bot can echo push and commit messages for GitHub repositories to any channel. The detailed setup is below:
IMPORTANT: Channel must have relay on, so if you didn't do that yet, run @relay-on
  1. Enable relay – by running @relay-on
  2. Insert a repository by running @github+ <full name of repo>
  3. Install a webhook (see screenshot below)
For every repository for which you wish to receive messages to your IRC channel, install a webhook to https://wm-bot.wmcloud.org/github/index.php (Libera) or https://wm-bot.wmflabs.org/github/index.php (freenode) in the settings of your repository. Make sure you set the content type to JSON, or it won't work.
Known issues: If you set up a token for channel relay, you will need to remove the repository and re-add it because tokens get added to the database only when a repository is inserted.
@github+
Requires trusted
Insert a repository full name into a database of your channel. If your repository is https://github.com/benapetr/test-100​, then the full name is benapetr/test-100.
For this to work you also need to install webhook into GitHub, see above for how to do that.
@github-
Requires trusted
Removes a repository full name from the database, hooks for this repository will be silently ignored.
System admin
These commands are not useful for regular users
@restart
Require root rights
Restart the process of bot
@reload
Require admin rights
Reload configuration of the channel
@system-rm
Requires root
This is a low-level system command that tell a bot to unload a specific module from system
@system-lm
Requires root
Load a module to system
@system-rejoin-all
Requires root
@system-rejoin-all <instance>
Rejoins all channels on instance
@reauth
Requires root
@reauth <instance>
Re-authenticates instance in IRC, including giving voice to the bots.
@instance
Requires root
@instance <instance> #<channel>
Changes default instance for a channel
Files and logs
Languages
The bot will talk any language you want in a specific channel. All you need to do, is ask admin of bot to say @language <code>
You can translate the bot to your language by creating a subpage, example Wm-bot/ru for Russian. Then just translate the default English file.
Supported languages are:
For developers
Source
Source code is in git type
git clone https://github.com/benapetr/wikimedia-bot.git
to download it
Compiling
In order to compile the bot, you need a C# compiler like GCS or Microsoft's CSC. Visual Studio or MonoDevelop are the recommended IDE's: they allow you to just open the project file and hit make.
This is a most simple way to build stuff on Debian:
# after you checkout the botcd wikimedia-bot make
Setting up
Installation
// This is a username for a bot​username​=​wm​-​bot​;​// This password is optional and bot will use it to auth with nickserv in case you provide itpassword=blabla;// This is a root url that will be used in queries like @info​web​=​https​:​//bots.wmflabs.org/~wm-bot/;​// Whether bot uses a bouncer or notserverIO=false;// Debug channel​debug​=​#​wm​-​bot​;​// Irc server bot will connect to​network​=​holmes​.​freenode​.​net​;​// This is css style that will be used for dynamically created html pages​style_html_file​=​https​:​//bots.wmflabs.org/~wm-bot/wmib/style.css;​// This is interval that bot will send messages to network server to in milliseconds, lower the interval is// faster the bot will send messages to server. Low interval may result in k-line on some networks.​interval​=​800​;​// Nickname for primary instance​nick​=​wm​-​bot​;​// Optional mysql username​mysql_user​=​jimmy_wales​;​// Optional mysql host​mysql_host​=​bots​-​labs​;​// Optional password​mysql_pw​=​I_own_wikipedia​;​// Name of database to store items to (by default bot doesn't use mysql, but some extensions might want to)​mysql_db​=​wmib​;​mysql_port​=​3306​;
.*@wikimedia/Petrb|root|this is a secret password|root
These users will be globally recognized in any channel, first column is regular expression to match IRC hostname, second is user level, third is password for system console, fourth is username for system console
now you can launch the bot (mono wmib.exe)
Restarting the bot
See admin guide at wikitech:wm-bot
External links
db of wm-bot in #mediawiki
Last edited on 16 January 2022, at 00:56
Content is available under CC BY-SA 3.0 unless otherwise noted.
Privacy policy
Terms of Use
Desktop
HomeRandomLog in Settings DonateAbout MetaDisclaimers
WatchEdit