diff --git a/README.md b/README.md index 2e86984..88f5f04 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,99 @@ # Italian Wikipedia Deletion Bot This software is an Italian Wikipedia bot. It keeps updated the public deletion logs of Italian Wikipedia pages. ## History of the project The script was originally developed by Mauro762 (aka MauroBot) in 2013 using JavaScript and previously developed in Python {{Citation needed}}. ## Installation sudo apt install git php-cli git clone --recursive https://github.com/valerio-bozzolan/ItalianWikipediaDeletionBot ## Configuration 1. Open the file [`config-example.php`](config-example.php) with a text editor 2. Fill your bot credentials 3. Save-as `config.php` ## Usage Run on today: ./bot.php Run on the latest 10 days: - ./bot.php 10 + ./bot.php --days=10 Run on a specific date (year-month-day): - ./bot.php 1 2018-03-13 + ./bot.php --from=2018-03-13 Run on a specific date and for 10 days before it: - ./bot.php 10 2018-03-13 + ./bot.php --days=10 --from=2018-03-13 + +Ask before saving and enable verbose mode: + + ./bot.php --ask --verbose + +Help: + + ./bot.php --help ## Update To fetch the updates: git pull --recurse-submodules ## Hacking Most of the behaviours — as the content of the categories, the pages, their edit summaries, etc. — can be changed simply hacking the content of the files from the [/templates](/templates) directory. Trust me, you are able to do it. Start becoming familiar with their structure: This is the place for some documentation, expecially about "placeholders". This is the place for a specific example This is the place for the most important part of this file. This part is what this template will generates. It uses stuff like "$1" or "%1%02d" as generic placeholders. To be honest: everything above the `` line it's pure documentation sugar. It's written to help you. I've spent some minutes on them. Please RTFM. asd A non-traumatic template example can be found [here](templates/CATEGORY_YEAR.content.tpl). It describes the generation of the yearly category. ## Framework You may not want to know this: HTTP connections, MediaWiki APIs (including login and tokens etc.), and other stuff, are handled by the [boz-mw](https://github.com/valerio-bozzolan/boz-mw) framework. ## License -Original files released under [Creative Commons BY-SA 3.0 International](https://creativecommons.org/licenses/by-sa/3.0/) and [WMF terms](https://wikimediafoundation.org/wiki/Special:MyLanguage/Terms_of_Use/it) by [Mauro742](https://it.wikipedia.org/wiki/Utente:Mauro742)/[MauroBot](https://it.wikipedia.org/wiki/Utente:MauroBot): -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/main.js -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/bot.js -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/category.js -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/dateFunctions.js -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/core.js -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/globals.js -* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/gui.js - Copyright (C) 2018 [Valerio Bozzolan](https://it.wikipedia.org/wiki/Utente:Valerio_Bozzolan) This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . + +Original files released under [Creative Commons BY-SA 3.0 International](https://creativecommons.org/licenses/by-sa/3.0/) and [WMF terms](https://wikimediafoundation.org/wiki/Special:MyLanguage/Terms_of_Use/it) by [Mauro742](https://it.wikipedia.org/wiki/Utente:Mauro742)/[MauroBot](https://it.wikipedia.org/wiki/Utente:MauroBot): +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/main.js +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/bot.js +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/category.js +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/dateFunctions.js +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/core.js +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/globals.js +* https://it.wikipedia.org/wiki/Utente:MauroBot/BotCancellazioni/gui.js diff --git a/bot.php b/bot.php index 44f87aa..07b1a3d 100755 --- a/bot.php +++ b/bot.php @@ -1,43 +1,82 @@ #!/usr/bin/php . namespace itwikidelbot; // autoload classes require __DIR__ . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'autoload.php'; use cli\Log; // load credentials require __DIR__ . DIRECTORY_SEPARATOR . 'config.php'; // the bot must be in sync with the italian community date_default_timezone_set( 'Europe/Rome' ); -// the first argument is the days to go backward -$DAYS = isset( $argv[ 1 ] ) ? (int) $argv[ 1 ] : 1; +// allowed only from command line interface +if( ! isset( $argv[ 0 ] ) ) { + exit( 1 ); +} + +// command line arguments +$opts = getopt( 'h', [ + 'ask', // ask for every edit | default: no + 'days:', // days to be processed | default: only one + 'from:', // date to start from | default: from today + 'help', // help message + 'verbose', // debug mode | default: no +] ); + +// help message +if( isset( $opts[ 'help' ] ) || isset( $opts[ 'h' ] ) ) { + printf( "usage: %s [OPTIONS]\n\n", $argv[ 0 ] ); + echo " --days=DAYS how many days to be processed (default: 1)\n"; + echo " --from=YYYY-MM-DD starting date (default: today)\n"; + echo " --ask ask before saving\n"; + echo " --verbose verbose mode\n"; + echo " -h --help show this help and exit\n"; + exit( 0 ); +} + +// days to be processed from now to the past +$DAYS = isset( $opts[ 'days' ] ) + ? (int) $opts[ 'days' ] + : 1; -// the second argument is a 'YYYY-MM-DD' date -$DATE = isset( $argv[ 2 ] ) ? $argv[ 2 ] : 'now'; +// starting date formatted as 'YYYY-MM-DD' +$DATE = isset( $opts[ 'from' ] ) + ? $opts[ 'from' ] + : 'now'; + +// ask for every edit +if( isset( $opts[ 'ask' ] ) ) { + Page::$ASK_BEFORE_SAVING = true; +} + +// verbose mode +if( isset( $opts[ 'verbose' ] ) ) { + Log::$DEBUG = true; +} Log::info( 'start' ); $bot = Bot::createFromString( $DATE ); for( $i = 0; $i < $DAYS; $i++ ) { $bot->run()->previousDay(); } Log::info( 'end' ); diff --git a/config-example.php b/config-example.php index 03bc0ac..76020a8 100644 --- a/config-example.php +++ b/config-example.php @@ -1,12 +1,5 @@