diff options
Diffstat (limited to 'includes/OutputPage.php')
| -rw-r--r-- | includes/OutputPage.php | 1537 |
1 files changed, 878 insertions, 659 deletions
diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 6ecc2754..419bbdf7 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -4,63 +4,211 @@ if ( !defined( 'MEDIAWIKI' ) ) { } /** + * This class should be covered by a general architecture document which does + * not exist as of January 2011. This is one of the Core classes and should + * be read at least once by any new developers. + * + * This class is used to prepare the final rendering. A skin is then + * applied to the output parameters (links, javascript, html, categories ...). + * + * @todo FIXME: Another class handles sending the whole page to the client. + * + * Some comments comes from a pairing session between Zak Greant and Ashar Voultoiz + * in November 2010. + * * @todo document */ -class OutputPage { - var $mMetatags = array(), $mKeywords = array(), $mLinktags = array(); +class OutputPage extends ContextSource { + /// Should be private. Used with addMeta() which adds <meta> + var $mMetatags = array(); + + /// <meta keyworkds="stuff"> most of the time the first 10 links to an article + var $mKeywords = array(); + + var $mLinktags = array(); + + /// Additional stylesheets. Looks like this is for extensions. Might be replaced by resource loader. var $mExtStyles = array(); - var $mPagetitle = '', $mBodytext = ''; + + /// Should be private - has getter and setter. Contains the HTML title + var $mPagetitle = ''; + + /// Contains all of the <body> content. Should be private we got set/get accessors and the append() method. + var $mBodytext = ''; /** - * Holds the debug lines that will be outputted as comments in page source if + * Holds the debug lines that will be output as comments in page source if * $wgDebugComments is enabled. See also $wgShowDebug. * TODO: make a getter method for this */ - public $mDebugtext = ''; + public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog() - var $mHTMLtitle = '', $mIsarticle = true, $mPrintable = false; - var $mSubtitle = '', $mRedirect = '', $mStatusCode; - var $mLastModified = '', $mETag = false; - var $mCategoryLinks = array(), $mCategories = array(), $mLanguageLinks = array(); + /// Should be private. Stores contents of <title> tag + var $mHTMLtitle = ''; + + /// Should be private. Is the displayed content related to the source of the corresponding wiki article. + var $mIsarticle = true; + + /** + * Should be private. We have to set isPrintable(). Some pages should + * never be printed (ex: redirections). + */ + var $mPrintable = false; + + /** + * Should be private. We have set/get/append methods. + * + * Contains the page subtitle. Special pages usually have some links here. + * Don't confuse with site subtitle added by skins. + */ + var $mSubtitle = ''; + + var $mRedirect = ''; + var $mStatusCode; + + /** + * mLastModified and mEtag are used for sending cache control. + * The whole caching system should probably be moved into its own class. + */ + var $mLastModified = ''; + + /** + * Should be private. No getter but used in sendCacheControl(); + * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used + * as a unique identifier for the content. It is later used by the client + * to compare its cached version with the server version. Client sends + * headers If-Match and If-None-Match containing its locally cached ETAG value. + * + * To get more information, you will have to look at HTTP/1.1 protocol which + * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616 + */ + var $mETag = false; + + var $mCategoryLinks = array(); + var $mCategories = array(); + + /// Should be private. Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') + var $mLanguageLinks = array(); + + /** + * Should be private. Used for JavaScript (pre resource loader) + * We should split js / css. + * mScripts content is inserted as is in <head> by Skin. This might contains + * either a link to a stylesheet or inline css. + */ + var $mScripts = ''; + + /** + * Inline CSS styles. Use addInlineStyle() sparsingly + */ + var $mInlineStyles = ''; + + // + var $mLinkColours; + + /** + * Used by skin template. + * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle ); + */ + var $mPageLinkTitle = ''; - var $mScripts = '', $mInlineStyles = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array(); + /// Array of elements in <head>. Parser might add its own headers! + var $mHeadItems = array(); + + // @todo FIXME: Next variables probably comes from the resource loader var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array(); var $mResourceLoader; + var $mJsConfigVars = array(); + + /** @todo FIXME: Is this still used ?*/ var $mInlineMsg = array(); var $mTemplateIds = array(); + var $mImageTimeKeys = array(); + + var $mRedirectCode = ''; + + var $mFeedLinksAppendQuery = null; - var $mAllowUserJs; - var $mSuppressQuickbar = false; + # What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page? + # @see ResourceLoaderModule::$origin + # ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden; + protected $mAllowedModules = array( + ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL, + ); + + /** + * @EasterEgg I just love the name for this self documenting variable. + * @todo document + */ var $mDoNothing = false; + + // Parser related. var $mContainsOldMagic = 0, $mContainsNewMagic = 0; + + /** + * Should be private. Has get/set methods properly documented. + * Stores "article flag" toggle. + */ var $mIsArticleRelated = true; - protected $mParserOptions = null; // lazy initialised, use parserOptions() + /// lazy initialised, use parserOptions() + protected $mParserOptions = null; + + /** + * Handles the atom / rss links. + * We probably only support atom in 2011. + * Looks like a private variable. + * @see $wgAdvertisedFeedTypes + */ var $mFeedLinks = array(); + // Gwicke work on squid caching? Roughly from 2003. var $mEnableClientCache = true; + + /** + * Flag if output should only contain the body of the article. + * Should be private. + */ var $mArticleBodyOnly = false; var $mNewSectionLink = false; var $mHideNewSectionLink = false; + + /** + * Comes from the parser. This was probably made to load CSS/JS only + * if we had <gallery>. Used directly in CategoryPage.php + * Looks like resource loader can replace this. + */ var $mNoGallery = false; + + // should be private. var $mPageTitleActionText = ''; var $mParseWarnings = array(); + + // Cache stuff. Looks like mEnableClientCache var $mSquidMaxage = 0; + + // @todo document var $mPreventClickjacking = true; + + /// should be private. To include the variable {{REVISIONID}} var $mRevisionId = null; - protected $mTitle = null; + + var $mFileVersion = null; /** * An array of stylesheet filenames (relative from skins path), with options * for CSS media, IE conditions, and RTL/LTR direction. * For internal use; add settings in the skin via $this->addStyle() + * + * Style again! This seems like a code duplication since we already have + * mStyles. This is what makes OpenSource amazing. */ var $styles = array(); /** - * Whether to load jQuery core. + * Whether jQuery is already handled. */ protected $mJQueryDone = false; @@ -72,12 +220,12 @@ class OutputPage { ); /** - * Constructor - * Initialise private variables + * Constructor for OutputPage. This should not be called directly. + * Instead a new RequestContext should be created and it will implicitly create + * a OutputPage tied to that context. */ - function __construct() { - global $wgAllowUserJs; - $this->mAllowUserJs = $wgAllowUserJs; + function __construct( IContextSource $context = null ) { + $this->setContext( $context ); } /** @@ -105,7 +253,6 @@ class OutputPage { * Set the HTTP status code to send with the output. * * @param $statusCode Integer - * @return nothing */ public function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; @@ -115,8 +262,8 @@ class OutputPage { * Add a new <meta> tag * To add an http-equiv meta tag, precede the name with "http:" * - * @param $name tag name - * @param $val tag value + * @param $name String tag name + * @param $val String tag value */ function addMeta( $name, $val ) { array_push( $this->mMetatags, array( $name, $val ) ); @@ -152,11 +299,24 @@ class OutputPage { * "rel" attribute will be automatically added */ function addMetadataLink( $linkarr ) { + $linkarr['rel'] = $this->getMetadataAttribute(); + $this->addLink( $linkarr ); + } + + /** + * Get the value of the "rel" attribute for metadata links + * + * @return String + */ + public function getMetadataAttribute() { # note: buggy CC software only reads first "meta" link static $haveMeta = false; - $linkarr['rel'] = $haveMeta ? 'alternate meta' : 'meta'; - $this->addLink( $linkarr ); - $haveMeta = true; + if ( $haveMeta ) { + return 'alternate meta'; + } else { + $haveMeta = true; + return 'meta'; + } } /** @@ -181,7 +341,7 @@ class OutputPage { } /** - * Get all links added by extensions + * Get all styles added by extensions * * @return Array */ @@ -228,12 +388,41 @@ class OutputPage { } /** + * Filter an array of modules to remove insufficiently trustworthy members, and modules + * which are no longer registered (eg a page is cached before an extension is disabled) + * @param $modules Array + * @param $position String if not null, only return modules with this position + * @param $type string + * @return Array + */ + protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule::TYPE_COMBINED ){ + $resourceLoader = $this->getResourceLoader(); + $filteredModules = array(); + foreach( $modules as $val ){ + $module = $resourceLoader->getModule( $val ); + if( $module instanceof ResourceLoaderModule + && $module->getOrigin() <= $this->getAllowedModules( $type ) + && ( is_null( $position ) || $module->getPosition() == $position ) ) + { + $filteredModules[] = $val; + } + } + return $filteredModules; + } + + /** * Get the list of modules to include on this page * + * @param $filter Bool whether to filter out insufficiently trustworthy modules + * @param $position String if not null, only return modules with this position + * @param $param string * @return Array of module names */ - public function getModules() { - return array_values( array_unique( $this->mModules ) ); + public function getModules( $filter = false, $position = null, $param = 'mModules' ) { + $modules = array_values( array_unique( $this->$param ) ); + return $filter + ? $this->filterModules( $modules, $position ) + : $modules; } /** @@ -249,10 +438,14 @@ class OutputPage { /** * Get the list of module JS to include on this page + * + * @param $filter + * @param $position + * * @return array of module names */ - public function getModuleScripts() { - return array_values( array_unique( $this->mModuleScripts ) ); + public function getModuleScripts( $filter = false, $position = null ) { + return $this->getModules( $filter, $position, 'mModuleScripts' ); } /** @@ -269,10 +462,13 @@ class OutputPage { /** * Get the list of module CSS to include on this page * + * @param $filter + * @param $position + * * @return Array of module names */ - public function getModuleStyles() { - return array_values( array_unique( $this->mModuleStyles ) ); + public function getModuleStyles( $filter = false, $position = null ) { + return $this->getModules( $filter, $position, 'mModuleStyles' ); } /** @@ -289,10 +485,13 @@ class OutputPage { /** * Get the list of module messages to include on this page * + * @param $filter + * @param $position + * * @return Array of module names */ - public function getModuleMessages() { - return array_values( array_unique( $this->mModuleMessages ) ); + public function getModuleMessages( $filter = false, $position = null ) { + return $this->getModules( $filter, $position, 'mModuleMessages' ); } /** @@ -375,10 +574,12 @@ class OutputPage { * * Side effect: sets mLastModified for Last-Modified header * + * @param $timestamp string + * * @return Boolean: true iff cache-ok headers was sent. */ public function checkLastModified( $timestamp ) { - global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest; + global $wgCachePages, $wgCacheEpoch; if ( !$timestamp || $timestamp == '19700101000000' ) { wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" ); @@ -388,7 +589,7 @@ class OutputPage { wfDebug( __METHOD__ . ": CACHE DISABLED\n", false ); return false; } - if( $wgUser->getOption( 'nocache' ) ) { + if( $this->getUser()->getOption( 'nocache' ) ) { wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false ); return false; } @@ -396,7 +597,7 @@ class OutputPage { $timestamp = wfTimestamp( TS_MW, $timestamp ); $modifiedTimes = array( 'page' => $timestamp, - 'user' => $wgUser->getTouched(), + 'user' => $this->getUser()->getTouched(), 'epoch' => $wgCacheEpoch ); wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) ); @@ -445,7 +646,7 @@ class OutputPage { # Give a 304 response code and disable body output wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false ); ini_set( 'zlib.output_compression', 0 ); - $wgRequest->response()->header( "HTTP/1.1 304 Not Modified" ); + $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" ); $this->sendCacheControl(); $this->disable(); @@ -538,6 +739,8 @@ class OutputPage { /** * "HTML title" means the contents of <title>. * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file. + * + * @param $name string */ public function setHTMLTitle( $name ) { $this->mHTMLtitle = $name; @@ -557,6 +760,8 @@ class OutputPage { * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>. * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed. * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely. + * + * @param $name string */ public function setPageTitle( $name ) { # change "<script>foo&bar</script>" to "<script>foo&bar</script>" @@ -583,23 +788,9 @@ class OutputPage { * @param $t Title object */ public function setTitle( $t ) { - $this->mTitle = $t; + $this->getContext()->setTitle( $t ); } - /** - * Get the Title object used in this instance - * - * @return Title - */ - public function getTitle() { - if ( $this->mTitle instanceof Title ) { - return $this->mTitle; - } else { - wfDebug( __METHOD__ . " called and \$mTitle is null. Return \$wgTitle for sanity\n" ); - global $wgTitle; - return $wgTitle; - } - } /** * Replace the subtile with $str @@ -826,7 +1017,7 @@ class OutputPage { /** * Get the list of language links * - * @return Associative array mapping language code to the page name + * @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */ public function getLanguageLinks() { return $this->mLanguageLinks; @@ -835,10 +1026,10 @@ class OutputPage { /** * Add an array of categories, with names in the keys * - * @param $categories Associative array mapping category name to its sort key + * @param $categories Array mapping category name => sort key */ public function addCategoryLinks( $categories ) { - global $wgUser, $wgContLang; + global $wgContLang; if ( !is_array( $categories ) || count( $categories ) == 0 ) { return; @@ -851,12 +1042,13 @@ class OutputPage { # Fetch existence plus the hiddencat property $dbr = wfGetDB( DB_SLAVE ); - $pageTable = $dbr->tableName( 'page' ); - $where = $lb->constructSet( 'page', $dbr ); - $propsTable = $dbr->tableName( 'page_props' ); - $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, page_latest, pp_value - FROM $pageTable LEFT JOIN $propsTable ON pp_propname='hiddencat' AND pp_page=page_id WHERE $where"; - $res = $dbr->query( $sql, __METHOD__ ); + $res = $dbr->select( array( 'page', 'page_props' ), + array( 'page_id', 'page_namespace', 'page_title', 'page_len', 'page_is_redirect', 'page_latest', 'pp_value' ), + $lb->constructSet( 'page', $dbr ), + __METHOD__, + array(), + array( 'page_props' => array( 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' ) ) ) + ); # Add the results to the link cache $lb->addResultToCache( LinkCache::singleton(), $res ); @@ -876,7 +1068,6 @@ class OutputPage { # Add the remaining categories to the skin if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) { - $sk = $wgUser->getSkin(); foreach ( $categories as $category => $type ) { $origcategory = $category; $title = Title::makeTitleSafe( NS_CATEGORY, $category ); @@ -888,7 +1079,7 @@ class OutputPage { } $text = $wgContLang->convertHtml( $title->getText() ); $this->mCategories[] = $title->getText(); - $this->mCategoryLinks[$type][] = $sk->link( $title, $text ); + $this->mCategoryLinks[$type][] = Linker::link( $title, $text ); } } } @@ -896,7 +1087,7 @@ class OutputPage { /** * Reset the category links (but not the category list) and add $categories * - * @param $categories Associative array mapping category name to its sort key + * @param $categories Array mapping category name => sort key */ public function setCategoryLinks( $categories ) { $this->mCategoryLinks = array(); @@ -925,36 +1116,58 @@ class OutputPage { } /** - * Suppress the quickbar from the output, only for skin supporting - * the quickbar + * Do not allow scripts which can be modified by wiki users to load on this page; + * only allow scripts bundled with, or generated by, the software. */ - public function suppressQuickbar() { - $this->mSuppressQuickbar = true; + public function disallowUserJs() { + $this->reduceAllowedModules( + ResourceLoaderModule::TYPE_SCRIPTS, + ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL + ); } /** - * Return whether the quickbar should be suppressed from the output - * + * Return whether user JavaScript is allowed for this page + * @deprecated since 1.18 Load modules with ResourceLoader, and origin and + * trustworthiness is identified and enforced automagically. * @return Boolean */ - public function isQuickbarSuppressed() { - return $this->mSuppressQuickbar; + public function isUserJsAllowed() { + return $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS ) >= ResourceLoaderModule::ORIGIN_USER_INDIVIDUAL; } /** - * Remove user JavaScript from scripts to load + * Show what level of JavaScript / CSS untrustworthiness is allowed on this page + * @see ResourceLoaderModule::$origin + * @param $type String ResourceLoaderModule TYPE_ constant + * @return Int ResourceLoaderModule ORIGIN_ class constant */ - public function disallowUserJs() { - $this->mAllowUserJs = false; + public function getAllowedModules( $type ){ + if( $type == ResourceLoaderModule::TYPE_COMBINED ){ + return min( array_values( $this->mAllowedModules ) ); + } else { + return isset( $this->mAllowedModules[$type] ) + ? $this->mAllowedModules[$type] + : ResourceLoaderModule::ORIGIN_ALL; + } } /** - * Return whether user JavaScript is allowed for this page - * - * @return Boolean + * Set the highest level of CSS/JS untrustworthiness allowed + * @param $type String ResourceLoaderModule TYPE_ constant + * @param $level Int ResourceLoaderModule class constant */ - public function isUserJsAllowed() { - return $this->mAllowUserJs; + public function setAllowedModules( $type, $level ){ + $this->mAllowedModules[$type] = $level; + } + + /** + * As for setAllowedModules(), but don't inadvertantly make the page more accessible + * @param $type String + * @param $level Int ResourceLoaderModule class constant + */ + public function reduceAllowedModules( $type, $level ){ + $this->mAllowedModules[$type] = min( $this->getAllowedModules($type), $level ); } /** @@ -1001,19 +1214,11 @@ class OutputPage { } /** - * @deprecated use parserOptions() instead - */ - public function setParserOptions( $options ) { - wfDeprecated( __METHOD__ ); - return $this->parserOptions( $options ); - } - - /** * Get/set the ParserOptions object to use for wikitext parsing * * @param $options either the ParserOption to use or null to only get the * current ParserOption object - * @return current ParserOption object + * @return ParserOptions object */ public function parserOptions( $options = null ) { if ( !$this->mParserOptions ) { @@ -1035,7 +1240,7 @@ class OutputPage { } /** - * Get the current revision ID + * Get the displayed revision ID * * @return Integer */ @@ -1044,6 +1249,49 @@ class OutputPage { } /** + * Set the displayed file version + * + * @param $file File|false + * @return Mixed: previous value + */ + public function setFileVersion( $file ) { + $val = null; + if ( $file instanceof File && $file->exists() ) { + $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ); + } + return wfSetVar( $this->mFileVersion, $val, true ); + } + + /** + * Get the displayed file version + * + * @return Array|null ('time' => MW timestamp, 'sha1' => sha1) + */ + public function getFileVersion() { + return $this->mFileVersion; + } + + /** + * Get the templates used on this page + * + * @return Array (namespace => dbKey => revId) + * @since 1.18 + */ + public function getTemplateIds() { + return $this->mTemplateIds; + } + + /** + * Get the files used on this page + * + * @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or '')) + * @since 1.18 + */ + public function getImageTimeKeys() { + return $this->mImageTimeKeys; + } + + /** * Convert wikitext to HTML and add it to the buffer * Default assumes that the current page title will be used. * @@ -1067,7 +1315,7 @@ class OutputPage { } /** - * Add wikitext with a custom Title object and + * Add wikitext with a custom Title object and tidy enabled. * * @param $text String: wikitext * @param $title Title object @@ -1119,43 +1367,6 @@ class OutputPage { } /** - * Add wikitext to the buffer, assuming that this is the primary text for a page view - * Saves the text into the parser cache if possible. - * - * @param $text String: wikitext - * @param $article Article object - * @param $cache Boolean - * @deprecated Use Article::outputWikitext - */ - public function addPrimaryWikiText( $text, $article, $cache = true ) { - global $wgParser; - - wfDeprecated( __METHOD__ ); - - $popts = $this->parserOptions(); - $popts->setTidy( true ); - $parserOutput = $wgParser->parse( - $text, $article->mTitle, - $popts, true, true, $this->mRevisionId - ); - $popts->setTidy( false ); - if ( $cache && $article && $parserOutput->isCacheable() ) { - $parserCache = ParserCache::singleton(); - $parserCache->save( $parserOutput, $article, $popts ); - } - - $this->addParserOutput( $parserOutput ); - } - - /** - * @deprecated use addWikiTextTidy() - */ - public function addSecondaryWikiText( $text, $linestart = true ) { - wfDeprecated( __METHOD__ ); - $this->addWikiTextTitleTidy( $text, $this->getTitle(), $linestart ); - } - - /** * Add a ParserOutput object, but without Html * * @param $parserOutput ParserOutput object @@ -1173,14 +1384,22 @@ 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 ) { + $this->addModuleScripts( $parserOutput->getModuleScripts() ); + $this->addModuleStyles( $parserOutput->getModuleStyles() ); + $this->addModuleMessages( $parserOutput->getModuleMessages() ); + + // Template versioning... + foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) { if ( isset( $this->mTemplateIds[$ns] ) ) { $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns]; } else { $this->mTemplateIds[$ns] = $dbks; } } + // File versioning... + foreach ( (array)$parserOutput->getImageTimeKeys() as $dbk => $data ) { + $this->mImageTimeKeys[$dbk] = $data; + } // Hooks registered in the object global $wgParserOutputHooks; @@ -1227,24 +1446,37 @@ class OutputPage { * @param $interface Boolean: use interface language ($wgLang instead of * $wgContLang) while parsing language sensitive magic * words like GRAMMAR and PLURAL + * @param $language Language object: target language object, will override + * $interface * @return String: HTML */ - public function parse( $text, $linestart = true, $interface = false ) { + public function parse( $text, $linestart = true, $interface = false, $language = null ) { global $wgParser; + if( is_null( $this->getTitle() ) ) { throw new MWException( 'Empty $mTitle in ' . __METHOD__ ); } + $popts = $this->parserOptions(); if ( $interface ) { $popts->setInterfaceMessage( true ); } + if ( $language !== null ) { + $oldLang = $popts->setTargetLanguage( $language ); + } + $parserOutput = $wgParser->parse( $text, $this->getTitle(), $popts, $linestart, true, $this->mRevisionId ); + if ( $interface ) { $popts->setInterfaceMessage( false ); } + if ( $language !== null ) { + $popts->setTargetLanguage( $oldLang ); + } + return $parserOutput->getText(); } @@ -1270,24 +1502,6 @@ class OutputPage { } /** - * @deprecated - * - * @param $article Article - * @return Boolean: true if successful, else false. - */ - public function tryParserCache( &$article ) { - wfDeprecated( __METHOD__ ); - $parserOutput = ParserCache::singleton()->get( $article, $article->getParserOptions() ); - - if ( $parserOutput !== false ) { - $this->addParserOutput( $parserOutput ); - return true; - } else { - return false; - } - } - - /** * Set the value of the "s-maxage" part of the "Cache-control" HTTP header * * @param $maxage Integer: maximum cache time on the Squid, in seconds. @@ -1299,7 +1513,9 @@ class OutputPage { /** * Use enableClientCache(false) to force it to send nocache headers * - * @param $state ?? + * @param $state bool + * + * @return bool */ public function enableClientCache( $state ) { return wfSetVar( $this->mEnableClientCache, $state ); @@ -1334,9 +1550,9 @@ class OutputPage { * @return Boolean */ function uncacheableBecauseRequestVars() { - global $wgRequest; - return $wgRequest->getText( 'useskin', false ) === false - && $wgRequest->getText( 'uselang', false ) === false; + $request = $this->getRequest(); + return $request->getText( 'useskin', false ) === false + && $request->getText( 'uselang', false ) === false; } /** @@ -1346,8 +1562,7 @@ class OutputPage { * @return Boolean */ function haveCacheVaryCookies() { - global $wgRequest; - $cookieHeader = $wgRequest->getHeader( 'cookie' ); + $cookieHeader = $this->getRequest()->getHeader( 'cookie' ); if ( $cookieHeader === false ) { return false; } @@ -1367,8 +1582,8 @@ class OutputPage { * Add an HTTP header that will influence on the cache * * @param $header String: header name - * @param $option either an Array or null - * @fixme Document the $option parameter; it appears to be for + * @param $option Array|null + * @todo FIXME: Document the $option parameter; it appears to be for * X-Vary-Options but what format is acceptable? */ public function addVaryHeader( $header, $option = null ) { @@ -1381,7 +1596,7 @@ class OutputPage { $this->mVaryHeader[$header] = $option; } } - $this->mVaryHeader[$header] = array_unique( $this->mVaryHeader[$header] ); + $this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] ); } /** @@ -1420,8 +1635,8 @@ class OutputPage { * /w/index.php?title=Main_page&variant=zh-cn should never be served. */ function addAcceptLanguage() { - global $wgRequest, $wgContLang; - if( !$wgRequest->getCheck( 'variant' ) && $wgContLang->hasVariants() ) { + global $wgContLang; + if( !$this->getRequest()->getCheck( 'variant' ) && $wgContLang->hasVariants() ) { $variants = $wgContLang->getVariants(); $aloption = array(); foreach ( $variants as $variant ) { @@ -1429,7 +1644,7 @@ class OutputPage { continue; } else { $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. @@ -1446,12 +1661,14 @@ class OutputPage { } /** - * Set a flag which will cause an X-Frame-Options header appropriate for - * edit pages to be sent. The header value is controlled by + * Set a flag which will cause an X-Frame-Options header appropriate for + * edit pages to be sent. The header value is controlled by * $wgEditPageFrameOptions. * - * This is the default for special pages. If you display a CSRF-protected + * This is the default for special pages. If you display a CSRF-protected * form on an ordinary view page, then you need to call this function. + * + * @param $enable bool */ public function preventClickjacking( $enable = true ) { $this->mPreventClickjacking = $enable; @@ -1467,9 +1684,11 @@ class OutputPage { } /** - * Get the X-Frame-Options header value (without the name part), or false - * if there isn't one. This is used by Skin to determine whether to enable + * Get the X-Frame-Options header value (without the name part), or false + * if there isn't one. This is used by Skin to determine whether to enable * JavaScript frame-breaking, for clients that don't support X-Frame-Options. + * + * @return string */ public function getFrameOptions() { global $wgBreakFrames, $wgEditPageFrameOptions; @@ -1484,9 +1703,9 @@ class OutputPage { * Send cache control HTTP headers */ public function sendCacheControl() { - global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest, $wgUseXVO; + global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO; - $response = $wgRequest->response(); + $response = $this->getRequest()->response(); if ( $wgUseETag && $this->mETag ) { $response->header( "ETag: $this->mETag" ); } @@ -1553,58 +1772,13 @@ class OutputPage { * * @param $code Integer: status code * @return String or null: message or null if $code is not in the list of - * messages + * messages + * + * @deprecated since 1.18 Use HttpStatus::getMessage() instead. */ public static function getStatusMessage( $code ) { - static $statusMessage = array( - 100 => 'Continue', - 101 => 'Switching Protocols', - 102 => 'Processing', - 200 => 'OK', - 201 => 'Created', - 202 => 'Accepted', - 203 => 'Non-Authoritative Information', - 204 => 'No Content', - 205 => 'Reset Content', - 206 => 'Partial Content', - 207 => 'Multi-Status', - 300 => 'Multiple Choices', - 301 => 'Moved Permanently', - 302 => 'Found', - 303 => 'See Other', - 304 => 'Not Modified', - 305 => 'Use Proxy', - 307 => 'Temporary Redirect', - 400 => 'Bad Request', - 401 => 'Unauthorized', - 402 => 'Payment Required', - 403 => 'Forbidden', - 404 => 'Not Found', - 405 => 'Method Not Allowed', - 406 => 'Not Acceptable', - 407 => 'Proxy Authentication Required', - 408 => 'Request Timeout', - 409 => 'Conflict', - 410 => 'Gone', - 411 => 'Length Required', - 412 => 'Precondition Failed', - 413 => 'Request Entity Too Large', - 414 => 'Request-URI Too Large', - 415 => 'Unsupported Media Type', - 416 => 'Request Range Not Satisfiable', - 417 => 'Expectation Failed', - 422 => 'Unprocessable Entity', - 423 => 'Locked', - 424 => 'Failed Dependency', - 500 => 'Internal Server Error', - 501 => 'Not Implemented', - 502 => 'Bad Gateway', - 503 => 'Service Unavailable', - 504 => 'Gateway Timeout', - 505 => 'HTTP Version Not Supported', - 507 => 'Insufficient Storage' - ); - return isset( $statusMessage[$code] ) ? $statusMessage[$code] : null; + wfDeprecated( __METHOD__ ); + return HttpStatus::getMessage( $code ); } /** @@ -1612,110 +1786,68 @@ class OutputPage { * the object, let's actually output it: */ public function output() { - global $wgUser, $wgOutputEncoding, $wgRequest; - global $wgLanguageCode, $wgDebugRedirects, $wgMimeType; - global $wgUseAjax, $wgAjaxWatch; - global $wgEnableMWSuggest, $wgUniversalEditButton; - global $wgArticle; + global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP; if( $this->mDoNothing ) { return; } + wfProfileIn( __METHOD__ ); + + $response = $this->getRequest()->response(); + if ( $this->mRedirect != '' ) { # Standards require redirect URLs to be absolute - $this->mRedirect = wfExpandUrl( $this->mRedirect ); + $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT ); if( $this->mRedirectCode == '301' || $this->mRedirectCode == '303' ) { if( !$wgDebugRedirects ) { - $message = self::getStatusMessage( $this->mRedirectCode ); - $wgRequest->response()->header( "HTTP/1.1 {$this->mRedirectCode} $message" ); + $message = HttpStatus::getMessage( $this->mRedirectCode ); + $response->header( "HTTP/1.1 {$this->mRedirectCode} $message" ); } $this->mLastModified = wfTimestamp( TS_RFC2822 ); } + if ( $wgVaryOnXFP ) { + $this->addVaryHeader( 'X-Forwarded-Proto' ); + } $this->sendCacheControl(); - $wgRequest->response()->header( "Content-Type: text/html; charset=utf-8" ); + $response->header( "Content-Type: text/html; charset=utf-8" ); if( $wgDebugRedirects ) { $url = htmlspecialchars( $this->mRedirect ); print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n"; print "<p>Location: <a href=\"$url\">$url</a></p>\n"; print "</body>\n</html>\n"; } else { - $wgRequest->response()->header( 'Location: ' . $this->mRedirect ); + $response->header( 'Location: ' . $this->mRedirect ); } wfProfileOut( __METHOD__ ); return; } elseif ( $this->mStatusCode ) { - $message = self::getStatusMessage( $this->mStatusCode ); + $message = HttpStatus::getMessage( $this->mStatusCode ); if ( $message ) { - $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message ); + $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message ); } } - $sk = $wgUser->getSkin(); - - // Add base resources - $this->addModules( 'mediawiki.util' ); - global $wgIncludeLegacyJavaScript; - if( $wgIncludeLegacyJavaScript ){ - $this->addModules( 'mediawiki.legacy.wikibits' ); - } - - // Add various resources if required - if ( $wgUseAjax ) { - $this->addModules( 'mediawiki.legacy.ajax' ); - - wfRunHooks( 'AjaxAddScript', array( &$this ) ); - - if( $wgAjaxWatch && $wgUser->isLoggedIn() ) { - $this->addModules( 'mediawiki.legacy.ajaxwatch' ); - } - - if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ) { - $this->addModules( 'mediawiki.legacy.mwsuggest' ); - } - } - - if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) { - $this->addModules( 'mediawiki.action.view.rightClickEdit' ); - } - - if( $wgUniversalEditButton ) { - if( isset( $wgArticle ) && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' ) - && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) { - // Original UniversalEditButton - $msg = wfMsg( 'edit' ); - $this->addLink( array( - 'rel' => 'alternate', - 'type' => 'application/x-wiki', - 'title' => $msg, - 'href' => $this->getTitle()->getLocalURL( 'action=edit' ) - ) ); - // Alternate edit link - $this->addLink( array( - 'rel' => 'edit', - 'title' => $msg, - 'href' => $this->getTitle()->getLocalURL( 'action=edit' ) - ) ); - } - } - - # Buffer output; final headers may depend on later processing ob_start(); - $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" ); - $wgRequest->response()->header( 'Content-language: ' . $wgLanguageCode ); + $response->header( "Content-type: $wgMimeType; charset=UTF-8" ); + $response->header( 'Content-language: ' . $wgLanguageCode ); // Prevent framing, if requested $frameOptions = $this->getFrameOptions(); if ( $frameOptions ) { - $wgRequest->response()->header( "X-Frame-Options: $frameOptions" ); + $response->header( "X-Frame-Options: $frameOptions" ); } if ( $this->mArticleBodyOnly ) { $this->out( $this->mBodytext ); } else { + $this->addDefaultModules(); + + $sk = $this->getSkin(); + // Hook that allows last minute changes to the output page, e.g. // adding of CSS or Javascript by extensions. wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) ); @@ -1731,127 +1863,31 @@ class OutputPage { } /** - * Actually output something with print(). Performs an iconv to the - * output encoding, if needed. + * Actually output something with print(). * * @param $ins String: the string to output */ public function out( $ins ) { - global $wgInputEncoding, $wgOutputEncoding, $wgContLang; - if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) { - $outs = $ins; - } else { - $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins ); - if ( false === $outs ) { - $outs = $ins; - } - } - 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. - * - * @return String - */ - public function reportTime() { - wfDeprecated( __METHOD__ ); - $time = wfReportTime(); - return $time; + print $ins; } /** * Produce a "user is blocked" page. - * - * @param $return Boolean: whether to have a "return to $wgTitle" message or not. - * @return nothing + * @deprecated since 1.18 */ - function blockedPage( $return = true ) { - global $wgUser, $wgContLang, $wgLang; - - $this->setPageTitle( wfMsg( 'blockedtitle' ) ); - $this->setRobotPolicy( 'noindex,nofollow' ); - $this->setArticleRelated( false ); - - $name = User::whoIs( $wgUser->blockedBy() ); - $reason = $wgUser->blockedFor(); - if( $reason == '' ) { - $reason = wfMsg( 'blockednoreason' ); - } - $blockTimestamp = $wgLang->timeanddate( - wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true - ); - $ip = wfGetIP(); - - $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]"; - - $blockid = $wgUser->mBlock->mId; - - $blockExpiry = $wgUser->mBlock->mExpiry; - if ( $blockExpiry == 'infinity' ) { - // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite' - // Search for localization in 'ipboptions' - $scBlockExpiryOptions = wfMsg( 'ipboptions' ); - foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) { - if ( strpos( $option, ':' ) === false ) { - continue; - } - list( $show, $value ) = explode( ':', $option ); - if ( $value == 'infinite' || $value == 'indefinite' ) { - $blockExpiry = $show; - break; - } - } - } else { - $blockExpiry = $wgLang->timeanddate( - wfTimestamp( TS_MW, $blockExpiry ), - true - ); - } - - if ( $wgUser->mBlock->mAuto ) { - $msg = 'autoblockedtext'; - } else { - $msg = 'blockedtext'; - } - - /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked. - * This could be a username, an IP range, or a single IP. */ - $intended = $wgUser->mBlock->mAddress; - - $this->addWikiMsg( - $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, - $intended, $blockTimestamp - ); - - # Don't auto-return to special pages - if( $return ) { - $return = $this->getTitle()->getNamespace() > -1 ? $this->getTitle() : null; - $this->returnToMain( null, $return ); - } + function blockedPage() { + throw new UserBlockedError( $this->getUser()->mBlock ); } /** * Output a standard error page * + * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) ); + * showErrorPage( 'titlemsg', $messageObject ); + * * @param $title String: message key for page title - * @param $msg String: message key for page text - * @param $params Array: message parameters + * @param $msg Mixed: message key (string) for page text, or a Message object + * @param $params Array: message parameters; ignored if $msg is a Message object */ public function showErrorPage( $title, $msg, $params = array() ) { if ( $this->getTitle() ) { @@ -1865,9 +1901,11 @@ class OutputPage { $this->mRedirect = ''; $this->mBodytext = ''; - array_unshift( $params, 'parse' ); - array_unshift( $params, $msg ); - $this->addHTML( call_user_func_array( 'wfMsgExt', $params ) ); + if ( $msg instanceof Message ){ + $this->addHTML( $msg->parse() ); + } else { + $this->addWikiMsgArray( $msg, $params ); + } $this->returnToMain(); } @@ -1910,60 +1948,35 @@ class OutputPage { /** * Display an error page noting that a given permission bit is required. - * + * @deprecated since 1.18, just throw the exception directly * @param $permission String: key required */ public function permissionRequired( $permission ) { - global $wgLang; - - $this->setPageTitle( wfMsg( 'badaccess' ) ); - $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) ); - $this->setRobotPolicy( 'noindex,nofollow' ); - $this->setArticleRelated( false ); - $this->mBodytext = ''; - - $groups = array_map( array( 'User', 'makeGroupLinkWiki' ), - User::getGroupsWithPermission( $permission ) ); - if( $groups ) { - $this->addWikiMsg( - 'badaccess-groups', - $wgLang->commaList( $groups ), - count( $groups ) - ); - } else { - $this->addWikiMsg( 'badaccess-group0' ); - } - $this->returnToMain(); + throw new PermissionsError( $permission ); } /** * Produce the stock "please login to use the wiki" page */ public function loginToUse() { - global $wgUser; - - if( $wgUser->isLoggedIn() ) { - $this->permissionRequired( 'read' ); - return; + if( $this->getUser()->isLoggedIn() ) { + throw new PermissionsError( 'read' ); } - $skin = $wgUser->getSkin(); - $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( + $loginLink = Linker::linkKnown( $loginTitle, wfMsgHtml( 'loginreqlink' ), array(), - array( 'returnto' => $this->getTitle()->getPrefixedText() ), - array( 'known', 'noclasses' ) + array( 'returnto' => $this->getTitle()->getPrefixedText() ) ); - $this->addHTML( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) ); - $this->addHTML( "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' ); + $this->addHTML( wfMessage( 'loginreqpagetext' )->rawParams( $loginLink )->parse() . + "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' ); # Don't return to the main page if the user can't read it # otherwise we'll end up in a pointless loop @@ -1976,7 +1989,7 @@ class OutputPage { /** * Format a list of error messages * - * @param $errors An array of arrays returned by Title::getUserPermissionsErrors + * @param $errors Array of arrays returned by Title::getUserPermissionsErrors * @param $action String: action that was denied or null if unknown * @return String: the wikitext error-messages, formatted into a list. */ @@ -2031,9 +2044,6 @@ class OutputPage { * @param $action String: action that was denied or null if unknown */ public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) { - global $wgUser; - $skin = $wgUser->getSkin(); - $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); @@ -2048,7 +2058,7 @@ class OutputPage { if( $source ) { $this->setPageTitle( wfMsg( 'viewsource' ) ); $this->setSubtitle( - wfMsg( 'viewsourcefor', $skin->linkKnown( $this->getTitle() ) ) + wfMsg( 'viewsourcefor', Linker::linkKnown( $this->getTitle() ) ) ); } else { $this->setPageTitle( wfMsg( 'badaccess' ) ); @@ -2056,9 +2066,7 @@ class OutputPage { $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) ); } else { // Wiki is read only - $this->setPageTitle( wfMsg( 'readonly' ) ); - $reason = wfReadOnlyReason(); - $this->wrapWikiMsg( "<div class='mw-readonly-error'>\n$1\n</div>", array( 'readonlytext', $reason ) ); + throw new ReadOnlyError; } // Show source, if supplied @@ -2068,17 +2076,17 @@ class OutputPage { $params = array( 'id' => 'wpTextbox1', 'name' => 'wpTextbox1', - 'cols' => $wgUser->getOption( 'cols' ), - 'rows' => $wgUser->getOption( 'rows' ), + 'cols' => $this->getUser()->getOption( 'cols' ), + 'rows' => $this->getUser()->getOption( 'rows' ), 'readonly' => 'readonly' ); $this->addHTML( Html::element( 'textarea', $params, $source ) ); // Show templates used by this article - $skin = $wgUser->getSkin(); $article = new Article( $this->getTitle() ); + $templates = Linker::formatTemplates( $article->getUsedTemplates() ); $this->addHTML( "<div class='templatesUsed'> -{$skin->formatTemplates( $article->getUsedTemplates() )} +$templates </div> " ); } @@ -2091,51 +2099,32 @@ class OutputPage { } } - /** @deprecated */ - public function errorpage( $title, $msg ) { - wfDeprecated( __METHOD__ ); - throw new ErrorPageError( $title, $msg ); - } - - /** @deprecated */ - public function databaseError( $fname, $sql, $error, $errno ) { - throw new MWException( "OutputPage::databaseError is obsolete\n" ); - } - - /** @deprecated */ - public function fatalError( $message ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( $message ); - } - - /** @deprecated */ - public function unexpectedValueError( $name, $val ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'unexpected', $name, $val ) ); - } - - /** @deprecated */ - public function fileCopyError( $old, $new ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) ); - } - - /** @deprecated */ - public function fileRenameError( $old, $new ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) ); - } - - /** @deprecated */ - public function fileDeleteError( $name ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filedeleteerror', $name ) ); + /** + * Turn off regular page output and return an error reponse + * for when rate limiting has triggered. + */ + public function rateLimited() { + throw new ThrottledError; } - /** @deprecated */ - public function fileNotFoundError( $name ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filenotfound', $name ) ); + /** + * Show a warning about slave lag + * + * If the lag is higher than $wgSlaveLagCritical seconds, + * then the warning is a bit more obvious. If the lag is + * lower than $wgSlaveLagWarning, then no warning is shown. + * + * @param $lag Integer: slave lag + */ + public function showLagWarning( $lag ) { + global $wgSlaveLagWarning, $wgSlaveLagCritical; + if( $lag >= $wgSlaveLagWarning ) { + $message = $lag < $wgSlaveLagCritical + ? 'lag-warn-normal' + : 'lag-warn-high'; + $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" ); + $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getContext()->getLang()->formatNum( $lag ) ) ); + } } public function showFatalError( $message ) { @@ -2171,15 +2160,14 @@ class OutputPage { * Add a "return to" link pointing to a specified title * * @param $title Title to link - * @param $query String: query string + * @param $query String query string * @param $text String text of the link (input is not escaped) */ public function addReturnTo( $title, $query = array(), $text = null ) { - global $wgUser; $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) ); $link = wfMsgHtml( 'returnto', - $wgUser->getSkin()->link( $title, $text, array(), $query ) + Linker::link( $title, $text, array(), $query ) ); $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" ); } @@ -2193,14 +2181,12 @@ class OutputPage { * @param $returntoquery String: query string for the return to link */ public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) { - global $wgRequest; - if ( $returnto == null ) { - $returnto = $wgRequest->getText( 'returnto' ); + $returnto = $this->getRequest()->getText( 'returnto' ); } if ( $returntoquery == null ) { - $returntoquery = $wgRequest->getText( 'returntoquery' ); + $returntoquery = $this->getRequest()->getText( 'returntoquery' ); } if ( $returnto === '' ) { @@ -2225,17 +2211,16 @@ class OutputPage { * @return String: The doctype, opening <html>, and head element. */ public function headElement( Skin $sk, $includeStyle = true ) { - global $wgOutputEncoding, $wgMimeType; - global $wgUseTrackbacks, $wgHtml5; - global $wgUser, $wgRequest, $wgLang; + global $wgContLang, $wgUseTrackbacks; + $userdir = $this->getLang()->getDir(); + $sitedir = $wgContLang->getDir(); if ( $sk->commonPrintStylesheet() ) { $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' ); } $sk->setupUserCss( $this ); - $lang = wfUILang(); - $ret = Html::htmlHeader( array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ) ); + $ret = Html::htmlHeader( array( 'lang' => $this->getLang()->getCode(), 'dir' => $userdir, 'class' => 'client-nojs' ) ); if ( $this->getHTMLTitle() == '' ) { $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) ); @@ -2247,19 +2232,12 @@ class OutputPage { $ret .= "$openHead\n"; } - if ( $wgHtml5 ) { - # More succinct than <meta http-equiv=Content-Type>, has the - # same effect - $ret .= Html::element( 'meta', array( 'charset' => $wgOutputEncoding ) ) . "\n"; - } else { - $this->addMeta( 'http:Content-Type', "$wgMimeType; charset=$wgOutputEncoding" ); - } - $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n"; $ret .= implode( "\n", array( - $this->getHeadLinks( $sk ), + $this->getHeadLinks( $sk, true ), $this->buildCssLinks( $sk ), + $this->getHeadScripts( $sk ), $this->getHeadItems() ) ); @@ -2275,12 +2253,12 @@ class OutputPage { $bodyAttrs = array(); # Crazy edit-on-double-click stuff - $action = $wgRequest->getVal( 'action', 'view' ); + $action = $this->getRequest()->getVal( 'action', 'view' ); if ( $this->getTitle()->getNamespace() != NS_SPECIAL && - !in_array( $action, array( 'edit', 'submit' ) ) && - $wgUser->getOption( 'editondblclick' ) + in_array( $action, array( 'view', 'purge' ) ) && + $this->getUser()->getOption( 'editondblclick' ) ) { $editUrl = $this->getTitle()->getLocalUrl( $sk->editUrlOptions() ); @@ -2288,24 +2266,15 @@ class OutputPage { Xml::escapeJsString( $editUrl ) . "'"; } - # Class bloat - $dir = wfUILang()->getDir(); - $bodyAttrs['class'] = "mediawiki $dir"; + # Classes for LTR/RTL directionality support + $bodyAttrs['class'] = "mediawiki $userdir sitedir-$sitedir"; - if ( $wgLang->capitalizeAllNouns() ) { + if ( $this->getContext()->getLang()->capitalizeAllNouns() ) { # A <body> class is probably not the best way to do this . . . $bodyAttrs['class'] .= ' capitalize-all-nouns'; } - $bodyAttrs['class'] .= ' ns-' . $this->getTitle()->getNamespace(); - if ( $this->getTitle()->getNamespace() == NS_SPECIAL ) { - $bodyAttrs['class'] .= ' ns-special'; - } elseif ( $this->getTitle()->isTalkPage() ) { - $bodyAttrs['class'] .= ' ns-talk'; - } else { - $bodyAttrs['class'] .= ' ns-subject'; - } - $bodyAttrs['class'] .= ' ' . Sanitizer::escapeClass( 'page-' . $this->getTitle()->getPrefixedText() ); - $bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $wgUser->getSkin()->getSkinName() ); + $bodyAttrs['class'] .= ' ' . $sk->getPageClasses( $this->getTitle() ); + $bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $sk->getSkinName() ); $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) ); @@ -2316,52 +2285,92 @@ class OutputPage { } /** + * Add the default ResourceLoader modules to this object + */ + private function addDefaultModules() { + global $wgIncludeLegacyJavaScript, $wgUseAjax, + $wgAjaxWatch, $wgEnableMWSuggest; + + // Add base resources + $this->addModules( array( + 'mediawiki.user', + 'mediawiki.util', + 'mediawiki.page.startup', + 'mediawiki.page.ready', + ) ); + if ( $wgIncludeLegacyJavaScript ){ + $this->addModules( 'mediawiki.legacy.wikibits' ); + } + + // Add various resources if required + if ( $wgUseAjax ) { + $this->addModules( 'mediawiki.legacy.ajax' ); + + wfRunHooks( 'AjaxAddScript', array( &$this ) ); + + if( $wgAjaxWatch && $this->getUser()->isLoggedIn() ) { + $this->addModules( 'mediawiki.action.watch.ajax' ); + } + + if ( $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) { + $this->addModules( 'mediawiki.legacy.mwsuggest' ); + } + } + + if ( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) { + $this->addModules( 'mediawiki.action.view.rightClickEdit' ); + } + } + + /** * Get a ResourceLoader object associated with this OutputPage + * + * @return ResourceLoader */ 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 $only String ResourceLoaderModule TYPE_ class constant * @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, $wgRequest; + global $wgLoadScript, $wgResourceLoaderUseESI, + $wgResourceLoaderInlinePrivateModules; // Lazy-load ResourceLoader // TODO: Should this be a static function of ResourceLoader instead? $baseQuery = array( - 'lang' => $wgLang->getCode(), + 'lang' => $this->getContext()->getLang()->getCode(), 'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false', 'skin' => $skin->getSkinName(), 'only' => $only, ); // Propagate printable and handheld parameters if present - if ( $wgRequest->getBool( 'printable' ) ) { + if ( $this->isPrintable() ) { $baseQuery['printable'] = 1; } - if ( $wgRequest->getBool( 'handheld' ) ) { + if ( $this->getRequest()->getBool( 'handheld' ) ) { $baseQuery['handheld'] = 1; } - + 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 = ''; @@ -2371,12 +2380,21 @@ class OutputPage { 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 ); + # Check that we're allowed to include this module on this page + if ( ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS ) + && $only == ResourceLoaderModule::TYPE_SCRIPTS ) + || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES ) + && $only == ResourceLoaderModule::TYPE_STYLES ) + ) + { + continue; + } $group = $module->getGroup(); if ( !isset( $groups[$group] ) ) { @@ -2384,14 +2402,15 @@ class OutputPage { } $groups[$group][$name] = $module; } + $links = ''; foreach ( $groups as $group => $modules ) { $query = $baseQuery; // Special handling for user-specific groups - if ( ( $group === 'user' || $group === 'private' ) && $wgUser->isLoggedIn() ) { - $query['user'] = $wgUser->getName(); + if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) { + $query['user'] = $this->getUser()->getName(); } - + // Create a fake request based on the one we are about to make so modules return // correct timestamp and emptiness data $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) ); @@ -2405,12 +2424,12 @@ class OutputPage { if ( $modules === array() ) { continue; } - + $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $modules ) ); - + // Support inlining of private modules if configured as such if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) { - if ( $only == 'styles' ) { + if ( $only == ResourceLoaderModule::TYPE_STYLES ) { $links .= Html::inlineStyle( $resourceLoader->makeModuleResponse( $context, $modules ) ); @@ -2446,107 +2465,244 @@ class OutputPage { $url .= '&*'; if ( $useESI && $wgResourceLoaderUseESI ) { $esi = Xml::element( 'esi:include', array( 'src' => $url ) ); - if ( $only == 'styles' ) { - $links .= Html::inlineStyle( $esi ); + if ( $only == ResourceLoaderModule::TYPE_STYLES ) { + $link = Html::inlineStyle( $esi ); } else { - $links .= Html::inlineScript( $esi ); + $link = Html::inlineScript( $esi ); } } else { // Automatically select style/script elements - if ( $only === 'styles' ) { - $links .= Html::linkedStyle( $url ) . "\n"; + if ( $only === ResourceLoaderModule::TYPE_STYLES ) { + $link = Html::linkedStyle( $url ); } else { - $links .= Html::linkedScript( $url ) . "\n"; + $link = Html::linkedScript( $url ); } } + + if( $group == 'noscript' ){ + $links .= Html::rawElement( 'noscript', array(), $link ) . "\n"; + } else { + $links .= $link . "\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 - * <head> but at the bottom of the <body> + * JS stuff to put in the <head>. This is the startup module, config + * vars and modules marked with position 'top' * * @param $sk Skin object to use * @return String: HTML fragment */ function getHeadScripts( Skin $sk ) { - global $wgUser, $wgRequest, $wgUseSiteJs; - // Startup - this will immediately load jquery and mediawiki modules - $scripts = $this->makeResourceLoaderLink( $sk, 'startup', 'scripts', true ); + $scripts = $this->makeResourceLoaderLink( $sk, 'startup', ResourceLoaderModule::TYPE_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"; + // Load config before anything else + $scripts .= Html::inlineScript( + ResourceLoader::makeLoaderConditionalScript( + ResourceLoader::makeConfigSetScript( $this->getJSVars() ) + ) + ); - // Script and Messages "only" requests - $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts(), 'scripts' ); - $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages(), 'messages' ); + // Script and Messages "only" requests marked for top inclusion + // Messages should go first + $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'top' ), ResourceLoaderModule::TYPE_MESSAGES ); + $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'top' ), ResourceLoaderModule::TYPE_SCRIPTS ); // Modules requests - let the client calculate dependencies and batch requests as it likes - if ( $this->getModules() ) { + // Only load modules that have marked themselves for loading at the top + $modules = $this->getModules( true, 'top' ); + if ( $modules ) { $scripts .= Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( - Xml::encodeJsCall( 'mediaWiki.loader.load', array( $this->getModules() ) ) . - Xml::encodeJsCall( 'mediaWiki.loader.go', array() ) + Xml::encodeJsCall( 'mw.loader.load', array( $modules ) ) ) - ) . "\n"; + ); + } + + return $scripts; + } + + /** + * JS stuff to put at the bottom of the <body>: modules marked with position 'bottom', + * legacy scripts ($this->mScripts), user preferences, site JS and user JS + * + * @param $sk Skin + * + * @return string + */ + function getBottomScripts( Skin $sk ) { + global $wgUseSiteJs, $wgAllowUserJs; + + // Script and Messages "only" requests marked for bottom inclusion + // Messages should go first + $scripts = $this->makeResourceLoaderLink( $sk, $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule::TYPE_MESSAGES ); + $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule::TYPE_SCRIPTS ); + + // Modules requests - let the client calculate dependencies and batch requests as it likes + // Only load modules that have marked themselves for loading at the bottom + $modules = $this->getModules( true, 'bottom' ); + if ( $modules ) { + $scripts .= Html::inlineScript( + ResourceLoader::makeLoaderConditionalScript( + Xml::encodeJsCall( 'mw.loader.load', array( $modules ) ) + ) + ); } // Legacy Scripts $scripts .= "\n" . $this->mScripts; + $userScripts = array( 'user.options', 'user.tokens' ); + // Add site JS if enabled if ( $wgUseSiteJs ) { - $scripts .= $this->makeResourceLoaderLink( $sk, 'site', 'scripts' ); + $scripts .= $this->makeResourceLoaderLink( $sk, 'site', ResourceLoaderModule::TYPE_SCRIPTS ); + if( $this->getUser()->isLoggedIn() ){ + $userScripts[] = 'user.groups'; + } } - // 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 ) ) { + // Add user JS if enabled + if ( $wgAllowUserJs && $this->getUser()->isLoggedIn() ) { + $action = $this->getRequest()->getVal( 'action', 'view' ); + if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $sk->userCanPreview( $action ) ) { # XXX: additional security check/prompt? - $scripts .= Html::inlineScript( "\n" . $wgRequest->getText( 'wpTextbox1' ) . "\n" ) . "\n"; + $scripts .= Html::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n"; } else { - $scripts .= $this->makeResourceLoaderLink( - $sk, array( 'user', 'user.options' ), 'scripts' - ); - $userOptionsAdded = true; + # @todo FIXME: This means that User:Me/Common.js doesn't load when previewing + # User:Me/Vector.js, and vice versa (bug26283) + $userScripts[] = 'user'; } } - if ( !$userOptionsAdded ) { - $scripts .= $this->makeResourceLoaderLink( $sk, 'user.options', 'scripts' ); - } - + $scripts .= $this->makeResourceLoaderLink( $sk, $userScripts, ResourceLoaderModule::TYPE_SCRIPTS ); + return $scripts; } /** - * Add default \<meta\> tags + * Add one or more variables to be set in mw.config in JavaScript. + * + * @param $key {String|Array} Key or array of key/value pars. + * @param $value {Mixed} Value of the configuration variable. */ - protected function addDefaultMeta() { - global $wgVersion, $wgHtml5; - - static $called = false; - if ( $called ) { - # Don't run this twice + public function addJsConfigVars( $keys, $value ) { + if ( is_array( $keys ) ) { + foreach ( $keys as $key => $value ) { + $this->mJsConfigVars[$key] = $value; + } return; } - $called = true; - if ( !$wgHtml5 ) { - $this->addMeta( 'http:Content-Style-Type', 'text/css' ); // bug 15835 + $this->mJsConfigVars[$keys] = $value; + } + + + /** + * Get an array containing the variables to be set in mw.config in JavaScript. + * + * Do not add things here which can be evaluated in ResourceLoaderStartupScript + * - in other words, page-indendent/site-wide variables (without state). + * You will only be adding bloat to the html page and causing page caches to + * have to be purged on configuration changes. + */ + protected function getJSVars() { + global $wgUseAjax, $wgEnableMWSuggest, $wgContLang; + + $title = $this->getTitle(); + $ns = $title->getNamespace(); + $nsname = MWNamespace::exists( $ns ) ? MWNamespace::getCanonicalName( $ns ) : $title->getNsText(); + if ( $ns == NS_SPECIAL ) { + list( $canonicalName, /*...*/ ) = SpecialPageFactory::resolveAlias( $title->getDBkey() ); + } else { + $canonicalName = false; # bug 21115 + } + + $vars = array( + 'wgCanonicalNamespace' => $nsname, + 'wgCanonicalSpecialPageName' => $canonicalName, + 'wgNamespaceNumber' => $title->getNamespace(), + 'wgPageName' => $title->getPrefixedDBKey(), + 'wgTitle' => $title->getText(), + 'wgCurRevisionId' => $title->getLatestRevID(), + 'wgArticleId' => $title->getArticleId(), + 'wgIsArticle' => $this->isArticle(), + 'wgAction' => $this->getRequest()->getText( 'action', 'view' ), + 'wgUserName' => $this->getUser()->isAnon() ? null : $this->getUser()->getName(), + 'wgUserGroups' => $this->getUser()->getEffectiveGroups(), + 'wgCategories' => $this->getCategories(), + 'wgBreakFrames' => $this->getFrameOptions() == 'DENY', + ); + if ( $wgContLang->hasVariants() ) { + $vars['wgUserVariant'] = $wgContLang->getPreferredVariant(); } - $this->addMeta( 'generator', "MediaWiki $wgVersion" ); + foreach ( $title->getRestrictionTypes() as $type ) { + $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type ); + } + if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) { + $vars['wgSearchNamespaces'] = SearchEngine::userNamespaces( $this->getUser() ); + } + if ( $title->isMainPage() ) { + $vars['wgIsMainPage'] = true; + } + + // Allow extensions to add their custom variables to the mw.config map. + // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not + // page-dependant but site-wide (without state). + // Alternatively, you may want to use OutputPage->addJsConfigVars() instead. + wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars ) ); + + // Merge in variables from addJsConfigVars last + return array_merge( $vars, $this->mJsConfigVars ); + } + + /** + * @param $sk Skin + * @param $addContentType bool + * + * @return string HTML tag links to be put in the header. + */ + public function getHeadLinks( Skin $sk, $addContentType = false ) { + global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI, + $wgSitename, $wgVersion, $wgHtml5, $wgMimeType, + $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes, + $wgDisableLangConversion, $wgCanonicalLanguageLinks, $wgContLang, + $wgRightsPage, $wgRightsUrl; + + $tags = array(); + + if ( $addContentType ) { + if ( $wgHtml5 ) { + # More succinct than <meta http-equiv=Content-Type>, has the + # same effect + $tags[] = Html::element( 'meta', array( 'charset' => 'UTF-8' ) ); + } else { + $tags[] = Html::element( 'meta', array( + 'http-equiv' => 'Content-Type', + 'content' => "$wgMimeType; charset=UTF-8" + ) ); + $tags[] = Html::element( 'meta', array( // bug 15835 + 'http-equiv' => 'Content-Style-Type', + 'content' => 'text/css' + ) ); + } + } + + $tags[] = Html::element( 'meta', array( + 'name' => 'generator', + 'content' => "MediaWiki $wgVersion", + ) ); $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}"; if( $p !== 'index,follow' ) { // http://www.robotstxt.org/wc/meta-user.html // Only show if it's different from the default robots policy - $this->addMeta( 'robots', $p ); + $tags[] = Html::element( 'meta', array( + 'name' => 'robots', + 'content' => $p, + ) ); } if ( count( $this->mKeywords ) > 0 ) { @@ -2554,27 +2710,15 @@ class OutputPage { "/<.*?" . ">/" => '', "/_/" => ' ' ); - $this->addMeta( - 'keywords', - preg_replace( + $tags[] = Html::element( 'meta', array( + 'name' => 'keywords', + 'content' => preg_replace( array_keys( $strip ), array_values( $strip ), implode( ',', $this->mKeywords ) ) - ); + ) ); } - } - - /** - * @return string HTML tag links to be put in the header. - */ - public function getHeadLinks( Skin $sk ) { - global $wgFeed; - - // Ideally this should happen earlier, somewhere. :P - $this->addDefaultMeta(); - - $tags = array(); foreach ( $this->mMetatags as $tag ) { if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) { @@ -2590,16 +2734,117 @@ class OutputPage { ) ); } + foreach ( $this->mLinktags as $tag ) { $tags[] = Html::element( 'link', $tag ); } - if( $wgFeed ) { + # Universal edit button + if ( $wgUniversalEditButton ) { + if ( $this->isArticleRelated() && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' ) + && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) { + // Original UniversalEditButton + $msg = wfMsg( 'edit' ); + $tags[] = Html::element( 'link', array( + 'rel' => 'alternate', + 'type' => 'application/x-wiki', + 'title' => $msg, + 'href' => $this->getTitle()->getLocalURL( 'action=edit' ) + ) ); + // Alternate edit link + $tags[] = Html::element( 'link', array( + 'rel' => 'edit', + 'title' => $msg, + 'href' => $this->getTitle()->getLocalURL( 'action=edit' ) + ) ); + } + } + + # Generally the order of the favicon and apple-touch-icon links + # should not matter, but Konqueror (3.5.9 at least) incorrectly + # uses whichever one appears later in the HTML source. Make sure + # apple-touch-icon is specified first to avoid this. + if ( $wgAppleTouchIcon !== false ) { + $tags[] = Html::element( 'link', array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) ); + } + + if ( $wgFavicon !== false ) { + $tags[] = Html::element( 'link', array( 'rel' => 'shortcut icon', 'href' => $wgFavicon ) ); + } + + # OpenSearch description link + $tags[] = Html::element( 'link', array( + 'rel' => 'search', + 'type' => 'application/opensearchdescription+xml', + 'href' => wfScript( 'opensearch_desc' ), + 'title' => wfMsgForContent( 'opensearch-desc' ), + ) ); + + if ( $wgEnableAPI ) { + # Real Simple Discovery link, provides auto-discovery information + # for the MediaWiki API (and potentially additional custom API + # support such as WordPress or Twitter-compatible APIs for a + # blogging extension, etc) + $tags[] = Html::element( 'link', array( + 'rel' => 'EditURI', + 'type' => 'application/rsd+xml', + // Output a protocol-relative URL here if $wgServer is protocol-relative + // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though + 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ), PROTO_RELATIVE ), + ) ); + } + + # Language variants + if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks + && $wgContLang->hasVariants() ) { + + $urlvar = $wgContLang->getURLVariant(); + + if ( !$urlvar ) { + $variants = $wgContLang->getVariants(); + foreach ( $variants as $_v ) { + $tags[] = Html::element( 'link', array( + 'rel' => 'alternate', + 'hreflang' => $_v, + 'href' => $this->getTitle()->getLocalURL( '', $_v ) ) + ); + } + } else { + $tags[] = Html::element( 'link', array( + 'rel' => 'canonical', + 'href' => $this->getTitle()->getCanonicalUrl() + ) ); + } + } + + # Copyright + $copyright = ''; + if ( $wgRightsPage ) { + $copy = Title::newFromText( $wgRightsPage ); + + if ( $copy ) { + $copyright = $copy->getLocalURL(); + } + } + + if ( !$copyright && $wgRightsUrl ) { + $copyright = $wgRightsUrl; + } + + if ( $copyright ) { + $tags[] = Html::element( 'link', array( + 'rel' => 'copyright', + 'href' => $copyright ) + ); + } + + # Feeds + if ( $wgFeed ) { foreach( $this->getSyndicationLinks() as $format => $link ) { - # Use the page name for the title (accessed through $wgTitle since - # there's no other way). In principle, this could lead to issues - # with having the same name for different feeds corresponding to - # the same page, but we can't avoid that at this low a level. + # Use the page name for the title. In principle, this could + # lead to issues with having the same name for different feeds + # corresponding to the same page, but we can't avoid that at + # this low a level. $tags[] = $this->feedLink( $format, @@ -2617,14 +2862,14 @@ class OutputPage { # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined. # If so, use it instead. - global $wgOverrideSiteFeed, $wgSitename, $wgAdvertisedFeedTypes; $rctitle = SpecialPage::getTitleFor( 'Recentchanges' ); if ( $wgOverrideSiteFeed ) { foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) { + // Note, this->feedLink escapes the url. $tags[] = $this->feedLink( $type, - htmlspecialchars( $feedUrl ), + $feedUrl, wfMsg( "site-{$type}-feed", $wgSitename ) ); } @@ -2638,7 +2883,6 @@ class OutputPage { } } } - return implode( "\n", $tags ); } @@ -2687,8 +2931,13 @@ class OutputPage { /** * Adds inline CSS styles * @param $style_css Mixed: inline CSS + * @param $flip False or String: Set to 'flip' to flip the CSS if needed */ - public function addInlineStyle( $style_css ){ + public function addInlineStyle( $style_css, $flip = false ) { + if( $flip === 'flip' && $this->getLang()->isRTL() ) { + # If wanted, and the interface is right-to-left, flip the CSS + $style_css = CSSJanus::transform( $style_css, true, false ); + } $this->mInlineStyles .= Html::inlineStyle( $style_css ); } @@ -2696,12 +2945,14 @@ 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. * @param $sk Skin object + * + * @return string */ public function buildCssLinks( $sk ) { $ret = ''; // Add ResourceLoader styles // Split the styles into four groups - $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array() ); + $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() ); $resourceLoader = $this->getResourceLoader(); foreach ( $this->getModuleStyles() as $name ) { $group = $resourceLoader->getModule( $name )->getGroup(); @@ -2714,19 +2965,19 @@ class OutputPage { // dynamically added styles to override statically added styles from other modules. So the order // has to be other, dynamic, site, private, user // Add statically added styles for other modules - $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], 'styles' ); + $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], ResourceLoaderModule::TYPE_STYLES ); // Add normal styles added through addStyle()/addInlineStyle() here $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles; // Add marker tag to mark the place where the client-side loader should inject dynamic styles // We use a <meta> tag with a made-up name for this because that's valid HTML - $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ); - + $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ) . "\n"; + // Add site, private and user styles // 'private' at present only contains user.options, so put that before 'user' // Any future private modules will likely have a similar user-specific character - foreach ( array( 'site', 'private', 'user' ) as $group ) { - $ret .= $this->makeResourceLoaderLink( - $sk, array_merge( $styles['site'], $styles['user'] ), 'styles' + foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) { + $ret .= $this->makeResourceLoaderLink( $sk, $styles[$group], + ResourceLoaderModule::TYPE_STYLES ); } return $ret; @@ -2753,8 +3004,7 @@ class OutputPage { */ protected function styleLink( $style, $options ) { if( isset( $options['dir'] ) ) { - $siteDir = wfUILang()->getDir(); - if( $siteDir != $options['dir'] ) { + if( $this->getLang()->getDir() != $options['dir'] ) { return ''; } } @@ -2826,43 +3076,6 @@ class OutputPage { } /** - * Turn off regular page output and return an error reponse - * for when rate limiting has triggered. - */ - public function rateLimited() { - $this->setPageTitle( wfMsg( 'actionthrottled' ) ); - $this->setRobotPolicy( 'noindex,follow' ); - $this->setArticleRelated( false ); - $this->enableClientCache( false ); - $this->mRedirect = ''; - $this->clearHTML(); - $this->setStatusCode( 503 ); - $this->addWikiMsg( 'actionthrottledtext' ); - - $this->returnToMain( null, $this->getTitle() ); - } - - /** - * Show a warning about slave lag - * - * If the lag is higher than $wgSlaveLagCritical seconds, - * then the warning is a bit more obvious. If the lag is - * lower than $wgSlaveLagWarning, then no warning is shown. - * - * @param $lag Integer: slave lag - */ - public function showLagWarning( $lag ) { - global $wgSlaveLagWarning, $wgSlaveLagCritical, $wgLang; - if( $lag >= $wgSlaveLagWarning ) { - $message = $lag < $wgSlaveLagCritical - ? 'lag-warn-normal' - : 'lag-warn-high'; - $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" ); - $this->wrapWikiMsg( "$wrap\n", array( $message, $wgLang->formatNum( $lag ) ) ); - } - } - - /** * Add a wikitext-formatted message to the output. * This is equivalent to: * @@ -2880,6 +3093,10 @@ class OutputPage { * instead of a variable argument list. * * $options is passed through to wfMsgExt(), see that function for details. + * + * @param $name string + * @param $args array + * @param $options array */ public function addWikiMsgArray( $name, $args, $options = array() ) { $options[] = 'parse'; @@ -2910,6 +3127,8 @@ class OutputPage { * $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" ); * * The newline after opening div is needed in some wikitext. See bug 19226. + * + * @param $wrap string */ public function wrapWikiMsg( $wrap /*, ...*/ ) { $msgSpecs = func_get_args(); @@ -2931,7 +3150,7 @@ class OutputPage { } $s = str_replace( '$' . ( $n + 1 ), wfMsgExt( $name, $options, $args ), $s ); } - $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) ); + $this->addWikiText( $s ); } /** @@ -2941,7 +3160,7 @@ 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 + * @deprecated since 1.17 */ public function includeJQuery( $modules = array() ) { return array(); |