maintenance/mergeMessageFileList.php

   1 <?php
   2 /**
   3  * Merge $wgExtensionMessagesFiles from various extensions to produce a
   4  * single array containing all message files.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24
  25 # Start from scratch
  26 define( 'MW_NO_EXTENSION_MESSAGES', 1 );
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29 $maintClass = 'MergeMessageFileList';
  30 $mmfl = false;
  31
  32 /**
  33  * Maintenance script that merges $wgExtensionMessagesFiles from various
  34  * extensions to produce a single array containing all message files.
  35  *
  36  * @ingroup Maintenance
  37  */
  38 class MergeMessageFileList extends Maintenance {
  39         /**
  40          * @var bool
  41          */
  42         protected $hasError;
  43
  44         function __construct() {
  45                 parent::__construct();
  46                 $this->addOption( 'list-file', 'A file containing a list of extension setup files, one per line.', false, true );
  47                 $this->addOption( 'extensions-dir', 'Path where extensions can be found.', false, true );
  48                 $this->addOption( 'output', 'Send output to this file (omit for stdout)', false, true );
  49                 $this->mDescription = 'Merge $wgExtensionMessagesFiles and $wgMessagesDirs from ' .
  50                         ' various extensions to produce a single file listing all message files and dirs.';
  51         }
  52
  53         public function execute() {
  54                 global $mmfl, $wgExtensionEntryPointListFiles;
  55
  56                 if ( !count( $wgExtensionEntryPointListFiles )
  57                         && !$this->hasOption( 'list-file' )
  58                         && !$this->hasOption( 'extensions-dir' )
  59                 ) {
  60                         $this->error( "Either --list-file or --extensions-dir must be provided if " .
  61                                 "\$wgExtensionEntryPointListFiles is not set", 1 );
  62                 }
  63
  64                 $mmfl = array( 'setupFiles' => array() );
  65
  66                 # Add setup files contained in file passed to --list-file
  67                 if ( $this->hasOption( 'list-file' ) ) {
  68                         $extensionPaths = $this->readFile( $this->getOption( 'list-file' ) );
  69                         $mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
  70                 }
  71
  72                 # Now find out files in a directory
  73                 if ( $this->hasOption( 'extensions-dir' ) ) {
  74                         $extdir = $this->getOption( 'extensions-dir' );
  75                         $entries = scandir( $extdir );
  76                         foreach ( $entries as $extname ) {
  77                                 if ( $extname == '.' || $extname == '..' || !is_dir( "$extdir/$extname" ) ) {
  78                                         continue;
  79                                 }
  80                                 $extfile = "{$extdir}/{$extname}/{$extname}.php";
  81                                 if ( file_exists( $extfile ) ) {
  82                                         $mmfl['setupFiles'][] = $extfile;
  83                                 } else {
  84                                         $this->hasError = true;
  85                                         $this->error( "Extension {$extname} in {$extdir} lacks expected {$extname}.php" );
  86                                 }
  87                         }
  88                 }
  89
  90                 # Add setup files defined via configuration
  91                 foreach ( $wgExtensionEntryPointListFiles as $points ) {
  92                         $extensionPaths = $this->readFile( $points );
  93                         $mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
  94                 }
  95
  96                 if ( $this->hasError ) {
  97                         $this->error( "Some files are missing (see above). Giving up.", 1 );
  98                 }
  99
 100                 if ( $this->hasOption( 'output' ) ) {
 101                         $mmfl['output'] = $this->getOption( 'output' );
 102                 }
 103                 if ( $this->hasOption( 'quiet' ) ) {
 104                         $mmfl['quiet'] = true;
 105                 }
 106         }
 107
 108         /**
 109          * @param string $fileName
 110          * @return array List of absolute extension paths
 111          */
 112         private function readFile( $fileName ) {
 113                 global $IP;
 114
 115                 $files = array();
 116                 $fileLines = file( $fileName );
 117                 if ( $fileLines === false ) {
 118                         $this->hasError = true;
 119                         $this->error( "Unable to open list file $fileName." );
 120                         return $files;
 121                 }
 122                 # Strip comments, discard empty lines, and trim leading and trailing
 123                 # whitespace. Comments start with '#' and extend to the end of the line.
 124                 foreach ( $fileLines as $extension ) {
 125                         $extension = trim( preg_replace( '/#.*/', '', $extension ) );
 126                         if ( $extension !== '' ) {
 127                                 # Paths may use the string $IP to be substituted by the actual value
 128                                 $extension = str_replace( '$IP', $IP, $extension );
 129                                 if ( file_exists( $extension ) ) {
 130                                         $files[] = $extension;
 131                                 } else {
 132                                         $this->hasError = true;
 133                                         $this->error( "Extension {$extension} doesn't exist" );
 134                                 }
 135                         }
 136                 }
 137                 return $files;
 138         }
 139 }
 140
 141 require_once RUN_MAINTENANCE_IF_MAIN;
 142
 143 foreach ( $mmfl['setupFiles'] as $fileName ) {
 144         if ( strval( $fileName ) === '' ) {
 145                 continue;
 146         }
 147         if ( empty( $mmfl['quiet'] ) ) {
 148                 fwrite( STDERR, "Loading data from $fileName\n" );
 149         }
 150         // Include the extension to update $wgExtensionMessagesFiles
 151         if ( !( include_once $fileName ) ) {
 152                 fwrite( STDERR, "Unable to read $fileName\n" );
 153                 exit( 1 );
 154         }
 155 }
 156 fwrite( STDERR, "\n" );
 157 $s =
 158         "<" . "?php\n" .
 159         "## This file is generated by mergeMessageFileList.php. Do not edit it directly.\n\n" .
 160         "if ( defined( 'MW_NO_EXTENSION_MESSAGES' ) ) return;\n\n" .
 161         '$wgExtensionMessagesFiles = ' . var_export( $wgExtensionMessagesFiles, true ) . ";\n\n" .
 162         '$wgMessagesDirs = ' . var_export( $wgMessagesDirs, true ) . ";\n\n";
 163
 164 $dirs = array(
 165         $IP,
 166         dirname( __DIR__ ),
 167         realpath( $IP )
 168 );
 169
 170 foreach ( $dirs as $dir ) {
 171         $s = preg_replace( "/'" . preg_quote( $dir, '/' ) . "([^']*)'/", '"$IP\1"', $s );
 172 }
 173
 174 if ( isset( $mmfl['output'] ) ) {
 175         file_put_contents( $mmfl['output'], $s );
 176 } else {
 177         echo $s;
 178 }