User:ClueBot II/ClueBot Script

ClueBot Script is a trivial scripting language designed specifically for very basic Wikipedia bot tasks.

=Syntax= 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=

Syntax
if conditional statement

Description
Executes statement if conditional is satisfied.

Syntax
while conditional statement

Description
Execute statement until conditional is no longer satisfied.

Syntax
foreach list delimiter %value statement

Description
For each item in the list, list, delimited by the delimiter, delimiter, set %value to the value of the current item and execute statement.

Syntax
eval ClueBot Script

Description
Evaluate the string ClueBot Script as ClueBot Script.

Syntax
set %variable conditional/value

Description
Sets %variable to the value of conditional/value.

Syntax
unset %variable

Description
Unsets %variable.

Syntax
varappend %variable data

Description
Append the data, data, to the end of %variable.

Syntax
varprepend %variable data

Description
Prepend the data, data, to the end of %variable.

Syntax
pagereplace page search replace

Description
Replaces all instances of the string search, with the string replace, on the page page.

Syntax
pagepregreplace page search replace

Description
Replaces all instances of the regular expression search with the regular expression replace string replace on the page page.

Syntax
pageprepend page data

Description
Prepends the data data to the beginning of the page page.

Syntax
pageappend page data

Description
Appends the data data to the end of the page page.

Syntax
pageset page data

Description
Sets the content of the page page to the data data.

Syntax
pageget page %data

Description
Retrieves the page page into the variable %data.

Syntax
getrecentchanges %data delimiter count

Description
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.

Syntax
getcategorymembers %data delimiter category count start

Description
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.

Syntax
getbacklinks %data delimiter page count %continue

Description
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.

Syntax
getembeddedin %data delimiter page count %continue

Description
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.

Syntax
getmodifiedtime %time page

Description
Retrieves the last modified unix timestamp of page into %time.

=Functions=

Syntax
$cat(string1,string2,string3,...)

Description
Returns the input strings concatenated. + is an alias for cat.

Syntax
$substr(string,start)

$substr(string,start,length)

Description
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.

Syntax
$gettok(list,delimiter,id)

$settok(list,delimiter,id,data)

$addtok(list,delimiter,data)

$deltok(list,delimiter,id)

Description
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.

Syntax
$strpos(haystack,needle)

$strpos(haystack,needle,offset)

$stripos(haystack,needle)

$stripos(haystack,needle,offset)

Description
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.

Syntax
$replace(data,search1,replace1,search2,replace2,...,...,searchN,replaceN)

Description
Replace each occurrence of search with replace. Multiple search/replace pairs may be given at one time.

Syntax
$pregreplace(data,searchregex,replaceregex)

Description
Performs regular expression search/replace on data. searchregex is the pattern to match and replaceregex is what to replace it with.

Syntax
$time(0)

Description
Returns the unix timestamp.

=Examples= set %page "User:ClueBot II/Sandbox"; set %data ""; set %reason "And now we mark it for deletion. (bot)"; pageset %page %data %reason;

getcategorymembers %cm &quot;\n&quot; &quot;Wikipedia bots&quot;; set %output &quot;&quot;; foreach %cm &quot;\n&quot; %page { if ($mid(%page,0,5) == 'User:') { varappend %output $cat(&quot;\n* &quot;,$mid(%page,5),&quot;&quot;); } } pageappend &quot;Wikipedia:Sandbox&quot; $cat(&quot;\n\nHere is a list of the bots on the first page of Category:Wikipedia bots:&quot;,%output) &quot;Adding list of bots.&quot;;

=See also= The CBS interpreter.

=Footnotes=
 * This command has an optional parameter editsummary which can be used to set an edit summary. Otherwise, one is automatically generated.