maintenance/updateSpecialPages.php

   1 <?php
   2 /**
   3  * Update for cached special pages.
   4  * Run this script periodically if you have miser mode enabled.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24
  25 require_once __DIR__ . '/Maintenance.php';
  26
  27 /**
  28  * Maintenance script to update cached special pages.
  29  *
  30  * @ingroup Maintenance
  31  */
  32 class UpdateSpecialPages extends Maintenance {
  33         public function __construct() {
  34                 parent::__construct();
  35                 $this->addOption( 'list', 'List special page names' );
  36                 $this->addOption( 'only', 'Only update "page"; case sensitive, ' .
  37                         'check correct case by calling this script with --list. ' .
  38                         'Ex: --only=BrokenRedirects', false, true );
  39                 $this->addOption( 'override', 'Also update pages that have updates disabled' );
  40         }
  41
  42         public function execute() {
  43                 global $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
  44
  45                 $dbw = $this->getDB( DB_MASTER );
  46
  47                 $this->doSpecialPageCacheUpdates( $dbw );
  48
  49                 foreach ( QueryPage::getPages() as $page ) {
  50                         list( $class, $special ) = $page;
  51                         $limit = isset( $page[2] ) ? $page[2] : null;
  52
  53                         # --list : just show the name of pages
  54                         if ( $this->hasOption( 'list' ) ) {
  55                                 $this->output( "$special [QueryPage]\n" );
  56                                 continue;
  57                         }
  58
  59                         if ( !$this->hasOption( 'override' )
  60                                 && $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate )
  61                         ) {
  62                                 $this->output( sprintf( "%-30s [QueryPage] disabled\n", $special ) );
  63                                 continue;
  64                         }
  65
  66                         $specialObj = SpecialPageFactory::getPage( $special );
  67                         if ( !$specialObj ) {
  68                                 $this->output( "No such special page: $special\n" );
  69                                 exit;
  70                         }
  71                         if ( $specialObj instanceof QueryPage ) {
  72                                 $queryPage = $specialObj;
  73                         } else {
  74                                 $class = get_class( $specialObj );
  75                                 $this->error( "$class is not an instance of QueryPage.\n", 1 );
  76                                 die;
  77                         }
  78
  79                         if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $queryPage->getName() ) {
  80                                 $this->output( sprintf( '%-30s [QueryPage] ', $special ) );
  81                                 if ( $queryPage->isExpensive() ) {
  82                                         $t1 = microtime( true );
  83                                         # Do the query
  84                                         $num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
  85                                         $t2 = microtime( true );
  86                                         if ( $num === false ) {
  87                                                 $this->output( "FAILED: database error\n" );
  88                                         } else {
  89                                                 $this->output( "got $num rows in " );
  90
  91                                                 $elapsed = $t2 - $t1;
  92                                                 $hours = intval( $elapsed / 3600 );
  93                                                 $minutes = intval( $elapsed % 3600 / 60 );
  94                                                 $seconds = $elapsed - $hours * 3600 - $minutes * 60;
  95                                                 if ( $hours ) {
  96                                                         $this->output( $hours . 'h ' );
  97                                                 }
  98                                                 if ( $minutes ) {
  99                                                         $this->output( $minutes . 'm ' );
 100                                                 }
 101                                                 $this->output( sprintf( "%.2fs\n", $seconds ) );
 102                                         }
 103                                         # Reopen any connections that have closed
 104                                         $this->reopenAndWaitForReplicas();
 105                                 } else {
 106                                         $this->output( "cheap, skipped\n" );
 107                                 }
 108                                 if ( $this->hasOption( 'only' ) ) {
 109                                         break;
 110                                 }
 111                         }
 112                 }
 113         }
 114
 115         /**
 116          * Re-open any closed db connection, and wait for replicas
 117          *
 118          * Queries that take a really long time, might cause the
 119          * mysql connection to "go away"
 120          */
 121         private function reopenAndWaitForReplicas() {
 122                 if ( !wfGetLB()->pingAll() ) {
 123                         $this->output( "\n" );
 124                         do {
 125                                 $this->error( "Connection failed, reconnecting in 10 seconds..." );
 126                                 sleep( 10 );
 127                         } while ( !wfGetLB()->pingAll() );
 128                         $this->output( "Reconnected\n\n" );
 129                 }
 130                 # Wait for the replica DB to catch up
 131                 wfWaitForSlaves();
 132         }
 133
 134         public function doSpecialPageCacheUpdates( $dbw ) {
 135                 global $wgSpecialPageCacheUpdates;
 136
 137                 foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
 138                         # --list : just show the name of pages
 139                         if ( $this->hasOption( 'list' ) ) {
 140                                 $this->output( "$special [callback]\n" );
 141                                 continue;
 142                         }
 143
 144                         if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $special ) {
 145                                 if ( !is_callable( $call ) ) {
 146                                         $this->error( "Uncallable function $call!" );
 147                                         continue;
 148                                 }
 149                                 $this->output( sprintf( '%-30s [callback] ', $special ) );
 150                                 $t1 = microtime( true );
 151                                 call_user_func( $call, $dbw );
 152                                 $t2 = microtime( true );
 153
 154                                 $this->output( "completed in " );
 155                                 $elapsed = $t2 - $t1;
 156                                 $hours = intval( $elapsed / 3600 );
 157                                 $minutes = intval( $elapsed % 3600 / 60 );
 158                                 $seconds = $elapsed - $hours * 3600 - $minutes * 60;
 159                                 if ( $hours ) {
 160                                         $this->output( $hours . 'h ' );
 161                                 }
 162                                 if ( $minutes ) {
 163                                         $this->output( $minutes . 'm ' );
 164                                 }
 165                                 $this->output( sprintf( "%.2fs\n", $seconds ) );
 166                                 # Wait for the replica DB to catch up
 167                                 $this->reopenAndWaitForReplicas();
 168                         }
 169                 }
 170         }
 171 }
 172
 173 $maintClass = "UpdateSpecialPages";
 174 require_once RUN_MAINTENANCE_IF_MAIN;