Fixes Bug 31865 - Tag <dws> for discarding whitespaces.
[lhc/web/wiklou.git] / maintenance / updateSpecialPages.php
index fae0722..ddf1601 100644 (file)
 <?php
-
-# Run this script periodically if you have miser mode enabled, to refresh the caches
-$options = array('only','help');
-
-require_once( 'commandLine.inc' );
-
-require_once( 'SpecialPage.php' );
-require_once( 'QueryPage.php' );
-
-if(@$options['help']) {
-       print "usage:updateSpecialPages.php [--help] [--only=page]\n";
-       print "  --help      : this help message\n";
-       print "  --list      : list special pages names\n";
-       print "  --only=page : only update 'page'. Ex: --only=BrokenRedirects\n";
-       wfDie();
-}
-
-$wgOut->disable();
-$dbw =& wfGetDB( DB_MASTER );
-
-foreach ( $wgQueryPages as $page ) {
-       @list( $class, $special, $limit ) = $page;
-
-       # --list : just show the name of pages
-       if( @$options['list'] ) {
-               print "$special\n";
-               continue;
-       }
-
-       if ( $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate ) ) {
-               printf("%-30s disabled\n", $special);
-               continue;
-       }
-
-       $specialObj = SpecialPage::getPage( $special );
-       if ( !$specialObj ) {
-               print "No such special page: $special\n";
-               exit;
-       }
-       if ( !class_exists( $class ) ) {
-               $file = $specialObj->getFile();
-               require_once( $file );
+/**
+ * Run this script periodically if you have miser mode enabled, to refresh the
+ * caches
+ *
+ * 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
+ * the Free Software Foundation; either version 2 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 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' );
+
+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' );
        }
-       $queryPage = new $class;
 
-       if( !(isset($options['only'])) or ($options['only'] == $queryPage->getName()) ) {
-       printf( '%-30s ',  $special );
+       public function execute() {
+               global $IP, $wgSpecialPageCacheUpdates, $wgQueryPages, $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
 
-       if ( $queryPage->isExpensive() ) {
-               $t1 = explode( ' ', microtime() );
-               # Do the query
-               $num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
-               $t2 = explode( ' ', microtime() );
+               $dbw = wfGetDB( DB_MASTER );
 
-               if ( $num === false ) {
-                       print "FAILED: database error\n";
-               } else {
-                       print "got $num rows in ";
-
-                       $elapsed = ($t2[0] - $t1[0]) + ($t2[1] - $t1[1]);
+               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 ) {
-                               print $hours . 'h ';
+                               $this->output( $hours . 'h ' );
                        }
                        if ( $minutes ) {
-                               print $minutes . 'm ';
+                               $this->output( $minutes . 'm ' );
                        }
-                       printf( "%.2fs\n", $seconds );
+                       $this->output( sprintf( "completed in %.2fs\n", $seconds ) );
+                       # Wait for the slave to catch up
+                       wfWaitForSlaves();
                }
 
-               # Reopen any connections that have closed
-               if ( !$wgLoadBalancer->pingAll())  {
-                       print "\n";
-                       do {
-                               print "Connection failed, reconnecting in 10 seconds...\n";
-                               sleep(10);
-                       } while ( !$wgLoadBalancer->pingAll() );
-                       print "Reconnected\n\n";
-               } else {
-                       # Commit the results
-                       $dbw->immediateCommit();
-               }
+               // This is needed to initialise $wgQueryPages
+               require_once( "$IP/includes/QueryPage.php" );
 
-               # Wait for the slave to catch up
-               /*
-               $slaveDB =& wfGetDB( DB_SLAVE, array('QueryPage::recache', 'vslow' ) );
-               while( $slaveDB->getLag() > 600 ) {
-                       print "Slave lagged, waiting...\n";
-                       sleep(30);
+               foreach ( $wgQueryPages as $page ) {
+                       list( $class, $special ) = $page;
+                       $limit = isset( $page[2] ) ? $page[2] : null;
 
-               }
-               */
-               wfWaitForSlaves( 5 );
+                       # --list : just show the name of pages
+                       if ( $this->hasOption( 'list' ) ) {
+                               $this->output( "$special\n" );
+                               continue;
+                       }
 
-       } else {
-               print "cheap, skipped\n";
-       }
+                       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();
+                                       }
+                                       # Wait for the slave to catch up
+                                       wfWaitForSlaves();
+                               } else {
+                                       $this->output( "cheap, skipped\n" );
+                               }
+                       }
+               }
        }
 }
 
-?>
+$maintClass = "UpdateSpecialPages";
+require_once( RUN_MAINTENANCE_IF_MAIN );