includes/registration/ExtensionRegistry.php

   1 <?php
   2
   3 use Composer\Semver\Semver;
   4
   5 /**
   6  * ExtensionRegistry class
   7  *
   8  * The Registry loads JSON files, and uses a Processor
   9  * to extract information from them. It also registers
  10  * classes with the autoloader.
  11  *
  12  * @since 1.25
  13  */
  14 class ExtensionRegistry {
  15
  16         /**
  17          * "requires" key that applies to MediaWiki core/$wgVersion
  18          */
  19         const MEDIAWIKI_CORE = 'MediaWiki';
  20
  21         /**
  22          * Version of the highest supported manifest version
  23          * Note: Update MANIFEST_VERSION_MW_VERSION when changing this
  24          */
  25         const MANIFEST_VERSION = 2;
  26
  27         /**
  28          * MediaWiki version constraint representing what the current
  29          * highest MANIFEST_VERSION is supported in
  30          */
  31         const MANIFEST_VERSION_MW_VERSION = '>= 1.29.0';
  32
  33         /**
  34          * Version of the oldest supported manifest version
  35          */
  36         const OLDEST_MANIFEST_VERSION = 1;
  37
  38         /**
  39          * Bump whenever the registration cache needs resetting
  40          */
  41         const CACHE_VERSION = 7;
  42
  43         /**
  44          * Special key that defines the merge strategy
  45          *
  46          * @since 1.26
  47          */
  48         const MERGE_STRATEGY = '_merge_strategy';
  49
  50         /**
  51          * Array of loaded things, keyed by name, values are credits information
  52          *
  53          * @var array
  54          */
  55         private $loaded = [];
  56
  57         /**
  58          * List of paths that should be loaded
  59          *
  60          * @var array
  61          */
  62         protected $queued = [];
  63
  64         /**
  65          * Whether we are done loading things
  66          *
  67          * @var bool
  68          */
  69         private $finished = false;
  70
  71         /**
  72          * Items in the JSON file that aren't being
  73          * set as globals
  74          *
  75          * @var array
  76          */
  77         protected $attributes = [];
  78
  79         /**
  80          * @var ExtensionRegistry
  81          */
  82         private static $instance;
  83
  84         /**
  85          * @codeCoverageIgnore
  86          * @return ExtensionRegistry
  87          */
  88         public static function getInstance() {
  89                 if ( self::$instance === null ) {
  90                         self::$instance = new self();
  91                 }
  92
  93                 return self::$instance;
  94         }
  95
  96         /**
  97          * @param string $path Absolute path to the JSON file
  98          */
  99         public function queue( $path ) {
 100                 global $wgExtensionInfoMTime;
 101
 102                 $mtime = $wgExtensionInfoMTime;
 103                 if ( $mtime === false ) {
 104                         if ( file_exists( $path ) ) {
 105                                 $mtime = filemtime( $path );
 106                         } else {
 107                                 throw new Exception( "$path does not exist!" );
 108                         }
 109                         // @codeCoverageIgnoreStart
 110                         if ( $mtime === false ) {
 111                                 $err = error_get_last();
 112                                 throw new Exception( "Couldn't stat $path: {$err['message']}" );
 113                                 // @codeCoverageIgnoreEnd
 114                         }
 115                 }
 116                 $this->queued[$path] = $mtime;
 117         }
 118
 119         /**
 120          * @throws MWException If the queue is already marked as finished (no further things should
 121          *  be loaded then).
 122          */
 123         public function loadFromQueue() {
 124                 global $wgVersion, $wgDevelopmentWarnings;
 125                 if ( !$this->queued ) {
 126                         return;
 127                 }
 128
 129                 if ( $this->finished ) {
 130                         throw new MWException(
 131                                 "The following paths tried to load late: "
 132                                 . implode( ', ', array_keys( $this->queued ) )
 133                         );
 134                 }
 135
 136                 // A few more things to vary the cache on
 137                 $versions = [
 138                         'registration' => self::CACHE_VERSION,
 139                         'mediawiki' => $wgVersion
 140                 ];
 141
 142                 // We use a try/catch because we don't want to fail here
 143                 // if $wgObjectCaches is not configured properly for APC setup
 144                 try {
 145                         // Don't use MediaWikiServices here to prevent instantiating it before extensions have
 146                         // been loaded
 147                         $cacheId = ObjectCache::detectLocalServerCache();
 148                         $cache = ObjectCache::newFromId( $cacheId );
 149                 } catch ( InvalidArgumentException $e ) {
 150                         $cache = new EmptyBagOStuff();
 151                 }
 152                 // See if this queue is in APC
 153                 $key = $cache->makeKey(
 154                         'registration',
 155                         md5( json_encode( $this->queued + $versions ) )
 156                 );
 157                 $data = $cache->get( $key );
 158                 if ( $data ) {
 159                         $this->exportExtractedData( $data );
 160                 } else {
 161                         $data = $this->readFromQueue( $this->queued );
 162                         $this->exportExtractedData( $data );
 163                         // Do this late since we don't want to extract it since we already
 164                         // did that, but it should be cached
 165                         $data['globals']['wgAutoloadClasses'] += $data['autoload'];
 166                         unset( $data['autoload'] );
 167                         if ( !( $data['warnings'] && $wgDevelopmentWarnings ) ) {
 168                                 // If there were no warnings that were shown, cache it
 169                                 $cache->set( $key, $data, 60 * 60 * 24 );
 170                         }
 171                 }
 172                 $this->queued = [];
 173         }
 174
 175         /**
 176          * Get the current load queue. Not intended to be used
 177          * outside of the installer.
 178          *
 179          * @return array
 180          */
 181         public function getQueue() {
 182                 return $this->queued;
 183         }
 184
 185         /**
 186          * Clear the current load queue. Not intended to be used
 187          * outside of the installer.
 188          */
 189         public function clearQueue() {
 190                 $this->queued = [];
 191         }
 192
 193         /**
 194          * After this is called, no more extensions can be loaded
 195          *
 196          * @since 1.29
 197          */
 198         public function finish() {
 199                 $this->finished = true;
 200         }
 201
 202         /**
 203          * Process a queue of extensions and return their extracted data
 204          *
 205          * @param array $queue keys are filenames, values are ignored
 206          * @return array extracted info
 207          * @throws Exception
 208          * @throws ExtensionDependencyError
 209          */
 210         public function readFromQueue( array $queue ) {
 211                 global $wgVersion;
 212                 $autoloadClasses = [];
 213                 $autoloadNamespaces = [];
 214                 $autoloaderPaths = [];
 215                 $processor = new ExtensionProcessor();
 216                 $versionChecker = new VersionChecker(
 217                         $wgVersion,
 218                         PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION . '.' . PHP_RELEASE_VERSION,
 219                         get_loaded_extensions()
 220                 );
 221                 $extDependencies = [];
 222                 $incompatible = [];
 223                 $warnings = false;
 224                 foreach ( $queue as $path => $mtime ) {
 225                         $json = file_get_contents( $path );
 226                         if ( $json === false ) {
 227                                 throw new Exception( "Unable to read $path, does it exist?" );
 228                         }
 229                         $info = json_decode( $json, /* $assoc = */ true );
 230                         if ( !is_array( $info ) ) {
 231                                 throw new Exception( "$path is not a valid JSON file." );
 232                         }
 233
 234                         if ( !isset( $info['manifest_version'] ) ) {
 235                                 wfDeprecated(
 236                                         "{$info['name']}'s extension.json or skin.json does not have manifest_version",
 237                                         '1.29'
 238                                 );
 239                                 $warnings = true;
 240                                 // For backwards-compatability, assume a version of 1
 241                                 $info['manifest_version'] = 1;
 242                         }
 243                         $version = $info['manifest_version'];
 244                         if ( $version < self::OLDEST_MANIFEST_VERSION || $version > self::MANIFEST_VERSION ) {
 245                                 $incompatible[] = "$path: unsupported manifest_version: {$version}";
 246                         }
 247
 248                         $dir = dirname( $path );
 249                         if ( isset( $info['AutoloadClasses'] ) ) {
 250                                 $autoload = $this->processAutoLoader( $dir, $info['AutoloadClasses'] );
 251                                 $GLOBALS['wgAutoloadClasses'] += $autoload;
 252                                 $autoloadClasses += $autoload;
 253                         }
 254                         if ( isset( $info['AutoloadNamespaces'] ) ) {
 255                                 $autoloadNamespaces += $this->processAutoLoader( $dir, $info['AutoloadNamespaces'] );
 256                                 AutoLoader::$psr4Namespaces += $autoloadNamespaces;
 257                         }
 258
 259                         // get all requirements/dependencies for this extension
 260                         $requires = $processor->getRequirements( $info );
 261
 262                         // validate the information needed and add the requirements
 263                         if ( is_array( $requires ) && $requires && isset( $info['name'] ) ) {
 264                                 $extDependencies[$info['name']] = $requires;
 265                         }
 266
 267                         // Get extra paths for later inclusion
 268                         $autoloaderPaths = array_merge( $autoloaderPaths,
 269                                 $processor->getExtraAutoloaderPaths( $dir, $info ) );
 270                         // Compatible, read and extract info
 271                         $processor->extractInfo( $path, $info, $version );
 272                 }
 273                 $data = $processor->getExtractedInfo();
 274                 $data['warnings'] = $warnings;
 275
 276                 // check for incompatible extensions
 277                 $incompatible = array_merge(
 278                         $incompatible,
 279                         $versionChecker
 280                                 ->setLoadedExtensionsAndSkins( $data['credits'] )
 281                                 ->checkArray( $extDependencies )
 282                 );
 283
 284                 if ( $incompatible ) {
 285                         throw new ExtensionDependencyError( $incompatible );
 286                 }
 287
 288                 // Need to set this so we can += to it later
 289                 $data['globals']['wgAutoloadClasses'] = [];
 290                 $data['autoload'] = $autoloadClasses;
 291                 $data['autoloaderPaths'] = $autoloaderPaths;
 292                 $data['autoloaderNS'] = $autoloadNamespaces;
 293                 return $data;
 294         }
 295
 296         protected function exportExtractedData( array $info ) {
 297                 foreach ( $info['globals'] as $key => $val ) {
 298                         // If a merge strategy is set, read it and remove it from the value
 299                         // so it doesn't accidentally end up getting set.
 300                         if ( is_array( $val ) && isset( $val[self::MERGE_STRATEGY] ) ) {
 301                                 $mergeStrategy = $val[self::MERGE_STRATEGY];
 302                                 unset( $val[self::MERGE_STRATEGY] );
 303                         } else {
 304                                 $mergeStrategy = 'array_merge';
 305                         }
 306
 307                         // Optimistic: If the global is not set, or is an empty array, replace it entirely.
 308                         // Will be O(1) performance.
 309                         if ( !array_key_exists( $key, $GLOBALS ) || ( is_array( $GLOBALS[$key] ) && !$GLOBALS[$key] ) ) {
 310                                 $GLOBALS[$key] = $val;
 311                                 continue;
 312                         }
 313
 314                         if ( !is_array( $GLOBALS[$key] ) || !is_array( $val ) ) {
 315                                 // config setting that has already been overridden, don't set it
 316                                 continue;
 317                         }
 318
 319                         switch ( $mergeStrategy ) {
 320                                 case 'array_merge_recursive':
 321                                         $GLOBALS[$key] = array_merge_recursive( $GLOBALS[$key], $val );
 322                                         break;
 323                                 case 'array_replace_recursive':
 324                                         $GLOBALS[$key] = array_replace_recursive( $GLOBALS[$key], $val );
 325                                         break;
 326                                 case 'array_plus_2d':
 327                                         $GLOBALS[$key] = wfArrayPlus2d( $GLOBALS[$key], $val );
 328                                         break;
 329                                 case 'array_plus':
 330                                         $GLOBALS[$key] += $val;
 331                                         break;
 332                                 case 'array_merge':
 333                                         $GLOBALS[$key] = array_merge( $val, $GLOBALS[$key] );
 334                                         break;
 335                                 default:
 336                                         throw new UnexpectedValueException( "Unknown merge strategy '$mergeStrategy'" );
 337                         }
 338                 }
 339
 340                 if ( isset( $info['autoloaderNS'] ) ) {
 341                         AutoLoader::$psr4Namespaces += $info['autoloaderNS'];
 342                 }
 343
 344                 foreach ( $info['defines'] as $name => $val ) {
 345                         define( $name, $val );
 346                 }
 347                 foreach ( $info['autoloaderPaths'] as $path ) {
 348                         if ( file_exists( $path ) ) {
 349                                 require_once $path;
 350                         }
 351                 }
 352
 353                 $this->loaded += $info['credits'];
 354                 if ( $info['attributes'] ) {
 355                         if ( !$this->attributes ) {
 356                                 $this->attributes = $info['attributes'];
 357                         } else {
 358                                 $this->attributes = array_merge_recursive( $this->attributes, $info['attributes'] );
 359                         }
 360                 }
 361
 362                 foreach ( $info['callbacks'] as $name => $cb ) {
 363                         if ( !is_callable( $cb ) ) {
 364                                 if ( is_array( $cb ) ) {
 365                                         $cb = '[ ' . implode( ', ', $cb ) . ' ]';
 366                                 }
 367                                 throw new UnexpectedValueException( "callback '$cb' is not callable" );
 368                         }
 369                         call_user_func( $cb, $info['credits'][$name] );
 370                 }
 371         }
 372
 373         /**
 374          * Loads and processes the given JSON file without delay
 375          *
 376          * If some extensions are already queued, this will load
 377          * those as well.
 378          *
 379          * @param string $path Absolute path to the JSON file
 380          */
 381         public function load( $path ) {
 382                 $this->loadFromQueue(); // First clear the queue
 383                 $this->queue( $path );
 384                 $this->loadFromQueue();
 385         }
 386
 387         /**
 388          * Whether a thing has been loaded
 389          * @param string $name
 390          * @param string $constraint The required version constraint for this dependency
 391          * @throws LogicException if a specific contraint is asked for,
 392          *                        but the extension isn't versioned
 393          * @return bool
 394          */
 395         public function isLoaded( $name, $constraint = '*' ) {
 396                 $isLoaded = isset( $this->loaded[$name] );
 397                 if ( $constraint === '*' || !$isLoaded ) {
 398                         return $isLoaded;
 399                 }
 400                 // if a specific constraint is requested, but no version is set, throw an exception
 401                 if ( !isset( $this->loaded[$name]['version'] ) ) {
 402                         $msg = "{$name} does not expose its version, but an extension or a skin"
 403                                         . " requires: {$constraint}.";
 404                         throw new LogicException( $msg );
 405                 }
 406
 407                 return SemVer::satisfies( $this->loaded[$name]['version'], $constraint );
 408         }
 409
 410         /**
 411          * @param string $name
 412          * @return array
 413          */
 414         public function getAttribute( $name ) {
 415                 return $this->attributes[$name] ?? [];
 416         }
 417
 418         /**
 419          * Get information about all things
 420          *
 421          * @return array
 422          */
 423         public function getAllThings() {
 424                 return $this->loaded;
 425         }
 426
 427         /**
 428          * Fully expand autoloader paths
 429          *
 430          * @param string $dir
 431          * @param array $files
 432          * @return array
 433          */
 434         protected function processAutoLoader( $dir, array $files ) {
 435                 // Make paths absolute, relative to the JSON file
 436                 foreach ( $files as &$file ) {
 437                         $file = "$dir/$file";
 438                 }
 439                 return $files;
 440         }
 441 }