var $mScripts = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array();
var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
+ var $mResourceLoader;
var $mInlineMsg = array();
var $mTemplateIds = array();
$nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
$this->mPagetitle = $nameWithTags;
- $taction = $this->getPageTitleActionText();
- if( !empty( $taction ) ) {
- $name .= ' - '.$taction;
- }
-
# change "<i>foo&bar</i>" to "foo&bar"
$this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) );
}
if( $variant === $wgContLang->getCode() ) {
continue;
} else {
- $aloption[] = "string-contains=$variant";
+ $aloption[] = 'string-contains=' . $variant;
+
+ // IE and some other browsers use another form of language code
+ // in their Accept-Language header, like "zh-CN" or "zh-TW".
+ // We should handle these too.
+ $ievariant = explode( '-', $variant );
+ if ( count( $ievariant ) == 2 ) {
+ $ievariant[1] = strtoupper( $ievariant[1] );
+ $ievariant = implode( '-', $ievariant );
+ $aloption[] = 'string-contains=' . $ievariant;
+ }
}
}
$this->addVaryHeader( 'Accept-Language', $aloption );
}
$sk = $wgUser->getSkin();
-
+
// Add base resources
$this->addModules( array( 'mediawiki.legacy.wikibits' ) );
-
+ $this->addModules( array( 'mediawiki.util' ) );
+
// Add various resources if required
if ( $wgUseAjax ) {
$this->addModules( 'mediawiki.legacy.ajax' );
}
if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) {
- $this->addModules( 'mediawiki.legacy.rightclickedit' );
+ $this->addModules( 'mediawiki.action.view.rightClickEdit' );
}
if( $wgUniversalEditButton ) {
* @return none
*/
public function addPasswordSecurity( $passwordId, $retypeId ) {
- $this->includeJQuery();
$data = array(
'password' => '#' . $passwordId,
'retype' => '#' . $retypeId,
$bodyAttrs['class'] .= ' ' . Sanitizer::escapeClass( 'page-' . $this->getTitle()->getPrefixedText() );
$bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $wgUser->getSkin()->getSkinName() );
+ $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
+ wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
+
$ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
return $ret;
}
-
- static function makeResourceLoaderLink( $skin, $modules, $only ) {
- global $wgUser, $wgLang, $wgRequest, $wgLoadScript;
+
+ /**
+ * Get a ResourceLoader object associated with this OutputPage
+ */
+ public function getResourceLoader() {
+ if ( is_null( $this->mResourceLoader ) ) {
+ $this->mResourceLoader = new ResourceLoader();
+ }
+ return $this->mResourceLoader;
+ }
+
+ /**
+ * TODO: Document
+ * @param $skin Skin
+ * @param $modules Array/string with the module name
+ * @param $only string May be styles, messages or scripts
+ * @param $useESI boolean
+ * @return string html <script> and <style> tags
+ */
+ protected function makeResourceLoaderLink( Skin $skin, $modules, $only, $useESI = false ) {
+ global $wgUser, $wgLang, $wgLoadScript, $wgResourceLoaderUseESI,
+ $wgResourceLoaderInlinePrivateModules;
+ // Lazy-load ResourceLoader
// TODO: Should this be a static function of ResourceLoader instead?
// TODO: Divide off modules starting with "user", and add the user parameter to them
$query = array(
'lang' => $wgLang->getCode(),
- 'debug' => $wgRequest->getBool( 'debug' ) && $wgRequest->getVal( 'debug' ) !== 'false',
- 'skin' => $wgUser->getSkin()->getSkinName(),
+ 'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
+ 'skin' => $skin->getSkinName(),
'only' => $only,
);
- $moduleGroups = array( null => array(), 'user' => array() );
- foreach ( (array) $modules as $module ) {
- $moduleGroups[strpos( $module, 'user' ) === 0 ? 'user' : null][] = $module;
+
+ if ( !count( $modules ) ) {
+ return '';
+ }
+
+ if ( count( $modules ) > 1 ) {
+ // Remove duplicate module requests
+ $modules = array_unique( (array) $modules );
+ // Sort module names so requests are more uniform
+ sort( $modules );
+
+ if ( ResourceLoader::inDebugMode() ) {
+ // Recursively call us for every item
+ $links = '';
+ foreach ( $modules as $name ) {
+ $links .= $this->makeResourceLoaderLink( $skin, $name, $only, $useESI );
+ }
+ return $links;
+ }
+ }
+
+ // Create keyed-by-group list of module objects from modules list
+ $groups = array();
+ $resourceLoader = $this->getResourceLoader();
+ foreach ( (array) $modules as $name ) {
+ $module = $resourceLoader->getModule( $name );
+ $group = $module->getGroup();
+ if ( !isset( $groups[$group] ) ) {
+ $groups[$group] = array();
+ }
+ $groups[$group][$name] = $module;
}
$links = '';
- foreach ( $moduleGroups as $group => $modules ) {
- if ( count( $modules ) ) {
- $query['modules'] = implode( '|', array_unique( (array) $modules ) );
- if ( $group === 'user' ) {
- $query['user'] = $wgUser->getName();
+ foreach ( $groups as $group => $modules ) {
+ $query['modules'] = implode( '|', array_keys( $modules ) );
+ // Special handling for user-specific groups
+ if ( ( $group === 'user' || $group === 'private' ) && $wgUser->isLoggedIn() ) {
+ $query['user'] = $wgUser->getName();
+ }
+ // Support inlining of private modules if configured as such
+ if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) {
+ $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
+ if ( $only == 'styles' ) {
+ $links .= Html::inlineStyle(
+ $resourceLoader->makeModuleResponse( $context, $modules )
+ );
+ } else {
+ $links .= Html::inlineScript(
+ ResourceLoader::makeLoaderConditionalScript(
+ $resourceLoader->makeModuleResponse( $context, $modules )
+ )
+ );
+ }
+ continue;
+ }
+ // Special handling for user and site groups; because users might change their stuff
+ // on-wiki like site or user pages, or user preferences; we need to find the highest
+ // timestamp of these user-changable modules so we can ensure cache misses on change
+ if ( $group === 'user' || $group === 'site' ) {
+ // Create a fake request based on the one we are about to make so modules return
+ // correct times
+ $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
+ // Get the maximum timestamp
+ $timestamp = 1;
+ foreach ( $modules as $module ) {
+ $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
+ }
+ // Add a version parameter so cache will break when things change
+ $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, round( $timestamp, -2 ) );
+ }
+ // Make queries uniform in order
+ ksort( $query );
+
+ $url = wfAppendQuery( $wgLoadScript, $query );
+ if ( $useESI && $wgResourceLoaderUseESI ) {
+ $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
+ if ( $only == 'styles' ) {
+ $links .= Html::inlineStyle( $esi );
+ } else {
+ $links .= Html::inlineScript( $esi );
}
+ } else {
// Automatically select style/script elements
if ( $only === 'styles' ) {
- $links .= Html::linkedStyle( wfAppendQuery( $wgLoadScript, $query ) );
+ $links .= Html::linkedStyle( wfAppendQuery( $wgLoadScript, $query ) ) . "\n";
} else {
- $links .= Html::linkedScript( wfAppendQuery( $wgLoadScript, $query ) );
+ $links .= Html::linkedScript( wfAppendQuery( $wgLoadScript, $query ) ) . "\n";
}
}
}
return $links;
}
-
+
/**
* Gets the global variables and mScripts; also adds userjs to the end if
* enabled. Despite the name, these scripts are no longer put in the
* @return String: HTML fragment
*/
function getHeadScripts( Skin $sk ) {
- global $wgUser, $wgRequest, $wgJsMimeType;
- global $wgUseSiteJs;
-
- // Statup - this will immediately load jquery and mediawiki modules
- $scripts = self::makeResourceLoaderLink( $sk, 'startup', 'scripts' );
-
- // Configuration -- This could be merged together with the load and go, but makeGlobalVariablesScript returns a
- // whole script tag -- grumble grumble...
+ global $wgUser, $wgRequest, $wgUseSiteJs;
+
+ // Startup - this will immediately load jquery and mediawiki modules
+ $scripts = $this->makeResourceLoaderLink( $sk, 'startup', 'scripts', true );
+
+ // Configuration -- This could be merged together with the load and go, but
+ // makeGlobalVariablesScript returns a whole script tag -- grumble grumble...
$scripts .= Skin::makeGlobalVariablesScript( $sk->getSkinName() ) . "\n";
-
- // Script and Messages "only"
- if ( $wgRequest->getBool( 'debug' ) && $wgRequest->getVal( 'debug' ) !== 'false' ) {
- // Scripts
- foreach ( $this->getModuleScripts() as $name ) {
- $scripts .= self::makeResourceLoaderLink( $sk, $name, 'scripts' );
- }
- // Messages
- foreach ( $this->getModuleMessages() as $name ) {
- $scripts .= self::makeResourceLoaderLink( $sk, $name, 'messages' );
- }
- } else {
- // Scripts
- if ( count( $this->getModuleScripts() ) ) {
- $scripts .= self::makeResourceLoaderLink( $sk, $this->getModuleScripts(), 'scripts' );
- }
- // Messages
- if ( count( $this->getModuleMessages() ) ) {
- $scripts .= self::makeResourceLoaderLink( $sk, $this->getModuleMessages(), 'messages' );
- }
- }
-
- // Modules - let the client calculate dependencies and batch requests as it likes
+
+ // Script and Messages "only" requests
+ $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts(), 'scripts' );
+ $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages(), 'messages' );
+
+ // Modules requests - let the client calculate dependencies and batch requests as it likes
if ( $this->getModules() ) {
- $modules = FormatJson::encode( $this->getModules() );
$scripts .= Html::inlineScript(
- "if ( mediaWiki !== undefined ) { mediaWiki.loader.load( {$modules} ); mediaWiki.loader.go(); }"
- );
+ ResourceLoader::makeLoaderConditionalScript(
+ Xml::encodeJsCall( 'mediaWiki.loader.load', array( $this->getModules() ) ) .
+ Xml::encodeJsCall( 'mediaWiki.loader.go', array() )
+ )
+ ) . "\n";
}
-
- // TODO: User Scripts should be included using the resource loader
- // Add user JS if enabled
- if( $this->isUserJsAllowed() && $wgUser->isLoggedIn() ) {
+
+ // Legacy Scripts
+ $scripts .= "\n" . $this->mScripts;
+
+ // Add site JS if enabled
+ if ( $wgUseSiteJs ) {
+ $scripts .= $this->makeResourceLoaderLink( $sk, 'site', 'scripts' );
+ }
+
+ // Add user JS if enabled - trying to load user.options as a bundle if possible
+ $userOptionsAdded = false;
+ if ( $this->isUserJsAllowed() && $wgUser->isLoggedIn() ) {
$action = $wgRequest->getVal( 'action', 'view' );
if( $this->mTitle && $this->mTitle->isJsSubpage() && $sk->userCanPreview( $action ) ) {
# XXX: additional security check/prompt?
$this->addInlineScript( $wgRequest->getText( 'wpTextbox1' ) );
} else {
- $userpage = $wgUser->getUserPage();
- foreach( array( 'common', $sk->getSkinName() ) as $name ) {
- $scriptpage = Title::makeTitleSafe( NS_USER, $userpage->getDBkey() . '/' . $name . '.js' );
- if ( $scriptpage && $scriptpage->exists() && ( $scriptpage->getLength() > 0 ) ) {
- $userjs = $scriptpage->getLocalURL( 'action=raw&ctype=' . $wgJsMimeType );
- $this->addScriptFile( $userjs, $scriptpage->getLatestRevID() );
- }
- }
+ $scripts .= $this->makeResourceLoaderLink(
+ $sk, array( 'user', 'user.options' ), 'scripts'
+ );
+ $userOptionsAdded = true;
}
}
- $scripts .= "\n" . $this->mScripts;
-
- // Add site JS if enabled
- if ( $wgUseSiteJs ) {
- $scripts .= self::makeResourceLoaderLink( $sk, 'site', 'scripts' );
+ if ( !$userOptionsAdded ) {
+ $scripts .= $this->makeResourceLoaderLink( $sk, 'user.options', 'scripts' );
}
return $scripts;
/**
* @return string HTML tag links to be put in the header.
*/
- public function getHeadLinks( $sk ) {
- global $wgFeed, $wgRequest;
+ public function getHeadLinks( Skin $sk ) {
+ global $wgFeed;
// Ideally this should happen earlier, somewhere. :P
$this->addDefaultMeta();
}
}
- // Support individual script requests in debug mode
- if ( $wgRequest->getBool( 'debug' ) && $wgRequest->getVal( 'debug' ) !== 'false' ) {
- foreach ( $this->getModuleStyles() as $name ) {
- $tags[] = self::makeResourceLoaderLink( $sk, $name, 'styles' );
- }
- } else {
- if ( count( $this->getModuleStyles() ) ) {
- $tags[] = self::makeResourceLoaderLink( $sk, $this->getModuleStyles(), 'styles' );
- }
+ // Split the styles into two groups, not user (0) and user (1)
+ $styles = array( array(), array() );
+ $resourceLoader = $this->getResourceLoader();
+ foreach ( $this->getModuleStyles() as $name ) {
+ $styles[$resourceLoader->getModule( $name )->getGroup() === 'user' ? 1 : 0][] = $name;
}
-
+ // Add styles to tags, user modules last
+ $tags[] = $this->makeResourceLoaderLink( $sk, $styles[0], 'styles' );
+ $tags[] = $this->makeResourceLoaderLink( $sk, $styles[1], 'styles' );
return implode( "\n", $tags );
}