MediaWiki  1.23.1
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->mDescription = "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 memoryLimit() {
52  if ( $this->hasOption( 'memory-limit' ) ) {
53  return parent::memoryLimit();
54  }
55  return '1000M';
56  }
57 
58  public function finalSetup() {
59  # This script needs to be run to build the inital l10n cache. But if
60  # $wgLanguageCode is not 'en', it won't be able to run because there is
61  # no l10n cache. Break the cycle by forcing $wgLanguageCode = 'en'.
62  global $wgLanguageCode;
63  $wgLanguageCode = 'en';
64  parent::finalSetup();
65  }
66 
67  public function execute() {
68  global $wgLocalisationCacheConf;
69 
70  $force = $this->hasOption( 'force' );
71  $threads = $this->getOption( 'threads', 1 );
72  if ( $threads < 1 || $threads != intval( $threads ) ) {
73  $this->output( "Invalid thread count specified; running single-threaded.\n" );
74  $threads = 1;
75  }
76  if ( $threads > 1 && wfIsWindows() ) {
77  $this->output( "Threaded rebuild is not supported on Windows; running single-threaded.\n" );
78  $threads = 1;
79  }
80  if ( $threads > 1 && !function_exists( 'pcntl_fork' ) ) {
81  $this->output( "PHP pcntl extension is not present; running single-threaded.\n" );
82  $threads = 1;
83  }
84 
85  $conf = $wgLocalisationCacheConf;
86  $conf['manualRecache'] = false; // Allow fallbacks to create CDB files
87  if ( $force ) {
88  $conf['forceRecache'] = true;
89  }
90  if ( $this->hasOption( 'outdir' ) ) {
91  $conf['storeDirectory'] = $this->getOption( 'outdir' );
92  }
93  $lc = new LocalisationCacheBulkLoad( $conf );
94 
95  $allCodes = array_keys( Language::fetchLanguageNames( null, 'mwfile' ) );
96  if ( $this->hasOption( 'lang' ) ) {
97  # Validate requested languages
98  $codes = array_intersect( $allCodes,
99  explode( ',', $this->getOption( 'lang' ) ) );
100  # Bailed out if nothing is left
101  if ( count( $codes ) == 0 ) {
102  $this->error( 'None of the languages specified exists.', 1 );
103  }
104  } else {
105  # By default get all languages
106  $codes = $allCodes;
107  }
108  sort( $codes );
109 
110  // Initialise and split into chunks
111  $numRebuilt = 0;
112  $total = count( $codes );
113  $chunks = array_chunk( $codes, ceil( count( $codes ) / $threads ) );
114  $pids = array();
115  foreach ( $chunks as $codes ) {
116  // Do not fork for only one thread
117  $pid = ( $threads > 1 ) ? pcntl_fork() : -1;
118 
119  if ( $pid === 0 ) {
120  // Child, reseed because there is no bug in PHP:
121  // http://bugs.php.net/bug.php?id=42465
122  mt_srand( getmypid() );
123  $numRebuilt = $this->doRebuild( $codes, $lc, $force );
124  // Abuse the exit value for the count of rebuild languages
125  exit( $numRebuilt );
126  } elseif ( $pid === -1 ) {
127  // Fork failed or one thread, do it serialized
128  $numRebuilt += $this->doRebuild( $codes, $lc, $force );
129  } else {
130  // Main thread
131  $pids[] = $pid;
132  }
133  }
134  // Wait for all children
135  foreach ( $pids as $pid ) {
136  $status = 0;
137  pcntl_waitpid( $pid, $status );
138  // Fetch the count from the return value
139  $numRebuilt += pcntl_wexitstatus( $status );
140  }
141 
142  $this->output( "$numRebuilt languages rebuilt out of $total\n" );
143  if ( $numRebuilt === 0 ) {
144  $this->output( "Use --force to rebuild the caches which are still fresh.\n" );
145  }
146  }
147 
156  private function doRebuild( $codes, $lc, $force ) {
157  $numRebuilt = 0;
158  foreach ( $codes as $code ) {
159  if ( $force || $lc->isExpired( $code ) ) {
160  $this->output( "Rebuilding $code...\n" );
161  $lc->recache( $code );
162  $numRebuilt++;
163  }
164  }
165  return $numRebuilt;
166  }
167 
173  public function setForce( $forced = true ) {
174  $this->mOptions['force'] = $forced;
175  }
176 }
177 
178 $maintClass = "RebuildLocalisationCache";
179 require_once RUN_MAINTENANCE_IF_MAIN;
RebuildLocalisationCache\setForce
setForce( $forced=true)
Sets whether a run of this maintenance script has the force parameter set.
Definition: rebuildLocalisationCache.php:173
RebuildLocalisationCache\__construct
__construct()
Default constructor.
Definition: rebuildLocalisationCache.php:40
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
RebuildLocalisationCache\execute
execute()
Do the actual work.
Definition: rebuildLocalisationCache.php:67
RebuildLocalisationCache\finalSetup
finalSetup()
Handle some last-minute setup here.
Definition: rebuildLocalisationCache.php:58
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
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
LocalisationCacheBulkLoad
A localisation cache optimised for loading large amounts of data for many languages.
Definition: LocalisationCache.php:1371
$total
$total
Definition: Utf8Test.php:92
Language\fetchLanguageNames
static fetchLanguageNames( $inLanguage=null, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:875
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
$maintClass
$maintClass
Definition: rebuildLocalisationCache.php:178
RebuildLocalisationCache
Maintenance script to rebuild the localisation cache.
Definition: rebuildLocalisationCache.php:39
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:2524
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:191
RebuildLocalisationCache\memoryLimit
memoryLimit()
Normally we disable the memory_limit when running admin scripts.
Definition: rebuildLocalisationCache.php:51
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
RebuildLocalisationCache\doRebuild
doRebuild( $codes, $lc, $force)
Helper function to rebuild list of languages codes.
Definition: rebuildLocalisationCache.php:156
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
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:181