Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7432154
mergeMessageFileList.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
7 KB
Referenced Files
None
Subscribers
None
mergeMessageFileList.php
View Options
<?php
/**
* Merge $wgExtensionMessagesFiles from various extensions to produce a
* single array containing all message files.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
# Start from scratch
use
MediaWiki\MainConfigNames
;
use
MediaWiki\Registration\ExtensionRegistry
;
use
MediaWiki\Settings\SettingsBuilder
;
// @codeCoverageIgnoreStart
define
(
'MW_NO_EXTENSION_MESSAGES'
,
1
);
require_once
__DIR__
.
'/Maintenance.php'
;
// @codeCoverageIgnoreEnd
/**
* Maintenance script that merges $wgExtensionMessagesFiles from various
* extensions to produce a single array containing all message files.
*
* @ingroup Maintenance
*/
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 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'
)
)
{
$extdir
=
$this
->
getOption
(
'extensions-dir'
);
# Allow multiple directories to be passed with ":" as delimiter
$extdirs
=
explode
(
':'
,
$extdir
);
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
);
}
/**
* Database access is not needed.
*
* @return int DB constant
*/
public
function
getDbType
()
{
return
Maintenance
::
DB_NONE
;
}
/**
* @param string $fileName
* @return array List of absolute extension paths
*/
private
function
readFile
(
$fileName
)
{
$IP
=
MW_INSTALL_PATH
;
$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 the string $IP to be substituted by the actual value
$extension
=
str_replace
(
'$IP'
,
$IP
,
$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
)
{
$IP
=
MW_INSTALL_PATH
;
$outputFile
=
$this
->
getOption
(
'output'
);
$quiet
=
$this
->
hasOption
(
'quiet'
);
$queue
=
[];
foreach
(
$setupFiles
as
$fileName
)
{
if
(
strval
(
$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
=
[
$IP
,
dirname
(
__DIR__
),
realpath
(
$IP
)
];
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
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 11:16 (4 h, 26 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
7b/bb/f98bb5990925f39dee7e8155cffd
Default Alt Text
mergeMessageFileList.php (7 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment