From: Reedy <reedy@wikimedia.org>
Date: Wed, 18 Sep 2013 23:00:47 +0000 (+0100)
Subject: Added $wgExtensionEntryPointListFiles for use with mergeMessageFileList.php
X-Git-Tag: 1.31.0-rc.0~18576
X-Git-Url: https://git.cyclocoop.org/%7B%24admin_url%7Dmembres/modifier.php?a=commitdiff_plain;h=8da7f5eeff330eda5efda5302ca53bcebf8b1cca;p=lhc%2Fweb%2Fwiklou.git

Added $wgExtensionEntryPointListFiles for use with mergeMessageFileList.php

Going to be used to change target file for labs vs production

Change-Id: Id4b16083435ef7f4fce31861c72889e664d07236
---

diff --git a/RELEASE-NOTES-1.22 b/RELEASE-NOTES-1.22
index 7e7f4039a7..a365da6159 100644
--- a/RELEASE-NOTES-1.22
+++ b/RELEASE-NOTES-1.22
@@ -239,6 +239,7 @@ production.
    referenced in LESS '@import' statements are looked up here first.
 * ResourceLoader supports hashes as module cache invalidation trigger (instead
   of or in addition to timestamps).
+* Added $wgExtensionEntryPointListFiles for use in mergeMessageFileList.php.
 
 === Bug fixes in 1.22 ===
 * Disable Special:PasswordReset when $wgEnableEmail is false. Previously one
diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index a577f7167d..98c583b939 100644
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -5918,6 +5918,13 @@ $wgExtensionFunctions = array();
  */
 $wgExtensionMessagesFiles = array();
 
+/**
+ * Array of files with list(s) of extension entry points to be used in
+ * maintenance/mergeMessageFileList.php
+ * @since 1.22
+ */
+$wgExtensionEntryPointListFiles = array();
+
 /**
  * Parser output hooks.
  * This is an associative array where the key is an extension-defined tag
diff --git a/maintenance/mergeMessageFileList.php b/maintenance/mergeMessageFileList.php
index 75b7ef0b49..e91833777d 100644
--- a/maintenance/mergeMessageFileList.php
+++ b/maintenance/mergeMessageFileList.php
@@ -36,10 +36,14 @@ $mmfl = false;
  * @ingroup Maintenance
  */
 class MergeMessageFileList extends Maintenance {
+	/**
+	 * @var bool
+	 */
+	protected $hasError;
 
 	function __construct() {
 		parent::__construct();
-		$this->addOption( 'list-file', 'A file containing a list of extension setup files, one per line.', true, true );
+		$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->mDescription = 'Merge $wgExtensionMessagesFiles from various extensions to produce a ' .
@@ -47,26 +51,25 @@ class MergeMessageFileList extends Maintenance {
 	}
 
 	public function execute() {
-		global $mmfl;
+		global $mmfl, $wgExtensionEntryPointListFiles;
 
-		# Add setup files contained in file passed to --list-file
-		$lines = file( $this->getOption( 'list-file' ) );
-		if ( $lines === false ) {
-			$this->error( 'Unable to open list file.' );
+		if ( !count( $wgExtensionEntryPointListFiles )
+			&& !$this->hasOption( 'list-file' )
+			&& !$this->hasOption( 'extensions-dir' )
+		) {
+			$this->error( "Either --list-file or --extensions-dir must be provided if " .
+				"\$wgExtensionEntryPointListFiles is not set", 1 );
 		}
+
 		$mmfl = array( 'setupFiles' => array() );
 
-		# Strip comments, discard empty lines, and trim leading and trailing
-		# whitespace. Comments start with '#' and extend to the end of the line.
-		foreach ( $lines as $line ) {
-			$line = trim( preg_replace( '/#.*/', '', $line ) );
-			if ( $line !== '' ) {
-				$mmfl['setupFiles'][] = $line;
-			}
+		# Add setup files contained in file passed to --list-file
+		if ( $this->hasOption( 'list-file' ) ) {
+			$extensionPaths = $this->readFile( $this->getOption( 'list-file' ) );
+			$mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
 		}
 
 		# Now find out files in a directory
-		$hasError = false;
 		if ( $this->hasOption( 'extensions-dir' ) ) {
 			$extdir = $this->getOption( 'extensions-dir' );
 			$entries = scandir( $extdir );
@@ -78,13 +81,19 @@ class MergeMessageFileList extends Maintenance {
 				if ( file_exists( $extfile ) ) {
 					$mmfl['setupFiles'][] = $extfile;
 				} else {
-					$hasError = true;
+					$this->hasError = true;
 					$this->error( "Extension {$extname} in {$extdir} lacks expected {$extname}.php" );
 				}
 			}
 		}
 
-		if ( $hasError ) {
+		# Add setup files defined via configuration
+		foreach ( $wgExtensionEntryPointListFiles as $points ) {
+			$extensionPaths = $this->readFile( $points );
+			$mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
+		}
+
+		if ( $this->hasError ) {
 			$this->error( "Some files are missing (see above). Giving up.", 1 );
 		}
 
@@ -95,6 +104,38 @@ class MergeMessageFileList extends Maintenance {
 			$mmfl['quiet'] = true;
 		}
 	}
+
+	/**
+	 * @param string $fileName
+	 * @return array List of absolute extension paths
+	 */
+	private function readFile( $fileName ) {
+		global $IP;
+
+		$files = array();
+		$fileLines = file( $fileName );
+		if ( $fileLines === false ) {
+			$this->hasError = true;
+			$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 the string $IP to be substituted by the actual value
+				$extension = str_replace( '$IP', $IP, $extension );
+				if ( file_exists( $extension ) ) {
+					$files[] = $extension;
+				} else {
+					$this->hasError = true;
+					$this->error( "Extension {$extension} doesn't exist" );
+				}
+			}
+		}
+		return $files;
+	}
 }
 
 require_once RUN_MAINTENANCE_IF_MAIN;
@@ -103,11 +144,11 @@ foreach ( $mmfl['setupFiles'] as $fileName ) {
 	if ( strval( $fileName ) === '' ) {
 		continue;
 	}
-	$fileName = str_replace( '$IP', $IP, $fileName );
 	if ( empty( $mmfl['quiet'] ) ) {
 		fwrite( STDERR, "Loading data from $fileName\n" );
 	}
-	if ( !( include_once $fileName ) ) {
+	// Include the extension to update $wgExtensionMessagesFiles
+	if ( !( include_once( $fileName ) ) ) {
 		fwrite( STDERR, "Unable to read $fileName\n" );
 		exit( 1 );
 	}
@@ -126,10 +167,7 @@ $dirs = array(
 );
 
 foreach ( $dirs as $dir ) {
-	$s = preg_replace(
-		"/'" . preg_quote( $dir, '/' ) . "([^']*)'/",
-		'"$IP\1"',
-		$s );
+	$s = preg_replace( "/'" . preg_quote( $dir, '/' ) . "([^']*)'/", '"$IP\1"', $s );
 }
 
 if ( isset( $mmfl['output'] ) ) {