4 * ExtensionRegistry class
6 * The Registry loads JSON files, and uses a Processor
7 * to extract information from them. It also registers
8 * classes with the autoloader.
12 class ExtensionRegistry
{
15 * Version of the highest supported manifest version
17 const MANIFEST_VERSION
= 1;
20 * Version of the oldest supported manifest version
22 const OLDEST_MANIFEST_VERSION
= 1;
30 * Array of loaded things, keyed by name, values are credits information
34 private $loaded = array();
37 * List of paths that should be loaded
41 protected $queued = array();
44 * Items in the JSON file that aren't being
49 protected $attributes = array();
52 * @var ExtensionRegistry
54 private static $instance;
57 * @return ExtensionRegistry
59 public static function getInstance() {
60 if ( self
::$instance === null ) {
61 self
::$instance = new self();
64 return self
::$instance;
67 public function __construct() {
68 // We use a try/catch instead of the $fallback parameter because
69 // we don't want to fail here if $wgObjectCaches is not configured
70 // properly for APC setup
72 $this->cache
= ObjectCache
::newAccelerator( array() );
73 } catch ( MWException
$e ) {
74 $this->cache
= new EmptyBagOStuff();
79 * @param string $path Absolute path to the JSON file
81 public function queue( $path ) {
82 global $wgExtensionInfoMTime;
84 $mtime = $wgExtensionInfoMTime;
85 if ( $mtime === false ) {
86 if ( file_exists( $path ) ) {
87 $mtime = filemtime( $path );
89 throw new Exception( "$path does not exist!" );
92 $err = error_get_last();
93 throw new Exception( "Couldn't stat $path: {$err['message']}" );
96 $this->queued
[$path] = $mtime;
99 public function loadFromQueue() {
100 if ( !$this->queued
) {
104 // See if this queue is in APC
105 $key = wfMemcKey( 'registration', md5( json_encode( $this->queued
) ) );
106 $data = $this->cache
->get( $key );
108 $this->exportExtractedData( $data );
110 $data = $this->readFromQueue( $this->queued
);
111 $this->exportExtractedData( $data );
112 // Do this late since we don't want to extract it since we already
113 // did that, but it should be cached
114 $data['globals']['wgAutoloadClasses'] +
= $data['autoload'];
115 unset( $data['autoload'] );
116 $this->cache
->set( $key, $data, 60 * 60 * 24 );
118 $this->queued
= array();
122 * Get the current load queue. Not intended to be used
123 * outside of the installer.
127 public function getQueue() {
128 return $this->queued
;
132 * Clear the current load queue. Not intended to be used
133 * outside of the installer.
135 public function clearQueue() {
136 $this->queued
= array();
140 * Process a queue of extensions and return their extracted data
142 * @param array $queue keys are filenames, values are ignored
143 * @return array extracted info
146 public function readFromQueue( array $queue ) {
147 $autoloadClasses = array();
148 $processor = new ExtensionProcessor();
149 foreach ( $queue as $path => $mtime ) {
150 $json = file_get_contents( $path );
151 if ( $json === false ) {
152 throw new Exception( "Unable to read $path, does it exist?" );
154 $info = json_decode( $json, /* $assoc = */ true );
155 if ( !is_array( $info ) ) {
156 throw new Exception( "$path is not a valid JSON file." );
158 if ( !isset( $info['manifest_version'] ) ) {
159 // For backwards-compatability, assume a version of 1
160 $info['manifest_version'] = 1;
162 $version = $info['manifest_version'];
163 if ( $version < self
::OLDEST_MANIFEST_VERSION ||
$version > self
::MANIFEST_VERSION
) {
164 throw new Exception( "$path: unsupported manifest_version: {$version}" );
166 $autoload = $this->processAutoLoader( dirname( $path ), $info );
167 // Set up the autoloader now so custom processors will work
168 $GLOBALS['wgAutoloadClasses'] +
= $autoload;
169 $autoloadClasses +
= $autoload;
170 $processor->extractInfo( $path, $info, $version );
172 $data = $processor->getExtractedInfo();
173 // Need to set this so we can += to it later
174 $data['globals']['wgAutoloadClasses'] = array();
175 foreach ( $data['credits'] as $credit ) {
176 $data['globals']['wgExtensionCredits'][$credit['type']][] = $credit;
178 $data['autoload'] = $autoloadClasses;
182 protected function exportExtractedData( array $info ) {
183 foreach ( $info['globals'] as $key => $val ) {
184 if ( !isset( $GLOBALS[$key] ) ||
( is_array( $GLOBALS[$key] ) && !$GLOBALS[$key] ) ) {
185 $GLOBALS[$key] = $val;
186 } elseif ( $key === 'wgHooks' ||
$key === 'wgExtensionCredits' ) {
187 // Special case $wgHooks and $wgExtensionCredits, which require a recursive merge.
188 // Ideally it would have been taken care of in the first if block though.
189 $GLOBALS[$key] = array_merge_recursive( $GLOBALS[$key], $val );
190 } elseif ( $key === 'wgGroupPermissions' ) {
191 // First merge individual groups
192 foreach ( $GLOBALS[$key] as $name => &$groupVal ) {
193 if ( isset( $val[$name] ) ) {
194 $groupVal +
= $val[$name];
197 // Now merge groups that didn't exist yet
198 $GLOBALS[$key] +
= $val;
199 } elseif ( is_array( $GLOBALS[$key] ) && is_array( $val ) ) {
200 $GLOBALS[$key] = array_merge( $val, $GLOBALS[$key] );
201 } // else case is a config setting where it has already been overriden, so don't set it
203 foreach ( $info['defines'] as $name => $val ) {
204 define( $name, $val );
206 foreach ( $info['callbacks'] as $cb ) {
207 call_user_func( $cb );
210 $this->loaded +
= $info['credits'];
212 if ( $info['attributes'] ) {
213 if ( !$this->attributes
) {
214 $this->attributes
= $info['attributes'];
216 $this->attributes
= array_merge_recursive( $this->attributes
, $info['attributes'] );
222 * Loads and processes the given JSON file without delay
224 * If some extensions are already queued, this will load
227 * @param string $path Absolute path to the JSON file
229 public function load( $path ) {
230 $this->loadFromQueue(); // First clear the queue
231 $this->queue( $path );
232 $this->loadFromQueue();
236 * Whether a thing has been loaded
237 * @param string $name
240 public function isLoaded( $name ) {
241 return isset( $this->loaded
[$name] );
245 * @param string $name
248 public function getAttribute( $name ) {
249 if ( isset( $this->attributes
[$name] ) ) {
250 return $this->attributes
[$name];
257 * Get information about all things
261 public function getAllThings() {
262 return $this->loaded
;
266 * Mark a thing as loaded
268 * @param string $name
269 * @param array $credits
271 protected function markLoaded( $name, array $credits ) {
272 $this->loaded
[$name] = $credits;
276 * Register classes with the autoloader
282 protected function processAutoLoader( $dir, array $info ) {
283 if ( isset( $info['AutoloadClasses'] ) ) {
284 // Make paths absolute, relative to the JSON file
285 return array_map( function( $file ) use ( $dir ) {
287 }, $info['AutoloadClasses'] );