X-Git-Url: https://git.cyclocoop.org/?a=blobdiff_plain;ds=sidebyside;f=includes%2FOutputPage.php;h=cec102a5989c2ea2fda585a440a1ef0e4bdf9803;hb=e72484da8995c0e028e396711516c16493b8be8a;hp=6b2a97d63cffba6288f165be388dc9824e17bb54;hpb=60c0474ca8d9885cf2f430f0f575f8e393f08a71;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 6b2a97d63c..cec102a598 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -1,6 +1,7 @@ array('list-contains=gzip'), - 'Cookie' => null ); + private $mVaryHeader = array( + 'Accept-Encoding' => array( 'list-contains=gzip' ), + 'Cookie' => null + ); /** * Constructor @@ -62,12 +78,23 @@ class OutputPage { $this->mAllowUserJs = $wgAllowUserJs; } + /** + * Redirect to $url rather than displaying the normal page + * + * @param $url String: URL + * @param $responsecode String: HTTP status code + */ public function redirect( $url, $responsecode = '302' ) { # Strip newlines as a paranoia check for header injection in PHP<5.1.2 $this->mRedirect = str_replace( "\n", '', $url ); $this->mRedirectCode = $responsecode; } + /** + * Get the URL to redirect to, or an empty string if not redirect URL set + * + * @return String + */ public function getRedirect() { return $this->mRedirect; } @@ -75,10 +102,12 @@ class OutputPage { /** * Set the HTTP status code to send with the output. * - * @param int $statusCode + * @param $statusCode Integer * @return nothing */ - function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; } + public function setStatusCode( $statusCode ) { + $this->mStatusCode = $statusCode; + } /** * Add a new tag @@ -91,19 +120,55 @@ class OutputPage { array_push( $this->mMetatags, array( $name, $val ) ); } + /** + * Add a keyword or a list of keywords in the page header + * + * @param $text String or array of strings + */ function addKeyword( $text ) { - if( is_array( $text )) { + if( is_array( $text ) ) { $this->mKeywords = array_merge( $this->mKeywords, $text ); } else { array_push( $this->mKeywords, $text ); } } + + /** + * Add a new \ tag to the page header + * + * @param $linkarr Array: associative array of attributes. + */ + function addLink( $linkarr ) { + array_push( $this->mLinktags, $linkarr ); + } + + /** + * Add a new \ with "rel" attribute set to "meta" + * + * @param $linkarr Array: associative array mapping attribute names to their + * values, both keys and values will be escaped, and the + * "rel" attribute will be automatically added + */ + function addMetadataLink( $linkarr ) { + # note: buggy CC software only reads first "meta" link + static $haveMeta = false; + $linkarr['rel'] = $haveMeta ? 'alternate meta' : 'meta'; + $this->addLink( $linkarr ); + $haveMeta = true; + } + + /** + * Add raw HTML to the list of scripts (including \ tag, etc.) + * + * @param $script String: raw HTML + */ function addScript( $script ) { $this->mScripts .= $script . "\n"; } /** * Register and add a stylesheet from an extension directory. + * * @param $url String path to sheet. Provide either a full url (beginning * with 'http', etc) or a relative path from the document root * (beginning with '/'). Otherwise it behaves identically to @@ -113,43 +178,137 @@ class OutputPage { array_push( $this->mExtStyles, $url ); } + /** + * Get all links added by extensions + * + * @return Array + */ + function getExtStyle() { + return $this->mExtStyles; + } + /** * Add a JavaScript file out of skins/common, or a given relative path. - * @param string $file filename in skins/common or complete on-server path (/foo/bar.js) + * + * @param $file String: filename in skins/common or complete on-server path + * (/foo/bar.js) + * @param $version String: style version of the file. Defaults to $wgStyleVersion */ - function addScriptFile( $file ) { - global $wgStylePath, $wgStyleVersion, $wgJsMimeType; - if( substr( $file, 0, 1 ) == '/' ) { + public function addScriptFile( $file, $version = null ) { + global $wgStylePath, $wgStyleVersion; + // See if $file parameter is an absolute URL or begins with a slash + if( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) { $path = $file; } else { - $path = "{$wgStylePath}/common/{$file}"; + $path = "{$wgStylePath}/common/{$file}"; } - $this->addScript( - Xml::element( 'script', - array( - 'type' => $wgJsMimeType, - 'src' => "$path?$wgStyleVersion", - ), - '', false - ) - ); + if ( is_null( $version ) ) + $version = $wgStyleVersion; + $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) ); } /** * Add a self-contained script tag with the given contents - * @param string $script JavaScript text, no " to "<script>foo&bar</script>" # but leave "foobar" alone $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) ); $this->mPagetitle = $nameWithTags; - $taction = $this->getPageTitleActionText(); + $taction = $this->getPageTitleActionText(); if( !empty( $taction ) ) { $name .= ' - '.$taction; } @@ -364,35 +571,125 @@ class OutputPage { $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) ); } + /** + * Return the "page title", i.e. the content of the \ tag. + * + * @return String + */ + public function getPageTitle() { + return $this->mPagetitle; + } + + /** + * Set the Title object to use + * + * @param $t Title object + */ public function setTitle( $t ) { $this->mTitle = $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' ); + } else { + wfDebug( __METHOD__ . " called and \$mTitle is null. Return \$wgTitle for sanity\n" ); global $wgTitle; return $wgTitle; } } - public function getHTMLTitle() { return $this->mHTMLtitle; } - public function getPageTitle() { return $this->mPagetitle; } - public function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514 - public function appendSubtitle( $str ) { $this->mSubtitle .= /*$this->parse(*/$str/*)*/; } // @bug 2514 - public function getSubtitle() { return $this->mSubtitle; } - public function isArticle() { return $this->mIsarticle; } - public function setPrintable() { $this->mPrintable = true; } - public function isPrintable() { return $this->mPrintable; } - public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery; } - public function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; } - public function getOnloadHandler() { return $this->mOnloadHandler; } - public function disable() { $this->mDoNothing = true; } - public function isDisabled() { return $this->mDoNothing; } + /** + * Replace the subtile with $str + * + * @param $str String: new value of the subtitle + */ + public function setSubtitle( $str ) { + $this->mSubtitle = /*$this->parse(*/ $str /*)*/; // @bug 2514 + } + /** + * Add $str to the subtitle + * + * @param $str String to add to the subtitle + */ + public function appendSubtitle( $str ) { + $this->mSubtitle .= /*$this->parse(*/ $str /*)*/; // @bug 2514 + } + + /** + * Get the subtitle + * + * @return String + */ + public function getSubtitle() { + return $this->mSubtitle; + } + + /** + * Set the page as printable, i.e. it'll be displayed with with all + * print styles included + */ + public function setPrintable() { + $this->mPrintable = true; + } + + /** + * Return whether the page is "printable" + * + * @return Boolean + */ + public function isPrintable() { + return $this->mPrintable; + } + + /** + * Disable output completely, i.e. calling output() will have no effect + */ + public function disable() { + $this->mDoNothing = true; + } + + /** + * Return whether the output will be completely disabled + * + * @return Boolean + */ + public function isDisabled() { + return $this->mDoNothing; + } + + /** + * Show an "add new section" link? + * + * @return Boolean + */ + public function showNewSectionLink() { + return $this->mNewSectionLink; + } + + /** + * Forcibly hide the new section link? + * + * @return Boolean + */ + public function forceHideNewSectionLink() { + return $this->mHideNewSectionLink; + } + + /** + * Add or remove feed links in the page header + * This is mainly kept for backward compatibility, see OutputPage::addFeedLink() + * for the new version + * @see addFeedLink() + * + * @param $show Boolean: true: add default feeds, false: remove all feeds + */ public function setSyndicated( $show = true ) { if ( $show ) { $this->setFeedAppendQuery( false ); @@ -401,8 +698,17 @@ class OutputPage { } } + /** + * Add default feeds to the page header + * This is mainly kept for backward compatibility, see OutputPage::addFeedLink() + * for the new version + * @see addFeedLink() + * + * @param $val String: query to append to feed links or false to output + * default links + */ public function setFeedAppendQuery( $val ) { - global $wgFeedClasses, $wgAdvertisedFeedTypes; + global $wgAdvertisedFeedTypes; $this->mFeedLinks = array(); @@ -415,18 +721,52 @@ class OutputPage { } } + /** + * Add a feed link to the page header + * + * @param $format String: feed type, should be a key of $wgFeedClasses + * @param $href String: URL + */ public function addFeedLink( $format, $href ) { - $this->mFeedLinks[$format] = $href; + global $wgAdvertisedFeedTypes; + + if ( in_array( $format, $wgAdvertisedFeedTypes ) ) { + $this->mFeedLinks[$format] = $href; + } } - public function isSyndicated() { return count($this->mFeedLinks); } + /** + * Should we output feed links for this page? + * @return Boolean + */ + public function isSyndicated() { + return count( $this->mFeedLinks ) > 0; + } - public function setArticleRelated( $v ) { - $this->mIsArticleRelated = $v; - if ( !$v ) { - $this->mIsarticle = false; - } + /** + * Return URLs for each supported syndication format for this page. + * @return array associating format keys with URLs + */ + public function getSyndicationLinks() { + return $this->mFeedLinks; + } + + /** + * Will currently always return null + * + * @return null + */ + public function getFeedAppendQuery() { + return $this->mFeedLinksAppendQuery; } + + /** + * Set whether the displayed content is related to the source of the + * corresponding article on the wiki + * Setting true will cause the change "article related" toggle to true + * + * @param $v Boolean + */ public function setArticleFlag( $v ) { $this->mIsarticle = $v; if ( $v ) { @@ -434,26 +774,71 @@ class OutputPage { } } - public function isArticleRelated() { return $this->mIsArticleRelated; } + /** + * Return whether the content displayed page is related to the source of + * the corresponding article on the wiki + * + * @return Boolean + */ + public function isArticle() { + return $this->mIsarticle; + } - public function getLanguageLinks() { return $this->mLanguageLinks; } - public function addLanguageLinks($newLinkArray) { - $this->mLanguageLinks += $newLinkArray; + /** + * Set whether this page is related an article on the wiki + * Setting false will cause the change of "article flag" toggle to false + * + * @param $v Boolean + */ + public function setArticleRelated( $v ) { + $this->mIsArticleRelated = $v; + if ( !$v ) { + $this->mIsarticle = false; + } } - public function setLanguageLinks($newLinkArray) { - $this->mLanguageLinks = $newLinkArray; + + /** + * Return whether this page is related an article on the wiki + * + * @return Boolean + */ + public function isArticleRelated() { + return $this->mIsArticleRelated; } - public function getCategoryLinks() { - return $this->mCategoryLinks; + /** + * Add new language links + * + * @param $newLinkArray Associative array mapping language code to the page + * name + */ + public function addLanguageLinks( $newLinkArray ) { + $this->mLanguageLinks += $newLinkArray; } - public function getCategories() { - return $this->mCategories; + /** + * Reset the language links and add new language links + * + * @param $newLinkArray Associative array mapping language code to the page + * name + */ + public function setLanguageLinks( $newLinkArray ) { + $this->mLanguageLinks = $newLinkArray; + } + + /** + * Get the list of language links + * + * @return Associative array mapping language code to the page name + */ + public function getLanguageLinks() { + return $this->mLanguageLinks; } /** * Add an array of categories, with names in the keys + * + * @param $categories Associative array mapping category name to its sort key */ public function addCategoryLinks( $categories ) { global $wgUser, $wgContLang; @@ -472,7 +857,7 @@ class OutputPage { $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, pp_value + $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__ ); @@ -480,8 +865,10 @@ class OutputPage { $lb->addResultToCache( LinkCache::singleton(), $res ); # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+ - $categories = array_combine( array_keys( $categories ), - array_fill( 0, count( $categories ), 'normal' ) ); + $categories = array_combine( + array_keys( $categories ), + array_fill( 0, count( $categories ), 'normal' ) + ); # Mark hidden categories foreach ( $res as $row ) { @@ -497,9 +884,11 @@ class OutputPage { $origcategory = $category; $title = Title::makeTitleSafe( NS_CATEGORY, $category ); $wgContLang->findVariantLink( $category, $title, true ); - if ( $category != $origcategory ) - if ( array_key_exists( $category, $categories ) ) + if ( $category != $origcategory ) { + if ( array_key_exists( $category, $categories ) ) { continue; + } + } $text = $wgContLang->convertHtml( $title->getText() ); $this->mCategories[] = $title->getText(); $this->mCategoryLinks[$type][] = $sk->link( $title, $text ); @@ -507,29 +896,128 @@ class OutputPage { } } - public function setCategoryLinks($categories) { + /** + * Reset the category links (but not the category list) and add $categories + * + * @param $categories Associative array mapping category name to its sort key + */ + public function setCategoryLinks( $categories ) { $this->mCategoryLinks = array(); - $this->addCategoryLinks($categories); + $this->addCategoryLinks( $categories ); + } + + /** + * Get the list of category links, in a 2-D array with the following format: + * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for + * hidden categories) and $link a HTML fragment with a link to the category + * page + * + * @return Array + */ + public function getCategoryLinks() { + return $this->mCategoryLinks; } - public function suppressQuickbar() { $this->mSuppressQuickbar = true; } - public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; } + /** + * Get the list of category names this page belongs to + * + * @return Array of strings + */ + public function getCategories() { + return $this->mCategories; + } - public function disallowUserJs() { $this->mAllowUserJs = false; } - public function isUserJsAllowed() { return $this->mAllowUserJs; } + /** + * Suppress the quickbar from the output, only for skin supporting + * the quickbar + */ + public function suppressQuickbar() { + $this->mSuppressQuickbar = true; + } - public function prependHTML( $text ) { $this->mBodytext = $text . $this->mBodytext; } - public function addHTML( $text ) { $this->mBodytext .= $text; } - public function clearHTML() { $this->mBodytext = ''; } - public function getHTML() { return $this->mBodytext; } - public function debug( $text ) { $this->mDebugtext .= $text; } + /** + * Return whether the quickbar should be suppressed from the output + * + * @return Boolean + */ + public function isQuickbarSuppressed() { + return $this->mSuppressQuickbar; + } + + /** + * Remove user JavaScript from scripts to load + */ + public function disallowUserJs() { + $this->mAllowUserJs = false; + } + + /** + * Return whether user JavaScript is allowed for this page + * + * @return Boolean + */ + public function isUserJsAllowed() { + return $this->mAllowUserJs; + } - /* @deprecated */ + /** + * Prepend $text to the body HTML + * + * @param $text String: HTML + */ + public function prependHTML( $text ) { + $this->mBodytext = $text . $this->mBodytext; + } + + /** + * Append $text to the body HTML + * + * @param $text String: HTML + */ + public function addHTML( $text ) { + $this->mBodytext .= $text; + } + + /** + * Clear the body HTML + */ + public function clearHTML() { + $this->mBodytext = ''; + } + + /** + * Get the body HTML + * + * @return String: HTML + */ + public function getHTML() { + return $this->mBodytext; + } + + /** + * Add $text to the debug output + * + * @param $text String: debug text + */ + public function debug( $text ) { + $this->mDebugtext .= $text; + } + + /** + * @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 + */ public function parserOptions( $options = null ) { if ( !$this->mParserOptions ) { $this->mParserOptions = new ParserOptions; @@ -540,40 +1028,78 @@ class OutputPage { /** * Set the revision ID which will be seen by the wiki text parser * for things such as embedded {{REVISIONID}} variable use. - * @param mixed $revid an integer, or NULL - * @return mixed previous value + * + * @param $revid Mixed: an positive integer, or null + * @return Mixed: previous value */ public function setRevisionId( $revid ) { $val = is_null( $revid ) ? null : intval( $revid ); return wfSetVar( $this->mRevisionId, $val ); } + /** + * Get the current revision ID + * + * @return Integer + */ public function getRevisionId() { return $this->mRevisionId; } /** * Convert wikitext to HTML and add it to the buffer - * Default assumes that the current page title will - * be used. + * Default assumes that the current page title will be used. * - * @param string $text - * @param bool $linestart + * @param $text String + * @param $linestart Boolean: is this the start of a line? */ public function addWikiText( $text, $linestart = true ) { $title = $this->getTitle(); // Work arround E_STRICT $this->addWikiTextTitle( $text, $title, $linestart ); } - public function addWikiTextWithTitle($text, &$title, $linestart = true) { - $this->addWikiTextTitle($text, $title, $linestart); + /** + * Add wikitext with a custom Title object + * + * @param $text String: wikitext + * @param $title Title object + * @param $linestart Boolean: is this the start of a line? + */ + public function addWikiTextWithTitle( $text, &$title, $linestart = true ) { + $this->addWikiTextTitle( $text, $title, $linestart ); } - function addWikiTextTitleTidy($text, &$title, $linestart = true) { + /** + * Add wikitext with a custom Title object and + * + * @param $text String: wikitext + * @param $title Title object + * @param $linestart Boolean: is this the start of a line? + */ + function addWikiTextTitleTidy( $text, &$title, $linestart = true ) { $this->addWikiTextTitle( $text, $title, $linestart, true ); } - public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) { + /** + * Add wikitext with tidy enabled + * + * @param $text String: wikitext + * @param $linestart Boolean: is this the start of a line? + */ + public function addWikiTextTidy( $text, $linestart = true ) { + $title = $this->getTitle(); + $this->addWikiTextTitleTidy( $text, $title, $linestart ); + } + + /** + * Add wikitext with a custom Title object + * + * @param $text String: wikitext + * @param $title Title object + * @param $linestart Boolean: is this the start of a line? + * @param $tidy Boolean: whether to use tidy + */ + public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false ) { global $wgParser; wfProfileIn( __METHOD__ ); @@ -583,8 +1109,10 @@ class OutputPage { $popts = $this->parserOptions(); $oldTidy = $popts->setTidy( $tidy ); - $parserOutput = $wgParser->parse( $text, $title, $popts, - $linestart, true, $this->mRevisionId ); + $parserOutput = $wgParser->parse( + $text, $title, $popts, + $linestart, true, $this->mRevisionId + ); $popts->setTidy( $oldTidy ); @@ -594,23 +1122,60 @@ class OutputPage { } /** - * @todo document - * @param ParserOutput object &$parserOutput + * 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 */ public function addParserOutputNoText( &$parserOutput ) { - global $wgExemptFromUserRobotsControl, $wgContentNamespaces; - $this->mLanguageLinks += $parserOutput->getLanguageLinks(); $this->addCategoryLinks( $parserOutput->getCategories() ); $this->mNewSectionLink = $parserOutput->getNewSection(); $this->mHideNewSectionLink = $parserOutput->getHideNewSection(); $this->mParseWarnings = $parserOutput->getWarnings(); - if ( $parserOutput->getCacheTime() == -1 ) { + if ( !$parserOutput->isCacheable() ) { $this->enableClientCache( false ); } $this->mNoGallery = $parserOutput->getNoGallery(); - $this->mHeadItems = array_merge( $this->mHeadItems, (array)$parserOutput->mHeadItems ); + $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] ) ) { @@ -619,15 +1184,6 @@ class OutputPage { $this->mTemplateIds[$ns] = $dbks; } } - // Page title - $dt = $parserOutput->getDisplayTitle(); - $title = $parserOutput->getTitleText(); - if ( $dt !== false ) { - $this->setPageTitle( $dt ); - } - else if ( $title != '' ) { - $this->setPageTitle( $title ); - } // Hooks registered in the object global $wgParserOutputHooks; @@ -642,64 +1198,22 @@ class OutputPage { } /** - * @todo document - * @param ParserOutput &$parserOutput + * Add a ParserOutput object + * + * @param $parserOutput ParserOutput */ function addParserOutput( &$parserOutput ) { $this->addParserOutputNoText( $parserOutput ); $text = $parserOutput->getText(); - wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) ); + wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) ); $this->addHTML( $text ); } - /** - * 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 string $text - * @param Article $article - * @param bool $cache - * @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->getCacheTime() != -1 ) { - $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 wikitext with tidy enabled - */ - public function addWikiTextTidy( $text, $linestart = true ) { - $title = $this->getTitle(); - $this->addWikiTextTitleTidy($text, $title, $linestart); - } - /** * Add the output of a QuickTemplate to the output buffer * - * @param QuickTemplate $template + * @param $template QuickTemplate */ public function addTemplate( &$template ) { ob_start(); @@ -711,9 +1225,12 @@ class OutputPage { /** * Parse wikitext and return the HTML. * - * @param string $text - * @param bool $linestart Is this the start of a line? - * @param bool $interface ?? + * @param $text String + * @param $linestart Boolean: is this the start of a line? + * @param $interface Boolean: use interface language ($wgLang instead of + * $wgContLang) while parsing language sensitive magic + * words like GRAMMAR and PLURAL + * @return String: HTML */ public function parse( $text, $linestart = true, $interface = false ) { global $wgParser; @@ -721,14 +1238,29 @@ class OutputPage { throw new MWException( 'Empty $mTitle in ' . __METHOD__ ); } $popts = $this->parserOptions(); - if ( $interface) { $popts->setInterfaceMessage(true); } - $parserOutput = $wgParser->parse( $text, $this->getTitle(), $popts, - $linestart, true, $this->mRevisionId ); - if ( $interface) { $popts->setInterfaceMessage(false); } + if ( $interface ) { + $popts->setInterfaceMessage( true ); + } + $parserOutput = $wgParser->parse( + $text, $this->getTitle(), $popts, + $linestart, true, $this->mRevisionId + ); + if ( $interface ) { + $popts->setInterfaceMessage( false ); + } return $parserOutput->getText(); } - /** Parse wikitext, strip paragraphs, and return the HTML. */ + /** + * Parse wikitext, strip paragraphs, and return the HTML. + * + * @param $text String + * @param $linestart Boolean: is this the start of a line? + * @param $interface Boolean: use interface language ($wgLang instead of + * $wgContLang) while parsing language sensitive magic + * words like GRAMMAR and PLURAL + * @return String: HTML + */ public function parseInline( $text, $linestart = true, $interface = false ) { $parsed = $this->parse( $text, $linestart, $interface ); @@ -741,18 +1273,16 @@ class OutputPage { } /** - * @param Article $article - * @param User $user - * * @deprecated * - * @return bool True if successful, else false. + * @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) { + if ( $parserOutput !== false ) { $this->addParserOutput( $parserOutput ); return true; } else { @@ -761,7 +1291,9 @@ class OutputPage { } /** - * @param int $maxage Maximum cache time on the Squid, in seconds. + * 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. */ public function setSquidMaxage( $maxage ) { $this->mSquidMaxage = $maxage; @@ -769,12 +1301,18 @@ class OutputPage { /** * Use enableClientCache(false) to force it to send nocache headers + * * @param $state ?? */ public function enableClientCache( $state ) { return wfSetVar( $this->mEnableClientCache, $state ); } + /** + * Get the list of cookies that will influence on the cache + * + * @return Array + */ function getCacheVaryCookies() { global $wgCookiePrefix, $wgCacheVaryCookies; static $cookies; @@ -787,20 +1325,28 @@ class OutputPage { ), $wgCacheVaryCookies ); - wfRunHooks('GetCacheVaryCookies', array( $this, &$cookies ) ); + wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) ); } return $cookies; } + /** + * Return whether this page is not cacheable because "useskin" or "uselang" + * URL parameters were passed. + * + * @return Boolean + */ function uncacheableBecauseRequestVars() { global $wgRequest; - return $wgRequest->getText('useskin', false) === false - && $wgRequest->getText('uselang', false) === false; + return $wgRequest->getText( 'useskin', false ) === false + && $wgRequest->getText( 'uselang', false ) === false; } /** * Check if the request has a cache-varying cookie header * If it does, it's very important that we don't allow public caching + * + * @return Boolean */ function haveCacheVaryCookies() { global $wgRequest; @@ -811,81 +1357,95 @@ class OutputPage { $cvCookies = $this->getCacheVaryCookies(); foreach ( $cvCookies as $cookieName ) { # Check for a simple string match, like the way squid does it - if ( strpos( $cookieHeader, $cookieName ) ) { - wfDebug( __METHOD__.": found $cookieName\n" ); + if ( strpos( $cookieHeader, $cookieName ) !== false ) { + wfDebug( __METHOD__ . ": found $cookieName\n" ); return true; } } - wfDebug( __METHOD__.": no cache-varying cookies found\n" ); + wfDebug( __METHOD__ . ": no cache-varying cookies found\n" ); return false; } + /** + * Add an HTTP header that will influence on the cache + * + * @param $header String: header name + * @param $option either an Array or null + */ public function addVaryHeader( $header, $option = null ) { if ( !array_key_exists( $header, $this->mVaryHeader ) ) { $this->mVaryHeader[$header] = $option; - } - elseif( is_array( $option ) ) { + } elseif( is_array( $option ) ) { if( is_array( $this->mVaryHeader[$header] ) ) { $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option ); - } - else { + } else { $this->mVaryHeader[$header] = $option; } } $this->mVaryHeader[$header] = array_unique( $this->mVaryHeader[$header] ); } - /** Get a complete X-Vary-Options header */ + /** + * Get a complete X-Vary-Options header + * + * @return String + */ public function getXVO() { $cvCookies = $this->getCacheVaryCookies(); - + $cookiesOption = array(); foreach ( $cvCookies as $cookieName ) { $cookiesOption[] = 'string-contains=' . $cookieName; } $this->addVaryHeader( 'Cookie', $cookiesOption ); - + $headers = array(); foreach( $this->mVaryHeader as $header => $option ) { $newheader = $header; - if( is_array( $option ) ) + if( is_array( $option ) ) { $newheader .= ';' . implode( ';', $option ); + } $headers[] = $newheader; } $xvo = 'X-Vary-Options: ' . implode( ',', $headers ); - + return $xvo; } - /** bug 21672: Add Accept-Language to Vary and XVO headers - if there's no 'variant' parameter existed in GET. - - For example: - /w/index.php?title=Main_page should always be served; but - /w/index.php?title=Main_page&variant=zh-cn should never be served. - - patched by Liangent and Philip */ + /** + * bug 21672: Add Accept-Language to Vary and XVO headers + * if there's no 'variant' parameter existed in GET. + * + * For example: + * /w/index.php?title=Main_page should always be served; but + * /w/index.php?title=Main_page&variant=zh-cn should never be served. + */ function addAcceptLanguage() { global $wgRequest, $wgContLang; - if( !$wgRequest->getCheck('variant') && $wgContLang->hasVariants() ) { + if( !$wgRequest->getCheck( 'variant' ) && $wgContLang->hasVariants() ) { $variants = $wgContLang->getVariants(); $aloption = array(); foreach ( $variants as $variant ) { - if( $variant === $wgContLang->getCode() ) + if( $variant === $wgContLang->getCode() ) { continue; - else + } else { $aloption[] = "string-contains=$variant"; + } } $this->addVaryHeader( 'Accept-Language', $aloption ); } } + /** + * Send cache control HTTP headers + */ public function sendCacheControl() { global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest, $wgUseXVO; $response = $wgRequest->response(); - if ($wgUseETag && $this->mETag) - $response->header("ETag: $this->mETag"); + if ( $wgUseETag && $this->mETag ) { + $response->header( "ETag: $this->mETag" ); + } $this->addAcceptLanguage(); @@ -899,8 +1459,10 @@ class OutputPage { } if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) { - if( $wgUseSquid && session_id() == '' && - ! $this->isPrintable() && $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies() ) + if( + $wgUseSquid && session_id() == '' && !$this->isPrintable() && + $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies() + ) { if ( $wgUseESI ) { # We'll purge the proxy cache explicitly, but require end user agents @@ -940,7 +1502,6 @@ class OutputPage { $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' ); $response->header( 'Pragma: no-cache' ); } - wfRunHooks('CacheHeadersAfterSet', array( $this ) ); } /** @@ -1008,12 +1569,12 @@ 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; - if( $this->mDoNothing ){ + if( $this->mDoNothing ) { return; } wfProfileIn( __METHOD__ ); @@ -1042,35 +1603,40 @@ class OutputPage { return; } elseif ( $this->mStatusCode ) { $message = self::getStatusMessage( $this->mStatusCode ); - if ( $message ) + if ( $message ) { $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message ); + } } $sk = $wgUser->getSkin(); - + + // Add base resources + $this->addModules( array( 'mediawiki.legacy.wikibits' ) ); + + // 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->addScriptFile( 'ajaxwatch.js' ); + $this->addModules( 'mediawiki.legacy.ajaxwatch' ); } - if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){ - $this->addScriptFile( 'mwsuggest.js' ); + if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ) { + $this->addModules( 'mediawiki.legacy.mwsuggest' ); } } if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) { - $this->addScriptFile( 'rightclickedit.js' ); + $this->addModules( 'mediawiki.legacy.rightclickedit' ); } if( $wgUniversalEditButton ) { if( isset( $wgArticle ) && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' ) && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) { // Original UniversalEditButton - $msg = wfMsg('edit'); + $msg = wfMsg( 'edit' ); $this->addLink( array( 'rel' => 'alternate', 'type' => 'application/x-wiki', @@ -1086,14 +1652,15 @@ class OutputPage { } } + # 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); + if ( $this->mArticleBodyOnly ) { + $this->out( $this->mBodytext ); } else { // Hook that allows last minute changes to the output page, e.g. // adding of CSS or Javascript by extensions. @@ -1112,7 +1679,8 @@ class OutputPage { /** * Actually output something with print(). Performs an iconv to the * output encoding, if needed. - * @param string $ins The string to output + * + * @param $ins String: the string to output */ public function out( $ins ) { global $wgInputEncoding, $wgOutputEncoding, $wgContLang; @@ -1120,7 +1688,9 @@ class OutputPage { $outs = $ins; } else { $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins ); - if ( false === $outs ) { $outs = $ins; } + if ( false === $outs ) { + $outs = $ins; + } } print $outs; } @@ -1130,7 +1700,6 @@ class OutputPage { */ public static function setEncodings() { global $wgInputEncoding, $wgOutputEncoding; - global $wgContLang; $wgInputEncoding = strtolower( $wgInputEncoding ); @@ -1142,9 +1711,9 @@ class OutputPage { } /** - * Deprecated, use wfReportTime() instead. - * @return string - * @deprecated + * @deprecated use wfReportTime() instead. + * + * @return String */ public function reportTime() { wfDeprecated( __METHOD__ ); @@ -1155,7 +1724,7 @@ class OutputPage { /** * Produce a "user is blocked" page. * - * @param bool $return Whether to have a "return to $wgTitle" message or not. + * @param $return Boolean: whether to have a "return to $wgTitle" message or not. * @return nothing */ function blockedPage( $return = true ) { @@ -1170,7 +1739,9 @@ class OutputPage { if( $reason == '' ) { $reason = wfMsg( 'blockednoreason' ); } - $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true ); + $blockTimestamp = $wgLang->timeanddate( + wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true + ); $ip = wfGetIP(); $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]"; @@ -1183,16 +1754,20 @@ class OutputPage { // Search for localization in 'ipboptions' $scBlockExpiryOptions = wfMsg( 'ipboptions' ); foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) { - if ( strpos( $option, ":" ) === false ) + if ( strpos( $option, ':' ) === false ) { continue; - list( $show, $value ) = explode( ":", $option ); + } + list( $show, $value ) = explode( ':', $option ); if ( $value == 'infinite' || $value == 'indefinite' ) { $blockExpiry = $show; break; } } } else { - $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true ); + $blockExpiry = $wgLang->timeanddate( + wfTimestamp( TS_MW, $blockExpiry ), + true + ); } if ( $wgUser->mBlock->mAuto ) { @@ -1202,10 +1777,13 @@ class OutputPage { } /* $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. */ + * 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 ); + $this->addWikiMsg( + $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, + $intended, $blockTimestamp + ); # Don't auto-return to special pages if( $return ) { @@ -1217,9 +1795,9 @@ class OutputPage { /** * Output a standard error page * - * @param string $title Message key for page title - * @param string $msg Message key for page text - * @param array $params Message parameters + * @param $title String: message key for page title + * @param $msg String: message key for page text + * @param $params Array: message parameters */ public function showErrorPage( $title, $msg, $params = array() ) { if ( $this->getTitle() ) { @@ -1243,10 +1821,10 @@ class OutputPage { /** * Output a standard permission error page * - * @param array $errors Error message keys + * @param $errors Array: error message keys + * @param $action String: action that was denied or null if unknown */ - public function showPermissionsErrorPage( $errors, $action = null ) - { + public function showPermissionsErrorPage( $errors, $action = null ) { $this->mDebugtext .= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n"; $this->setPageTitle( wfMsg( 'permissionserrors' ) ); @@ -1259,17 +1837,11 @@ class OutputPage { $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) ); } - /** @deprecated */ - public function errorpage( $title, $msg ) { - wfDeprecated( __METHOD__ ); - throw new ErrorPageError( $title, $msg ); - } - /** * Display an error page indicating that a given version of MediaWiki is * required to use it * - * @param mixed $version The version of MediaWiki needed to use the page + * @param $version Mixed: the version of MediaWiki needed to use the page */ public function versionRequired( $version ) { $this->setPageTitle( wfMsg( 'versionrequired', $version ) ); @@ -1285,7 +1857,7 @@ class OutputPage { /** * Display an error page noting that a given permission bit is required. * - * @param string $permission key required + * @param $permission String: key required */ public function permissionRequired( $permission ) { global $wgLang; @@ -1299,36 +1871,22 @@ class OutputPage { $groups = array_map( array( 'User', 'makeGroupLinkWiki' ), User::getGroupsWithPermission( $permission ) ); if( $groups ) { - $this->addWikiMsg( 'badaccess-groups', + $this->addWikiMsg( + 'badaccess-groups', $wgLang->commaList( $groups ), - count( $groups) ); + count( $groups ) + ); } else { $this->addWikiMsg( 'badaccess-group0' ); } $this->returnToMain(); } - /** - * Use permissionRequired. - * @deprecated - */ - public function sysopRequired() { - throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" ); - } - - /** - * Use permissionRequired. - * @deprecated - */ - public function developerRequired() { - throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" ); - } - /** * Produce the stock "please login to use the wiki" page */ public function loginToUse() { - global $wgUser, $wgContLang; + global $wgUser; if( $wgUser->isLoggedIn() ) { $this->permissionRequired( 'read' ); @@ -1351,45 +1909,48 @@ class OutputPage { array( 'known', 'noclasses' ) ); $this->addHTML( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) ); - $this->addHTML( "\n" ); + $this->addHTML( "\n' ); # Don't return to the main page if the user can't read it # otherwise we'll end up in a pointless loop $mainPage = Title::newMainPage(); - if( $mainPage->userCanRead() ) + if( $mainPage->userCanRead() ) { $this->returnToMain( null, $mainPage ); - } - - /** @deprecated */ - public function databaseError( $fname, $sql, $error, $errno ) { - throw new MWException( "OutputPage::databaseError is obsolete\n" ); + } } /** - * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors - * @return string The wikitext error-messages, formatted into a list. + * Format a list of error messages + * + * @param $errors An 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. */ public function formatPermissionsErrorMessage( $errors, $action = null ) { - if ($action == null) { - $text = wfMsgNoTrans( 'permissionserrorstext', count($errors)). "\n\n"; + if ( $action == null ) { + $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n"; } else { - global $wgLang; $action_desc = wfMsgNoTrans( "action-$action" ); - $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n"; + $text = wfMsgNoTrans( + 'permissionserrorstext-withaction', + count( $errors ), + $action_desc + ) . "\n\n"; } - if (count( $errors ) > 1) { + if ( count( $errors ) > 1 ) { $text .= '
    ' . "\n"; - foreach( $errors as $error ) - { + foreach( $errors as $error ) { $text .= '
  • '; $text .= call_user_func_array( 'wfMsgNoTrans', $error ); $text .= "
  • \n"; } $text .= '
'; } else { - $text .= "
\n" . call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . "\n
"; + $text .= "
\n" . + call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . + "\n
"; } return $text; @@ -1410,9 +1971,10 @@ class OutputPage { * * @todo Needs to be split into multiple functions. * - * @param string $source Source code to show (or null). - * @param bool $protected Is this a permissions error? - * @param array $reasons List of reasons for this error, as returned by Title::getUserPermissionsErrors(). + * @param $source String: source code to show (or null). + * @param $protected Boolean: is this a permissions error? + * @param $reasons Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors(). + * @param $action String: action that was denied or null if unknown */ public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) { global $wgUser; @@ -1423,25 +1985,16 @@ class OutputPage { // If no reason is given, just supply a default "I can't let you do // that, Dave" message. Should only occur if called by legacy code. - if ( $protected && empty($reasons) ) { + if ( $protected && empty( $reasons ) ) { $reasons[] = array( 'badaccess-group0' ); } - if ( !empty($reasons) ) { + if ( !empty( $reasons ) ) { // Permissions error if( $source ) { $this->setPageTitle( wfMsg( 'viewsource' ) ); $this->setSubtitle( - wfMsg( - 'viewsourcefor', - $skin->link( - $this->getTitle(), - null, - array(), - array(), - array( 'known', 'noclasses' ) - ) - ) + wfMsg( 'viewsourcefor', $skin->linkKnown( $this->getTitle() ) ) ); } else { $this->setPageTitle( wfMsg( 'badaccess' ) ); @@ -1451,7 +2004,7 @@ class OutputPage { // Wiki is read only $this->setPageTitle( wfMsg( 'readonly' ) ); $reason = wfReadOnlyReason(); - $this->wrapWikiMsg( '
\n$1
', array( 'readonlytext', $reason ) ); + $this->wrapWikiMsg( "
\n$1\n
", array( 'readonlytext', $reason ) ); } // Show source, if supplied @@ -1484,6 +2037,39 @@ class OutputPage { } } + /** + * Adds JS-based password security checker + * @param $passwordId String ID of input box containing password + * @param $retypeId String ID of input box containing retyped password + * @return none + */ + public function addPasswordSecurity( $passwordId, $retypeId ) { + $this->includeJQuery(); + $data = array( + 'password' => '#' . $passwordId, + 'retype' => '#' . $retypeId, + 'messages' => array(), + ); + foreach ( array( 'password-strength', 'password-strength-bad', 'password-strength-mediocre', + 'password-strength-acceptable', 'password-strength-good', 'password-retype', 'password-retype-mismatch' + ) as $message ) { + $data['messages'][$message] = wfMsg( $message ); + } + $this->addScript( Html::inlineScript( 'var passwordSecurity=' . FormatJson::encode( $data ) ) ); + $this->addModules( 'mediawiki.legacy.password' ); + } + + /** @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__ ); @@ -1521,8 +2107,8 @@ class OutputPage { } public function showFatalError( $message ) { - $this->setPageTitle( wfMsg( "internalerror" ) ); - $this->setRobotPolicy( "noindex,nofollow" ); + $this->setPageTitle( wfMsg( 'internalerror' ) ); + $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); $this->enableClientCache( false ); $this->mRedirect = ''; @@ -1554,12 +2140,15 @@ class OutputPage { * * @param $title Title to link * @param $query String: query string + * @param $text String text of the link (input is not escaped) */ - public function addReturnTo( $title, $query = array() ) { + 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, null, array(), $query ) ); + $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) ); + $link = wfMsgHtml( + 'returnto', + $wgUser->getSkin()->link( $title, $text, array(), $query ) + ); $this->addHTML( "

{$link}

\n" ); } @@ -1599,119 +2188,228 @@ class OutputPage { } /** - * @return string The doctype, opening , and head element. - * * @param $sk Skin The given Skin + * @param $includeStyle Boolean: unused + * @return String: The doctype, opening , and head element. */ public function headElement( Skin $sk, $includeStyle = true ) { - global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType; - global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces, $wgHtml5Version; - global $wgContLang, $wgUseTrackbacks, $wgStyleVersion, $wgHtml5, $wgWellFormedXml; + global $wgOutputEncoding, $wgMimeType; + global $wgUseTrackbacks, $wgHtml5; + global $wgUser, $wgRequest, $wgLang; - $this->addMeta( "http:Content-Type", "$wgMimeType; charset={$wgOutputEncoding}" ); if ( $sk->commonPrintStylesheet() ) { - $this->addStyle( 'common/wikiprintable.css', 'print' ); + $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' ); } $sk->setupUserCss( $this ); - $ret = ''; - - if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) { - $ret .= "\n"; - } + $ret = Html::htmlHeader( array( 'lang' => wfUILang()->getCode() ) ); if ( $this->getHTMLTitle() == '' ) { - $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() )); + $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) ); } - $dir = $wgContLang->getDir(); + $openHead = Html::openElement( 'head' ); + if ( $openHead ) { + # Don't bother with the newline if $head == '' + $ret .= "$openHead\n"; + } if ( $wgHtml5 ) { - if ( $wgWellFormedXml ) { - # Unknown elements and attributes are okay in XML, but unknown - # named entities are well-formedness errors and will break XML - # parsers. Thus we need a doctype that gives us appropriate - # entity definitions. The HTML5 spec permits four legacy - # doctypes as obsolete but conforming, so let's pick one of - # those, although it makes our pages look like XHTML1 Strict. - # Isn't compatibility great? - $ret .= "\n"; - } else { - # Much saner. - $ret .= "\n"; - } - $ret .= ", has the + # same effect + $ret .= Html::element( 'meta', array( 'charset' => $wgOutputEncoding ) ) . "\n"; } else { - $ret .= "\n"; - $ret .= " $ns) { - $ret .= "xmlns:{$tag}=\"{$ns}\" "; - } - $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" dir=\"$dir\">\n"; + $this->addMeta( 'http:Content-Type', "$wgMimeType; charset=$wgOutputEncoding" ); } - $ret .= "\n"; - $ret .= "" . htmlspecialchars( $this->getHTMLTitle() ) . "\n"; + $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n"; + $ret .= implode( "\n", array( - $this->getHeadLinks(), + $this->getHeadLinks( $sk ), $this->buildCssLinks(), - $this->getHeadScripts( $sk ), $this->getHeadItems(), - )); - if( $sk->usercss ){ + ) ); + if ( $sk->usercss ) { $ret .= Html::inlineStyle( $sk->usercss ); } - if ($wgUseTrackbacks && $this->isArticleRelated()) + if ( $wgUseTrackbacks && $this->isArticleRelated() ) { $ret .= $this->getTitle()->trackbackRDF(); + } - $ret .= "\n"; - return $ret; - } + $closeHead = Html::closeElement( 'head' ); + if ( $closeHead ) { + $ret .= "$closeHead\n"; + } - /* - * gets the global variables and mScripts - * - * also adds userjs to the end if enabled: - */ - function getHeadScripts( Skin $sk ) { - global $wgUser, $wgRequest, $wgJsMimeType, $wgUseSiteJs; - global $wgStylePath, $wgStyleVersion; + $bodyAttrs = array(); - $scripts = Skin::makeGlobalVariablesScript( $sk->getSkinName() ); - $scripts .= Html::linkedScript( "{$wgStylePath}/common/wikibits.js?$wgStyleVersion" ); + # Crazy edit-on-double-click stuff + $action = $wgRequest->getVal( 'action', 'view' ); - //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() ) - ) - ); + if ( + $this->getTitle()->getNamespace() != NS_SPECIAL && + !in_array( $action, array( 'edit', 'submit' ) ) && + $wgUser->getOption( 'editondblclick' ) + ) + { + $bodyAttrs['ondblclick'] = "document.location = '" . Xml::escapeJsString( $this->getTitle()->getEditURL() ) . "'"; } - //add user js if enabled: - if( $this->isUserJsAllowed() && $wgUser->isLoggedIn() ) { + # Class bloat + $dir = wfUILang()->getDir(); + $bodyAttrs['class'] = "mediawiki $dir"; + + if ( $wgLang->capitalizeAllNouns() ) { + # A 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() ); + + $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n"; + + return $ret; + } + + static function makeResourceLoaderLink( $skin, $modules, $only ) { + global $wgUser, $wgLang, $wgRequest, $wgLoadScript; + // TODO: Should this be a static function of ResourceLoader instead? + // TODO: Divide off modules starting with "user", and add the user parameter to them + $query = array( + 'lang' => $wgLang->getCode(), + 'debug' => ( $wgRequest->getBool( 'debug' ) && $wgRequest->getVal( 'debug' ) == 'true' ) ? 'true' : 'false', + 'skin' => $wgUser->getSkin()->getSkinName(), + 'only' => $only, + ); + $moduleGroups = array( null => array(), 'user' => array() ); + foreach ( (array) $modules as $name ) { + $moduleGroups[strpos( $name, 'user' ) === 0 ? 'user' : null][] = $name; + } + $links = ''; + foreach ( $moduleGroups as $group => $modules ) { + if ( count( $modules ) ) { + sort( $modules ); + $query['modules'] = implode( '|', array_unique( (array) $modules ) ); + if ( $group === 'user' && $wgUser->isLoggedIn() ) { + $query['user'] = $wgUser->getName(); + } + // 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 upon change + $timestamp = 0; + foreach ( $modules as $name ) { + $module = ResourceLoader::getModule( $name ); + if ( + $module instanceof ResourceLoaderWikiModule || + $module instanceof ResourceLoaderUserPreferencesModule + ) { + $timestamp = max( + $timestamp, + $module->getModifiedTime( new ResourceLoaderContext( new FauxRequest( $query ) ) ) + ); + } + } + // Add a version parameter if any of the modules were user-changable + if ( $timestamp ) { + $query['version'] = wfTimestamp( TS_ISO_8601, round( $timestamp, -2 ) ); + } + // Make queries uniform in order + ksort( $query ); + // Automatically select style/script elements + if ( $only === 'styles' ) { + $links .= Html::linkedStyle( wfAppendQuery( $wgLoadScript, $query ) ); + } else { + $links .= Html::linkedScript( wfAppendQuery( $wgLoadScript, $query ) ); + } + } + } + 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 + * but at the bottom of the + * + * @param $sk Skin object to use + * @return String: HTML fragment + */ + function getHeadScripts( Skin $sk ) { + global $wgUser, $wgRequest; + global $wgUseSiteJs; + + // Statup - this will immediately load jquery and mediawiki modules + $scripts = self::makeResourceLoaderLink( $sk, 'startup', 'scripts' ); + + // Configuration -- This could be merged together with the load and go, but makeGlobalVariablesScript returns a + // whole script tag -- grumble grumble... + $scripts .= Skin::makeGlobalVariablesScript( $sk->getSkinName() ) . "\n"; + + // Script and Messages "only" + if ( $wgRequest->getBool( 'debug' ) && $wgRequest->getVal( 'debug' ) !== 'false' ) { + // Scripts + foreach ( $this->getModuleScripts() as $name ) { + $scripts .= self::makeResourceLoaderLink( $sk, $name, 'scripts' ); + } + // Messages + foreach ( $this->getModuleMessages() as $name ) { + $scripts .= self::makeResourceLoaderLink( $sk, $name, 'messages' ); + } + } else { + // Scripts + if ( count( $this->getModuleScripts() ) ) { + $scripts .= self::makeResourceLoaderLink( $sk, $this->getModuleScripts(), 'scripts' ); + } + // Messages + if ( count( $this->getModuleMessages() ) ) { + $scripts .= self::makeResourceLoaderLink( $sk, $this->getModuleMessages(), 'messages' ); + } + } + + // Modules - let the client calculate dependencies and batch requests as it likes + if ( $this->getModules() ) { + $modules = FormatJson::encode( $this->getModules() ); + $scripts .= Html::inlineScript( + "if ( mediaWiki !== undefined ) { mediaWiki.loader.load( {$modules} ); mediaWiki.loader.go(); }" + ); + } + + // 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() and $sk->userCanPreview( $action ) ) { + if( $this->mTitle && $this->mTitle->isJsSubpage() && $sk->userCanPreview( $action ) ) { # XXX: additional security check/prompt? $this->addInlineScript( $wgRequest->getText( 'wpTextbox1' ) ); } else { - $userpage = $wgUser->getUserPage(); - $userjs = Skin::makeUrl( - $userpage->getPrefixedText() . '/' . $sk->getSkinName() . '.js', - 'action=raw&ctype=' . $wgJsMimeType ); - $this->addScriptFile( $userjs ); + $scripts .= self::makeResourceLoaderLink( $sk, array( 'user', 'user.options' ), 'scripts' ); + $userOptionsAdded = true; } } - + if ( !$userOptionsAdded ) { + $scripts .= self::makeResourceLoaderLink( $sk, 'user.options', 'scripts' ); + } $scripts .= "\n" . $this->mScripts; + + // Add site JS if enabled + if ( $wgUseSiteJs ) { + $scripts .= self::makeResourceLoaderLink( $sk, 'site', 'scripts' ); + } + return $scripts; } + /** + * Add default \ tags + */ protected function addDefaultMeta() { global $wgVersion, $wgHtml5; @@ -1723,7 +2421,7 @@ class OutputPage { $called = true; if ( !$wgHtml5 ) { - $this->addMeta( 'http:Content-Style-Type', 'text/css' ); //bug 15835 + $this->addMeta( 'http:Content-Style-Type', 'text/css' ); // bug 15835 } $this->addMeta( 'generator', "MediaWiki $wgVersion" ); @@ -1739,15 +2437,22 @@ class OutputPage { "/<.*?" . ">/" => '', "/_/" => ' ' ); - $this->addMeta( 'keywords', preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ) ) ); + $this->addMeta( + 'keywords', + 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() { - global $wgRequest, $wgFeed; + public function getHeadLinks( $sk ) { + global $wgFeed, $wgRequest; // Ideally this should happen earlier, somewhere. :P $this->addDefaultMeta(); @@ -1764,7 +2469,9 @@ class OutputPage { $tags[] = Html::element( 'meta', array( $a => $tag[0], - 'content' => $tag[1] ) ); + 'content' => $tag[1] + ) + ); } foreach ( $this->mLinktags as $tag ) { $tags[] = Html::element( 'link', $tag ); @@ -1781,7 +2488,8 @@ class OutputPage { $format, $link, # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep) - wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() ) ); + wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() ) + ); } # Recent changes feed should appear on every page (except recentchanges, @@ -1792,66 +2500,81 @@ class OutputPage { # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined. # If so, use it instead. - global $wgOverrideSiteFeed, $wgSitename, $wgFeedClasses, $wgAdvertisedFeedTypes; + global $wgOverrideSiteFeed, $wgSitename, $wgAdvertisedFeedTypes; $rctitle = SpecialPage::getTitleFor( 'Recentchanges' ); if ( $wgOverrideSiteFeed ) { foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) { - $tags[] = $this->feedLink ( + $tags[] = $this->feedLink( $type, htmlspecialchars( $feedUrl ), - wfMsg( "site-{$type}-feed", $wgSitename ) ); + wfMsg( "site-{$type}-feed", $wgSitename ) + ); } } elseif ( $this->getTitle()->getPrefixedText() != $rctitle->getPrefixedText() ) { foreach ( $wgAdvertisedFeedTypes as $format ) { $tags[] = $this->feedLink( $format, $rctitle->getLocalURL( "feed={$format}" ), - wfMsg( "site-{$format}-feed", $wgSitename ) ); # For grep: 'site-rss-feed', 'site-atom-feed'. + wfMsg( "site-{$format}-feed", $wgSitename ) # For grep: 'site-rss-feed', 'site-atom-feed'. + ); } } } + // Support individual script requests in debug mode + if ( $wgRequest->getBool( 'debug' ) && $wgRequest->getVal( 'debug' ) !== 'false' ) { + foreach ( $this->getModuleStyles() as $name ) { + $tags[] = self::makeResourceLoaderLink( $sk, $name, 'styles' ); + } + } else { + if ( count( $this->getModuleStyles() ) ) { + $tags[] = self::makeResourceLoaderLink( $sk, $this->getModuleStyles(), 'styles' ); + } + } + return implode( "\n", $tags ); } /** - * Return URLs for each supported syndication format for this page. - * @return array associating format keys with URLs - */ - public function getSyndicationLinks() { - return $this->mFeedLinks; - } - - /** - * Generate a for an RSS feed. + * Generate a for a feed. + * + * @param $type String: feed type + * @param $url String: URL to the feed + * @param $text String: value of the "title" attribute + * @return String: HTML fragment */ private function feedLink( $type, $url, $text ) { return Html::element( 'link', array( 'rel' => 'alternate', 'type' => "application/$type+xml", 'title' => $text, - 'href' => $url ) ); + 'href' => $url ) + ); } /** * Add a local or specified stylesheet, with the given media options. * Meant primarily for internal use... * - * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any. - * @param $conditional -- for IE conditional comments, specifying an IE version - * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets + * @param $style String: URL to the file + * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any. + * @param $condition String: for IE conditional comments, specifying an IE version + * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets */ - public function addStyle( $style, $media='', $condition='', $dir='' ) { + public function addStyle( $style, $media = '', $condition = '', $dir = '' ) { $options = array(); // Even though we expect the media type to be lowercase, but here we // force it to lowercase to be safe. - if( $media ) + if( $media ) { $options['media'] = $media; - if( $condition ) + } + if( $condition ) { $options['condition'] = $condition; - if( $dir ) + } + if( $dir ) { $options['dir'] = $dir; + } $this->styles[$style] = $options; } @@ -1868,24 +2591,34 @@ class OutputPage { * These will be applied to various media & IE conditionals. */ public function buildCssLinks() { + return implode( "\n", $this->buildCssLinksArray() ); + } + + public function buildCssLinksArray() { $links = array(); foreach( $this->styles as $file => $options ) { $link = $this->styleLink( $file, $options ); - if( $link ) - $links[] = $link; + if( $link ) { + $links[$file] = $link; + } } - - return implode( "\n", $links ); + return $links; } + /** + * Generate \ tags for stylesheets + * + * @param $style String: URL to the file + * @param $options Array: option, can contain 'condition', 'dir', 'media' + * keys + * @return String: HTML fragment + */ protected function styleLink( $style, $options ) { - global $wgRequest; - if( isset( $options['dir'] ) ) { - global $wgContLang; - $siteDir = $wgContLang->getDir(); - if( $siteDir != $options['dir'] ) + $siteDir = wfUILang()->getDir(); + if( $siteDir != $options['dir'] ) { return ''; + } } if( isset( $options['media'] ) ) { @@ -1915,6 +2648,12 @@ class OutputPage { return $link; } + /** + * Transform "media" attribute based on request parameters + * + * @param $media String: current value of the "media" attribute + * @return String: modified value of the "media" attribute + */ function transformCssMedia( $media ) { global $wgRequest, $wgHandheldForIPhone; @@ -1953,37 +2692,18 @@ class OutputPage { * for when rate limiting has triggered. */ public function rateLimited() { - - $this->setPageTitle(wfMsg('actionthrottled')); + $this->setPageTitle( wfMsg( 'actionthrottled' ) ); $this->setRobotPolicy( 'noindex,follow' ); $this->setArticleRelated( false ); $this->enableClientCache( false ); $this->mRedirect = ''; $this->clearHTML(); - $this->setStatusCode(503); + $this->setStatusCode( 503 ); $this->addWikiMsg( 'actionthrottledtext' ); $this->returnToMain( null, $this->getTitle() ); } - /** - * Show an "add new section" link? - * - * @return bool - */ - public function showNewSectionLink() { - return $this->mNewSectionLink; - } - - /** - * Forcibly hide the new section link? - * - * @return bool - */ - public function forceHideNewSectionLink() { - return $this->mHideNewSectionLink; - } - /** * Show a warning about slave lag * @@ -1991,7 +2711,7 @@ class OutputPage { * then the warning is a bit more obvious. If the lag is * lower than $wgSlaveLagWarning, then no warning is shown. * - * @param int $lag Slave lag + * @param $lag Integer: slave lag */ public function showLagWarning( $lag ) { global $wgSlaveLagWarning, $wgSlaveLagCritical, $wgLang; @@ -2045,11 +2765,11 @@ class OutputPage { * * For example: * - * $wgOut->wrapWikiMsg( "
\n$1
", 'some-error' ); + * $wgOut->wrapWikiMsg( "
\n$1\n
", 'some-error' ); * * Is equivalent to: * - * $wgOut->addWikiText( "
\n" . wfMsgNoTrans( 'some-error' ) . '
' ); + * $wgOut->addWikiText( "
\n" . wfMsgNoTrans( 'some-error' ) . "\n
" ); * * The newline after opening div is needed in some wikitext. See bug 19226. */ @@ -2075,4 +2795,18 @@ class OutputPage { } $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) ); } + + /** + * Include jQuery core. Use this to avoid loading it multiple times + * before we get a usable script loader. + * + * @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() ) { + return array(); + } + }