]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - maintenance/updateSpecialPages.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / maintenance / updateSpecialPages.php
index 3e5df98248e119205f8e3c41d7d00c8cde57a00e..5ea3828214ac5157036ed83ebdd63d1c7a0a5b0e 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /**
- * Run this script periodically if you have miser mode enabled, to refresh the
- * caches
+ * Update for cached special pages.
+ * Run this script periodically if you have miser mode enabled.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * @ingroup Maintenance
  */
 
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
 
+/**
+ * Maintenance script to update cached special pages.
+ *
+ * @ingroup Maintenance
+ */
 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( 'only', 'Only update "page"; case sensitive, ' .
+                       'check correct case by calling this script with --list. ' .
+                       'Ex: --only=BrokenRedirects', false, true );
                $this->addOption( 'override', 'Also update pages that have updates disabled' );
        }
 
        public function execute() {
-               global $IP, $wgOut, $wgSpecialPageCacheUpdates, $wgQueryPages, $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
-               $wgOut->disable();
-               $dbw = wfGetDB( DB_MASTER );
+               global $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
 
-               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( 5 );
-               }
+               $dbw = $this->getDB( DB_MASTER );
 
-               // This is needed to initialise $wgQueryPages
-               require_once( "$IP/includes/QueryPage.php" );
+               $this->doSpecialPageCacheUpdates( $dbw );
 
-               foreach ( $wgQueryPages as $page ) {
-                       @list( $class, $special, $limit ) = $page;
+               foreach ( QueryPage::getPages() 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" );
+                               $this->output( "$special [QueryPage]\n" );
                                continue;
                        }
 
-                       if ( !$this->hasOption( 'override' ) && $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate ) ) {
-                               $this->output( sprintf( "%-30s disabled\n", $special ) );
+                       if ( !$this->hasOption( 'override' )
+                               && $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate )
+                       ) {
+                               $this->output( sprintf( "%-30s [QueryPage] disabled\n", $special ) );
                                continue;
                        }
 
-                       $specialObj = SpecialPage::getPage( $special );
+                       $specialObj = SpecialPageFactory::getPage( $special );
                        if ( !$specialObj ) {
                                $this->output( "No such special page: $special\n" );
                                exit;
                        }
-                       if ( !class_exists( $class ) ) {
-                               $file = $specialObj->getFile();
-                               require_once( $file );
+                       if ( $specialObj instanceof QueryPage ) {
+                               $queryPage = $specialObj;
+                       } else {
+                               $class = get_class( $specialObj );
+                               $this->error( "$class is not an instance of QueryPage.\n", 1 );
+                               die;
                        }
-                       $queryPage = new $class;
 
                        if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $queryPage->getName() ) {
-                               $this->output( sprintf( '%-30s ',  $special ) );
+                               $this->output( sprintf( '%-30s [QueryPage] ', $special ) );
                                if ( $queryPage->isExpensive() ) {
-                                       $t1 = explode( ' ', microtime() );
+                                       $t1 = microtime( true );
                                        # Do the query
                                        $num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
-                                       $t2 = explode( ' ', microtime() );
+                                       $t2 = microtime( true );
                                        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] );
+                                               $elapsed = $t2 - $t1;
                                                $hours = intval( $elapsed / 3600 );
                                                $minutes = intval( $elapsed % 3600 / 60 );
                                                $seconds = $elapsed - $hours * 3600 - $minutes * 60;
@@ -114,26 +101,64 @@ class UpdateSpecialPages extends Maintenance {
                                                $this->output( sprintf( "%.2fs\n", $seconds ) );
                                        }
                                        # Reopen any connections that have closed
-                                       if ( !wfGetLB()->pingAll() )  {
+                                       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();
                                        }
-                                       # Wait for the slave to catch up
-                                       wfWaitForSlaves( 5 );
+                                       # Wait for the replica DB to catch up
+                                       wfWaitForSlaves();
                                } else {
                                        $this->output( "cheap, skipped\n" );
                                }
+                               if ( $this->hasOption( 'only' ) ) {
+                                       break;
+                               }
+                       }
+               }
+       }
+
+       public function doSpecialPageCacheUpdates( $dbw ) {
+               global $wgSpecialPageCacheUpdates;
+
+               foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
+                       # --list : just show the name of pages
+                       if ( $this->hasOption( 'list' ) ) {
+                               $this->output( "$special [callback]\n" );
+                               continue;
+                       }
+
+                       if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $special ) {
+                               if ( !is_callable( $call ) ) {
+                                       $this->error( "Uncallable function $call!" );
+                                       continue;
+                               }
+                               $this->output( sprintf( '%-30s [callback] ', $special ) );
+                               $t1 = microtime( true );
+                               call_user_func( $call, $dbw );
+                               $t2 = microtime( true );
+
+                               $this->output( "completed in " );
+                               $elapsed = $t2 - $t1;
+                               $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 ) );
+                               # Wait for the replica DB to catch up
+                               wfWaitForSlaves();
                        }
                }
        }
 }
 
 $maintClass = "UpdateSpecialPages";
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;