includes/resourceloader/ResourceLoaderStartUpModule.php

   1 <?php
   2 /**
   3  * Module for resource loader initialization.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Trevor Parscal
  22  * @author Roan Kattouw
  23  */
  24
  25 class ResourceLoaderStartUpModule extends ResourceLoaderModule {
  26
  27         /* Protected Members */
  28
  29         protected $modifiedTime = array();
  30
  31         /* Protected Methods */
  32
  33         /**
  34          * @param $context ResourceLoaderContext
  35          * @return array
  36          */
  37         protected function getConfig( $context ) {
  38                 global $wgLoadScript, $wgScript, $wgStylePath, $wgScriptExtension,
  39                         $wgArticlePath, $wgScriptPath, $wgServer, $wgContLang,
  40                         $wgVariantArticlePath, $wgActionPaths, $wgVersion,
  41                         $wgEnableAPI, $wgEnableWriteAPI, $wgDBname,
  42                         $wgSitename, $wgFileExtensions, $wgExtensionAssetsPath,
  43                         $wgCookiePrefix, $wgResourceLoaderMaxQueryLength;
  44
  45                 $mainPage = Title::newMainPage();
  46
  47                 /**
  48                  * Namespace related preparation
  49                  * - wgNamespaceIds: Key-value pairs of all localized, canonical and aliases for namespaces.
  50                  * - wgCaseSensitiveNamespaces: Array of namespaces that are case-sensitive.
  51                  */
  52                 $namespaceIds = $wgContLang->getNamespaceIds();
  53                 $caseSensitiveNamespaces = array();
  54                 foreach( MWNamespace::getCanonicalNamespaces() as $index => $name ) {
  55                         $namespaceIds[$wgContLang->lc( $name )] = $index;
  56                         if ( !MWNamespace::isCapitalized( $index ) ) {
  57                                 $caseSensitiveNamespaces[] = $index;
  58                         }
  59                 }
  60
  61                 // Build list of variables
  62                 $vars = array(
  63                         'wgLoadScript' => $wgLoadScript,
  64                         'debug' => $context->getDebug(),
  65                         'skin' => $context->getSkin(),
  66                         'stylepath' => $wgStylePath,
  67                         'wgUrlProtocols' => wfUrlProtocols(),
  68                         'wgArticlePath' => $wgArticlePath,
  69                         'wgScriptPath' => $wgScriptPath,
  70                         'wgScriptExtension' => $wgScriptExtension,
  71                         'wgScript' => $wgScript,
  72                         'wgVariantArticlePath' => $wgVariantArticlePath,
  73                         // Force object to avoid "empty" associative array from
  74                         // becoming [] instead of {} in JS (bug 34604)
  75                         'wgActionPaths' => (object)$wgActionPaths,
  76                         'wgServer' => $wgServer,
  77                         'wgUserLanguage' => $context->getLanguage(),
  78                         'wgContentLanguage' => $wgContLang->getCode(),
  79                         'wgVersion' => $wgVersion,
  80                         'wgEnableAPI' => $wgEnableAPI,
  81                         'wgEnableWriteAPI' => $wgEnableWriteAPI,
  82                         'wgMainPageTitle' => $mainPage->getPrefixedText(),
  83                         'wgFormattedNamespaces' => $wgContLang->getFormattedNamespaces(),
  84                         'wgNamespaceIds' => $namespaceIds,
  85                         'wgSiteName' => $wgSitename,
  86                         'wgFileExtensions' => array_values( $wgFileExtensions ),
  87                         'wgDBname' => $wgDBname,
  88                         // This sucks, it is only needed on Special:Upload, but I could
  89                         // not find a way to add vars only for a certain module
  90                         'wgFileCanRotate' => BitmapHandler::canRotate(),
  91                         'wgAvailableSkins' => Skin::getSkinNames(),
  92                         'wgExtensionAssetsPath' => $wgExtensionAssetsPath,
  93                         // MediaWiki sets cookies to have this prefix by default
  94                         'wgCookiePrefix' => $wgCookiePrefix,
  95                         'wgResourceLoaderMaxQueryLength' => $wgResourceLoaderMaxQueryLength,
  96                         'wgCaseSensitiveNamespaces' => $caseSensitiveNamespaces,
  97                 );
  98
  99                 wfRunHooks( 'ResourceLoaderGetConfigVars', array( &$vars ) );
 100
 101                 return $vars;
 102         }
 103
 104         /**
 105          * Gets registration code for all modules
 106          *
 107          * @param $context ResourceLoaderContext object
 108          * @return String: JavaScript code for registering all modules with the client loader
 109          */
 110         public static function getModuleRegistrations( ResourceLoaderContext $context ) {
 111                 global $wgCacheEpoch;
 112                 wfProfileIn( __METHOD__ );
 113
 114                 $out = '';
 115                 $registrations = array();
 116                 $resourceLoader = $context->getResourceLoader();
 117                 $target = $context->getRequest()->getVal( 'target', 'desktop' );
 118
 119                 // Register sources
 120                 $out .= ResourceLoader::makeLoaderSourcesScript( $resourceLoader->getSources() );
 121
 122                 // Register modules
 123                 foreach ( $resourceLoader->getModuleNames() as $name ) {
 124                         $module = $resourceLoader->getModule( $name );
 125                         $moduleTargets = $module->getTargets();
 126                         if ( in_array( $target, $moduleTargets ) ) {
 127                                 $deps = $module->getDependencies();
 128                                 $group = $module->getGroup();
 129                                 $source = $module->getSource();
 130                                 // Support module loader scripts
 131                                 $loader = $module->getLoaderScript();
 132                                 if ( $loader !== false ) {
 133                                         $version = wfTimestamp( TS_ISO_8601_BASIC,
 134                                                 $module->getModifiedTime( $context ) );
 135                                         $out .= ResourceLoader::makeCustomLoaderScript( $name, $version, $deps, $group, $source, $loader );
 136                                 }
 137                                 // Automatically register module
 138                                 else {
 139                                         // getModifiedTime() is supposed to return a UNIX timestamp, but it doesn't always
 140                                         // seem to do that, and custom implementations might forget. Coerce it to TS_UNIX
 141                                         $moduleMtime = wfTimestamp( TS_UNIX, $module->getModifiedTime( $context ) );
 142                                         $mtime = max( $moduleMtime, wfTimestamp( TS_UNIX, $wgCacheEpoch ) );
 143                                         // Modules without dependencies, a group or a foreign source pass two arguments (name, timestamp) to
 144                                         // mw.loader.register()
 145                                         if ( !count( $deps ) && $group === null && $source === 'local' ) {
 146                                                 $registrations[] = array( $name, $mtime );
 147                                         }
 148                                         // Modules with dependencies but no group or foreign source pass three arguments
 149                                         // (name, timestamp, dependencies) to mw.loader.register()
 150                                         elseif ( $group === null && $source === 'local' ) {
 151                                                 $registrations[] = array( $name, $mtime, $deps );
 152                                         }
 153                                         // Modules with a group but no foreign source pass four arguments (name, timestamp, dependencies, group)
 154                                         // to mw.loader.register()
 155                                         elseif ( $source === 'local' ) {
 156                                                 $registrations[] = array( $name, $mtime, $deps, $group );
 157                                         }
 158                                         // Modules with a foreign source pass five arguments (name, timestamp, dependencies, group, source)
 159                                         // to mw.loader.register()
 160                                         else {
 161                                                 $registrations[] = array( $name, $mtime, $deps, $group, $source );
 162                                         }
 163                                 }
 164                         }
 165                 }
 166                 $out .= ResourceLoader::makeLoaderRegisterScript( $registrations );
 167
 168                 wfProfileOut( __METHOD__ );
 169                 return $out;
 170         }
 171
 172         /* Methods */
 173
 174         /**
 175          * @return bool
 176          */
 177         public function isRaw() {
 178                 return true;
 179         }
 180
 181         /**
 182          * @param $context ResourceLoaderContext
 183          * @return string
 184          */
 185         public function getScript( ResourceLoaderContext $context ) {
 186                 global $IP, $wgLoadScript, $wgLegacyJavaScriptGlobals;
 187
 188                 $out = file_get_contents( "$IP/resources/startup.js" );
 189                 if ( $context->getOnly() === 'scripts' ) {
 190
 191                         // The core modules:
 192                         $moduleNames = array( 'jquery', 'mediawiki' );
 193                         wfRunHooks( 'ResourceLoaderGetStartupModules', array( &$moduleNames ) );
 194
 195                         // Get the latest version
 196                         $loader = $context->getResourceLoader();
 197                         $version = 0;
 198                         foreach ( $moduleNames as $moduleName ) {
 199                                 $version = max( $version,
 200                                         $loader->getModule( $moduleName )->getModifiedTime( $context )
 201                                 );
 202                         }
 203                         // Build load query for StartupModules
 204                         $query = array(
 205                                 'modules' => ResourceLoader::makePackedModulesString( $moduleNames ),
 206                                 'only' => 'scripts',
 207                                 'lang' => $context->getLanguage(),
 208                                 'skin' => $context->getSkin(),
 209                                 'debug' => $context->getDebug() ? 'true' : 'false',
 210                                 'version' => wfTimestamp( TS_ISO_8601_BASIC, $version )
 211                         );
 212                         // Ensure uniform query order
 213                         ksort( $query );
 214
 215                         // Startup function
 216                         $configuration = $this->getConfig( $context );
 217                         $registrations = self::getModuleRegistrations( $context );
 218                         $registrations = str_replace( "\n", "\n\t", trim( $registrations ) ); // fix indentation
 219                         $out .= "var startUp = function() {\n" .
 220                                 "\tmw.config = new " . Xml::encodeJsCall( 'mw.Map', array( $wgLegacyJavaScriptGlobals ) ) . "\n" .
 221                                 "\t$registrations\n" .
 222                                 "\t" . Xml::encodeJsCall( 'mw.config.set', array( $configuration ) ) .
 223                                 "};\n";
 224
 225                         // Conditional script injection
 226                         $scriptTag = Html::linkedScript( $wgLoadScript . '?' . wfArrayToCGI( $query ) );
 227                         $out .= "if ( isCompatible() ) {\n" .
 228                                 "\t" . Xml::encodeJsCall( 'document.write', array( $scriptTag ) ) .
 229                                 "}\n" .
 230                                 "delete isCompatible;";
 231                 }
 232
 233                 return $out;
 234         }
 235
 236         /**
 237          * @return bool
 238          */
 239         public function supportsURLLoading() {
 240                 return false;
 241         }
 242
 243         /**
 244          * @param $context ResourceLoaderContext
 245          * @return array|mixed
 246          */
 247         public function getModifiedTime( ResourceLoaderContext $context ) {
 248                 global $IP, $wgCacheEpoch;
 249
 250                 $hash = $context->getHash();
 251                 if ( isset( $this->modifiedTime[$hash] ) ) {
 252                         return $this->modifiedTime[$hash];
 253                 }
 254
 255                 // Call preloadModuleInfo() on ALL modules as we're about
 256                 // to call getModifiedTime() on all of them
 257                 $loader = $context->getResourceLoader();
 258                 $loader->preloadModuleInfo( $loader->getModuleNames(), $context );
 259
 260                 $this->modifiedTime[$hash] = filemtime( "$IP/resources/startup.js" );
 261                 // ATTENTION!: Because of the line above, this is not going to cause
 262                 // infinite recursion - think carefully before making changes to this
 263                 // code!
 264                 $time = wfTimestamp( TS_UNIX, $wgCacheEpoch );
 265                 foreach ( $loader->getModuleNames() as $name ) {
 266                         $module = $loader->getModule( $name );
 267                         $time = max( $time, $module->getModifiedTime( $context ) );
 268                 }
 269                 return $this->modifiedTime[$hash] = $time;
 270         }
 271
 272         /* Methods */
 273
 274         /**
 275          * @return string
 276          */
 277         public function getGroup() {
 278                 return 'startup';
 279         }
 280 }