includes/registration/ExtensionRegistry.php

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