MediaWiki  1.30.0
ExtensionProcessor.php
Go to the documentation of this file.
1 <?php
2 
3 class ExtensionProcessor implements Processor {
4 
10  protected static $globalSettings = [
11  'ActionFilteredLogs',
12  'Actions',
13  'AddGroups',
14  'APIFormatModules',
15  'APIListModules',
16  'APIMetaModules',
17  'APIModules',
18  'APIPropModules',
19  'AuthManagerAutoConfig',
20  'AvailableRights',
21  'CentralIdLookupProviders',
22  'ChangeCredentialsBlacklist',
23  'ConfigRegistry',
24  'ContentHandlers',
25  'DefaultUserOptions',
26  'ExtensionEntryPointListFiles',
27  'ExtensionFunctions',
28  'FeedClasses',
29  'FileExtensions',
30  'FilterLogTypes',
31  'GrantPermissionGroups',
32  'GrantPermissions',
33  'GroupPermissions',
34  'GroupsAddToSelf',
35  'GroupsRemoveFromSelf',
36  'HiddenPrefs',
37  'ImplicitGroups',
38  'JobClasses',
39  'LogActions',
40  'LogActionsHandlers',
41  'LogHeaders',
42  'LogNames',
43  'LogRestrictions',
44  'LogTypes',
45  'MediaHandlers',
46  'PasswordPolicy',
47  'RateLimits',
48  'RecentChangesFlags',
49  'RemoveCredentialsBlacklist',
50  'RemoveGroups',
51  'ResourceLoaderLESSVars',
52  'ResourceLoaderSources',
53  'RevokePermissions',
54  'SessionProviders',
55  'SpecialPages',
56  'ValidSkinNames',
57  ];
58 
64  protected static $coreAttributes = [
65  'SkinOOUIThemes',
66  'TrackingCategories',
67  ];
68 
76  protected static $mergeStrategies = [
77  'wgAuthManagerAutoConfig' => 'array_plus_2d',
78  'wgCapitalLinkOverrides' => 'array_plus',
79  'wgExtensionCredits' => 'array_merge_recursive',
80  'wgExtraGenderNamespaces' => 'array_plus',
81  'wgGrantPermissions' => 'array_plus_2d',
82  'wgGroupPermissions' => 'array_plus_2d',
83  'wgHooks' => 'array_merge_recursive',
84  'wgNamespaceContentModels' => 'array_plus',
85  'wgNamespaceProtection' => 'array_plus',
86  'wgNamespacesWithSubpages' => 'array_plus',
87  'wgPasswordPolicy' => 'array_merge_recursive',
88  'wgRateLimits' => 'array_plus_2d',
89  'wgRevokePermissions' => 'array_plus_2d',
90  ];
91 
97  protected static $creditsAttributes = [
98  'name',
99  'namemsg',
100  'author',
101  'version',
102  'url',
103  'description',
104  'descriptionmsg',
105  'license-name',
106  ];
107 
114  protected static $notAttributes = [
115  'callback',
116  'Hooks',
117  'namespaces',
118  'ResourceFileModulePaths',
119  'ResourceModules',
120  'ResourceModuleSkinStyles',
121  'ExtensionMessagesFiles',
122  'MessagesDirs',
123  'type',
124  'config',
125  'config_prefix',
126  'ServiceWiringFiles',
127  'ParserTestFiles',
128  'AutoloadClasses',
129  'manifest_version',
130  'load_composer_autoloader',
131  ];
132 
140  protected $globals = [
141  'wgExtensionMessagesFiles' => [],
142  'wgMessagesDirs' => [],
143  ];
144 
150  protected $defines = [];
151 
158  protected $callbacks = [];
159 
163  protected $credits = [];
164 
171  protected $attributes = [];
172 
179  protected $extAttributes = [];
180 
187  public function extractInfo( $path, array $info, $version ) {
188  $dir = dirname( $path );
189  if ( $version === 2 ) {
190  $this->extractConfig2( $info, $dir );
191  } else {
192  // $version === 1
193  $this->extractConfig1( $info );
194  }
195  $this->extractHooks( $info );
196  $this->extractExtensionMessagesFiles( $dir, $info );
197  $this->extractMessagesDirs( $dir, $info );
198  $this->extractNamespaces( $info );
199  $this->extractResourceLoaderModules( $dir, $info );
200  $this->extractServiceWiringFiles( $dir, $info );
201  $this->extractParserTestFiles( $dir, $info );
202  $name = $this->extractCredits( $path, $info );
203  if ( isset( $info['callback'] ) ) {
204  $this->callbacks[$name] = $info['callback'];
205  }
206 
207  if ( $version === 2 ) {
208  $this->extractAttributes( $path, $info );
209  }
210 
211  foreach ( $info as $key => $val ) {
212  // If it's a global setting,
213  if ( in_array( $key, self::$globalSettings ) ) {
214  $this->storeToArray( $path, "wg$key", $val, $this->globals );
215  continue;
216  }
217  // Ignore anything that starts with a @
218  if ( $key[0] === '@' ) {
219  continue;
220  }
221 
222  if ( $version === 2 ) {
223  // Only whitelisted attributes are set
224  if ( in_array( $key, self::$coreAttributes ) ) {
225  $this->storeToArray( $path, $key, $val, $this->attributes );
226  }
227  } else {
228  // version === 1
229  if ( !in_array( $key, self::$notAttributes )
230  && !in_array( $key, self::$creditsAttributes )
231  ) {
232  // If it's not blacklisted, it's an attribute
233  $this->storeToArray( $path, $key, $val, $this->attributes );
234  }
235  }
236 
237  }
238  }
239 
244  protected function extractAttributes( $path, array $info ) {
245  if ( isset( $info['attributes'] ) ) {
246  foreach ( $info['attributes'] as $extName => $value ) {
247  $this->storeToArray( $path, $extName, $value, $this->extAttributes );
248  }
249  }
250  }
251 
252  public function getExtractedInfo() {
253  // Make sure the merge strategies are set
254  foreach ( $this->globals as $key => $val ) {
255  if ( isset( self::$mergeStrategies[$key] ) ) {
256  $this->globals[$key][ExtensionRegistry::MERGE_STRATEGY] = self::$mergeStrategies[$key];
257  }
258  }
259 
260  // Merge $this->extAttributes into $this->attributes depending on what is loaded
261  foreach ( $this->extAttributes as $extName => $value ) {
262  // Only set the attribute if $extName is loaded (and hence present in credits)
263  if ( isset( $this->credits[$extName] ) ) {
264  foreach ( $value as $attrName => $attrValue ) {
265  $this->storeToArray(
266  '', // Don't provide a path since it's impossible to generate an error here
267  $extName . $attrName,
268  $attrValue,
269  $this->attributes
270  );
271  }
272  unset( $this->extAttributes[$extName] );
273  }
274  }
275 
276  return [
277  'globals' => $this->globals,
278  'defines' => $this->defines,
279  'callbacks' => $this->callbacks,
280  'credits' => $this->credits,
281  'attributes' => $this->attributes,
282  ];
283  }
284 
285  public function getRequirements( array $info ) {
286  return isset( $info['requires'] ) ? $info['requires'] : [];
287  }
288 
289  protected function extractHooks( array $info ) {
290  if ( isset( $info['Hooks'] ) ) {
291  foreach ( $info['Hooks'] as $name => $value ) {
292  if ( is_array( $value ) ) {
293  foreach ( $value as $callback ) {
294  $this->globals['wgHooks'][$name][] = $callback;
295  }
296  } else {
297  $this->globals['wgHooks'][$name][] = $value;
298  }
299  }
300  }
301  }
302 
308  protected function extractNamespaces( array $info ) {
309  if ( isset( $info['namespaces'] ) ) {
310  foreach ( $info['namespaces'] as $ns ) {
311  if ( defined( $ns['constant'] ) ) {
312  // If the namespace constant is already defined, use it.
313  // This allows namespace IDs to be overwritten locally.
314  $id = constant( $ns['constant'] );
315  } else {
316  $id = $ns['id'];
317  $this->defines[ $ns['constant'] ] = $id;
318  }
319 
320  if ( !( isset( $ns['conditional'] ) && $ns['conditional'] ) ) {
321  // If it is not conditional, register it
322  $this->attributes['ExtensionNamespaces'][$id] = $ns['name'];
323  }
324  if ( isset( $ns['gender'] ) ) {
325  $this->globals['wgExtraGenderNamespaces'][$id] = $ns['gender'];
326  }
327  if ( isset( $ns['subpages'] ) && $ns['subpages'] ) {
328  $this->globals['wgNamespacesWithSubpages'][$id] = true;
329  }
330  if ( isset( $ns['content'] ) && $ns['content'] ) {
331  $this->globals['wgContentNamespaces'][] = $id;
332  }
333  if ( isset( $ns['defaultcontentmodel'] ) ) {
334  $this->globals['wgNamespaceContentModels'][$id] = $ns['defaultcontentmodel'];
335  }
336  if ( isset( $ns['protection'] ) ) {
337  $this->globals['wgNamespaceProtection'][$id] = $ns['protection'];
338  }
339  if ( isset( $ns['capitallinkoverride'] ) ) {
340  $this->globals['wgCapitalLinkOverrides'][$id] = $ns['capitallinkoverride'];
341  }
342  }
343  }
344  }
345 
346  protected function extractResourceLoaderModules( $dir, array $info ) {
347  $defaultPaths = isset( $info['ResourceFileModulePaths'] )
348  ? $info['ResourceFileModulePaths']
349  : false;
350  if ( isset( $defaultPaths['localBasePath'] ) ) {
351  if ( $defaultPaths['localBasePath'] === '' ) {
352  // Avoid double slashes (e.g. /extensions/Example//path)
353  $defaultPaths['localBasePath'] = $dir;
354  } else {
355  $defaultPaths['localBasePath'] = "$dir/{$defaultPaths['localBasePath']}";
356  }
357  }
358 
359  foreach ( [ 'ResourceModules', 'ResourceModuleSkinStyles' ] as $setting ) {
360  if ( isset( $info[$setting] ) ) {
361  foreach ( $info[$setting] as $name => $data ) {
362  if ( isset( $data['localBasePath'] ) ) {
363  if ( $data['localBasePath'] === '' ) {
364  // Avoid double slashes (e.g. /extensions/Example//path)
365  $data['localBasePath'] = $dir;
366  } else {
367  $data['localBasePath'] = "$dir/{$data['localBasePath']}";
368  }
369  }
370  if ( $defaultPaths ) {
371  $data += $defaultPaths;
372  }
373  $this->globals["wg$setting"][$name] = $data;
374  }
375  }
376  }
377  }
378 
379  protected function extractExtensionMessagesFiles( $dir, array $info ) {
380  if ( isset( $info['ExtensionMessagesFiles'] ) ) {
381  $this->globals["wgExtensionMessagesFiles"] += array_map( function ( $file ) use ( $dir ) {
382  return "$dir/$file";
383  }, $info['ExtensionMessagesFiles'] );
384  }
385  }
386 
394  protected function extractMessagesDirs( $dir, array $info ) {
395  if ( isset( $info['MessagesDirs'] ) ) {
396  foreach ( $info['MessagesDirs'] as $name => $files ) {
397  foreach ( (array)$files as $file ) {
398  $this->globals["wgMessagesDirs"][$name][] = "$dir/$file";
399  }
400  }
401  }
402  }
403 
410  protected function extractCredits( $path, array $info ) {
411  $credits = [
412  'path' => $path,
413  'type' => isset( $info['type'] ) ? $info['type'] : 'other',
414  ];
415  foreach ( self::$creditsAttributes as $attr ) {
416  if ( isset( $info[$attr] ) ) {
417  $credits[$attr] = $info[$attr];
418  }
419  }
420 
421  $name = $credits['name'];
422 
423  // If someone is loading the same thing twice, throw
424  // a nice error (T121493)
425  if ( isset( $this->credits[$name] ) ) {
426  $firstPath = $this->credits[$name]['path'];
427  $secondPath = $credits['path'];
428  throw new Exception( "It was attempted to load $name twice, from $firstPath and $secondPath." );
429  }
430 
431  $this->credits[$name] = $credits;
432  $this->globals['wgExtensionCredits'][$credits['type']][] = $credits;
433 
434  return $name;
435  }
436 
443  protected function extractConfig1( array $info ) {
444  if ( isset( $info['config'] ) ) {
445  if ( isset( $info['config']['_prefix'] ) ) {
446  $prefix = $info['config']['_prefix'];
447  unset( $info['config']['_prefix'] );
448  } else {
449  $prefix = 'wg';
450  }
451  foreach ( $info['config'] as $key => $val ) {
452  if ( $key[0] !== '@' ) {
453  $this->globals["$prefix$key"] = $val;
454  }
455  }
456  }
457  }
458 
466  protected function extractConfig2( array $info, $dir ) {
467  if ( isset( $info['config_prefix'] ) ) {
468  $prefix = $info['config_prefix'];
469  } else {
470  $prefix = 'wg';
471  }
472  if ( isset( $info['config'] ) ) {
473  foreach ( $info['config'] as $key => $data ) {
474  $value = $data['value'];
475  if ( isset( $data['merge_strategy'] ) ) {
476  $value[ExtensionRegistry::MERGE_STRATEGY] = $data['merge_strategy'];
477  }
478  if ( isset( $data['path'] ) && $data['path'] ) {
479  $value = "$dir/$value";
480  }
481  $this->globals["$prefix$key"] = $value;
482  }
483  }
484  }
485 
486  protected function extractServiceWiringFiles( $dir, array $info ) {
487  if ( isset( $info['ServiceWiringFiles'] ) ) {
488  foreach ( $info['ServiceWiringFiles'] as $path ) {
489  $this->globals['wgServiceWiringFiles'][] = "$dir/$path";
490  }
491  }
492  }
493 
494  protected function extractParserTestFiles( $dir, array $info ) {
495  if ( isset( $info['ParserTestFiles'] ) ) {
496  foreach ( $info['ParserTestFiles'] as $path ) {
497  $this->globals['wgParserTestFiles'][] = "$dir/$path";
498  }
499  }
500  }
501 
509  protected function storeToArray( $path, $name, $value, &$array ) {
510  if ( !is_array( $value ) ) {
511  throw new InvalidArgumentException( "The value for '$name' should be an array (from $path)" );
512  }
513  if ( isset( $array[$name] ) ) {
514  $array[$name] = array_merge_recursive( $array[$name], $value );
515  } else {
516  $array[$name] = $value;
517  }
518  }
519 
520  public function getExtraAutoloaderPaths( $dir, array $info ) {
521  $paths = [];
522  if ( isset( $info['load_composer_autoloader'] ) && $info['load_composer_autoloader'] === true ) {
523  $path = "$dir/vendor/autoload.php";
524  if ( file_exists( $path ) ) {
525  $paths[] = $path;
526  }
527  }
528  return $paths;
529  }
530 }
ExtensionProcessor\getRequirements
getRequirements(array $info)
Get the requirements for the provided info.
Definition: ExtensionProcessor.php:285
ExtensionProcessor\extractParserTestFiles
extractParserTestFiles( $dir, array $info)
Definition: ExtensionProcessor.php:494
ExtensionProcessor\$coreAttributes
static string[] $coreAttributes
Top-level attributes that come from MW core.
Definition: ExtensionProcessor.php:64
ExtensionProcessor\$callbacks
callable[] $callbacks
Things to be called once registration of these extensions are done keyed by the name of the extension...
Definition: ExtensionProcessor.php:158
ExtensionProcessor\$mergeStrategies
static array $mergeStrategies
Mapping of global settings to their specific merge strategies.
Definition: ExtensionProcessor.php:76
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
ExtensionProcessor\extractResourceLoaderModules
extractResourceLoaderModules( $dir, array $info)
Definition: ExtensionProcessor.php:346
ExtensionProcessor\extractConfig1
extractConfig1(array $info)
Set configuration settings for manifest_version == 1.
Definition: ExtensionProcessor.php:443
ExtensionProcessor\storeToArray
storeToArray( $path, $name, $value, &$array)
Definition: ExtensionProcessor.php:509
Processor
Processors read associated arrays and register whatever is required.
Definition: Processor.php:9
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ExtensionProcessor\extractExtensionMessagesFiles
extractExtensionMessagesFiles( $dir, array $info)
Definition: ExtensionProcessor.php:379
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
ExtensionRegistry\MERGE_STRATEGY
const MERGE_STRATEGY
Special key that defines the merge strategy.
Definition: ExtensionRegistry.php:41
ExtensionProcessor\extractHooks
extractHooks(array $info)
Definition: ExtensionProcessor.php:289
ExtensionProcessor
Definition: ExtensionProcessor.php:3
ExtensionProcessor\extractServiceWiringFiles
extractServiceWiringFiles( $dir, array $info)
Definition: ExtensionProcessor.php:486
ExtensionProcessor\extractConfig2
extractConfig2(array $info, $dir)
Set configuration settings for manifest_version == 2.
Definition: ExtensionProcessor.php:466
ExtensionProcessor\$globals
array $globals
Stuff that is going to be set to $GLOBALS.
Definition: ExtensionProcessor.php:140
$dir
$dir
Definition: Autoload.php:8
ExtensionProcessor\getExtraAutoloaderPaths
getExtraAutoloaderPaths( $dir, array $info)
Get the path for additional autoloaders, e.g.
Definition: ExtensionProcessor.php:520
$value
$value
Definition: styleTest.css.php:45
ExtensionProcessor\$credits
array $credits
Definition: ExtensionProcessor.php:163
globals
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining globals
Definition: globals.txt:25
ExtensionProcessor\extractNamespaces
extractNamespaces(array $info)
Register namespaces with the appropriate global settings.
Definition: ExtensionProcessor.php:308
ExtensionProcessor\getExtractedInfo
getExtractedInfo()
Definition: ExtensionProcessor.php:252
ExtensionProcessor\$extAttributes
array $extAttributes
Extension attributes, keyed by name => settings.
Definition: ExtensionProcessor.php:179
ExtensionProcessor\$globalSettings
static array $globalSettings
Keys that should be set to $GLOBALS.
Definition: ExtensionProcessor.php:10
ExtensionProcessor\$creditsAttributes
static array $creditsAttributes
Keys that are part of the extension credits.
Definition: ExtensionProcessor.php:97
ExtensionProcessor\extractAttributes
extractAttributes( $path, array $info)
Definition: ExtensionProcessor.php:244
ExtensionProcessor\extractCredits
extractCredits( $path, array $info)
Definition: ExtensionProcessor.php:410
$path
$path
Definition: NoLocalSettings.php:26
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
ExtensionProcessor\extractInfo
extractInfo( $path, array $info, $version)
Definition: ExtensionProcessor.php:187
ExtensionProcessor\$defines
array $defines
Things that should be define()'d.
Definition: ExtensionProcessor.php:150
ExtensionProcessor\$attributes
array $attributes
Any thing else in the $info that hasn't already been processed.
Definition: ExtensionProcessor.php:171
ExtensionProcessor\$notAttributes
static array $notAttributes
Things that are not 'attributes', but are not in $globalSettings or $creditsAttributes.
Definition: ExtensionProcessor.php:114
ExtensionProcessor\extractMessagesDirs
extractMessagesDirs( $dir, array $info)
Set message-related settings, which need to be expanded to use absolute paths.
Definition: ExtensionProcessor.php:394
array
the array() calling protocol came about after MediaWiki 1.4rc1.