3 use MediaWiki\MediaWikiServices
;
6 * ExtensionRegistry class
8 * The Registry loads JSON files, and uses a Processor
9 * to extract information from them. It also registers
10 * classes with the autoloader.
14 class ExtensionRegistry
{
17 * "requires" key that applies to MediaWiki core/$wgVersion
19 const MEDIAWIKI_CORE
= 'MediaWiki';
22 * Version of the highest supported manifest version
24 const MANIFEST_VERSION
= 2;
27 * Version of the oldest supported manifest version
29 const OLDEST_MANIFEST_VERSION
= 1;
32 * Bump whenever the registration cache needs resetting
34 const CACHE_VERSION
= 3;
37 * Special key that defines the merge strategy
41 const MERGE_STRATEGY
= '_merge_strategy';
49 * Array of loaded things, keyed by name, values are credits information
56 * List of paths that should be loaded
60 protected $queued = [];
63 * Items in the JSON file that aren't being
68 protected $attributes = [];
71 * @var ExtensionRegistry
73 private static $instance;
76 * @return ExtensionRegistry
78 public static function getInstance() {
79 if ( self
::$instance === null ) {
80 self
::$instance = new self();
83 return self
::$instance;
86 public function __construct() {
87 // We use a try/catch because we don't want to fail here
88 // if $wgObjectCaches is not configured properly for APC setup
90 $this->cache
= MediaWikiServices
::getInstance()->getLocalServerObjectCache();
91 } catch ( MWException
$e ) {
92 $this->cache
= new EmptyBagOStuff();
97 * @param string $path Absolute path to the JSON file
99 public function queue( $path ) {
100 global $wgExtensionInfoMTime;
102 $mtime = $wgExtensionInfoMTime;
103 if ( $mtime === false ) {
104 if ( file_exists( $path ) ) {
105 $mtime = filemtime( $path );
107 throw new Exception( "$path does not exist!" );
110 $err = error_get_last();
111 throw new Exception( "Couldn't stat $path: {$err['message']}" );
114 $this->queued
[$path] = $mtime;
117 public function loadFromQueue() {
119 if ( !$this->queued
) {
123 // A few more things to vary the cache on
125 'registration' => self
::CACHE_VERSION
,
126 'mediawiki' => $wgVersion
129 // See if this queue is in APC
132 md5( json_encode( $this->queued +
$versions ) )
134 $data = $this->cache
->get( $key );
136 $this->exportExtractedData( $data );
138 $data = $this->readFromQueue( $this->queued
);
139 $this->exportExtractedData( $data );
140 // Do this late since we don't want to extract it since we already
141 // did that, but it should be cached
142 $data['globals']['wgAutoloadClasses'] +
= $data['autoload'];
143 unset( $data['autoload'] );
144 $this->cache
->set( $key, $data, 60 * 60 * 24 );
150 * Get the current load queue. Not intended to be used
151 * outside of the installer.
155 public function getQueue() {
156 return $this->queued
;
160 * Clear the current load queue. Not intended to be used
161 * outside of the installer.
163 public function clearQueue() {
168 * Process a queue of extensions and return their extracted data
170 * @param array $queue keys are filenames, values are ignored
171 * @return array extracted info
174 public function readFromQueue( array $queue ) {
176 $autoloadClasses = [];
177 $autoloaderPaths = [];
178 $processor = new ExtensionProcessor();
180 $coreVersionParser = new CoreVersionChecker( $wgVersion );
181 foreach ( $queue as $path => $mtime ) {
182 $json = file_get_contents( $path );
183 if ( $json === false ) {
184 throw new Exception( "Unable to read $path, does it exist?" );
186 $info = json_decode( $json, /* $assoc = */ true );
187 if ( !is_array( $info ) ) {
188 throw new Exception( "$path is not a valid JSON file." );
190 if ( !isset( $info['manifest_version'] ) ) {
191 // For backwards-compatability, assume a version of 1
192 $info['manifest_version'] = 1;
194 $version = $info['manifest_version'];
195 if ( $version < self
::OLDEST_MANIFEST_VERSION ||
$version > self
::MANIFEST_VERSION
) {
196 throw new Exception( "$path: unsupported manifest_version: {$version}" );
198 $autoload = $this->processAutoLoader( dirname( $path ), $info );
199 // Set up the autoloader now so custom processors will work
200 $GLOBALS['wgAutoloadClasses'] +
= $autoload;
201 $autoloadClasses +
= $autoload;
202 // Check any constraints against MediaWiki core
203 $requires = $processor->getRequirements( $info );
204 if ( isset( $requires[self
::MEDIAWIKI_CORE
] )
205 && !$coreVersionParser->check( $requires[self
::MEDIAWIKI_CORE
] )
207 // Doesn't match, mark it as incompatible.
208 $incompatible[] = "{$info['name']} is not compatible with the current "
209 . "MediaWiki core (version {$wgVersion}), it requires: " . $requires[self
::MEDIAWIKI_CORE
]
213 // Get extra paths for later inclusion
214 $autoloaderPaths = array_merge( $autoloaderPaths,
215 $processor->getExtraAutoloaderPaths( dirname( $path ), $info ) );
216 // Compatible, read and extract info
217 $processor->extractInfo( $path, $info, $version );
219 if ( $incompatible ) {
220 if ( count( $incompatible ) === 1 ) {
221 throw new Exception( $incompatible[0] );
223 throw new Exception( implode( "\n", $incompatible ) );
226 $data = $processor->getExtractedInfo();
227 // Need to set this so we can += to it later
228 $data['globals']['wgAutoloadClasses'] = [];
229 $data['autoload'] = $autoloadClasses;
230 $data['autoloaderPaths'] = $autoloaderPaths;
234 protected function exportExtractedData( array $info ) {
235 foreach ( $info['globals'] as $key => $val ) {
236 // If a merge strategy is set, read it and remove it from the value
237 // so it doesn't accidentally end up getting set.
238 if ( is_array( $val ) && isset( $val[self
::MERGE_STRATEGY
] ) ) {
239 $mergeStrategy = $val[self
::MERGE_STRATEGY
];
240 unset( $val[self
::MERGE_STRATEGY
] );
242 $mergeStrategy = 'array_merge';
245 // Optimistic: If the global is not set, or is an empty array, replace it entirely.
246 // Will be O(1) performance.
247 if ( !isset( $GLOBALS[$key] ) ||
( is_array( $GLOBALS[$key] ) && !$GLOBALS[$key] ) ) {
248 $GLOBALS[$key] = $val;
252 if ( !is_array( $GLOBALS[$key] ) ||
!is_array( $val ) ) {
253 // config setting that has already been overridden, don't set it
257 switch ( $mergeStrategy ) {
258 case 'array_merge_recursive':
259 $GLOBALS[$key] = array_merge_recursive( $GLOBALS[$key], $val );
261 case 'array_replace_recursive':
262 $GLOBALS[$key] = array_replace_recursive( $GLOBALS[$key], $val );
264 case 'array_plus_2d':
265 $GLOBALS[$key] = wfArrayPlus2d( $GLOBALS[$key], $val );
268 $GLOBALS[$key] +
= $val;
271 $GLOBALS[$key] = array_merge( $val, $GLOBALS[$key] );
274 throw new UnexpectedValueException( "Unknown merge strategy '$mergeStrategy'" );
278 foreach ( $info['defines'] as $name => $val ) {
279 define( $name, $val );
281 foreach ( $info['autoloaderPaths'] as $path ) {
284 foreach ( $info['callbacks'] as $cb ) {
285 call_user_func( $cb );
288 $this->loaded +
= $info['credits'];
289 if ( $info['attributes'] ) {
290 if ( !$this->attributes
) {
291 $this->attributes
= $info['attributes'];
293 $this->attributes
= array_merge_recursive( $this->attributes
, $info['attributes'] );
299 * Loads and processes the given JSON file without delay
301 * If some extensions are already queued, this will load
304 * @param string $path Absolute path to the JSON file
306 public function load( $path ) {
307 $this->loadFromQueue(); // First clear the queue
308 $this->queue( $path );
309 $this->loadFromQueue();
313 * Whether a thing has been loaded
314 * @param string $name
317 public function isLoaded( $name ) {
318 return isset( $this->loaded
[$name] );
322 * @param string $name
325 public function getAttribute( $name ) {
326 if ( isset( $this->attributes
[$name] ) ) {
327 return $this->attributes
[$name];
334 * Get information about all things
338 public function getAllThings() {
339 return $this->loaded
;
343 * Mark a thing as loaded
345 * @param string $name
346 * @param array $credits
348 protected function markLoaded( $name, array $credits ) {
349 $this->loaded
[$name] = $credits;
353 * Register classes with the autoloader
359 protected function processAutoLoader( $dir, array $info ) {
360 if ( isset( $info['AutoloadClasses'] ) ) {
361 // Make paths absolute, relative to the JSON file
362 return array_map( function( $file ) use ( $dir ) {
364 }, $info['AutoloadClasses'] );