MediaWiki  REL1_31
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. ' .
38  'Ex: --only=BrokenRedirects', false, true );
39  $this->addOption( 'override', 'Also update pages that have updates disabled' );
40  }
41 
42  public function execute() {
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->fatalError( "$class is not an instance of QueryPage.\n" );
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 
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 ) {
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 
174 require_once RUN_MAINTENANCE_IF_MAIN;
UpdateSpecialPages\reopenAndWaitForReplicas
reopenAndWaitForReplicas()
Re-open any closed db connection, and wait for replicas.
Definition: updateSpecialPages.php:121
$maintClass
$maintClass
Definition: updateSpecialPages.php:173
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:2825
$wgSpecialPageCacheUpdates
$wgSpecialPageCacheUpdates
Additional functions to be performed with updateSpecialPages.
Definition: DefaultSettings.php:7574
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
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:34
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2966
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
UpdateSpecialPages\__construct
__construct()
Default constructor.
Definition: updateSpecialPages.php:33
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
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:134
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
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:22
$wgQueryCacheLimit
$wgQueryCacheLimit
Number of rows to cache in 'querycache' table when miser mode is on.
Definition: DefaultSettings.php:2201
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:416
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
$special
this hook is for auditing only RecentChangesLinked and Watchlist $special
Definition: hooks.txt:998
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
SpecialPageFactory\getPage
static getPage( $name)
Find the object with a given name and return it (or NULL)
Definition: SpecialPageFactory.php:369
QueryPage\getPages
static getPages()
Get a list of query page classes and their associated special pages, for periodic updates.
Definition: QueryPage.php:66
$wgDisableQueryPageUpdate
$wgDisableQueryPageUpdate
Set this to an array of special page names to prevent maintenance/updateSpecialPages....
Definition: DefaultSettings.php:7896
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
UpdateSpecialPages\execute
execute()
Do the actual work.
Definition: updateSpecialPages.php:42