User:SPCUClerkbot/documentation

'''THIS BOT DOES NOT DO CHECKUSERS or have the technical ability to do so, its function is assisting SPI clerks.

SPCUclerkbot is in current development. The bot is intended to help SPI clerks by doing some limited tasks. Any edits to wikipedia will first be checked over by our bot approvals group.

General Commands

 * !search cases - type this, followed by a username or ip; used to search the database for any mention in a case (spi, cu or ssp)
 * !count cases - provides a real time count of all active cases, from non cu to pending close
 * !report (x) - type this, followed by a case name; used to provide a sock report based on contributions of listed accounts and quick info about accounts related to the case (intersecting edits made by confirmed or suspected socks)
 * !report (x/x/...) - type this, followed by one account name/ip, a space, and another account/ip with brackets (e.g. User:Example)to compare two users/ips; for additional accounts, just add another space and account/ip with brackets

Config commands
These can be done by sending it the command "!config set " where command is one of the bolded items below and value is a sensible value. The majority of these commands are restricted to admins and developers only. (admins can do most anything except for create new keys/items in the config file).

Array values
If there is more then one value in the variable, (The bot will tell you) you need to use the command !config set . Please do not execute this on an item where there is only one value unless the list below tells you it is ok.


 * !config set  
 * Command to modify keys that store an array of values.
 * Note that this command is restricted to those in "admin_hosts". If you think you should have access, feel free to ask but this is a safeguard to keep untrusted folks from messing up the bot too severely. Ask on IRC, being a checkuser clerk accepted by the rest of the clerks does help.
 * Also note that this does give admins the technical capacity to mark themselves as developers by running !config set developer_hosts add . Admins should be trusted enough not to do this! The reason for the separation is to mark commands with no other use then debugging as developer only.

Other interesting config commands

 * !config save -- Saves the configuration file to disk, don't do this unless you know the changes you made are good as it may be difficult to undo. (ie you may have to wait for me to fix it by manually editing it's config file). Restricted to group admin_hosts.
 * !config reload -- Loads the config file. This is a safe command, if you did something you want to undo, this loads the config file from disk and resets everything to the last prior saved state. Restricted to group admin_hosts.
 * !config get  -- Displays in IRC the contents of a config value. This is useful for seeing who has access, and exploring the config settings. Not restricted to any group
 * !config key   -- This is primarally for developer use, a new value added by a user won't be taken advantage of by the program. How it works is when "new key" is added, it also adds the value you specify as an initial value. When a key is deleted, it just removes the key ignoring the value parameter. Restricted to group developer_hosts.

Base configuration

 * wikimedia_channel - What channel it joins on the wikimedia rc server. This should be left at en.wikipedia. You may change this to an array value by by following the instructions at . Doing so tells the bot to join more then one channel on the wikimedia server.
 * freenode_channel - What channel it joins on the freenode network. This is the checkuser clerk channel. You may change this to an array value by by following the instructions at . Doing so tells the bot to join more then one channel on the freenode server.
 * watch_titlespace - What page and subpages should it watch? It is currently 'Wikipedia:Requests for checkuser', which means the bot watches that page and all subpages of it. Please for the time being limit it to only one page to watch.
 * ssp_titlespace - contains the page and subpages that the bot is watching for the new SPI system. The bot will report some changes and edit in other cases. (in current development).
 * rfcu_template - contains the template that it must find in the bottom section to be considered a "request for checkuser action". If this is not found, the bot treats the request as a request for ssp action.

On-wiki access levels

 * checkuser_clerks - An array of user names who are accepted by the bot as SPI clerks.
 * checkusers - AN array of user names who are accepted by the bot as CheckUsers.

Access system config

 * admin_hosts - Admins are considered to be anyone permitted to edit the configuration files. Normal users will be allowed to query the bot, but won't be allowed to change any of the configuration files or settings. Admins can add or remove other admins by following the instructions listed at.
 * These values are the irc hostmask. You can see these by typing /whois, and looking for the output from nickserv: it should look like "=== nixeagle  “Wilhelm”" where the bolded portion is the part you want to add to the array for the bot.
 * developer_hosts - An array of hosts that are accepted by the bot as developers. This is used by the bot to limit commands that are useful only for developing to developers only as some of those commands can be annoying/hard to fix if used wrongly.

Developer config
The following values are probably not that interesting to change as a user of the bot. Please don't change these values unless you are actively debugging/programming the bot.

All of these are restricted to group admin_hosts, however admins are advised not to modify these without good reason.
 * wikimedia_flood - Instructs the bot to act as a repeater from irc.wikimedia.org to irc.freenode.org. There are two valid settings: 0 and 1. The default is 0. Changing this value to 1 will cause the bot to flood any and all channels it is in on freenode.