MediaWiki  1.28.0
rebuildLocalisationCache.php
Go to the documentation of this file.
1 <?php
2 
32 require_once __DIR__ . '/Maintenance.php';
33 
40  public function __construct() {
41  parent::__construct();
42  $this->addDescription( 'Rebuild the localisation cache' );
43  $this->addOption( 'force', 'Rebuild all files, even ones not out of date' );
44  $this->addOption( 'threads', 'Fork more than one thread', false, true );
45  $this->addOption( 'outdir', 'Override the output directory (normally $wgCacheDirectory)',
46  false, true );
47  $this->addOption( 'lang', 'Only rebuild these languages, comma separated.',
48  false, true );
49  }
50 
51  public function finalSetup() {
52  # This script needs to be run to build the inital l10n cache. But if
53  # $wgLanguageCode is not 'en', it won't be able to run because there is
54  # no l10n cache. Break the cycle by forcing $wgLanguageCode = 'en'.
56  $wgLanguageCode = 'en';
57  parent::finalSetup();
58  }
59 
60  public function execute() {
62 
63  $force = $this->hasOption( 'force' );
64  $threads = $this->getOption( 'threads', 1 );
65  if ( $threads < 1 || $threads != intval( $threads ) ) {
66  $this->output( "Invalid thread count specified; running single-threaded.\n" );
67  $threads = 1;
68  }
69  if ( $threads > 1 && wfIsWindows() ) {
70  $this->output( "Threaded rebuild is not supported on Windows; running single-threaded.\n" );
71  $threads = 1;
72  }
73  if ( $threads > 1 && !function_exists( 'pcntl_fork' ) ) {
74  $this->output( "PHP pcntl extension is not present; running single-threaded.\n" );
75  $threads = 1;
76  }
77 
79  $conf['manualRecache'] = false; // Allow fallbacks to create CDB files
80  if ( $force ) {
81  $conf['forceRecache'] = true;
82  }
83  if ( $this->hasOption( 'outdir' ) ) {
84  $conf['storeDirectory'] = $this->getOption( 'outdir' );
85  }
86  $lc = new LocalisationCacheBulkLoad( $conf );
87 
88  $allCodes = array_keys( Language::fetchLanguageNames( null, 'mwfile' ) );
89  if ( $this->hasOption( 'lang' ) ) {
90  # Validate requested languages
91  $codes = array_intersect( $allCodes,
92  explode( ',', $this->getOption( 'lang' ) ) );
93  # Bailed out if nothing is left
94  if ( count( $codes ) == 0 ) {
95  $this->error( 'None of the languages specified exists.', 1 );
96  }
97  } else {
98  # By default get all languages
99  $codes = $allCodes;
100  }
101  sort( $codes );
102 
103  // Initialise and split into chunks
104  $numRebuilt = 0;
105  $total = count( $codes );
106  $chunks = array_chunk( $codes, ceil( count( $codes ) / $threads ) );
107  $pids = [];
108  $parentStatus = 0;
109  foreach ( $chunks as $codes ) {
110  // Do not fork for only one thread
111  $pid = ( $threads > 1 ) ? pcntl_fork() : -1;
112 
113  if ( $pid === 0 ) {
114  // Child, reseed because there is no bug in PHP:
115  // http://bugs.php.net/bug.php?id=42465
116  mt_srand( getmypid() );
117 
118  $this->doRebuild( $codes, $lc, $force );
119  exit( 0 );
120  } elseif ( $pid === -1 ) {
121  // Fork failed or one thread, do it serialized
122  $numRebuilt += $this->doRebuild( $codes, $lc, $force );
123  } else {
124  // Main thread
125  $pids[] = $pid;
126  }
127  }
128  // Wait for all children
129  foreach ( $pids as $pid ) {
130  $status = 0;
131  pcntl_waitpid( $pid, $status );
132  if ( pcntl_wexitstatus( $status ) ) {
133  // Pass a fatal error code through to the caller
134  $parentStatus = pcntl_wexitstatus( $status );
135  }
136  }
137 
138  if ( !$pids ) {
139  $this->output( "$numRebuilt languages rebuilt out of $total\n" );
140  if ( $numRebuilt === 0 ) {
141  $this->output( "Use --force to rebuild the caches which are still fresh.\n" );
142  }
143  }
144  if ( $parentStatus ) {
145  exit( $parentStatus );
146  }
147  }
148 
157  private function doRebuild( $codes, $lc, $force ) {
158  $numRebuilt = 0;
159  foreach ( $codes as $code ) {
160  if ( $force || $lc->isExpired( $code ) ) {
161  $this->output( "Rebuilding $code...\n" );
162  $lc->recache( $code );
163  $numRebuilt++;
164  }
165  }
166 
167  return $numRebuilt;
168  }
169 
175  public function setForce( $forced = true ) {
176  $this->mOptions['force'] = $forced;
177  }
178 }
179 
180 $maintClass = "RebuildLocalisationCache";
181 require_once RUN_MAINTENANCE_IF_MAIN;
A localisation cache optimised for loading large amounts of data for many languages.
Maintenance script to rebuild the localisation cache.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
hasOption($name)
Checks to see if a particular param exists.
setForce($forced=true)
Sets whether a run of this maintenance script has the force parameter set.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfIsWindows()
Check if the operating system is Windows.
static fetchLanguageNames($inLanguage=null, $include= 'mw')
Get an array of language names, indexed by code.
Definition: Language.php:800
$wgLanguageCode
Site language code.
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
$wgLocalisationCacheConf
Localisation cache configuration.
addDescription($text)
Set the description text.
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:802
getOption($name, $default=null)
Get an option, or return the default.
output($out, $channel=null)
Throw some output to the user.
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:35
error($err, $die=0)
Throw an error to the user.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
doRebuild($codes, $lc, $force)
Helper function to rebuild list of languages codes.