MediaWiki  1.23.0
updateSpecialPages.php
Go to the documentation of this file.
1 <?php
25 require_once __DIR__ . '/Maintenance.php';
26 
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 or on ' .
38  'includes/QueryPage.php. 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 = wfGetDB( 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  if ( !class_exists( $class ) ) {
75  $file = $specialObj->getFile();
76  require_once $file;
77  }
78  $queryPage = new $class;
79  }
80 
81  if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $queryPage->getName() ) {
82  $this->output( sprintf( '%-30s [QueryPage] ', $special ) );
83  if ( $queryPage->isExpensive() ) {
84  $t1 = explode( ' ', microtime() );
85  # Do the query
86  $num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
87  $t2 = explode( ' ', microtime() );
88  if ( $num === false ) {
89  $this->output( "FAILED: database error\n" );
90  } else {
91  $this->output( "got $num rows in " );
92 
93  $elapsed = ( $t2[0] - $t1[0] ) + ( $t2[1] - $t1[1] );
94  $hours = intval( $elapsed / 3600 );
95  $minutes = intval( $elapsed % 3600 / 60 );
96  $seconds = $elapsed - $hours * 3600 - $minutes * 60;
97  if ( $hours ) {
98  $this->output( $hours . 'h ' );
99  }
100  if ( $minutes ) {
101  $this->output( $minutes . 'm ' );
102  }
103  $this->output( sprintf( "%.2fs\n", $seconds ) );
104  }
105  # Reopen any connections that have closed
106  if ( !wfGetLB()->pingAll() ) {
107  $this->output( "\n" );
108  do {
109  $this->error( "Connection failed, reconnecting in 10 seconds..." );
110  sleep( 10 );
111  } while ( !wfGetLB()->pingAll() );
112  $this->output( "Reconnected\n\n" );
113  }
114  # Wait for the slave to catch up
115  wfWaitForSlaves();
116  } else {
117  $this->output( "cheap, skipped\n" );
118  }
119  if ( $this->hasOption( 'only' ) ) {
120  break;
121  }
122  }
123  }
124  }
125 
126  public function doSpecialPageCacheUpdates( $dbw ) {
127  global $wgSpecialPageCacheUpdates;
128 
129  foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
130  # --list : just show the name of pages
131  if ( $this->hasOption( 'list' ) ) {
132  $this->output( "$special [callback]\n" );
133  continue;
134  }
135 
136  if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $special ) {
137  if ( !is_callable( $call ) ) {
138  $this->error( "Uncallable function $call!" );
139  continue;
140  }
141  $this->output( sprintf( '%-30s [callback] ', $special ) );
142  $t1 = explode( ' ', microtime() );
143  call_user_func( $call, $dbw );
144  $t2 = explode( ' ', microtime() );
145 
146  $this->output( "completed in " );
147  $elapsed = ( $t2[0] - $t1[0] ) + ( $t2[1] - $t1[1] );
148  $hours = intval( $elapsed / 3600 );
149  $minutes = intval( $elapsed % 3600 / 60 );
150  $seconds = $elapsed - $hours * 3600 - $minutes * 60;
151  if ( $hours ) {
152  $this->output( $hours . 'h ' );
153  }
154  if ( $minutes ) {
155  $this->output( $minutes . 'm ' );
156  }
157  $this->output( sprintf( "%.2fs\n", $seconds ) );
158  # Wait for the slave to catch up
159  wfWaitForSlaves();
160  }
161  }
162  }
163 }
164 
165 $maintClass = "UpdateSpecialPages";
166 require_once RUN_MAINTENANCE_IF_MAIN;
DB_MASTER
const DB_MASTER
Definition: Defines.php:56
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
$maintClass
$maintClass
Definition: updateSpecialPages.php:165
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:3660
wfGetDB
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3650
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
UpdateSpecialPages
Maintenance script to update cached special pages.
Definition: updateSpecialPages.php:32
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
$limit
if( $sleep) $limit
Definition: importImages.php:99
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
QueryPage
This is a class for doing query pages; since they're almost all the same, we factor out some of the f...
Definition: QueryPage.php:30
UpdateSpecialPages\__construct
__construct()
Default constructor.
Definition: updateSpecialPages.php:33
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
wfWaitForSlaves
wfWaitForSlaves( $maxLag=false, $wiki=false, $cluster=false)
Modern version of wfWaitForSlaves().
Definition: GlobalFunctions.php:3795
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
UpdateSpecialPages\doSpecialPageCacheUpdates
doSpecialPageCacheUpdates( $dbw)
Definition: updateSpecialPages.php:126
$file
if(PHP_SAPI !='cli') $file
Definition: UtfNormalTest2.php:30
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:191
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:333
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:314
SpecialPageFactory\getPage
static getPage( $name)
Find the object with a given name and return it (or NULL)
Definition: SpecialPageFactory.php:338
QueryPage\getPages
static getPages()
Get a list of query page classes and their associated special pages, for periodic updates.
Definition: QueryPage.php:66
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:181
UpdateSpecialPages\execute
execute()
Do the actual work.
Definition: updateSpecialPages.php:42
$special
namespace and then decline to actually register it RecentChangesLinked and Watchlist $special
Definition: hooks.txt:815