X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=includes%2FOutputPage.php;h=a135166e66c7d877140689063dbc12b3c630fc14;hb=0e3ed4741cad61b29dc86eee268e499f3512079d;hp=5a908b67e81e8b203b6148b21a008ec9b906e5e4;hpb=9ff4fc77058c86060f899a35760075e10b37a41c;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 5a908b67e8..a135166e66 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -50,13 +50,14 @@ class OutputPage { /** * Whether to load jQuery core. */ - protected $mIncludeJQuery = false; + protected $mJQueryDone = false; private $mIndexPolicy = 'index'; private $mFollowPolicy = 'follow'; private $mVaryHeader = array( 'Accept-Encoding' => array('list-contains=gzip'), 'Cookie' => null ); + /** * Constructor * Initialise private variables @@ -66,12 +67,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; } @@ -79,10 +91,13 @@ 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 @@ -95,19 +110,56 @@ 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 @@ -117,35 +169,54 @@ 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) */ - function addScriptFile( $file ) { + public function addScriptFile( $file ) { global $wgStylePath, $wgStyleVersion; - if( substr( $file, 0, 1 ) == '/' ) { + if( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) { $path = $file; } else { $path = "{$wgStylePath}/common/{$file}"; } - $this->addScript( Html::linkedScript( "$path?$wgStyleVersion" ) ); + $this->addScript( Html::linkedScript( wfAppendQuery( $path, $wgStyleVersion ) ) ); } /** * Add a self-contained script tag with the given contents - * @param string $script JavaScript text, no " to "<script>foo&bar</script>" @@ -358,31 +482,120 @@ 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 { + } else { wfDebug( __METHOD__ . ' called and $mTitle is null. Return $wgTitle for sanity' ); 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 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 @@ -410,7 +623,7 @@ class OutputPage { * default links */ public function setFeedAppendQuery( $val ) { - global $wgFeedClasses, $wgAdvertisedFeedTypes; + global $wgAdvertisedFeedTypes; $this->mFeedLinks = array(); @@ -434,20 +647,37 @@ class OutputPage { } /** - * Return the number of feed links that will be added to the page header - * + * Should we output feed links for this page? * @return Boolean */ - public function isSyndicated() { return count($this->mFeedLinks); } + public function isSyndicated() { + return count( $this->mFeedLinks ) > 0; + } - public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery; } + /** + * Return URLs for each supported syndication format for this page. + * @return array associating format keys with URLs + */ + public function getSyndicationLinks() { + return $this->mFeedLinks; + } - public function setArticleRelated( $v ) { - $this->mIsArticleRelated = $v; - if ( !$v ) { - $this->mIsarticle = false; - } + /** + * 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 ) { @@ -455,26 +685,73 @@ 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) { + /** + * 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; + } + } + + /** + * Return whether this page is related an article on the wiki + * + * @return Boolean + */ + public function isArticleRelated() { + return $this->mIsArticleRelated; + } + + + /** + * Add new language links + * + * @param $newLinkArray Associative array mapping language code to the page + * name + */ + public function addLanguageLinks( $newLinkArray ) { $this->mLanguageLinks += $newLinkArray; } - public function setLanguageLinks($newLinkArray) { + + /** + * 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; } - public function getCategoryLinks() { - return $this->mCategoryLinks; + /** + * Get the list of language links + * + * @return Associative array mapping language code to the page name + */ + public function getLanguageLinks() { + return $this->mLanguageLinks; } - public function getCategories() { - return $this->mCategories; - } /** * 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; @@ -504,53 +781,157 @@ class OutputPage { $categories = array_combine( array_keys( $categories ), array_fill( 0, count( $categories ), 'normal' ) ); - # Mark hidden categories - foreach ( $res as $row ) { - if ( isset( $row->pp_value ) ) { - $categories[$row->page_title] = 'hidden'; - } - } + # Mark hidden categories + foreach ( $res as $row ) { + if ( isset( $row->pp_value ) ) { + $categories[$row->page_title] = 'hidden'; + } + } + + # 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 ); + $wgContLang->findVariantLink( $category, $title, true ); + 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 ); + } + } + } + + /** + * 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 ); + } + + /** + * 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; + } + + /** + * Get the list of category names this page belongs to + * + * @return Array of strings + */ + public function getCategories() { + return $this->mCategories; + } + + + /** + * Suppress the quickbar from the output, only for skin supporting + * the quickbar + */ + public function suppressQuickbar() { + $this->mSuppressQuickbar = true; + } + + /** + * 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; + } + + + /** + * Prepend $text to the body HTML + * + * @param $text String: HTML + */ + public function prependHTML( $text ) { + $this->mBodytext = $text . $this->mBodytext; + } - # 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 ); - $wgContLang->findVariantLink( $category, $title, true ); - 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 ); - } - } + /** + * Append $text to the body HTML + * + * @param $text String: HTML + */ + public function addHTML( $text ) { + $this->mBodytext .= $text; } - public function setCategoryLinks($categories) { - $this->mCategoryLinks = array(); - $this->addCategoryLinks($categories); + /** + * Clear the body HTML + */ + public function clearHTML() { + $this->mBodytext = ''; } - public function suppressQuickbar() { $this->mSuppressQuickbar = true; } - public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; } + /** + * Get the body HTML + * + * @return String: HTML + */ + public function getHTML() { + return $this->mBodytext; + } - public function disallowUserJs() { $this->mAllowUserJs = false; } - public function isUserJsAllowed() { return $this->mAllowUserJs; } - 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; } + /** + * Add $text to the debug output + * + * @param $text String: debug text + */ + public function debug( $text ) { + $this->mDebugtext .= $text; + } + - /* @deprecated */ + /** + * @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; @@ -561,40 +942,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__ ); @@ -615,8 +1034,45 @@ 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->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 a ParserOutput object, but without Html + * + * @param $parserOutput ParserOutput object */ public function addParserOutputNoText( &$parserOutput ) { global $wgExemptFromUserRobotsControl, $wgContentNamespaces; @@ -640,11 +1096,6 @@ class OutputPage { $this->mTemplateIds[$ns] = $dbks; } } - // Page title - $title = $parserOutput->getTitleText(); - if ( $title != '' ) { - $this->setPageTitle( $title ); - } // Hooks registered in the object global $wgParserOutputHooks; @@ -659,8 +1110,9 @@ class OutputPage { } /** - * @todo document - * @param ParserOutput &$parserOutput + * Add a ParserOutput object + * + * @param $parserOutput ParserOutput */ function addParserOutput( &$parserOutput ) { $this->addParserOutputNoText( $parserOutput ); @@ -669,54 +1121,11 @@ class OutputPage { $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(); @@ -728,9 +1137,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; @@ -745,7 +1157,16 @@ class OutputPage { 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 ); @@ -758,12 +1179,10 @@ 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__ ); @@ -778,7 +1197,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; @@ -786,12 +1207,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; @@ -809,15 +1236,23 @@ class OutputPage { 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 + 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; @@ -837,6 +1272,12 @@ class OutputPage { 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; @@ -852,7 +1293,11 @@ class OutputPage { $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(); @@ -874,14 +1319,14 @@ class OutputPage { 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() ) { @@ -897,6 +1342,9 @@ class OutputPage { } } + /** + * Send cache control HTTP headers + */ public function sendCacheControl() { global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest, $wgUseXVO; @@ -957,7 +1405,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 ) ); } /** @@ -1028,7 +1475,7 @@ class OutputPage { global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType; global $wgUseAjax, $wgAjaxWatch; global $wgEnableMWSuggest, $wgUniversalEditButton; - global $wgArticle; + global $wgArticle, $wgJQueryOnEveryPage; if( $this->mDoNothing ){ return; @@ -1071,6 +1518,7 @@ class OutputPage { wfRunHooks( 'AjaxAddScript', array( &$this ) ); if( $wgAjaxWatch && $wgUser->isLoggedIn() ) { + $this->includeJQuery(); $this->addScriptFile( 'ajaxwatch.js' ); } @@ -1102,6 +1550,10 @@ class OutputPage { ) ); } } + + if ( $wgJQueryOnEveryPage ) { + $this->includeJQuery(); + } # Buffer output; final headers may depend on later processing ob_start(); @@ -1129,7 +1581,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; @@ -1159,9 +1612,9 @@ class OutputPage { } /** - * Deprecated, use wfReportTime() instead. - * @return string - * @deprecated + * @deprecated use wfReportTime() instead. + * + * @return String */ public function reportTime() { wfDeprecated( __METHOD__ ); @@ -1172,7 +1625,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 ) { @@ -1234,9 +1687,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() ) { @@ -1260,10 +1713,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' ) ); @@ -1276,17 +1729,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 ) ); @@ -1302,7 +1749,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; @@ -1326,16 +1773,14 @@ class OutputPage { } /** - * Use permissionRequired. - * @deprecated + * @deprecated use permissionRequired() */ public function sysopRequired() { throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" ); } /** - * Use permissionRequired. - * @deprecated + * @deprecated use permissionRequired() */ public function developerRequired() { throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" ); @@ -1377,14 +1822,12 @@ class OutputPage { $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) { @@ -1427,9 +1870,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; @@ -1468,7 +1912,7 @@ class OutputPage { // Wiki is read only $this->setPageTitle( wfMsg( 'readonly' ) ); $reason = wfReadOnlyReason(); - $this->wrapWikiMsg( '
\n$1
', array( 'readonlytext', $reason ) ); + $this->wrapWikiMsg( "
\n$1
", array( 'readonlytext', $reason ) ); } // Show source, if supplied @@ -1501,6 +1945,17 @@ 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__ ); @@ -1571,12 +2026,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 ) ); + $link = wfMsgHtml( + 'returnto', + $wgUser->getSkin()->link( $title, $text, array(), $query ) + ); $this->addHTML( "

{$link}

\n" ); } @@ -1616,76 +2074,62 @@ class OutputPage { } /** - * @return string The doctype, opening , and head element. - * * @param $sk Skin The given Skin + * @param $includeStyle 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 $wgContLanguageCode, $wgOutputEncoding, $wgMimeType; + global $wgContLang, $wgUseTrackbacks, $wgStyleVersion, $wgHtml5; global $wgUser, $wgRequest, $wgLang; - $this->addMeta( "http:Content-Type", "$wgMimeType; charset={$wgOutputEncoding}" ); if ( $sk->commonPrintStylesheet() ) { $this->addStyle( 'common/wikiprintable.css', 'print' ); } $sk->setupUserCss( $this ); - $ret = ''; - - if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) { - $ret .= "\n"; - } + $dir = $wgContLang->getDir(); + $htmlAttribs = array( 'lang' => $wgContLanguageCode, 'dir' => $dir ); + $ret = Html::htmlHeader( $htmlAttribs ); if ( $this->getHTMLTitle() == '' ) { - $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() )); + $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) ); } - $dir = $wgContLang->getDir(); - 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" ); + } + + $openHead = Html::openElement( 'head' ); + if ( $openHead ) { + # Don't bother with the newline if $head == '' + $ret .= "$openHead\n"; } + $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n"; + - $ret .= "\n"; - $ret .= "" . htmlspecialchars( $this->getHTMLTitle() ) . "\n"; $ret .= implode( "\n", array( $this->getHeadLinks(), $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"; + $closeHead = Html::closeElement( 'head' ); + if ( $closeHead ) { + $ret .= "$closeHead\n"; + } $bodyAttrs = array(); @@ -1721,11 +2165,13 @@ class OutputPage { return $ret; } - /* - * gets the global variables and mScripts + /** + * Gets the global variables and mScripts; also adds userjs to the end if + * enabled * - * also adds userjs to the end if enabled: - */ + * @param $sk Skin object to use + * @return String: HTML fragment + */ function getHeadScripts( Skin $sk ) { global $wgUser, $wgRequest, $wgJsMimeType, $wgUseSiteJs; global $wgStylePath, $wgStyleVersion; @@ -1751,13 +2197,16 @@ class OutputPage { $this->addInlineScript( $wgRequest->getText( 'wpTextbox1' ) ); } else { $userpage = $wgUser->getUserPage(); - $scriptpage = Title::makeTitleSafe( - NS_USER, - $userpage->getDBkey() . '/' . $sk->getSkinName() . '.js' - ); - if ( $scriptpage && $scriptpage->exists() ) { - $userjs = Skin::makeUrl( $scriptpage->getPrefixedText(), 'action=raw&ctype=' . $wgJsMimeType ); - $this->addScriptFile( $userjs ); + $names = array( 'common', $sk->getSkinName() ); + foreach( $names as $name ) { + $scriptpage = Title::makeTitleSafe( + NS_USER, + $userpage->getDBkey() . '/' . $name . '.js' + ); + if ( $scriptpage && $scriptpage->exists() ) { + $userjs = $scriptpage->getLocalURL( 'action=raw&ctype=' . $wgJsMimeType ); + $this->addScriptFile( $userjs ); + } } } } @@ -1766,6 +2215,9 @@ class OutputPage { return $scripts; } + /** + * Add default \ tags + */ protected function addDefaultMeta() { global $wgVersion, $wgHtml5; @@ -1846,7 +2298,7 @@ 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 ) { @@ -1870,15 +2322,12 @@ class OutputPage { } /** - * 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( @@ -1892,9 +2341,10 @@ class OutputPage { * 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='' ) { $options = array(); @@ -1932,6 +2382,14 @@ class OutputPage { return implode( "\n", $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; @@ -1969,6 +2427,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; @@ -2007,7 +2471,6 @@ class OutputPage { * for when rate limiting has triggered. */ public function rateLimited() { - $this->setPageTitle(wfMsg('actionthrottled')); $this->setRobotPolicy( 'noindex,follow' ); $this->setArticleRelated( false ); @@ -2020,24 +2483,6 @@ class OutputPage { $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 * @@ -2045,7 +2490,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; @@ -2103,7 +2548,7 @@ class OutputPage { * * Is equivalent to: * - * $wgOut->addWikiText( "
\n" . wfMsgNoTrans( 'some-error' ) . '
' ); + * $wgOut->addWikiText( "
\n" . wfMsgNoTrans( 'some-error' ) . "
" ); * * The newline after opening div is needed in some wikitext. See bug 19226. */ @@ -2132,19 +2577,25 @@ class OutputPage { /** * Include jQuery core. Use this to avoid loading it multiple times - * before we get usable script loader. + * 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 */ - public function includeJQuery() { - if ( $this->mIncludeJQuery ) return; - $this->mIncludeJQuery = true; + public function includeJQuery( $modules = array() ) { + global $wgStylePath, $wgStyleVersion, $wgJQueryVersion, $wgJQueryMinified; - global $wgScriptPath, $wgStyleVersion, $wgJsMimeType; + $supportedModules = array( /** TODO: add things here */ ); + $unsupported = array_diff( $modules, $supportedModules ); - $params = array( - 'type' => $wgJsMimeType, - 'src' => "$wgScriptPath/js2/js2stopgap.min.js?$wgStyleVersion", - ); - $this->mScripts = Html::element( 'script', $params ) . "\n" . $this->mScripts; + $min = $wgJQueryMinified ? '.min' : ''; + $url = "$wgStylePath/common/jquery-$wgJQueryVersion$min.js?$wgStyleVersion"; + if ( !$this->mJQueryDone ) { + $this->mJQueryDone = true; + $this->mScripts = Html::linkedScript( $url ) . "\n" . $this->mScripts; + } + return $unsupported; } }