User:ClueBot II/ClueBot Script
ClueBot Script is a trivial scripting language designed specifically for very basic Wikipedia bot tasks.
Syntax[edit]
The syntax is very similar to that of PHP. Each statement must end in a semicolon (";"). Conditionals are grouped in parenthesis ("()"). Groups of statements are grouped in braces ("{}"). Variables are prefixed with a percent sign ("%"). Functions are prefixed with a dollar sign ("$").
Statements[edit]
if[edit]
Syntax[edit]
if conditional statement
Description[edit]
Executes statement if conditional is satisfied.
while[edit]
Syntax[edit]
while conditional statement
Description[edit]
Execute statement until conditional is no longer satisfied.
foreach[edit]
Syntax[edit]
foreach list delimiter %value statement
Description[edit]
For each item in the list, list, delimited by the delimiter, delimiter, set %value to the value of the current item and execute statement.
eval[edit]
Syntax[edit]
eval ClueBot Script
Description[edit]
Evaluate the string ClueBot Script as ClueBot Script.
set[edit]
Syntax[edit]
set %variable conditional/value
Description[edit]
Sets %variable to the value of conditional/value.
unset[edit]
Syntax[edit]
unset %variable
Description[edit]
Unsets %variable.
varappend[edit]
Syntax[edit]
varappend %variable data
Description[edit]
Append the data, data, to the end of %variable.
varprepend[edit]
Syntax[edit]
varprepend %variable data
Description[edit]
Prepend the data, data, to the end of %variable.
pagereplace[edit]
Syntax[edit]
pagereplace1 page search replace
Description[edit]
Replaces all instances of the string search, with the string replace, on the page page.
pagepregreplace[edit]
Syntax[edit]
pagepregreplace1 page search replace
Description[edit]
Replaces all instances of the regular expression search with the regular expression replace string replace on the page page.
pageprepend[edit]
Syntax[edit]
pageprepend1 page data
Description[edit]
Prepends the data data to the beginning of the page page.
pageappend[edit]
Syntax[edit]
pageappend1 page data
Description[edit]
Appends the data data to the end of the page page.
pageset[edit]
Syntax[edit]
pageset1 page data
Description[edit]
Sets the content of the page page to the data data.
pageget[edit]
Syntax[edit]
pageget page %data
Description[edit]
Retrieves the page page into the variable %data.
getrecentchanges[edit]
Syntax[edit]
getrecentchanges %data delimiter count
Description[edit]
Retrieves the names of the pages in the count most recent changes into the variable %data, delimited by the string delimiter. The count parameter is optional and defaults to 10.
getcategorymembers[edit]
Syntax[edit]
getcategorymembers %data delimiter category count start
Description[edit]
Retrieves count page names in the category category beginning with start into the variable %data. The count parameter is optional and defaults to 500. The start parameter is optional and defaults to the first page in the category.
getbacklinks[edit]
Syntax[edit]
getbacklinks %data delimiter page count %continue
Description[edit]
Retrieves the pages that link to page into the variable %data. The count parameter is optional. The %continue parameter is optional, but if provided will determine where to continue, when the statement finishes, %continue will be filled with where it left off, so pass it back to continue where it left off.
getembeddedin[edit]
Syntax[edit]
getembeddedin %data delimiter page count %continue
Description[edit]
Retrieves the pages that transclude page into the variable %data. The count parameter is optional. The %continue parameter is optional, but if provided will determine where to continue, when the statement finishes, %continue will be filled with where it left off, so pass it back to continue where it left off.
getmodifiedtime[edit]
Syntax[edit]
getmodifiedtime %time page
Description[edit]
Retrieves the last modified unix timestamp of page into %time.
Functions[edit]
cat/+[edit]
Syntax[edit]
$cat(string1,string2,string3,...)
Description[edit]
Returns the input strings concatenated. + is an alias for cat.
substr/mid[edit]
Syntax[edit]
$substr(string,start)
$substr(string,start,length)
Description[edit]
Returns a part of string. If length is omitted, it returns string starting from start to the end of string, otherwise, it returns length characters, starting from start. This function works exactly like PHP's substr] function. mid is an alias for substr.
gettok/settok/addtok/deltok[edit]
Syntax[edit]
$gettok(list,delimiter,id)
$settok(list,delimiter,id,data)
$addtok(list,delimiter,data)
$deltok(list,delimiter,id)
Description[edit]
Id starts at 1. List is a delimited list. Delimiter is the delimiter of the list. Gettok returns the idth item in the list, unless id is 0, then it returns the number of items in the list. Settok sets an item in the list, overwriting the previous value (if necessary). Addtok adds an item to the end of the list. Deltok removes the idth item from the list.
strpos/stripos[edit]
Syntax[edit]
$strpos(haystack,needle)
$strpos(haystack,needle,offset)
$stripos(haystack,needle)
$stripos(haystack,needle,offset)
Description[edit]
Returns the numeric position of the first occurrence (or the offset occurrence, if offset is given) of needle in the haystack string. strpos and stripos are the same except stripos is case insensitive.
replace[edit]
Syntax[edit]
$replace(data,search1,replace1,search2,replace2,...,...,searchN,replaceN)
Description[edit]
Replace each occurrence of search with replace. Multiple search/replace pairs may be given at one time.
pregreplace[edit]
Syntax[edit]
$pregreplace(data,searchregex,replaceregex)
Description[edit]
Performs regular expression search/replace on data. searchregex is the pattern to match and replaceregex is what to replace it with.
time[edit]
Syntax[edit]
$time(0)
Description[edit]
Returns the unix timestamp.
Examples[edit]
set %page "User:ClueBot II/Sandbox";
set %data "{{db-user}}";
set %reason "And now we mark it for deletion. (bot)";
pageset %page %data %reason;
getcategorymembers %cm "\n" "Wikipedia bots";
set %output "";
foreach %cm "\n" %page {
if ($mid(%page,0,5) == 'User:') {
varappend %output $cat("\n* [[",%page,"|",$mid(%page,5),"]]");
}
}
pageappend "Wikipedia:Sandbox" $cat("\n\nHere is a list of the bots on the first page of [[:Category:Wikipedia bots]]:",%output) "Adding list of bots.";
See also[edit]
Footnotes[edit]
- ^1 This command has an optional parameter editsummary which can be used to set an edit summary. Otherwise, one is automatically generated.