mergeMessageFileList.php

Go to the documentation of this file.

<?php
# Start from scratch
use MediaWiki\MainConfigNames;
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\Registration\ExtensionRegistry;
use MediaWiki\Settings\SettingsBuilder;
 
// @codeCoverageIgnoreStart
define( 'MW_NO_EXTENSION_MESSAGES', 1 );
 
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
class MergeMessageFileList extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addOption(
            'list-file',
            'A file containing a list of extension setup files, one per line.',
            false,
            true
        );
        $this->addOption( 'extensions-dir', 'Path where extensions can be found.', false, true );
        $this->addOption( 'output', 'Send output to this file (omit for stdout)', false, true );
        $this->addDescription( 'Merge $wgExtensionMessagesFiles and $wgMessagesDirs from ' .
            ' various extensions to produce a single file listing all message files and dirs.'
        );
    }
 
    public function execute() {
        $config = $this->getConfig();
        $extensionEntryPointListFiles = $config->get( MainConfigNames::ExtensionEntryPointListFiles );
 
        if (
            !count( $extensionEntryPointListFiles )
            && !$this->hasOption( 'list-file' )
            && !$this->hasOption( 'extensions-dir' )
        ) {
            $this->fatalError( "Either --list-file or --extensions-dir must be provided if " .
                "\$wgExtensionEntryPointListFiles is not set" );
        }
 
        $setupFiles = [];
 
        # Add setup files contained in the file passed to --list-file
        if ( $this->hasOption( 'list-file' ) ) {
            $extensionPaths = $this->readFile( $this->getOption( 'list-file' ) );
            $setupFiles = array_merge( $setupFiles, $extensionPaths );
        }
 
        # Now find out files in a directory
        if ( $this->hasOption( 'extensions-dir' ) ) {
            # Allow multiple directories to be passed with ":" as a delimiter
            $extDirs = explode( ':', $this->getOption( 'extensions-dir' ) );
            foreach ( $extDirs as $extDir ) {
                $entries = scandir( $extDir );
                foreach ( $entries as $extName ) {
                    if ( $extName === '.' || $extName === '..' || !is_dir( "$extDir/$extName" ) ) {
                        continue;
                    }
                    $possibilities = [
                        "$extDir/$extName/extension.json",
                        "$extDir/$extName/skin.json",
                    ];
                    $found = false;
                    foreach ( $possibilities as $extFile ) {
                        if ( file_exists( $extFile ) ) {
                            $setupFiles[] = $extFile;
                            $found = true;
                            break;
                        }
                    }
 
                    if ( !$found ) {
                        $this->error( "Extension {$extName} in {$extDir} lacks expected entry point: " .
                            "extension.json or skin.json " .
                            "(PHP entry points are no longer supported by this script)." );
                    }
                }
            }
        }
 
        # Add setup files defined via configuration
        foreach ( $extensionEntryPointListFiles as $points ) {
            $extensionPaths = $this->readFile( $points );
            $setupFiles = array_merge( $setupFiles, $extensionPaths );
        }
 
        $this->generateMessageFileList( $setupFiles );
    }
 
    public function finalSetup( SettingsBuilder $settingsBuilder ) {
        # This script commonly needs to be run before the l10n cache. But if
        # LanguageCode is not 'en', it won't be able to run because there is
        # no l10n cache. Break the cycle by forcing the LanguageCode setting to 'en'.
        $settingsBuilder->putConfigValue( MainConfigNames::LanguageCode, 'en' );
        parent::finalSetup( $settingsBuilder );
    }
 
    public function getDbType() {
        return Maintenance::DB_NONE;
    }
 
    private function readFile( string $fileName ): array {
        $files = [];
        $fileLines = file( $fileName );
        if ( $fileLines === false ) {
            $this->error( "Unable to open list file $fileName." );
 
            return $files;
        }
        # Strip comments, discard empty lines, and trim leading and trailing
        # whitespace. Comments start with '#' and extend to the end of the line.
        foreach ( $fileLines as $extension ) {
            $extension = trim( preg_replace( '/#.*/', '', $extension ) );
            if ( $extension !== '' ) {
                # Paths may use a $IP placeholder string which we substitute here
                $extension = str_replace( '$IP', MW_INSTALL_PATH, $extension );
                if ( !str_ends_with( $extension, '.json' ) ) {
                    $this->error( "Extension {$extension} does not end with .json " .
                        "(PHP entry points are no longer supported by this script)" );
                } elseif ( file_exists( $extension ) ) {
                    $files[] = $extension;
                } else {
                    $this->error( "Extension {$extension} doesn't exist" );
                }
            }
        }
 
        return $files;
    }
 
    private function generateMessageFileList( array $setupFiles ): void {
        $outputFile = $this->getOption( 'output' );
        $quiet = $this->hasOption( 'quiet' );
 
        $queue = [];
        foreach ( $setupFiles as $fileName ) {
            if ( (string)$fileName === '' ) {
                continue;
            }
            if ( !$quiet ) {
                fwrite( STDERR, "Loading data from $fileName\n" );
            }
            $queue[$fileName] = 1;
        }
 
        $config = $this->getConfig();
        $vars = [
            'wgExtensionMessagesFiles' => $config->get( MainConfigNames::ExtensionMessagesFiles ),
            'wgMessagesDirs' => $config->get( MainConfigNames::MessagesDirs ),
        ];
 
        if ( $queue ) {
            $registry = new ExtensionRegistry();
            $data = $registry->readFromQueue( $queue );
            foreach ( [ 'wgExtensionMessagesFiles', 'wgMessagesDirs' ] as $var ) {
                if ( isset( $data['globals'][$var] ) ) {
                    $vars[$var] = array_merge( $data['globals'][$var], $vars[$var] );
                }
            }
        }
 
        if ( !$quiet ) {
            fwrite( STDERR, "\n" );
        }
        $s =
            "<?php\n" .
            "## This file is generated by mergeMessageFileList.php. Do not edit it directly.\n\n" .
            "if ( defined( 'MW_NO_EXTENSION_MESSAGES' ) ) return;\n\n" .
            '$wgExtensionMessagesFiles = ' . var_export( $vars['wgExtensionMessagesFiles'], true ) . ";\n\n" .
            '$wgMessagesDirs = ' . var_export( $vars['wgMessagesDirs'], true ) . ";\n\n";
 
        $dirs = [
            MW_INSTALL_PATH,
            dirname( __DIR__ ),
            realpath( MW_INSTALL_PATH )
        ];
        foreach ( $dirs as $dir ) {
            $s = preg_replace( "/'" . preg_quote( $dir, '/' ) . "([^']*)'/", '"$IP\1"', $s );
        }
 
        if ( $outputFile !== null ) {
            $res = file_put_contents( $outputFile, $s );
            if ( $res === false ) {
                fwrite( STDERR, "Failed to write to $outputFile\n" );
                exit( 1 );
            }
        } else {
            echo $s;
        }
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = MergeMessageFileList::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd