diff --git a/includes/autoload.php b/includes/autoload.php index 1bef3fe..dd2ed5e 100644 --- a/includes/autoload.php +++ b/includes/autoload.php @@ -1,17 +1,20 @@ . +// load some common functions +require __DIR__ . '/functions.php'; + // autoload boz-mw classes require __DIR__ . '/boz-mw/autoload.php'; diff --git a/includes/functions.php b/includes/functions.php new file mode 100644 index 0000000..fc225d6 --- /dev/null +++ b/includes/functions.php @@ -0,0 +1,57 @@ +. + +/** + * Show the help message and die + */ +function show_help() { + + global $argv; + + echo "Welcome in your MediaWiki Orphanizer bot!\n\n"; + echo "Available options:\n"; + + // show every available option + foreach( \cli\Opts::instance()->getParams() as $param ) { + + // long option + if( $param->hasLongName() ) { + echo " --{$param->getLongName()}"; + if( $param->isValueRequired() ) { + echo "=VALUE"; + } + echo "\n"; + } + + // short option + if( $param->hasShortName() ) { + echo " -{$param->getShortName()}"; + if( $param->isValueRequired() ) { + echo "=VALUE"; + } + echo "\n"; + } + + // description + echo " \t{$param->getDescription()}\n"; + } + + echo "\n Example:\n" . + " \t{$argv[0]} --wiki=itwiki --list=Wikipedia:PDC/Elenco\n\n" . + " Have fun! by Valerio Bozzolan, Daimona Eaytoy\n" ; + + exit( 0 ); + +} diff --git a/orphanize.php b/orphanize.php index 86aaa09..b4637ad 100755 --- a/orphanize.php +++ b/orphanize.php @@ -1,389 +1,359 @@ #!/usr/bin/php . namespace itwikidelbot; // die on whatever error set_error_handler( function( $errno, $errstr, $errfile, $errline ) { if( error_reporting() !== 0 ) { throw new \ErrorException( $errstr, 0, $errno, $errfile, $errline ); } } ); // do not expose from web isset( $argv[ 0 ] ) or exit( 1 ); // autoload classes require __DIR__ . '/includes/autoload.php'; // require config file file_exists( $config_path = __DIR__ . '/config.php' ) or die( "Please provide the configuration file at $config_path\n" ); require $config_path; // how much titles at time requesting - this is a MediaWiki limit define( 'MAX_TRANCHE_TITLES', 50 ); // classes used use \cli\Input; use \cli\Opts; use \cli\ParamFlag; use \cli\ParamValued; use \cli\Log; use \web\MediaWikis; use \mw\Wikilink; use \mw\Ns; use \mw\API\ProtectedPageException; // register available options $opts = Opts::instance()->register( [ // register arguments with a value new ParamValued( 'wiki', null, 'Specify a wiki from it\'s UID' ), new ParamValued( 'cfg', null, 'Title of an on-wiki configuration page with JSON content model' ), new ParamValued( 'list', null, 'Specify a pagename that should contain the wikilinks to be orphanized' ), new ParamValued( 'summary', null, 'Edit summary' ), new ParamValued( 'ns', null, 'Namespace whitelist' ), new ParamValued( 'warmup', null, 'Start only if the last edit on the list was done at least $warmup seconds ago' ), new ParamValued( 'cooldown', null, 'End early when reaching this number of edits' ), // register arguments without a value new ParamFlag( 'debug', null, 'Increase verbosity' ), new ParamFlag( 'help', 'h', 'Show this message and quit' ), new ParamFlag( 'no-interaction', null, 'Do not confirm every change' ), ] ); // show help if( $opts->getArg( 'help' ) ) { - echo "Welcome in your MediaWiki Orphanizer bot!\n\n"; - echo "Available options:\n"; - foreach( Opts::instance()->getParams() as $param ) { - - // long option - if( $param->hasLongName() ) { - echo " --{$param->getLongName()}"; - if( $param->isValueRequired() ) { - echo "=VALUE"; - } - echo "\n"; - } - - // short option - if( $param->hasShortName() ) { - echo " -{$param->getShortName()}"; - if( $param->isValueRequired() ) { - echo "=VALUE"; - } - echo "\n"; - } - - // description - echo " \t{$param->getDescription()}\n"; - } - - echo "\n Example:\n" . - " \t{$argv[0]} --wiki=itwiki --list=Wikipedia:PDC/Elenco\n\n" . - " Have fun! by Valerio Bozzolan\n" ; - - exit( 0 ); + show_help(); } // disable interaction $NO_INTERACTION = $opts->getArg( 'no-interaction' ); // title source $TITLE_SOURCE = $opts->getArg( 'list', 'Utente:.avgas/Wikilink da orfanizzare' ); // cfg page $CFG_PAGE = $opts->getArg( 'cfg', 'Utente:OrfanizzaBot/Configurazione' ); Log::info( "start" ); // increase verbosity if( $opts->getArg( 'debug' ) ) { Log::$DEBUG = true; } // wiki identifier $wiki_uid = $opts->getArg( 'wiki', 'itwiki' ); // wiki instance $wiki = Mediawikis::findFromUid( $wiki_uid ); // retrieve config page (that's a JSON page) Log::info( "reading $CFG_PAGE" ); $cfgRevs = $wiki->fetch( [ 'action' => 'query', 'titles' => $CFG_PAGE, 'prop' => 'revisions', 'rvslots' => 'main', 'rvprop' => 'content', ] ); $cfgRev = reset( $cfgRevs->query->pages )->revisions[0]; if ( $cfgRev->slots->main->contentmodel !== 'json' ) { Log::error( 'The cfg page must have JSON content model.' ); exit( 1 ); } $cfg = json_decode( $cfgRev->slots->main->{ '*' } ); // edit summary $SUMMARY = isset( $cfg->summary ) ? $cfg->summary : "Bot TEST: orfanizzazione voci eliminate in seguito a [[WP:RPC|consenso cancellazione]]"; // limit to a certain namespace (default is every namespace) $NS = isset( $cfg->ns ) ? $cfg->ns : null; // number of seconds of pause after last edit to the list (default is immediately) $WARMUP = isset( $cfg->warmup ) ? $cfg->warmup : -1; // limit to a certain number of edits (default 1000 edits) $COOLDOWN = isset( $cfg->cooldown ) ? $cfg->cooldown : 1000; // query titles to be orphanized alongside the last revision of the list $responses = $wiki->createQuery( [ 'action' => 'query', 'titles' => $TITLE_SOURCE, 'prop' => [ 'links', 'revisions', ], 'rvslots' => 'main', 'rvprop' => 'timestamp', ] ); // collect links and take the last edit timestamp $titles_to_be_orphanized = []; Log::info( "reading $TITLE_SOURCE" ); foreach( $responses as $response ) { foreach( $response->query->pages as $page ) { // check warmup $timestamp = reset( $page->revisions )->timestamp; $timestamp = \DateTime::createFromFormat( \DateTime::ISO8601, $timestamp ); $seconds = time() - $timestamp->getTimestamp(); if( $seconds < $WARMUP ) { Log::info( "edited just $seconds seconds ago: quit until warmup $WARMUP" ); exit( 1 ); } // collect links foreach( $page->links as $link ) { $titles_to_be_orphanized[] = Ns::defaultCanonicalName( $link->ns ) . $link->title; } } } // die if no links if( ! $titles_to_be_orphanized ) { Log::info( 'empty list' ); exit( 1 ); } // keep a copy $involved_pagetitles = $titles_to_be_orphanized; // log titles Log::info( 'read ' . count( $titles_to_be_orphanized ) . ' pages to be orphanized:' ); foreach( $titles_to_be_orphanized as $title ) { Log::info( " $title" ); } // associative array of page IDs as key and a boolean as value containg pages to be orphanized $involved_pageids = []; // note that the API accepts a maximum trance of titles while( $less_titles_to_be_orphanized = array_splice( $titles_to_be_orphanized, 0, MAX_TRANCHE_TITLES ) ) { // API arguments for the linkshere query $linksto_args = [ 'action' => 'query', 'titles' => $less_titles_to_be_orphanized, 'prop' => 'linkshere', 'lhprop' => 'pageid', 'lhshow' => '!redirect', 'lhlimit' => 300, ]; // limit to certain namespaces if( $NS !== null ) { $linksto_args[ 'lhnamespace' ] = implode( '|', $NS ); } // cumulate the linkshere page ids Log::info( "requesting linkshere..." ); $linksto = $wiki->createQuery( $linksto_args ); foreach( $linksto as $response ) { foreach( $response->query->pages as $page ) { if( isset( $page->linkshere ) ) { foreach( $page->linkshere as $linkingpage ) { $involved_pageids[] = (int) $linkingpage->pageid; } } } } } // count of involved pages Log::info( sprintf( "found %d pages containing the %d involved wlinks", count( $involved_pageids ), count( $involved_pagetitles ) ) ); // number of edited pages $edits = 0; // note that the API accepts a maximum tranche of IDs while( $less_involved_pageids = array_splice( $involved_pageids, 0, MAX_TRANCHE_TITLES ) ) { // query last revision $responses = $wiki->createQuery( [ 'action' => 'query', 'pageids' => $less_involved_pageids, 'prop' => 'revisions', 'rvslots' => 'main', 'rvprop' => [ 'content', 'timestamp', ], ] ); // for each response foreach( $responses as $response ) { // for each page foreach( $response->query->pages as $page ) { // avoid too many edits if( $edits > $COOLDOWN ) { Log::info( "reached cooldown: stop" ); exit( 0 ); } // page ID to be edited $pageid = $page->pageid; // does it have a revision? if( !isset( $page->revisions[ 0 ] ) ) { continue; } // the first revision $revision = $page->revisions[ 0 ]; // timestamp of the revision useful to avoid edit conflicts $timestamp = $revision->timestamp; // wikitext from the main slot of this revision $wikitext_raw = $revision->slots->main->{ '*' }; // create a Wikitext object $wikitext = $wiki->createWikitext( $wikitext_raw ); // for each of the titles to be orphanized foreach( $involved_pagetitles as $involved_pagetitle ) { // parse the orphanizing title $title = $wiki->createTitleParsing( $involved_pagetitle ); // a wikilink with and without alias $wikilink_simple = $wiki->createWikilink( $title, Wikilink::NO_ALIAS ); $wikilink_alias = $wiki->createWikilink( $title, Wikilink::WHATEVER_ALIAS ); // replace simple links e.g. [[Hello]] $wikilink_regex_simple = $wikilink_simple->getRegex( [ 'title-group-name' => 'title', ] ); // replace links with alias e.g. [[Hello|whatever]] $wikilink_regex_alias = $wikilink_alias->getRegex( [ 'alias-group-name' => 'alias', ] ); Log::debug( "regex simple wikilink:" ); Log::debug( $wikilink_regex_simple ); Log::debug( "regex wikilink aliased:" ); Log::debug( $wikilink_regex_alias ); // convert '[[Hello]]' to 'Hello' $wikitext->pregReplaceCallback( "/$wikilink_regex_simple/", function ( $matches ) { return $matches[ 'title' ]; } ); // convert '[[Hello|world]]' to 'world' $wikitext->pregReplaceCallback( "/$wikilink_regex_alias/", function ( $matches ) { return $matches[ 'alias' ]; } ); } // end loop titles to be orphanized // check for changes and save if( $wikitext->isChanged() ) { Log::info( "changes on page $pageid:" ); foreach( $wikitext->getHumanUniqueSobstitutions() as $sobstitution ) { Log::info( "\t $sobstitution" ); } if( $NO_INTERACTION || 'n' !== Input::yesNoQuestion( "confirm changes" ) ) { try { // eventually login and save $wiki->login()->edit( [ 'pageid' => $pageid, 'text' => $wikitext->getWikitext(), 'summary' => $SUMMARY, 'timestamp' => $timestamp, 'minor' => 1, 'bot' => 1, ] ); $edits++; } catch( ProtectedPageException $e ) { Log::warn( "skip protected page $pageid" ); } } // end confirmation } // end save } // end loop pages } // end loop responses } // end loop involved page IDs Log::info( "end" );