3 class ExtensionProcessor
implements Processor
{
6 * Keys that should be set to $GLOBALS
10 protected static $globalSettings = [
19 'AuthManagerAutoConfig',
21 'CentralIdLookupProviders',
22 'ChangeCredentialsBlacklist',
26 'ExtensionEntryPointListFiles',
31 'GrantPermissionGroups',
35 'GroupsRemoveFromSelf',
51 'RemoveCredentialsBlacklist',
53 'ResourceLoaderSources',
61 * Top-level attributes that come from MW core
65 protected static $coreAttributes = [
71 * Mapping of global settings to their specific merge strategies.
73 * @see ExtensionRegistry::exportExtractedData
74 * @see getExtractedInfo
77 protected static $mergeStrategies = [
78 'wgAuthManagerAutoConfig' => 'array_plus_2d',
79 'wgCapitalLinkOverrides' => 'array_plus',
80 'wgExtensionCredits' => 'array_merge_recursive',
81 'wgExtraGenderNamespaces' => 'array_plus',
82 'wgGrantPermissions' => 'array_plus_2d',
83 'wgGroupPermissions' => 'array_plus_2d',
84 'wgHooks' => 'array_merge_recursive',
85 'wgNamespaceContentModels' => 'array_plus',
86 'wgNamespaceProtection' => 'array_plus',
87 'wgNamespacesWithSubpages' => 'array_plus',
88 'wgPasswordPolicy' => 'array_merge_recursive',
89 'wgRateLimits' => 'array_plus_2d',
90 'wgRevokePermissions' => 'array_plus_2d',
94 * Keys that are part of the extension credits
98 protected static $creditsAttributes = [
110 * Things that are not 'attributes', and are not in
111 * $globalSettings or $creditsAttributes.
115 protected static $notAttributes = [
119 'ResourceFileModulePaths',
121 'ResourceModuleSkinStyles',
123 'ExtensionMessagesFiles',
128 'ServiceWiringFiles',
132 'load_composer_autoloader',
136 * Stuff that is going to be set to $GLOBALS
138 * Some keys are pre-set to arrays so we can += to them
142 protected $globals = [
143 'wgExtensionMessagesFiles' => [],
144 'wgMessagesDirs' => [],
148 * Things that should be define()'d
152 protected $defines = [];
155 * Things to be called once registration of these extensions are done
156 * keyed by the name of the extension that it belongs to
160 protected $callbacks = [];
165 protected $credits = [];
170 protected $config = [];
173 * Any thing else in the $info that hasn't
174 * already been processed
178 protected $attributes = [];
181 * Extension attributes, keyed by name =>
186 protected $extAttributes = [];
189 * @param string $path
191 * @param int $version manifest_version for info
193 public function extractInfo( $path, array $info, $version ) {
194 $dir = dirname( $path );
195 $this->extractHooks( $info );
196 $this->extractExtensionMessagesFiles( $dir, $info );
197 $this->extractMessagesDirs( $dir, $info );
198 $this->extractNamespaces( $info );
199 $this->extractResourceLoaderModules( $dir, $info );
200 if ( isset( $info['ServiceWiringFiles'] ) ) {
201 $this->extractPathBasedGlobal(
202 'wgServiceWiringFiles',
204 $info['ServiceWiringFiles']
207 if ( isset( $info['ParserTestFiles'] ) ) {
208 $this->extractPathBasedGlobal(
211 $info['ParserTestFiles']
214 $name = $this->extractCredits( $path, $info );
215 if ( isset( $info['callback'] ) ) {
216 $this->callbacks
[$name] = $info['callback'];
219 // config should be after all core globals are extracted,
220 // so duplicate setting detection will work fully
221 if ( $version === 2 ) {
222 $this->extractConfig2( $info, $dir );
225 $this->extractConfig1( $info );
228 if ( $version === 2 ) {
229 $this->extractAttributes( $path, $info );
232 foreach ( $info as $key => $val ) {
233 // If it's a global setting,
234 if ( in_array( $key, self
::$globalSettings ) ) {
235 $this->storeToArray( $path, "wg$key", $val, $this->globals
);
238 // Ignore anything that starts with a @
239 if ( $key[0] === '@' ) {
243 if ( $version === 2 ) {
244 // Only whitelisted attributes are set
245 if ( in_array( $key, self
::$coreAttributes ) ) {
246 $this->storeToArray( $path, $key, $val, $this->attributes
);
250 if ( !in_array( $key, self
::$notAttributes )
251 && !in_array( $key, self
::$creditsAttributes )
253 // If it's not blacklisted, it's an attribute
254 $this->storeToArray( $path, $key, $val, $this->attributes
);
262 * @param string $path
265 protected function extractAttributes( $path, array $info ) {
266 if ( isset( $info['attributes'] ) ) {
267 foreach ( $info['attributes'] as $extName => $value ) {
268 $this->storeToArray( $path, $extName, $value, $this->extAttributes
);
273 public function getExtractedInfo() {
274 // Make sure the merge strategies are set
275 foreach ( $this->globals
as $key => $val ) {
276 if ( isset( self
::$mergeStrategies[$key] ) ) {
277 $this->globals
[$key][ExtensionRegistry
::MERGE_STRATEGY
] = self
::$mergeStrategies[$key];
281 // Merge $this->extAttributes into $this->attributes depending on what is loaded
282 foreach ( $this->extAttributes
as $extName => $value ) {
283 // Only set the attribute if $extName is loaded (and hence present in credits)
284 if ( isset( $this->credits
[$extName] ) ) {
285 foreach ( $value as $attrName => $attrValue ) {
287 '', // Don't provide a path since it's impossible to generate an error here
288 $extName . $attrName,
293 unset( $this->extAttributes
[$extName] );
298 'globals' => $this->globals
,
299 'config' => $this->config
,
300 'defines' => $this->defines
,
301 'callbacks' => $this->callbacks
,
302 'credits' => $this->credits
,
303 'attributes' => $this->attributes
,
307 public function getRequirements( array $info, $includeDev ) {
309 if ( !$includeDev ||
!isset( $info['dev-requires'] ) ) {
310 return $info['requires'] ??
[];
313 if ( !isset( $info['requires'] ) ) {
314 return $info['dev-requires'] ??
[];
317 // OK, we actually have to merge everything
320 // Helper that combines version requirements by
321 // picking the non-null if one is, or combines
322 // the two. Note that it is not possible for
323 // both inputs to be null.
324 $pick = function ( $a, $b ) {
327 } elseif ( $b === null ) {
334 $req = $info['requires'];
335 $dev = $info['dev-requires'];
336 if ( isset( $req['MediaWiki'] ) ||
isset( $dev['MediaWiki'] ) ) {
337 $merged['MediaWiki'] = $pick(
338 $req['MediaWiki'] ??
null,
339 $dev['MediaWiki'] ??
null
343 $platform = array_merge(
344 array_keys( $req['platform'] ??
[] ),
345 array_keys( $dev['platform'] ??
[] )
348 foreach ( $platform as $pkey ) {
349 if ( $pkey === 'php' ) {
351 $req['platform']['php'] ??
null,
352 $dev['platform']['php'] ??
null
355 // Prefer dev value, but these should be constant
356 // anyways (ext-* and ability-*)
357 $value = $dev['platform'][$pkey] ??
$req['platform'][$pkey];
359 $merged['platform'][$pkey] = $value;
363 foreach ( [ 'extensions', 'skins' ] as $thing ) {
364 $things = array_merge(
365 array_keys( $req[$thing] ??
[] ),
366 array_keys( $dev[$thing] ??
[] )
368 foreach ( $things as $name ) {
369 $merged[$thing][$name] = $pick(
370 $req[$thing][$name] ??
null,
371 $dev[$thing][$name] ??
null
379 protected function extractHooks( array $info ) {
380 if ( isset( $info['Hooks'] ) ) {
381 foreach ( $info['Hooks'] as $name => $value ) {
382 if ( is_array( $value ) ) {
383 foreach ( $value as $callback ) {
384 $this->globals
['wgHooks'][$name][] = $callback;
387 $this->globals
['wgHooks'][$name][] = $value;
394 * Register namespaces with the appropriate global settings
398 protected function extractNamespaces( array $info ) {
399 if ( isset( $info['namespaces'] ) ) {
400 foreach ( $info['namespaces'] as $ns ) {
401 if ( defined( $ns['constant'] ) ) {
402 // If the namespace constant is already defined, use it.
403 // This allows namespace IDs to be overwritten locally.
404 $id = constant( $ns['constant'] );
407 $this->defines
[ $ns['constant'] ] = $id;
410 if ( !( isset( $ns['conditional'] ) && $ns['conditional'] ) ) {
411 // If it is not conditional, register it
412 $this->attributes
['ExtensionNamespaces'][$id] = $ns['name'];
414 if ( isset( $ns['gender'] ) ) {
415 $this->globals
['wgExtraGenderNamespaces'][$id] = $ns['gender'];
417 if ( isset( $ns['subpages'] ) && $ns['subpages'] ) {
418 $this->globals
['wgNamespacesWithSubpages'][$id] = true;
420 if ( isset( $ns['content'] ) && $ns['content'] ) {
421 $this->globals
['wgContentNamespaces'][] = $id;
423 if ( isset( $ns['defaultcontentmodel'] ) ) {
424 $this->globals
['wgNamespaceContentModels'][$id] = $ns['defaultcontentmodel'];
426 if ( isset( $ns['protection'] ) ) {
427 $this->globals
['wgNamespaceProtection'][$id] = $ns['protection'];
429 if ( isset( $ns['capitallinkoverride'] ) ) {
430 $this->globals
['wgCapitalLinkOverrides'][$id] = $ns['capitallinkoverride'];
436 protected function extractResourceLoaderModules( $dir, array $info ) {
437 $defaultPaths = $info['ResourceFileModulePaths'] ??
false;
438 if ( isset( $defaultPaths['localBasePath'] ) ) {
439 if ( $defaultPaths['localBasePath'] === '' ) {
440 // Avoid double slashes (e.g. /extensions/Example//path)
441 $defaultPaths['localBasePath'] = $dir;
443 $defaultPaths['localBasePath'] = "$dir/{$defaultPaths['localBasePath']}";
447 foreach ( [ 'ResourceModules', 'ResourceModuleSkinStyles' ] as $setting ) {
448 if ( isset( $info[$setting] ) ) {
449 foreach ( $info[$setting] as $name => $data ) {
450 if ( isset( $data['localBasePath'] ) ) {
451 if ( $data['localBasePath'] === '' ) {
452 // Avoid double slashes (e.g. /extensions/Example//path)
453 $data['localBasePath'] = $dir;
455 $data['localBasePath'] = "$dir/{$data['localBasePath']}";
458 if ( $defaultPaths ) {
459 $data +
= $defaultPaths;
461 $this->globals
["wg$setting"][$name] = $data;
466 if ( isset( $info['QUnitTestModule'] ) ) {
467 $data = $info['QUnitTestModule'];
468 if ( isset( $data['localBasePath'] ) ) {
469 if ( $data['localBasePath'] === '' ) {
470 // Avoid double slashes (e.g. /extensions/Example//path)
471 $data['localBasePath'] = $dir;
473 $data['localBasePath'] = "$dir/{$data['localBasePath']}";
476 $this->attributes
['QUnitTestModules']["test.{$info['name']}"] = $data;
480 protected function extractExtensionMessagesFiles( $dir, array $info ) {
481 if ( isset( $info['ExtensionMessagesFiles'] ) ) {
482 foreach ( $info['ExtensionMessagesFiles'] as &$file ) {
483 $file = "$dir/$file";
485 $this->globals
["wgExtensionMessagesFiles"] +
= $info['ExtensionMessagesFiles'];
490 * Set message-related settings, which need to be expanded to use
496 protected function extractMessagesDirs( $dir, array $info ) {
497 if ( isset( $info['MessagesDirs'] ) ) {
498 foreach ( $info['MessagesDirs'] as $name => $files ) {
499 foreach ( (array)$files as $file ) {
500 $this->globals
["wgMessagesDirs"][$name][] = "$dir/$file";
507 * @param string $path
509 * @return string Name of thing
512 protected function extractCredits( $path, array $info ) {
515 'type' => $info['type'] ??
'other',
517 foreach ( self
::$creditsAttributes as $attr ) {
518 if ( isset( $info[$attr] ) ) {
519 $credits[$attr] = $info[$attr];
523 $name = $credits['name'];
525 // If someone is loading the same thing twice, throw
526 // a nice error (T121493)
527 if ( isset( $this->credits
[$name] ) ) {
528 $firstPath = $this->credits
[$name]['path'];
529 $secondPath = $credits['path'];
530 throw new Exception( "It was attempted to load $name twice, from $firstPath and $secondPath." );
533 $this->credits
[$name] = $credits;
534 $this->globals
['wgExtensionCredits'][$credits['type']][] = $credits;
540 * Set configuration settings for manifest_version == 1
541 * @todo In the future, this should be done via Config interfaces
545 protected function extractConfig1( array $info ) {
546 if ( isset( $info['config'] ) ) {
547 if ( isset( $info['config']['_prefix'] ) ) {
548 $prefix = $info['config']['_prefix'];
549 unset( $info['config']['_prefix'] );
553 foreach ( $info['config'] as $key => $val ) {
554 if ( $key[0] !== '@' ) {
555 $this->addConfigGlobal( "$prefix$key", $val, $info['name'] );
562 * Set configuration settings for manifest_version == 2
563 * @todo In the future, this should be done via Config interfaces
568 protected function extractConfig2( array $info, $dir ) {
569 $prefix = $info['config_prefix'] ??
'wg';
570 if ( isset( $info['config'] ) ) {
571 foreach ( $info['config'] as $key => $data ) {
572 $value = $data['value'];
573 if ( isset( $data['merge_strategy'] ) ) {
574 $value[ExtensionRegistry
::MERGE_STRATEGY
] = $data['merge_strategy'];
576 if ( isset( $data['path'] ) && $data['path'] ) {
577 $value = "$dir/$value";
579 $this->addConfigGlobal( "$prefix$key", $value, $info['name'] );
580 $data['providedby'] = $info['name'];
581 if ( isset( $info['ConfigRegistry'][0] ) ) {
582 $data['configregistry'] = array_keys( $info['ConfigRegistry'] )[0];
584 $this->config
[$key] = $data;
590 * Helper function to set a value to a specific global, if it isn't set already.
592 * @param string $key The config key with the prefix and anything
593 * @param mixed $value The value of the config
594 * @param string $extName Name of the extension
596 private function addConfigGlobal( $key, $value, $extName ) {
597 if ( array_key_exists( $key, $this->globals
) ) {
598 throw new RuntimeException(
599 "The configuration setting '$key' was already set by MediaWiki core or"
600 . " another extension, and cannot be set again by $extName." );
602 $this->globals
[$key] = $value;
605 protected function extractPathBasedGlobal( $global, $dir, $paths ) {
606 foreach ( $paths as $path ) {
607 $this->globals
[$global][] = "$dir/$path";
612 * @param string $path
613 * @param string $name
614 * @param array $value
615 * @param array &$array
616 * @throws InvalidArgumentException
618 protected function storeToArray( $path, $name, $value, &$array ) {
619 if ( !is_array( $value ) ) {
620 throw new InvalidArgumentException( "The value for '$name' should be an array (from $path)" );
622 if ( isset( $array[$name] ) ) {
623 $array[$name] = array_merge_recursive( $array[$name], $value );
625 $array[$name] = $value;
629 public function getExtraAutoloaderPaths( $dir, array $info ) {
631 if ( isset( $info['load_composer_autoloader'] ) && $info['load_composer_autoloader'] === true ) {
632 $paths[] = "$dir/vendor/autoload.php";