Merge "(bug 17808) (bug 21167) use real links for search suggestions"
[lhc/web/wiklou.git] / maintenance / updateSpecialPages.php
index aaad371..f92f67a 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
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @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();
@@ -32,20 +38,20 @@ class UpdateSpecialPages extends Maintenance {
        }
 
        public function execute() {
-               global $IP, $wgOut, $wgSpecialPageCacheUpdates, $wgQueryPages, $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
-               $wgOut->disable();
+               global $IP, $wgSpecialPageCacheUpdates, $wgQueryPages, $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
+
                $dbw = wfGetDB( DB_MASTER );
 
-               foreach( $wgSpecialPageCacheUpdates as $special => $call ) {
-                       if( !is_callable($call) ) {
+               foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
+                       if ( !is_callable( $call ) ) {
                                $this->error( "Uncallable function $call!" );
                                continue;
                        }
+                       $this->output( sprintf( '%-30s ', $special ) );
                        $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]);
+                       $elapsed = ( $t2[0] - $t1[0] ) + ( $t2[1] - $t1[1] );
                        $hours = intval( $elapsed / 3600 );
                        $minutes = intval( $elapsed % 3600 / 60 );
                        $seconds = $elapsed - $hours * 3600 - $minutes * 60;
@@ -57,38 +63,43 @@ class UpdateSpecialPages extends Maintenance {
                        }
                        $this->output( sprintf( "completed in %.2fs\n", $seconds ) );
                        # Wait for the slave to catch up
-                       wfWaitForSlaves( 5 );
+                       wfWaitForSlaves();
                }
 
                // This is needed to initialise $wgQueryPages
                require_once( "$IP/includes/QueryPage.php" );
 
-               foreach( $wgQueryPages as $page ) {
-                       @list( $class, $special, $limit ) = $page;
+               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') ) {
+                       if ( $this->hasOption( 'list' ) ) {
                                $this->output( "$special\n" );
                                continue;
                        }
 
-                       if ( !$this->hasOption('override') && $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate ) ) {
+                       if ( !$this->hasOption( 'override' ) && $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate ) ) {
                                $this->output( sprintf( "%-30s 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 {
+                               if ( !class_exists( $class ) ) {
+                                       $file = $specialObj->getFile();
+                                       require_once( $file );
+                               }
+                               $queryPage = new $class;
                        }
-                       $queryPage = new $class;
 
-                       if( !$this->hasOption('only') || $this->getOption('only') == $queryPage->getName() ) {
+                       if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $queryPage->getName() ) {
                                $this->output( sprintf( '%-30s ',  $special ) );
                                if ( $queryPage->isExpensive() ) {
                                        $t1 = explode( ' ', microtime() );
@@ -100,7 +111,7 @@ class UpdateSpecialPages extends Maintenance {
                                        } else {
                                                $this->output( "got $num rows in " );
 
-                                               $elapsed = ($t2[0] - $t1[0]) + ($t2[1] - $t1[1]);
+                                               $elapsed = ( $t2[0] - $t1[0] ) + ( $t2[1] - $t1[1] );
                                                $hours = intval( $elapsed / 3600 );
                                                $minutes = intval( $elapsed % 3600 / 60 );
                                                $seconds = $elapsed - $hours * 3600 - $minutes * 60;
@@ -113,7 +124,7 @@ 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..." );
@@ -122,10 +133,10 @@ class UpdateSpecialPages extends Maintenance {
                                                $this->output( "Reconnected\n\n" );
                                        } else {
                                                # Commit the results
-                                               $dbw->commit();
+                                               $dbw->commit( __METHOD__ );
                                        }
                                        # Wait for the slave to catch up
-                                       wfWaitForSlaves( 5 );
+                                       wfWaitForSlaves();
                                } else {
                                        $this->output( "cheap, skipped\n" );
                                }
@@ -135,4 +146,4 @@ class UpdateSpecialPages extends Maintenance {
 }
 
 $maintClass = "UpdateSpecialPages";
-require_once( DO_MAINTENANCE );
+require_once( RUN_MAINTENANCE_IF_MAIN );