includes/registration/ExtensionRegistry.php

   1 <?php
   2
   3 /**
   4  * ExtensionRegistry class
   5  *
   6  * The Registry loads JSON files, and uses a Processor
   7  * to extract information from them. It also registers
   8  * classes with the autoloader.
   9  *
  10  * @since 1.25
  11  */
  12 class ExtensionRegistry {
  13
  14         /**
  15          * @var BagOStuff
  16          */
  17         protected $cache;
  18
  19         /**
  20          * Array of loaded things, keyed by name, values are credits information
  21          *
  22          * @var array
  23          */
  24         private $loaded = array();
  25
  26         /**
  27          * List of paths that should be loaded
  28          *
  29          * @var array
  30          */
  31         protected $queued = array();
  32
  33         /**
  34          * Items in the JSON file that aren't being
  35          * set as globals
  36          *
  37          * @var array
  38          */
  39         protected $attributes = array();
  40
  41         /**
  42          * Processors, 'default' should be set by subclasses in the constructor
  43          *
  44          * @var Processor[]
  45          */
  46         protected $processors = array();
  47
  48         /**
  49          * @var ExtensionRegistry
  50          */
  51         private static $instance;
  52
  53         /**
  54          * @return ExtensionRegistry
  55          */
  56         public static function getInstance() {
  57                 if ( self::$instance === null ) {
  58                         self::$instance = new self();
  59                 }
  60
  61                 return self::$instance;
  62         }
  63
  64         public function __construct() {
  65                 $this->cache = ObjectCache::newAccelerator( array(), CACHE_NONE );
  66         }
  67
  68         /**
  69          * @param string $path Absolute path to the JSON file
  70          */
  71         public function queue( $path ) {
  72                 global $wgExtensionInfoMTime;
  73                 if ( $wgExtensionInfoMTime !== false ) {
  74                         $mtime = $wgExtensionInfoMTime;
  75                 } else {
  76                         $mtime = filemtime( $path );
  77                 }
  78                 $this->queued[$path] = $mtime;
  79         }
  80
  81         public function loadFromQueue() {
  82                 if ( !$this->queued ) {
  83                         return;
  84                 }
  85
  86                 $this->queued = array_unique( $this->queued );
  87
  88                 // See if this queue is in APC
  89                 $key = wfMemcKey( 'registration', md5( json_encode( $this->queued ) ) );
  90                 $data = $this->cache->get( $key );
  91                 if ( $data ) {
  92                         $this->exportExtractedData( $data );
  93                 } else {
  94                         $data = array( 'globals' => array( 'wgAutoloadClasses' => array() ) );
  95                         $autoloadClasses = array();
  96                         foreach ( $this->queued as $path => $mtime ) {
  97                                 $json = file_get_contents( $path );
  98                                 $info = json_decode( $json, /* $assoc = */ true );
  99                                 if ( !is_array( $info ) ) {
 100                                         throw new Exception( "$path is not a valid JSON file." );
 101                                 }
 102                                 $autoload = $this->processAutoLoader( dirname( $path ), $info );
 103                                 // Set up the autoloader now so custom processors will work
 104                                 $GLOBALS['wgAutoloadClasses'] += $autoload;
 105                                 $autoloadClasses += $autoload;
 106                                 if ( isset( $info['processor'] ) ) {
 107                                         $processor = $this->getProcessor( $info['processor'] );
 108                                 } else {
 109                                         $processor = $this->getProcessor( 'default' );
 110                                 }
 111                                 $processor->extractInfo( $path, $info );
 112                         }
 113                         foreach ( $this->processors as $processor ) {
 114                                 $data = array_merge_recursive( $data, $processor->getExtractedInfo() );
 115                         }
 116                         foreach ( $data['credits'] as $credit ) {
 117                                 $data['globals']['wgExtensionCredits'][$credit['type']][] = $credit;
 118                         }
 119                         $this->processors = array(); // Reset
 120                         $this->exportExtractedData( $data );
 121                         // Do this late since we don't want to extract it since we already
 122                         // did that, but it should be cached
 123                         $data['globals']['wgAutoloadClasses'] += $autoloadClasses;
 124                         $this->cache->set( $key, $data );
 125                 }
 126                 $this->queued = array();
 127         }
 128
 129         protected function getProcessor( $type ) {
 130                 if ( !isset( $this->processors[$type] ) ) {
 131                         $processor = $type === 'default' ? new ExtensionProcessor() : new $type();
 132                         if ( !$processor instanceof Processor ) {
 133                                 throw new Exception( "$type is not a Processor" );
 134                         }
 135                         $this->processors[$type] = $processor;
 136                 }
 137
 138                 return $this->processors[$type];
 139         }
 140
 141         protected function exportExtractedData( array $info ) {
 142                 foreach ( $info['globals'] as $key => $val ) {
 143                         if ( !isset( $GLOBALS[$key] ) || !$GLOBALS[$key] ) {
 144                                 $GLOBALS[$key] = $val;
 145                         } elseif ( is_array( $GLOBALS[$key] ) && is_array( $val ) ) {
 146                                 $GLOBALS[$key] = array_merge_recursive( $GLOBALS[$key], $val );
 147                         } // else case is a config setting where it has already been overriden, so don't set it
 148                 }
 149                 foreach ( $info['defines'] as $name => $val ) {
 150                         define( $name, $val );
 151                 }
 152                 foreach ( $info['callbacks'] as $cb ) {
 153                         call_user_func( $cb );
 154                 }
 155
 156                 $this->loaded += $info['credits'];
 157
 158                 if ( $info['attributes'] ) {
 159                         if ( !$this->attributes ) {
 160                                 $this->attributes = $info['attributes'];
 161                         } else {
 162                                 $this->attributes = array_merge_recursive( $this->attributes, $info['attributes'] );
 163                         }
 164                 }
 165         }
 166
 167         /**
 168          * Loads and processes the given JSON file without delay
 169          *
 170          * If some extensions are already queued, this will load
 171          * those as well.
 172          *
 173          * @param string $path Absolute path to the JSON file
 174          */
 175         public function load( $path ) {
 176                 $this->loadFromQueue(); // First clear the queue
 177                 $this->queue( $path );
 178                 $this->loadFromQueue();
 179         }
 180
 181         /**
 182          * Whether a thing has been loaded
 183          * @param string $name
 184          * @return bool
 185          */
 186         public function isLoaded( $name ) {
 187                 return isset( $this->loaded[$name] );
 188         }
 189
 190         /**
 191          * @param string $name
 192          * @return array
 193          */
 194         public function getAttribute( $name ) {
 195                 if ( isset( $this->attributes[$name] ) ) {
 196                         return $this->attributes[$name];
 197                 } else {
 198                         return array();
 199                 }
 200         }
 201
 202         /**
 203          * Get information about all things
 204          *
 205          * @return array
 206          */
 207         public function getAllThings() {
 208                 return $this->loaded;
 209         }
 210
 211         /**
 212          * Mark a thing as loaded
 213          *
 214          * @param string $name
 215          * @param array $credits
 216          */
 217         protected function markLoaded( $name, array $credits ) {
 218                 $this->loaded[$name] = $credits;
 219         }
 220
 221         /**
 222          * Register classes with the autoloader
 223          *
 224          * @param string $dir
 225          * @param array $info
 226          * @return array
 227          */
 228         protected function processAutoLoader( $dir, array $info ) {
 229                 if ( isset( $info['AutoloadClasses'] ) ) {
 230                         // Make paths absolute, relative to the JSON file
 231                         return array_map( function( $file ) use ( $dir ) {
 232                                 return "$dir/$file";
 233                         }, $info['AutoloadClasses'] );
 234                 } else {
 235                         return array();
 236                 }
 237         }
 238 }