updateSpecialPages.php

Go to the documentation of this file.

<?php
require_once( __DIR__ . '/Maintenance.php' );

class UpdateSpecialPages extends Maintenance {
        public function __construct() {
                parent::__construct();
                $this->addOption( 'list', 'List special page names' );
                $this->addOption( 'only', 'Only update "page". Ex: --only=BrokenRedirects', false, true );
                $this->addOption( 'override', 'Also update pages that have updates disabled' );
        }

        public function execute() {
                global $IP, $wgSpecialPageCacheUpdates, $wgQueryPages, $wgQueryCacheLimit, $wgDisableQueryPageUpdate;

                $dbw = wfGetDB( DB_MASTER );

                foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
                        if ( !is_callable( $call ) ) {
                                $this->error( "Uncallable function $call!" );
                                continue;
                        }
                        $t1 = explode( ' ', microtime() );
                        call_user_func( $call, $dbw );
                        $t2 = explode( ' ', microtime() );
                        $this->output( sprintf( '%-30s ', $special ) );
                        $elapsed = ( $t2[0] - $t1[0] ) + ( $t2[1] - $t1[1] );
                        $hours = intval( $elapsed / 3600 );
                        $minutes = intval( $elapsed % 3600 / 60 );
                        $seconds = $elapsed - $hours * 3600 - $minutes * 60;
                        if ( $hours ) {
                                $this->output( $hours . 'h ' );
                        }
                        if ( $minutes ) {
                                $this->output( $minutes . 'm ' );
                        }
                        $this->output( sprintf( "completed in %.2fs\n", $seconds ) );
                        # Wait for the slave to catch up
                        wfWaitForSlaves();
                }

                // This is needed to initialise $wgQueryPages
                require_once( "$IP/includes/QueryPage.php" );

                foreach ( $wgQueryPages as $page ) {
                        list( $class, $special ) = $page;
                        $limit = isset( $page[2] ) ? $page[2] : null;

                        # --list : just show the name of pages
                        if ( $this->hasOption( 'list' ) ) {
                                $this->output( "$special\n" );
                                continue;
                        }

                        if ( !$this->hasOption( 'override' ) && $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate ) ) {
                                $this->output( sprintf( "%-30s disabled\n", $special ) );
                                continue;
                        }

                        $specialObj = SpecialPageFactory::getPage( $special );
                        if ( !$specialObj ) {
                                $this->output( "No such special page: $special\n" );
                                exit;
                        }
                        if ( $specialObj instanceof QueryPage ) {
                                $queryPage = $specialObj;
                        } else {
                                if ( !class_exists( $class ) ) {
                                        $file = $specialObj->getFile();
                                        require_once( $file );
                                }
                                $queryPage = new $class;
                        }

                        if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $queryPage->getName() ) {
                                $this->output( sprintf( '%-30s ',  $special ) );
                                if ( $queryPage->isExpensive() ) {
                                        $t1 = explode( ' ', microtime() );
                                        # Do the query
                                        $num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
                                        $t2 = explode( ' ', microtime() );
                                        if ( $num === false ) {
                                                $this->output( "FAILED: database error\n" );
                                        } else {
                                                $this->output( "got $num rows in " );

                                                $elapsed = ( $t2[0] - $t1[0] ) + ( $t2[1] - $t1[1] );
                                                $hours = intval( $elapsed / 3600 );
                                                $minutes = intval( $elapsed % 3600 / 60 );
                                                $seconds = $elapsed - $hours * 3600 - $minutes * 60;
                                                if ( $hours ) {
                                                        $this->output( $hours . 'h ' );
                                                }
                                                if ( $minutes ) {
                                                        $this->output( $minutes . 'm ' );
                                                }
                                                $this->output( sprintf( "%.2fs\n", $seconds ) );
                                        }
                                        # Reopen any connections that have closed
                                        if ( !wfGetLB()->pingAll() )  {
                                                $this->output( "\n" );
                                                do {
                                                        $this->error( "Connection failed, reconnecting in 10 seconds..." );
                                                        sleep( 10 );
                                                } while ( !wfGetLB()->pingAll() );
                                                $this->output( "Reconnected\n\n" );
                                        } else {
                                                # Commit the results
                                                $dbw->commit( __METHOD__ );
                                        }
                                        # Wait for the slave to catch up
                                        wfWaitForSlaves();
                                } else {
                                        $this->output( "cheap, skipped\n" );
                                }
                        }
                }
        }
}

$maintClass = "UpdateSpecialPages";
require_once( RUN_MAINTENANCE_IF_MAIN );