Checking permissions for $wgUser while doing an edit with another user is not a good...
[lhc/web/wiklou.git] / includes / OutputPage.php
index 343a352..de50c06 100644 (file)
@@ -24,6 +24,8 @@ class OutputPage {
        var $mCategoryLinks = array(), $mCategories = array(), $mLanguageLinks = array();
 
        var $mScripts = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array();
+       var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
+       var $mResourceLoader;
        var $mInlineMsg = array();
 
        var $mTemplateIds = array();
@@ -224,6 +226,85 @@ class OutputPage {
                return $this->mScripts . $this->getHeadItems();
        }
 
+       /**
+        * Get the list of modules to include on this page
+        *
+        * @return Array of module names
+        */
+       public function getModules() {
+               return $this->mModules;
+       }
+
+       /**
+        * Add one or more modules recognized by the resource loader. Modules added
+        * through this function will be loaded by the resource loader when the
+        * page loads.
+        *
+        * @param $modules Mixed: module name (string) or array of module names
+        */
+       public function addModules( $modules ) {
+               $this->mModules = array_merge( $this->mModules, (array)$modules );
+       }
+
+       /**
+        * Get the list of module JS to include on this page
+        * @return array of module names
+        */
+       public function getModuleScripts() {
+               return $this->mModuleScripts;
+       }
+
+       /**
+        * Add only JS of one or more modules recognized by the resource loader. Module
+        * scripts added through this function will be loaded by the resource loader when
+        * the page loads.
+        *
+        * @param $modules Mixed: module name (string) or array of module names
+        */
+       public function addModuleScripts( $modules ) {
+               $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
+       }
+
+       /**
+        * Get the list of module CSS to include on this page
+        *
+        * @return Array of module names
+        */
+       public function getModuleStyles() {
+               return $this->mModuleStyles;
+       }
+
+       /**
+        * Add only CSS of one or more modules recognized by the resource loader. Module
+        * styles added through this function will be loaded by the resource loader when
+        * the page loads.
+        *
+        * @param $modules Mixed: module name (string) or array of module names
+        */
+       public function addModuleStyles( $modules ) {
+               $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
+       }
+
+       /**
+        * Get the list of module messages to include on this page
+        *
+        * @return Array of module names
+        */
+       public function getModuleMessages() {
+               return $this->mModuleMessages;
+       }
+
+       /**
+        * Add only messages of one or more modules recognized by the resource loader.
+        * Module messages added through this function will be loaded by the resource
+        * loader when the page loads.
+        *
+        * @param $modules Mixed: module name (string) or array of module names
+        */
+       public function addModuleMessages( $modules ) {
+               $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
+       }
+
        /**
         * Get all header items in a string
         *
@@ -482,11 +563,6 @@ class OutputPage {
                $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
                $this->mPagetitle = $nameWithTags;
 
-               $taction = $this->getPageTitleActionText();
-               if( !empty( $taction ) ) {
-                       $name .= ' - '.$taction;
-               }
-
                # change "<i>foo&amp;bar</i>" to "foo&bar"
                $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) );
        }
@@ -1095,6 +1171,7 @@ class OutputPage {
                }
                $this->mNoGallery = $parserOutput->getNoGallery();
                $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
+               $this->addModules( $parserOutput->getModules() );
                // Versioning...
                foreach ( (array)$parserOutput->mTemplateIds as $ns => $dbks ) {
                        if ( isset( $this->mTemplateIds[$ns] ) ) {
@@ -1348,7 +1425,17 @@ class OutputPage {
                                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 );
@@ -1488,10 +1575,10 @@ class OutputPage {
         */
        public function output() {
                global $wgUser, $wgOutputEncoding, $wgRequest;
-               global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
+               global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
                global $wgUseAjax, $wgAjaxWatch;
                global $wgEnableMWSuggest, $wgUniversalEditButton;
-               global $wgArticle, $wgJQueryOnEveryPage;
+               global $wgArticle;
 
                if( $this->mDoNothing ) {
                        return;
@@ -1529,23 +1616,26 @@ class OutputPage {
 
                $sk = $wgUser->getSkin();
 
+               // Add base resources
+               $this->addModules( array( 'mediawiki.legacy.wikibits', 'mediawiki.util' ) );
+
+               // Add various resources if required
                if ( $wgUseAjax ) {
-                       $this->addScriptFile( 'ajax.js' );
+                       $this->addModules( 'mediawiki.legacy.ajax' );
 
                        wfRunHooks( 'AjaxAddScript', array( &$this ) );
 
                        if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
-                               $this->includeJQuery();
-                               $this->addScriptFile( 'ajaxwatch.js' );
+                               $this->addModules( 'mediawiki.action.watch.ajax' );
                        }
 
                        if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ) {
-                               $this->addScriptFile( 'mwsuggest.js' );
+                               $this->addModules( 'mediawiki.legacy.mwsuggest' );
                        }
                }
 
                if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) {
-                       $this->addScriptFile( 'rightclickedit.js' );
+                       $this->addModules( 'mediawiki.action.view.rightClickEdit' );
                }
 
                if( $wgUniversalEditButton ) {
@@ -1568,15 +1658,12 @@ class OutputPage {
                        }
                }
 
-               if ( $wgJQueryOnEveryPage ) {
-                       $this->includeJQuery();
-               }
 
                # Buffer output; final headers may depend on later processing
                ob_start();
 
                $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
-               $wgRequest->response()->header( 'Content-language: ' . $wgContLanguageCode );
+               $wgRequest->response()->header( 'Content-language: ' . $wgLanguageCode );
 
                if ( $this->mArticleBodyOnly ) {
                        $this->out( $this->mBodytext );
@@ -1614,21 +1701,6 @@ class OutputPage {
                print $outs;
        }
 
-       /**
-        * @todo document
-        */
-       public static function setEncodings() {
-               global $wgInputEncoding, $wgOutputEncoding;
-
-               $wgInputEncoding = strtolower( $wgInputEncoding );
-
-               if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
-                       $wgOutputEncoding = strtolower( $wgOutputEncoding );
-                       return;
-               }
-               $wgOutputEncoding = $wgInputEncoding;
-       }
-
        /**
         * @deprecated use wfReportTime() instead.
         *
@@ -1730,9 +1802,7 @@ class OutputPage {
                $this->mRedirect = '';
                $this->mBodytext = '';
 
-               array_unshift( $params, 'parse' );
-               array_unshift( $params, $msg );
-               $this->addHTML( call_user_func_array( 'wfMsgExt', $params ) );
+               $this->addWikiMsgArray( $msg, $params );
 
                $this->returnToMain();
        }
@@ -1817,7 +1887,7 @@ class OutputPage {
                $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
                $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
                $this->setRobotPolicy( 'noindex,nofollow' );
-               $this->setArticleFlag( false );
+               $this->setArticleRelated( false );
 
                $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
                $loginLink = $skin->link(
@@ -1963,7 +2033,6 @@ class OutputPage {
         * @return none
         */
        public function addPasswordSecurity( $passwordId, $retypeId ) {
-               $this->includeJQuery();
                $data = array(
                        'password' => '#' . $passwordId,
                        'retype' => '#' . $retypeId,
@@ -1975,8 +2044,7 @@ class OutputPage {
                        $data['messages'][$message] = wfMsg( $message );
                }
                $this->addScript( Html::inlineScript( 'var passwordSecurity=' . FormatJson::encode( $data ) ) );
-               $this->addScriptFile( 'password.js' );
-               $this->addStyle( 'common/password.css' );
+               $this->addModules( 'mediawiki.legacy.password' );
        }
 
        /** @deprecated */
@@ -2118,7 +2186,7 @@ class OutputPage {
                global $wgUser, $wgRequest, $wgLang;
 
                if ( $sk->commonPrintStylesheet() ) {
-                       $this->addStyle( 'common/wikiprintable.css', 'print' );
+                       $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
                }
                $sk->setupUserCss( $this );
 
@@ -2146,8 +2214,8 @@ class OutputPage {
 
                $ret .= implode( "\n", array(
                        $this->getHeadLinks(),
-                       $this->buildCssLinks(),
-                       $this->getHeadScripts( $sk ) . $this->getHeadItems(),
+                       $this->buildCssLinks( $sk ),
+                       $this->getHeadItems(),
                ) );
                if ( $sk->usercss ) {
                        $ret .= Html::inlineStyle( $sk->usercss );
@@ -2195,60 +2263,195 @@ class OutputPage {
                $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;
        }
 
+       /**
+        * 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' => ResourceLoader::inDebugMode() ? 'true' : 'false',
+                       'skin' => $skin->getSkinName(),
+                       'only' => $only,
+               );
+               
+               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 ( $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 ) ) . "\n";
+                               } else {
+                                       $links .= Html::linkedScript( wfAppendQuery( $wgLoadScript, $query ) ) . "\n";
+                               }
+                       }
+               }
+               return $links;
+       }
+
        /**
         * Gets the global variables and mScripts; also adds userjs to the end if
-        * enabled
+        * enabled. Despite the name, these scripts are no longer put in the
+        * <head> but at the bottom of the <body>
         *
         * @param $sk Skin object to use
         * @return String: HTML fragment
         */
        function getHeadScripts( Skin $sk ) {
-               global $wgUser, $wgRequest, $wgJsMimeType, $wgUseSiteJs;
-               global $wgStylePath, $wgStyleVersion;
+               global $wgUser, $wgRequest, $wgUseSiteJs;
+
+               // Startup - this will immediately load jquery and mediawiki modules
+               $scripts = $this->makeResourceLoaderLink( $sk, 'startup', 'scripts', true );
 
-               $scripts = Skin::makeGlobalVariablesScript( $sk->getSkinName() ) . "\n";
-               $scripts .= Html::linkedScript( "{$wgStylePath}/common/wikibits.js?$wgStyleVersion" );
-
-               // add site JS if enabled
-               if( $wgUseSiteJs ) {
-                       $jsCache = $wgUser->isLoggedIn() ? '&smaxage=0' : '';
-                       $this->addScriptFile(
-                               Skin::makeUrl(
-                                       '-',
-                                       "action=raw$jsCache&gen=js&useskin=" .
-                                       urlencode( $sk->getSkinName() )
+               // 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" 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() ) {
+                       $scripts .= Html::inlineScript(
+                               ResourceLoader::makeLoaderConditionalScript(
+                                       Xml::encodeJsCall( 'mediaWiki.loader.load', array( $this->getModules() ) ) .
+                                       Xml::encodeJsCall( 'mediaWiki.loader.go', array() )
                                )
-                       );
+                       ) . "\n";
+               }
+
+               // Legacy Scripts
+               $scripts .= "\n" . $this->mScripts;
+
+               // Add site JS if enabled
+               if ( $wgUseSiteJs ) {
+                       $scripts .= $this->makeResourceLoaderLink( $sk, 'site', 'scripts' );
                }
 
-               // add user JS if enabled
-               if( $this->isUserJsAllowed() && $wgUser->isLoggedIn() ) {
+               // 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' ) );
+                               $scripts .= Html::inlineScript( "\n" . $wgRequest->getText( 'wpTextbox1' ) . "\n" ) . "\n";
                        } else {
-                               $userpage = $wgUser->getUserPage();
-                               $names = array( 'common', $sk->getSkinName() );
-                               foreach( $names 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;
+               if ( !$userOptionsAdded ) {
+                       $scripts .= $this->makeResourceLoaderLink( $sk, 'user.options', 'scripts' );
+               }
+               
                return $scripts;
        }
 
@@ -2424,8 +2627,23 @@ class OutputPage {
         * Build a set of <link>s for the stylesheets specified in the $this->styles array.
         * These will be applied to various media & IE conditionals.
         */
-       public function buildCssLinks() {
-               return implode( "\n", $this->buildCssLinksArray() );
+       public function buildCssLinks( $sk ) {
+               // Split the styles into three groups
+               $styles = array( 'other' => array(), 'user' => array(), 'site' => array() );
+               $resourceLoader = $this->getResourceLoader();
+               foreach ( $this->getModuleStyles() as $name ) {
+                       $group = $resourceLoader->getModule( $name )->getGroup();
+                       // Modules in groups named "other" or anything different than "user" or "site" will
+                       // be placed in the "other" group
+                       $styles[isset( $style[$group] ) ? $group : 'other'][] = $name;
+               }
+               // Add tags created using legacy methods
+               $tags = $this->buildCssLinksArray();
+               // Add ResourceLoader module style tags
+               $tags[] = $this->makeResourceLoaderLink(
+                       $sk, array_merge( $styles['other'], $styles['site'], $styles['user'] ), 'styles'
+               );
+               return implode( "\n", $tags );
        }
 
        public function buildCssLinksArray() {
@@ -2637,20 +2855,10 @@ class OutputPage {
         * @param $modules Array: list of jQuery modules which should be loaded
         * @return Array: the list of modules which were not loaded.
         * @since 1.16
+        * @deprecated No longer needed as of 1.17
         */
        public function includeJQuery( $modules = array() ) {
-               global $wgStylePath, $wgStyleVersion, $wgJQueryVersion, $wgJQueryMinified;
-
-               $supportedModules = array( /** TODO: add things here */ );
-               $unsupported = array_diff( $modules, $supportedModules );
-
-               $min = $wgJQueryMinified ? '.min' : '';
-               $url = "$wgStylePath/common/jquery-$wgJQueryVersion$min.js?$wgStyleVersion";
-               if ( !$this->mJQueryDone ) {
-                       $this->mJQueryDone = true;
-                       $this->mScripts = Html::linkedScript( $url ) . "\n" . $this->mScripts;
-               }
-               return $unsupported;
+               return array();
        }
 
 }