includes/registration/ExtensionProcessor.php

   1 <?php
   2
   3 class ExtensionProcessor implements Processor {
   4
   5         /**
   6          * Keys that should be set to $GLOBALS
   7          *
   8          * @var array
   9          */
  10         protected static $globalSettings = [
  11                 'ResourceLoaderSources',
  12                 'ResourceLoaderLESSVars',
  13                 'ResourceLoaderLESSImportPaths',
  14                 'DefaultUserOptions',
  15                 'HiddenPrefs',
  16                 'GroupPermissions',
  17                 'RevokePermissions',
  18                 'ImplicitGroups',
  19                 'GroupsAddToSelf',
  20                 'GroupsRemoveFromSelf',
  21                 'AddGroups',
  22                 'RemoveGroups',
  23                 'AvailableRights',
  24                 'ContentHandlers',
  25                 'ConfigRegistry',
  26                 'SessionProviders',
  27                 'AuthManagerAutoConfig',
  28                 'CentralIdLookupProviders',
  29                 'RateLimits',
  30                 'RecentChangesFlags',
  31                 'MediaHandlers',
  32                 'ExtensionFunctions',
  33                 'ExtensionEntryPointListFiles',
  34                 'SpecialPages',
  35                 'JobClasses',
  36                 'LogTypes',
  37                 'LogRestrictions',
  38                 'FilterLogTypes',
  39                 'ActionFilteredLogs',
  40                 'LogNames',
  41                 'LogHeaders',
  42                 'LogActions',
  43                 'LogActionsHandlers',
  44                 'Actions',
  45                 'APIModules',
  46                 'APIFormatModules',
  47                 'APIMetaModules',
  48                 'APIPropModules',
  49                 'APIListModules',
  50                 'ValidSkinNames',
  51                 'FeedClasses',
  52         ];
  53
  54         /**
  55          * Mapping of global settings to their specific merge strategies.
  56          *
  57          * @see ExtensionRegistry::exportExtractedData
  58          * @see getExtractedInfo
  59          * @var array
  60          */
  61         protected static $mergeStrategies = [
  62                 'wgGroupPermissions' => 'array_plus_2d',
  63                 'wgRevokePermissions' => 'array_plus_2d',
  64                 'wgHooks' => 'array_merge_recursive',
  65                 'wgExtensionCredits' => 'array_merge_recursive',
  66                 'wgExtraGenderNamespaces' => 'array_plus',
  67                 'wgNamespacesWithSubpages' => 'array_plus',
  68                 'wgNamespaceContentModels' => 'array_plus',
  69                 'wgNamespaceProtection' => 'array_plus',
  70                 'wgCapitalLinkOverrides' => 'array_plus',
  71                 'wgRateLimits' => 'array_plus_2d',
  72                 'wgAuthManagerAutoConfig' => 'array_plus_2d',
  73         ];
  74
  75         /**
  76          * Keys that are part of the extension credits
  77          *
  78          * @var array
  79          */
  80         protected static $creditsAttributes = [
  81                 'name',
  82                 'namemsg',
  83                 'author',
  84                 'version',
  85                 'url',
  86                 'description',
  87                 'descriptionmsg',
  88                 'license-name',
  89         ];
  90
  91         /**
  92          * Things that are not 'attributes', but are not in
  93          * $globalSettings or $creditsAttributes.
  94          *
  95          * @var array
  96          */
  97         protected static $notAttributes = [
  98                 'callback',
  99                 'Hooks',
 100                 'namespaces',
 101                 'ResourceFileModulePaths',
 102                 'ResourceModules',
 103                 'ResourceModuleSkinStyles',
 104                 'ExtensionMessagesFiles',
 105                 'MessagesDirs',
 106                 'type',
 107                 'config',
 108                 'ParserTestFiles',
 109                 'AutoloadClasses',
 110                 'manifest_version',
 111                 'load_composer_autoloader',
 112         ];
 113
 114         /**
 115          * Stuff that is going to be set to $GLOBALS
 116          *
 117          * Some keys are pre-set to arrays so we can += to them
 118          *
 119          * @var array
 120          */
 121         protected $globals = [
 122                 'wgExtensionMessagesFiles' => [],
 123                 'wgMessagesDirs' => [],
 124         ];
 125
 126         /**
 127          * Things that should be define()'d
 128          *
 129          * @var array
 130          */
 131         protected $defines = [];
 132
 133         /**
 134          * Things to be called once registration of these extensions are done
 135          *
 136          * @var callable[]
 137          */
 138         protected $callbacks = [];
 139
 140         /**
 141          * @var array
 142          */
 143         protected $credits = [];
 144
 145         /**
 146          * Any thing else in the $info that hasn't
 147          * already been processed
 148          *
 149          * @var array
 150          */
 151         protected $attributes = [];
 152
 153         /**
 154          * @param string $path
 155          * @param array $info
 156          * @param int $version manifest_version for info
 157          * @return array
 158          */
 159         public function extractInfo( $path, array $info, $version ) {
 160                 $this->extractConfig( $info );
 161                 $this->extractHooks( $info );
 162                 $dir = dirname( $path );
 163                 $this->extractExtensionMessagesFiles( $dir, $info );
 164                 $this->extractMessagesDirs( $dir, $info );
 165                 $this->extractNamespaces( $info );
 166                 $this->extractResourceLoaderModules( $dir, $info );
 167                 $this->extractParserTestFiles( $dir, $info );
 168                 if ( isset( $info['callback'] ) ) {
 169                         $this->callbacks[] = $info['callback'];
 170                 }
 171
 172                 $this->extractCredits( $path, $info );
 173                 foreach ( $info as $key => $val ) {
 174                         if ( in_array( $key, self::$globalSettings ) ) {
 175                                 $this->storeToArray( $path, "wg$key", $val, $this->globals );
 176                         // Ignore anything that starts with a @
 177                         } elseif ( $key[0] !== '@' && !in_array( $key, self::$notAttributes )
 178                                 && !in_array( $key, self::$creditsAttributes )
 179                         ) {
 180                                 $this->storeToArray( $path, $key, $val, $this->attributes );
 181                         }
 182                 }
 183         }
 184
 185         public function getExtractedInfo() {
 186                 // Make sure the merge strategies are set
 187                 foreach ( $this->globals as $key => $val ) {
 188                         if ( isset( self::$mergeStrategies[$key] ) ) {
 189                                 $this->globals[$key][ExtensionRegistry::MERGE_STRATEGY] = self::$mergeStrategies[$key];
 190                         }
 191                 }
 192
 193                 return [
 194                         'globals' => $this->globals,
 195                         'defines' => $this->defines,
 196                         'callbacks' => $this->callbacks,
 197                         'credits' => $this->credits,
 198                         'attributes' => $this->attributes,
 199                 ];
 200         }
 201
 202         public function getRequirements( array $info ) {
 203                 $requirements = [];
 204                 $key = ExtensionRegistry::MEDIAWIKI_CORE;
 205                 if ( isset( $info['requires'][$key] ) ) {
 206                         $requirements[$key] = $info['requires'][$key];
 207                 }
 208
 209                 return $requirements;
 210         }
 211
 212         protected function extractHooks( array $info ) {
 213                 if ( isset( $info['Hooks'] ) ) {
 214                         foreach ( $info['Hooks'] as $name => $value ) {
 215                                 if ( is_array( $value ) ) {
 216                                         foreach ( $value as $callback ) {
 217                                                 $this->globals['wgHooks'][$name][] = $callback;
 218                                         }
 219                                 } else {
 220                                         $this->globals['wgHooks'][$name][] = $value;
 221                                 }
 222                         }
 223                 }
 224         }
 225
 226         /**
 227          * Register namespaces with the appropriate global settings
 228          *
 229          * @param array $info
 230          */
 231         protected function extractNamespaces( array $info ) {
 232                 if ( isset( $info['namespaces'] ) ) {
 233                         foreach ( $info['namespaces'] as $ns ) {
 234                                 $id = $ns['id'];
 235                                 $this->defines[$ns['constant']] = $id;
 236                                 $this->attributes['ExtensionNamespaces'][$id] = $ns['name'];
 237                                 if ( isset( $ns['gender'] ) ) {
 238                                         $this->globals['wgExtraGenderNamespaces'][$id] = $ns['gender'];
 239                                 }
 240                                 if ( isset( $ns['subpages'] ) && $ns['subpages'] ) {
 241                                         $this->globals['wgNamespacesWithSubpages'][$id] = true;
 242                                 }
 243                                 if ( isset( $ns['content'] ) && $ns['content'] ) {
 244                                         $this->globals['wgContentNamespaces'][] = $id;
 245                                 }
 246                                 if ( isset( $ns['defaultcontentmodel'] ) ) {
 247                                         $this->globals['wgNamespaceContentModels'][$id] = $ns['defaultcontentmodel'];
 248                                 }
 249                                 if ( isset( $ns['protection'] ) ) {
 250                                         $this->globals['wgNamespaceProtection'][$id] = $ns['protection'];
 251                                 }
 252                                 if ( isset( $ns['capitallinkoverride'] ) ) {
 253                                         $this->globals['wgCapitalLinkOverrides'][$id] = $ns['capitallinkoverride'];
 254                                 }
 255                         }
 256                 }
 257         }
 258
 259         protected function extractResourceLoaderModules( $dir, array $info ) {
 260                 $defaultPaths = isset( $info['ResourceFileModulePaths'] )
 261                         ? $info['ResourceFileModulePaths']
 262                         : false;
 263                 if ( isset( $defaultPaths['localBasePath'] ) ) {
 264                         if ( $defaultPaths['localBasePath'] === '' ) {
 265                                 // Avoid double slashes (e.g. /extensions/Example//path)
 266                                 $defaultPaths['localBasePath'] = $dir;
 267                         } else {
 268                                 $defaultPaths['localBasePath'] = "$dir/{$defaultPaths['localBasePath']}";
 269                         }
 270                 }
 271
 272                 foreach ( [ 'ResourceModules', 'ResourceModuleSkinStyles' ] as $setting ) {
 273                         if ( isset( $info[$setting] ) ) {
 274                                 foreach ( $info[$setting] as $name => $data ) {
 275                                         if ( isset( $data['localBasePath'] ) ) {
 276                                                 if ( $data['localBasePath'] === '' ) {
 277                                                         // Avoid double slashes (e.g. /extensions/Example//path)
 278                                                         $data['localBasePath'] = $dir;
 279                                                 } else {
 280                                                         $data['localBasePath'] = "$dir/{$data['localBasePath']}";
 281                                                 }
 282                                         }
 283                                         if ( $defaultPaths ) {
 284                                                 $data += $defaultPaths;
 285                                         }
 286                                         $this->globals["wg$setting"][$name] = $data;
 287                                 }
 288                         }
 289                 }
 290         }
 291
 292         protected function extractExtensionMessagesFiles( $dir, array $info ) {
 293                 if ( isset( $info['ExtensionMessagesFiles'] ) ) {
 294                         $this->globals["wgExtensionMessagesFiles"] += array_map( function( $file ) use ( $dir ) {
 295                                 return "$dir/$file";
 296                         }, $info['ExtensionMessagesFiles'] );
 297                 }
 298         }
 299
 300         /**
 301          * Set message-related settings, which need to be expanded to use
 302          * absolute paths
 303          *
 304          * @param string $dir
 305          * @param array $info
 306          */
 307         protected function extractMessagesDirs( $dir, array $info ) {
 308                 if ( isset( $info['MessagesDirs'] ) ) {
 309                         foreach ( $info['MessagesDirs'] as $name => $files ) {
 310                                 foreach ( (array)$files as $file ) {
 311                                         $this->globals["wgMessagesDirs"][$name][] = "$dir/$file";
 312                                 }
 313                         }
 314                 }
 315         }
 316
 317         /**
 318          * @param string $path
 319          * @param array $info
 320          * @throws Exception
 321          */
 322         protected function extractCredits( $path, array $info ) {
 323                 $credits = [
 324                         'path' => $path,
 325                         'type' => isset( $info['type'] ) ? $info['type'] : 'other',
 326                 ];
 327                 foreach ( self::$creditsAttributes as $attr ) {
 328                         if ( isset( $info[$attr] ) ) {
 329                                 $credits[$attr] = $info[$attr];
 330                         }
 331                 }
 332
 333                 $name = $credits['name'];
 334
 335                 // If someone is loading the same thing twice, throw
 336                 // a nice error (T121493)
 337                 if ( isset( $this->credits[$name] ) ) {
 338                         $firstPath = $this->credits[$name]['path'];
 339                         $secondPath = $credits['path'];
 340                         throw new Exception( "It was attempted to load $name twice, from $firstPath and $secondPath." );
 341                 }
 342
 343                 $this->credits[$name] = $credits;
 344                 $this->globals['wgExtensionCredits'][$credits['type']][] = $credits;
 345         }
 346
 347         /**
 348          * Set configuration settings
 349          * @todo In the future, this should be done via Config interfaces
 350          *
 351          * @param array $info
 352          */
 353         protected function extractConfig( array $info ) {
 354                 if ( isset( $info['config'] ) ) {
 355                         if ( isset( $info['config']['_prefix'] ) ) {
 356                                 $prefix = $info['config']['_prefix'];
 357                                 unset( $info['config']['_prefix'] );
 358                         } else {
 359                                 $prefix = 'wg';
 360                         }
 361                         foreach ( $info['config'] as $key => $val ) {
 362                                 if ( $key[0] !== '@' ) {
 363                                         $this->globals["$prefix$key"] = $val;
 364                                 }
 365                         }
 366                 }
 367         }
 368
 369         protected function extractParserTestFiles( $dir, array $info ) {
 370                 if ( isset( $info['ParserTestFiles'] ) ) {
 371                         foreach ( $info['ParserTestFiles'] as $path ) {
 372                                 $this->globals['wgParserTestFiles'][] = "$dir/$path";
 373                         }
 374                 }
 375         }
 376
 377         /**
 378          * @param string $path
 379          * @param string $name
 380          * @param array $value
 381          * @param array &$array
 382          * @throws InvalidArgumentException
 383          */
 384         protected function storeToArray( $path, $name, $value, &$array ) {
 385                 if ( !is_array( $value ) ) {
 386                         throw new InvalidArgumentException( "The value for '$name' should be an array (from $path)" );
 387                 }
 388                 if ( isset( $array[$name] ) ) {
 389                         $array[$name] = array_merge_recursive( $array[$name], $value );
 390                 } else {
 391                         $array[$name] = $value;
 392                 }
 393         }
 394
 395         public function getExtraAutoloaderPaths( $dir, array $info ) {
 396                 $paths = [];
 397                 if ( isset( $info['load_composer_autoloader'] ) && $info['load_composer_autoloader'] === true ) {
 398                         $path = "$dir/vendor/autoload.php";
 399                         if ( file_exists( $path ) ) {
 400                                 $paths[] = $path;
 401                         }
 402                 }
 403                 return $paths;
 404         }
 405 }