includes/registration/ExtensionRegistry.php

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