3 class ExtensionProcessor
implements Processor
{
6 * Keys that should be set to $GLOBALS
10 protected static $globalSettings = [
11 'ResourceLoaderSources',
12 'ResourceLoaderLESSVars',
18 'GrantPermissionGroups',
21 'GroupsRemoveFromSelf',
28 'AuthManagerAutoConfig',
29 'CentralIdLookupProviders',
30 'ChangeCredentialsBlacklist',
31 'RemoveCredentialsBlacklist',
36 'ExtensionEntryPointListFiles',
58 * Mapping of global settings to their specific merge strategies.
60 * @see ExtensionRegistry::exportExtractedData
61 * @see getExtractedInfo
64 protected static $mergeStrategies = [
65 'wgGroupPermissions' => 'array_plus_2d',
66 'wgRevokePermissions' => 'array_plus_2d',
67 'wgGrantPermissions' => 'array_plus_2d',
68 'wgHooks' => 'array_merge_recursive',
69 'wgExtensionCredits' => 'array_merge_recursive',
70 'wgExtraGenderNamespaces' => 'array_plus',
71 'wgNamespacesWithSubpages' => 'array_plus',
72 'wgNamespaceContentModels' => 'array_plus',
73 'wgNamespaceProtection' => 'array_plus',
74 'wgCapitalLinkOverrides' => 'array_plus',
75 'wgRateLimits' => 'array_plus_2d',
76 'wgAuthManagerAutoConfig' => 'array_plus_2d',
80 * Keys that are part of the extension credits
84 protected static $creditsAttributes = [
96 * Things that are not 'attributes', but are not in
97 * $globalSettings or $creditsAttributes.
101 protected static $notAttributes = [
105 'ResourceFileModulePaths',
107 'ResourceModuleSkinStyles',
108 'ExtensionMessagesFiles',
116 'load_composer_autoloader',
120 * Stuff that is going to be set to $GLOBALS
122 * Some keys are pre-set to arrays so we can += to them
126 protected $globals = [
127 'wgExtensionMessagesFiles' => [],
128 'wgMessagesDirs' => [],
132 * Things that should be define()'d
136 protected $defines = [];
139 * Things to be called once registration of these extensions are done
143 protected $callbacks = [];
148 protected $credits = [];
151 * Any thing else in the $info that hasn't
152 * already been processed
156 protected $attributes = [];
159 * @param string $path
161 * @param int $version manifest_version for info
164 public function extractInfo( $path, array $info, $version ) {
165 $dir = dirname( $path );
166 if ( $version === 2 ) {
167 $this->extractConfig2( $info, $dir );
170 $this->extractConfig1( $info );
172 $this->extractHooks( $info );
173 $this->extractExtensionMessagesFiles( $dir, $info );
174 $this->extractMessagesDirs( $dir, $info );
175 $this->extractNamespaces( $info );
176 $this->extractResourceLoaderModules( $dir, $info );
177 $this->extractParserTestFiles( $dir, $info );
178 if ( isset( $info['callback'] ) ) {
179 $this->callbacks
[] = $info['callback'];
182 $this->extractCredits( $path, $info );
183 foreach ( $info as $key => $val ) {
184 if ( in_array( $key, self
::$globalSettings ) ) {
185 $this->storeToArray( $path, "wg$key", $val, $this->globals
);
186 // Ignore anything that starts with a @
187 } elseif ( $key[0] !== '@' && !in_array( $key, self
::$notAttributes )
188 && !in_array( $key, self
::$creditsAttributes )
190 $this->storeToArray( $path, $key, $val, $this->attributes
);
195 public function getExtractedInfo() {
196 // Make sure the merge strategies are set
197 foreach ( $this->globals
as $key => $val ) {
198 if ( isset( self
::$mergeStrategies[$key] ) ) {
199 $this->globals
[$key][ExtensionRegistry
::MERGE_STRATEGY
] = self
::$mergeStrategies[$key];
204 'globals' => $this->globals
,
205 'defines' => $this->defines
,
206 'callbacks' => $this->callbacks
,
207 'credits' => $this->credits
,
208 'attributes' => $this->attributes
,
212 public function getRequirements( array $info ) {
214 $key = ExtensionRegistry
::MEDIAWIKI_CORE
;
215 if ( isset( $info['requires'][$key] ) ) {
216 $requirements[$key] = $info['requires'][$key];
219 return $requirements;
222 protected function extractHooks( array $info ) {
223 if ( isset( $info['Hooks'] ) ) {
224 foreach ( $info['Hooks'] as $name => $value ) {
225 if ( is_array( $value ) ) {
226 foreach ( $value as $callback ) {
227 $this->globals
['wgHooks'][$name][] = $callback;
230 $this->globals
['wgHooks'][$name][] = $value;
237 * Register namespaces with the appropriate global settings
241 protected function extractNamespaces( array $info ) {
242 if ( isset( $info['namespaces'] ) ) {
243 foreach ( $info['namespaces'] as $ns ) {
245 $this->defines
[$ns['constant']] = $id;
246 if ( !( isset( $ns['conditional'] ) && $ns['conditional'] ) ) {
247 // If it is not conditional, register it
248 $this->attributes
['ExtensionNamespaces'][$id] = $ns['name'];
250 if ( isset( $ns['gender'] ) ) {
251 $this->globals
['wgExtraGenderNamespaces'][$id] = $ns['gender'];
253 if ( isset( $ns['subpages'] ) && $ns['subpages'] ) {
254 $this->globals
['wgNamespacesWithSubpages'][$id] = true;
256 if ( isset( $ns['content'] ) && $ns['content'] ) {
257 $this->globals
['wgContentNamespaces'][] = $id;
259 if ( isset( $ns['defaultcontentmodel'] ) ) {
260 $this->globals
['wgNamespaceContentModels'][$id] = $ns['defaultcontentmodel'];
262 if ( isset( $ns['protection'] ) ) {
263 $this->globals
['wgNamespaceProtection'][$id] = $ns['protection'];
265 if ( isset( $ns['capitallinkoverride'] ) ) {
266 $this->globals
['wgCapitalLinkOverrides'][$id] = $ns['capitallinkoverride'];
272 protected function extractResourceLoaderModules( $dir, array $info ) {
273 $defaultPaths = isset( $info['ResourceFileModulePaths'] )
274 ?
$info['ResourceFileModulePaths']
276 if ( isset( $defaultPaths['localBasePath'] ) ) {
277 if ( $defaultPaths['localBasePath'] === '' ) {
278 // Avoid double slashes (e.g. /extensions/Example//path)
279 $defaultPaths['localBasePath'] = $dir;
281 $defaultPaths['localBasePath'] = "$dir/{$defaultPaths['localBasePath']}";
285 foreach ( [ 'ResourceModules', 'ResourceModuleSkinStyles' ] as $setting ) {
286 if ( isset( $info[$setting] ) ) {
287 foreach ( $info[$setting] as $name => $data ) {
288 if ( isset( $data['localBasePath'] ) ) {
289 if ( $data['localBasePath'] === '' ) {
290 // Avoid double slashes (e.g. /extensions/Example//path)
291 $data['localBasePath'] = $dir;
293 $data['localBasePath'] = "$dir/{$data['localBasePath']}";
296 if ( $defaultPaths ) {
297 $data +
= $defaultPaths;
299 $this->globals
["wg$setting"][$name] = $data;
305 protected function extractExtensionMessagesFiles( $dir, array $info ) {
306 if ( isset( $info['ExtensionMessagesFiles'] ) ) {
307 $this->globals
["wgExtensionMessagesFiles"] +
= array_map( function( $file ) use ( $dir ) {
309 }, $info['ExtensionMessagesFiles'] );
314 * Set message-related settings, which need to be expanded to use
320 protected function extractMessagesDirs( $dir, array $info ) {
321 if ( isset( $info['MessagesDirs'] ) ) {
322 foreach ( $info['MessagesDirs'] as $name => $files ) {
323 foreach ( (array)$files as $file ) {
324 $this->globals
["wgMessagesDirs"][$name][] = "$dir/$file";
331 * @param string $path
335 protected function extractCredits( $path, array $info ) {
338 'type' => isset( $info['type'] ) ?
$info['type'] : 'other',
340 foreach ( self
::$creditsAttributes as $attr ) {
341 if ( isset( $info[$attr] ) ) {
342 $credits[$attr] = $info[$attr];
346 $name = $credits['name'];
348 // If someone is loading the same thing twice, throw
349 // a nice error (T121493)
350 if ( isset( $this->credits
[$name] ) ) {
351 $firstPath = $this->credits
[$name]['path'];
352 $secondPath = $credits['path'];
353 throw new Exception( "It was attempted to load $name twice, from $firstPath and $secondPath." );
356 $this->credits
[$name] = $credits;
357 $this->globals
['wgExtensionCredits'][$credits['type']][] = $credits;
361 * Set configuration settings for manifest_version == 1
362 * @todo In the future, this should be done via Config interfaces
366 protected function extractConfig1( array $info ) {
367 if ( isset( $info['config'] ) ) {
368 if ( isset( $info['config']['_prefix'] ) ) {
369 $prefix = $info['config']['_prefix'];
370 unset( $info['config']['_prefix'] );
374 foreach ( $info['config'] as $key => $val ) {
375 if ( $key[0] !== '@' ) {
376 $this->globals
["$prefix$key"] = $val;
383 * Set configuration settings for manifest_version == 2
384 * @todo In the future, this should be done via Config interfaces
389 protected function extractConfig2( array $info, $dir ) {
390 if ( isset( $info['config_prefix'] ) ) {
391 $prefix = $info['config_prefix'];
395 if ( isset( $info['config'] ) ) {
396 foreach ( $info['config'] as $key => $data ) {
397 $value = $data['value'];
398 if ( isset( $value['merge_strategy'] ) ) {
399 $value[ExtensionRegistry
::MERGE_STRATEGY
] = $data['merge_strategy'];
401 if ( isset( $data['path'] ) && $data['path'] ) {
402 $value = "$dir/$value";
404 $this->globals
["$prefix$key"] = $value;
409 protected function extractParserTestFiles( $dir, array $info ) {
410 if ( isset( $info['ParserTestFiles'] ) ) {
411 foreach ( $info['ParserTestFiles'] as $path ) {
412 $this->globals
['wgParserTestFiles'][] = "$dir/$path";
418 * @param string $path
419 * @param string $name
420 * @param array $value
421 * @param array &$array
422 * @throws InvalidArgumentException
424 protected function storeToArray( $path, $name, $value, &$array ) {
425 if ( !is_array( $value ) ) {
426 throw new InvalidArgumentException( "The value for '$name' should be an array (from $path)" );
428 if ( isset( $array[$name] ) ) {
429 $array[$name] = array_merge_recursive( $array[$name], $value );
431 $array[$name] = $value;
435 public function getExtraAutoloaderPaths( $dir, array $info ) {
437 if ( isset( $info['load_composer_autoloader'] ) && $info['load_composer_autoloader'] === true ) {
438 $path = "$dir/vendor/autoload.php";
439 if ( file_exists( $path ) ) {