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