includes/registration/ExtensionProcessor.php

   1 <?php
   2
   3 class ExtensionProcessor implements Processor {
   4
   5         /**
   6          * Keys that should be set to $GLOBALS
   7          *
   8          * @var array
   9          */
  10         protected static $globalSettings = array(
  11                 'ResourceLoaderSources',
  12                 'ResourceLoaderLESSVars',
  13                 'ResourceLoaderLESSImportPaths',
  14                 'DefaultUserOptions',
  15                 'HiddenPrefs',
  16                 'GroupPermissions',
  17                 'RevokePermissions',
  18                 'ImplicitGroups',
  19                 'GroupsAddToSelf',
  20                 'GroupsRemoveFromSelf',
  21                 'AddGroups',
  22                 'RemoveGroups',
  23                 'AvailableRights',
  24                 'ContentHandlers',
  25                 'ConfigRegistry',
  26                 'RateLimits',
  27                 'ParserTestFiles',
  28                 'RecentChangesFlags',
  29                 'ExtensionFunctions',
  30                 'ExtensionEntryPointListFiles',
  31                 'SpecialPages',
  32                 'SpecialPageGroups',
  33                 'JobClasses',
  34                 'LogTypes',
  35                 'LogRestrictions',
  36                 'FilterLogTypes',
  37                 'LogNames',
  38                 'LogHeaders',
  39                 'LogActions',
  40                 'LogActionsHandlers',
  41                 'Actions',
  42                 'APIModules',
  43                 'APIFormatModules',
  44                 'APIMetaModules',
  45                 'APIPropModules',
  46                 'APIListModules',
  47         );
  48
  49         /**
  50          * Keys that are part of the extension credits
  51          *
  52          * @var array
  53          */
  54         protected static $creditsAttributes = array(
  55                 'name',
  56                 'author',
  57                 'version',
  58                 'url',
  59                 'description',
  60                 'descriptionmsg',
  61                 'license-name',
  62         );
  63
  64         /**
  65          * Stuff that is going to be set to $GLOBALS
  66          *
  67          * Some keys are pre-set to arrays so we can += to them
  68          *
  69          * @var array
  70          */
  71         protected $globals = array(
  72                 'wgExtensionMessagesFiles' => array(),
  73                 'wgMessagesDirs' => array(),
  74         );
  75
  76         /**
  77          * Things that should be define()'d
  78          *
  79          * @var array
  80          */
  81         protected $defines = array();
  82
  83         /**
  84          * Things to be called once registration of these extensions are done
  85          *
  86          * @var callable[]
  87          */
  88         protected $callbacks = array();
  89
  90         /**
  91          * @var array
  92          */
  93         protected $credits = array();
  94
  95         /**
  96          * Any thing else in the $info that hasn't
  97          * already been processed
  98          *
  99          * @var array
 100          */
 101         protected $attributes = array();
 102
 103         /**
 104          * List of keys that have already been processed
 105          *
 106          * @var array
 107          */
 108         protected $processed = array();
 109
 110         /**
 111          * @param string $path
 112          * @param array $info
 113          * @return array
 114          */
 115         public function extractInfo( $path, array $info ) {
 116                 $this->extractConfig( $info );
 117                 $this->extractHooks( $info );
 118                 $dir = dirname( $path );
 119                 $this->extractMessageSettings( $dir, $info );
 120                 $this->extractNamespaces( $info );
 121                 $this->extractResourceLoaderModules( $dir, $info );
 122                 if ( isset( $info['callback'] ) ) {
 123                         $this->callbacks[] = $info['callback'];
 124                         $this->processed[] = 'callback';
 125                 }
 126
 127                 $this->extractCredits( $path, $info );
 128                 foreach ( $info as $key => $val ) {
 129                         if ( in_array( $key, self::$globalSettings ) ) {
 130                                 $this->storeToArray( "wg$key", $val, $this->globals );
 131                         // Ignore anything that starts with a @
 132                         } elseif ( $key[0] !== '@' && !in_array( $key, $this->processed ) ) {
 133                                 $this->storeToArray( $key, $val, $this->attributes );
 134                         }
 135                 }
 136
 137         }
 138
 139         public function getExtractedInfo() {
 140                 return array(
 141                         'globals' => $this->globals,
 142                         'defines' => $this->defines,
 143                         'callbacks' => $this->callbacks,
 144                         'credits' => $this->credits,
 145                         'attributes' => $this->attributes,
 146                 );
 147         }
 148
 149         protected function extractHooks( array $info ) {
 150                 if ( isset( $info['Hooks'] ) ) {
 151                         foreach ( $info['Hooks'] as $name => $callable ) {
 152                                 $this->globals['wgHooks'][$name][] = $callable;
 153                         }
 154                         $this->processed[] = 'Hooks';
 155                 }
 156         }
 157
 158         /**
 159          * Register namespaces with the appropriate global settings
 160          *
 161          * @param array $info
 162          */
 163         protected function extractNamespaces( array $info ) {
 164                 if ( isset( $info['namespaces'] ) ) {
 165                         foreach ( $info['namespaces'] as $ns ) {
 166                                 $id = $ns['id'];
 167                                 $this->defines[$ns['constant']] = $id;
 168                                 $this->globals['wgExtraNamespaces'][$id] = $ns['name'];
 169                                 if ( isset( $ns['gender'] ) ) {
 170                                         $this->globals['wgExtraGenderNamespaces'][$id] = $ns['gender'];
 171                                 }
 172                                 if ( isset( $ns['subpages'] ) && $ns['subpages'] ) {
 173                                         $this->globals['wgNamespacesWithSubpages'][$id] = true;
 174                                 }
 175                                 if ( isset( $ns['content'] ) && $ns['content'] ) {
 176                                         $this->globals['wgContentNamespaces'][] = $id;
 177                                 }
 178                                 if ( isset( $ns['defaultcontentmodel'] ) ) {
 179                                         $this->globals['wgNamespaceContentModels'][$id] = $ns['defaultcontentmodel'];
 180                                 }
 181                         }
 182                         $this->processed[] = 'namespaces';
 183                 }
 184         }
 185
 186         protected function extractResourceLoaderModules( $dir, array $info ) {
 187                 if ( isset( $info['ResourceModules'] ) ) {
 188                         foreach ( $info['ResourceModules'] as $name => $data ) {
 189                                 if ( isset( $data['localBasePath'] ) ) {
 190                                         $data['localBasePath'] = "$dir/{$data['localBasePath']}";
 191                                 }
 192                                 $this->globals['wgResourceModules'][$name] = $data;
 193                         }
 194                 }
 195         }
 196
 197         /**
 198          * Set message-related settings, which need to be expanded to use
 199          * absolute paths
 200          *
 201          * @param string $dir
 202          * @param array $info
 203          */
 204         protected function extractMessageSettings( $dir, array $info ) {
 205                 foreach ( array( 'ExtensionMessagesFiles', 'MessagesDirs' ) as $key ) {
 206                         if ( isset( $info[$key] ) ) {
 207                                 $this->globals["wg$key"] += array_map( function( $file ) use ( $dir ) {
 208                                         return "$dir/$file";
 209                                 }, $info[$key] );
 210                                 $this->processed[] = $key;
 211                         }
 212                 }
 213         }
 214
 215         protected function extractCredits( $path, array $info ) {
 216                 $credits = array(
 217                         'path' => $path,
 218                         'type' => isset( $info['type'] ) ? $info['type'] : 'other',
 219                 );
 220                 $this->processed[] = 'type';
 221                 foreach ( self::$creditsAttributes as $attr ) {
 222                         if ( isset( $info[$attr] ) ) {
 223                                 $credits[$attr] = $info[$attr];
 224                                 $this->processed[] = $attr;
 225                         }
 226                 }
 227
 228                 $this->credits[$credits['name']] = $credits;
 229         }
 230
 231         /**
 232          * Set configuration settings
 233          * @todo In the future, this should be done via Config interfaces
 234          *
 235          * @param array $info
 236          */
 237         protected function extractConfig( array $info ) {
 238                 if ( isset( $info['config'] ) ) {
 239                         foreach ( $info['config'] as $key => $val ) {
 240                                 $this->globals["wg$key"] = $val;
 241                         }
 242                         $this->processed[] = 'config';
 243                 }
 244         }
 245
 246         /**
 247          * @param string $name
 248          * @param mixed $value
 249          * @param array &$array
 250          */
 251         protected function storeToArray( $name, $value, &$array ) {
 252                 if ( isset( $array[$name] ) ) {
 253                         $array[$name] = array_merge_recursive( $array[$name], $value );
 254                 } else {
 255                         $array[$name] = $value;
 256                 }
 257         }
 258 }