maintenance/rebuildLocalisationCache.php

   1 <?php
   2
   3 /**
   4  * Rebuild the localisation cache. Useful if you disabled automatic updates
   5  * using $wgLocalisationCacheConf['manualRecache'] = true;
   6  *
   7  * Usage:
   8  *    php rebuildLocalisationCache.php [--force] [--threads=N]
   9  *
  10  * Use --force to rebuild all files, even the ones that are not out of date.
  11  * Use --threads=N to fork more threads.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  26  * http://www.gnu.org/copyleft/gpl.html
  27  *
  28  * @file
  29  * @ingroup Maintenance
  30  */
  31
  32 require_once __DIR__ . '/Maintenance.php';
  33
  34 /**
  35  * Maintenance script to rebuild the localisation cache.
  36  *
  37  * @ingroup Maintenance
  38  */
  39 class RebuildLocalisationCache extends Maintenance {
  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                 return 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 LocalisationCache_BulkLoad( $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
 148         /**
 149          * Helper function to rebuild list of languages codes. Prints the code
 150          * for each language which is rebuilt.
 151          * @param $codes array List of language codes to rebuild.
 152          * @param $lc LocalisationCache Instance of LocalisationCache_BulkLoad (?)
 153          * @param $force bool Rebuild up-to-date languages
 154          * @return int Number of rebuilt languages
 155          */
 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
 168         /**
 169          * Sets whether a run of this maintenance script has the force parameter set
 170          *
 171          * @param bool $forced
 172          */
 173         public function setForce( $forced = true ) {
 174                 $this->mOptions['force'] = $forced;
 175         }
 176 }
 177
 178 $maintClass = "RebuildLocalisationCache";
 179 require_once RUN_MAINTENANCE_IF_MAIN;