1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<?php
/**
* Print serialized output of MediaWiki config vars.
*
* 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
* @author Tim Starling
* @author Antoine Musso <hashar@free.fr>
*/
use MediaWiki\Json\FormatJson;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Print serialized output of MediaWiki config vars
*
* @ingroup Maintenance
*/
class GetConfiguration extends Maintenance {
/** @var string|null */
protected $regex = null;
/** @var array */
protected $settings_list = [];
/**
* List of format output internally supported.
* Each item MUST be lower case.
*/
private const OUT_FORMATS = [
'json',
'php',
'serialize',
'vardump',
];
public function __construct() {
parent::__construct();
$this->addDescription( 'Get serialized MediaWiki site configuration' );
$this->addOption( 'regex', 'regex to filter variables with', false, true );
$this->addOption( 'iregex', 'same as --regex but case insensitive', false, true );
$this->addOption( 'settings', 'Space-separated list of wg* variables', false, true );
$this->addOption( 'format', implode( ', ', self::OUT_FORMATS ), false, true );
$this->addOption(
'json-partial-output-on-error',
'Use JSON_PARTIAL_OUTPUT_ON_ERROR flag with json_encode(). This allows for partial response to ' .
'be output in case of an exception while serializing to JSON. If an error occurs, ' .
'the wgGetConfigurationJsonErrorOccurred field is set in the output.'
);
}
public function validateParamsAndArgs() {
$error_out = false;
# Get the format and make sure it is set to a valid default value
$format = strtolower( $this->getOption( 'format', 'PHP' ) );
$validFormat = in_array( $format, self::OUT_FORMATS );
if ( !$validFormat ) {
$this->error( "--format set to an unrecognized format" );
$error_out = true;
}
if ( $this->getOption( 'regex' ) && $this->getOption( 'iregex' ) ) {
$this->error( "Can only use either --regex or --iregex" );
$error_out = true;
}
$this->regex = $this->getOption( 'regex' ) ?: $this->getOption( 'iregex' );
if ( $this->regex ) {
$this->regex = '/' . $this->regex . '/';
if ( $this->hasOption( 'iregex' ) ) {
# case insensitive regex
$this->regex .= 'i';
}
}
if ( $this->hasOption( 'settings' ) ) {
$this->settings_list = explode( ' ', $this->getOption( 'settings' ) );
# Values validation
foreach ( $this->settings_list as $name ) {
if ( !preg_match( '/^wg[A-Z]/', $name ) ) {
$this->error( "Variable '$name' does start with 'wg'." );
$error_out = true;
} elseif ( !array_key_exists( $name, $GLOBALS ) ) {
$this->error( "Variable '$name' is not set." );
$error_out = true;
} elseif ( !$this->isAllowedVariable( $GLOBALS[$name] ) ) {
$this->error( "Variable '$name' includes non-array, non-scalar, items." );
$error_out = true;
}
}
}
parent::validateParamsAndArgs();
if ( $error_out ) {
# Force help and quit
$this->maybeHelp( true );
}
}
public function execute() {
// Settings we will display
$res = [];
# Default: dump any wg / wmg variable
if ( !$this->regex && !$this->getOption( 'settings' ) ) {
$this->regex = '/^wm?g/';
}
# Filter out globals based on the regex
if ( $this->regex ) {
foreach ( $GLOBALS as $name => $value ) {
if ( preg_match( $this->regex, $name ) ) {
$res[$name] = $value;
}
}
}
# Explicitly dumps a list of provided global names
if ( $this->settings_list ) {
foreach ( $this->settings_list as $name ) {
$res[$name] = $GLOBALS[$name];
}
}
ksort( $res );
switch ( strtolower( $this->getOption( 'format' ) ) ) {
case 'serialize':
case 'php':
$out = serialize( $res );
break;
case 'vardump':
$out = $this->formatVarDump( $res );
break;
case 'json':
$out = FormatJson::encode( $res );
if ( !$out && $this->getOption( 'json-partial-output-on-error' ) ) {
$res['wgGetConfigurationJsonErrorOccurred'] = true;
$out = json_encode( $res, JSON_PARTIAL_OUTPUT_ON_ERROR );
}
break;
default:
$this->fatalError( "Invalid serialization format given." );
}
if ( !is_string( $out ) ) {
$this->fatalError( "Failed to serialize the requested settings." );
}
if ( $out ) {
$this->output( $out . "\n" );
}
}
protected function formatVarDump( $res ) {
$ret = '';
foreach ( $res as $key => $value ) {
# intercept var_dump() output
ob_start();
print "\${$key} = ";
var_dump( $value );
# grab var_dump() output and discard it from the output buffer
$ret .= trim( ob_get_clean() ) . ";\n";
}
return trim( $ret, "\n" );
}
private function isAllowedVariable( $value ) {
if ( is_array( $value ) ) {
foreach ( $value as $v ) {
if ( !$this->isAllowedVariable( $v ) ) {
return false;
}
}
return true;
} elseif ( is_scalar( $value ) || $value === null ) {
return true;
}
return false;
}
}
// @codeCoverageIgnoreStart
$maintClass = GetConfiguration::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd
|
