View source for Wikipedia:WPCleaner/Bot tools

{{WPCleaner}}

[[File:WPCleaner - Bot Tools.png|center|alt=Bot tools|Bot tools]]
{{clr}}

WPCleaner provides a few [[WP:Bot|Bot]] tools:
[[File:WPCleaner - Bot Tools - General.png|right|alt=General bot tools|General bot tools]]
[[File:WPCleaner - Bot Tools - CheckWiki.png|right|alt=Bot tools for Check Wiki|Bot tools for Check Wiki]]
* Update of existing disambiguation warning messages on talk pages to inform contributors on the presence of links to disambiguation pages.
* Update of ISBN warning messages on talk pages to inform contributors on the presence of ISBN errors.
* Update of duplicate arguments warning messages on talk pages to inform contributors on the presence of duplicate arguments.
* Make a list of [[User:NicoV/ISBN errors|ISBN errors]] with related articles.
* Monitor recent changes to detect new disambiguation links.
* [[WP:WCW|Check Wiki project]]:
** Automatic fixing for some errors.
** Verification of existing errors in articles.
** Verification of white lists.


'''Note:''' These tools are meant to be used only by [[WP:Bot policy|authorized bots]].
They can modify a lots of pages in a small amount of time.
Use only this functions if you understand perfectly the modifications about to be made.
It's your responsibility to ensure that the modifications are correct.

== Command line usage ==

Most of these tools are also available in the command line, so they can be used automatically on a regular basis.

To use WPCleaner from the command line:
* Download [http://site4145.mutu.sivit.org/WikiCleaner/WikipediaCleaner.jar WikipediaCleaner.jar]
* Run WPCleaner with the following command:
** On Windows, <code>java -cp WikipediaCleaner.jar org.wikipediacleaner.Bot ''general_options'' ''wiki'' ''user'' ''password'' ''command'' ''options…''</code>

Where :
* <code>''general_options''</code> are possible general options:
** <code>-timelimit ''seconds''</code> to define a time limit in seconds for the execution time
* <code>''wiki''</code> is the wiki code on which WPCleaner should run (« en » for this wiki)
* <code>''user''</code> is your user name
* <code>''password''</code> is your password
* <code>''command''</code> is the command to run, and <code>''options…''</code> the specific options for the command. Available commands are :
** <code>UpdateDabWarnings</code> to update disambiguation warnings ([[:fr:Modèle:Avertissement Homonymie|example on frwiki]])
** <code>UpdateDuplicateArgsWarnings</code> to update duplicate arguments warnings ([[:fr:Modèle:Avertissement Argument dupliqué|example on frwiki]])
** <code>UpdateISBNWarnings</code> to update ISBN warnings ([[:fr:Modèle:Avertissement ISBN|example on frwiki]])
** <code>ListISBNWarnings</code> to update the [[Wikipedia:WikiProject Check Wikipedia/ISBN errors|list of ISBN errors]]
** <code>UpdateISSNWarnings</code> to update ISSN warnings ([[:fr:Modèle:Avertissement ISSN|example on frwiki]])
** <code>ListISSNWarnings</code> to update the [[Wikipedia:WikiProject Check Wikipedia/ISSN errors|list of ISSN errors]]
** <code>FixCheckWiki</code> to fix some errors for the Check Wiki project. The options contain error numbers for lists to be analyzed (<code>''errorNumber''</code>) and eventually other errors to be fixed if found in the article (<code>+''errorNumber''</code>).
** <code>ListCheckWiki</code> to analyze a [https://dumps.wikimedia.org/backup-index.html MediaWiki dump file] to find some errors for the Check Wiki project. The options contain:
*** path to the dump file,
*** path to the directory or files (<code>''directoryOrFile''</code>) or the name of page (<code>wiki:''pageName''</code>), where the result will be stored. Note: <code>{0}</code> will be replaced by the error number.
*** error numbers for lists to be analyzed (<code>''errorNumber''</code>).

=== Update ===

It's always better to use an up to date version of WPCleaner, and it's even more important when running in bot mode.

The <code>UpdateWPCleaner.bat</code> script below retrieves the last version of WPCleaner on Windows. The <code>wget</code> program can be downloaded from the [http://gnuwin32.sourceforge.net/packages/wget.htm GnuWin32 project].

<syntaxhighlight lang="dosbatch">
@ECHO OFF

:: Update WPCleaner
DEL /F WikipediaCleaner.jar
"C:\Program Files (x86)\GnuWin32\bin\wget.exe" http://site4145.mutu.sivit.org/WikiCleaner/WikipediaCleaner.jar
</syntaxhighlight>

=== Repetitive tasks ===

It's possible to create scripts to do some repetitive tasks.

The <code>FixCheckWiki.bat</code> script below automatically fixes error #16 (Control characters).

<syntaxhighlight lang="dosbatch">
@ECHO OFF

:: Update WPCleaner
CALL UpdateWPCleaner.bat

java -cp WikipediaCleaner.jar org.wikipediacleaner.Bot fr USER PASSWORD FixCheckWiki 16
</syntaxhighlight>

== Running on Toolforge ==

It's possible to run WPCleaner in bot mode on Toolforge. Details can be found in [https://phabricator.wikimedia.org/T258207 this Phabricator issue], especially in [https://phabricator.wikimedia.org/T258207#8092429 this comment].

== Running on Synology NAS ==

It's possible to run WPCleaner in bot mode on some NAS, depending on the brand and model of the NAS. This chapter gives an example for Synology NAS (tested with DS411j model).

To run automated tasks with WPCleaner at regular interval, follow the steps below:
* Install Java (details on the procedure are available at [http://pcloadletter.co.uk/2011/08/23/java-package-for-synology/ pcloadletter]):
** 
** Check which CPU your NAS has, based on [http://forum.synology.com/wiki/index.php/What_kind_of_CPU_does_my_NAS_have this list] (DS411j example: ''Marvell Kirkwood mv6281 1.2Ghz ARM'' so ARM).
** Download Java 7 Embedded for your kind of CPU on [http://www.oracle.com/technetwork/java/embedded/downloads/javase/index.html Oracle website] (DS411j example: ''ejre-7u55-fcs-b13-linux-arm-sflt-headless-17_mar_2014.tar.gz'') and copy it in the shared folder ''public'' of your NAS (create this folder if needed)
** In your NAS package centre, add ''PCLoadLetter'' with url http://packages.pcloadletter.co.uk.
** Install package ''Java SE Embedded 7''.
* Create the script:
** Create a dedicated directory for the script (example: ''/volume1/Divers/WPCleaner/ISBNWarnings'')
** Create the script itself (example : ''script.sh'' below to be adapted according to the directory you have chosen and the task to be accomplished). A few explanations:
*** On the first line, use <code>#!/bin/sh</code>
*** Then use the <code>cd</code> command to go in the directory containing the script
*** Update WPCleaner (<code>rm</code> and <code>wget</code> commands)
*** Run the automated task(s) with WPCleaner (example, update disambiguation warnings)
** Check that the script works from the command line
* Schedule the script using the NAS Task Scheduler.


<syntaxhighlight lang="bash">
#!/bin/sh
cd /volume1/Divers/WPCleaner/FixCheckWiki/
/bin/rm -f WikipediaCleaner.jar 2>&1 | /usr/bin/tee script.log
/usr/bin/wget -nv http://site4145.mutu.sivit.org/WikiCleaner/WikipediaCleaner.jar 2>&1 | /usr/bin/tee -a script.log
/volume1/@appstore/java7/jre/bin/java -Xmx1024m -cp WikipediaCleaner.jar org.wikipediacleaner.Bot fr USER PASSWORD UpdateDabWarnings 2>&1 | /usr/bin/tee -a script.log
echo Finished >> script.log
</syntaxhighlight>

[[Category:WPCleaner|Bot tools]]