diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2008-03-21 11:49:34 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2008-03-21 11:49:34 +0100 |
commit | 086ae52d12011746a75f5588e877347bc0457352 (patch) | |
tree | e73263c7a29d0f94fafb874562610e16eb292ba8 /includes/OutputPage.php | |
parent | 749e7fb2bae7bbda855de3c9e319435b9f698ff7 (diff) |
Update auf MediaWiki 1.12.0
Diffstat (limited to 'includes/OutputPage.php')
-rw-r--r-- | includes/OutputPage.php | 371 |
1 files changed, 268 insertions, 103 deletions
diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 06467157..1fddeb7d 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -23,12 +23,14 @@ class OutputPage { var $mIsArticleRelated; protected $mParserOptions; // lazy initialised, use parserOptions() var $mShowFeedLinks = false; + var $mFeedLinksAppendQuery = false; var $mEnableClientCache = true; var $mArticleBodyOnly = false; var $mNewSectionLink = false; var $mNoGallery = false; var $mPageTitleActionText = ''; + var $mParseWarnings = array(); /** * Constructor @@ -63,6 +65,10 @@ class OutputPage { $this->mRedirect = str_replace( "\n", '', $url ); $this->mRedirectCode = $responsecode; } + + public function getRedirect() { + return $this->mRedirect; + } /** * Set the HTTP status code to send with the output. @@ -228,6 +234,8 @@ class OutputPage { public function isPrintable() { return $this->mPrintable; } public function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; } public function isSyndicated() { return $this->mShowFeedLinks; } + public function setFeedAppendQuery( $val ) { $this->mFeedLinksAppendQuery = $val; } + 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; } @@ -351,10 +359,12 @@ class OutputPage { wfIncrStats('pcache_not_possible'); $popts = $this->parserOptions(); - $popts->setTidy($tidy); + $oldTidy = $popts->setTidy($tidy); $parserOutput = $wgParser->parse( $text, $title, $popts, $linestart, true, $this->mRevisionId ); + + $popts->setTidy( $oldTidy ); $this->addParserOutput( $parserOutput ); @@ -370,6 +380,7 @@ class OutputPage { $this->addCategoryLinks( $parserOutput->getCategories() ); $this->mNewSectionLink = $parserOutput->getNewSection(); $this->addKeywords( $parserOutput ); + $this->mParseWarnings = $parserOutput->getWarnings(); if ( $parserOutput->getCacheTime() == -1 ) { $this->enableClientCache( false ); } @@ -514,16 +525,33 @@ class OutputPage { && $wgRequest->getText('uselang', false) === false; } + /** Get a complete X-Vary-Options header */ + public function getXVO() { + global $wgCookiePrefix; + return 'X-Vary-Options: ' . + # User ID cookie + "Cookie;string-contains={$wgCookiePrefix}UserID;" . + # Session cookie + 'string-contains=' . session_name() . ',' . + # Encoding checks for gzip only + 'Accept-Encoding;list-contains=gzip'; + } + public function sendCacheControl() { global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest; $fname = 'OutputPage::sendCacheControl'; + $response = $wgRequest->response(); if ($wgUseETag && $this->mETag) - $wgRequest->response()->header("ETag: $this->mETag"); + $response->header("ETag: $this->mETag"); # don't serve compressed data to clients who can't handle it # maintain different caches for logged-in users and non-logged in ones - $wgRequest->response()->header( 'Vary: Accept-Encoding, Cookie' ); + $response->header( 'Vary: Accept-Encoding, Cookie' ); + + # Add an X-Vary-Options header for Squid with Wikimedia patches + $response->header( $this->getXVO() ); + if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache ) { if( $wgUseSquid && session_id() == '' && ! $this->isPrintable() && $this->mSquidMaxage != 0 ) @@ -535,8 +563,8 @@ class OutputPage { wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false ); # start with a shorter timeout for initial testing # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"'); - $wgRequest->response()->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"'); - $wgRequest->response()->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' ); + $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"'); + $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' ); } else { # We'll purge the proxy cache for anons explicitly, but require end user agents # to revalidate against the proxy on each visit. @@ -545,24 +573,24 @@ class OutputPage { wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false ); # start with a shorter timeout for initial testing # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" ); - $wgRequest->response()->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' ); + $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' ); } } else { # We do want clients to cache if they can, but they *must* check for updates # on revisiting the page. wfDebug( "$fname: private caching; {$this->mLastModified} **\n", false ); - $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' ); - $wgRequest->response()->header( "Cache-Control: private, must-revalidate, max-age=0" ); + $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' ); + $response->header( "Cache-Control: private, must-revalidate, max-age=0" ); } - if($this->mLastModified) $wgRequest->response()->header( "Last-modified: {$this->mLastModified}" ); + if($this->mLastModified) $response->header( "Last-modified: {$this->mLastModified}" ); } else { wfDebug( "$fname: no caching **\n", false ); # In general, the absence of a last modified header should be enough to prevent # the client from using its cache. We send a few other things just to make sure. - $wgRequest->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' ); - $wgRequest->response()->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' ); - $wgRequest->response()->header( 'Pragma: no-cache' ); + $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' ); + $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' ); + $response->header( 'Pragma: no-cache' ); } } @@ -581,29 +609,10 @@ class OutputPage { } $fname = 'OutputPage::output'; wfProfileIn( $fname ); - $sk = $wgUser->getSkin(); - - if ( $wgUseAjax ) { - $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" ); - - wfRunHooks( 'AjaxAddScript', array( &$this ) ); - - if( $wgAjaxSearch ) { - $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js?$wgStyleVersion\"></script>\n" ); - $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" ); - } - - if( $wgAjaxWatch && $wgUser->isLoggedIn() ) { - $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxwatch.js?$wgStyleVersion\"></script>\n" ); - } - } if ( '' != $this->mRedirect ) { - if( substr( $this->mRedirect, 0, 4 ) != 'http' ) { - # Standards require redirect URLs to be absolute - global $wgServer; - $this->mRedirect = $wgServer . $this->mRedirect; - } + # Standards require redirect URLs to be absolute + $this->mRedirect = wfExpandUrl( $this->mRedirect ); if( $this->mRedirectCode == '301') { if( !$wgDebugRedirects ) { $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently"); @@ -680,6 +689,25 @@ class OutputPage { $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] ); } + $sk = $wgUser->getSkin(); + + if ( $wgUseAjax ) { + $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" ); + + wfRunHooks( 'AjaxAddScript', array( &$this ) ); + + if( $wgAjaxSearch && $wgUser->getBoolOption( 'ajaxsearch' ) ) { + $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js?$wgStyleVersion\"></script>\n" ); + $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" ); + } + + if( $wgAjaxWatch && $wgUser->isLoggedIn() ) { + $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxwatch.js?$wgStyleVersion\"></script>\n" ); + } + } + + + # Buffer output; final headers may depend on later processing ob_start(); @@ -758,6 +786,9 @@ class OutputPage { $name = User::whoIs( $wgUser->blockedBy() ); $reason = $wgUser->blockedFor(); + if( $reason == '' ) { + $reason = wfMsg( 'blockednoreason' ); + } $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true ); $ip = wfGetIP(); @@ -793,7 +824,7 @@ class OutputPage { * This could be a username, an ip range, or a single ip. */ $intended = $wgUser->mBlock->mAddress; - $this->addWikiText( wfMsg( $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 ) { @@ -811,9 +842,9 @@ class OutputPage { */ public function showErrorPage( $title, $msg, $params = array() ) { global $wgTitle; - - $this->mDebugtext .= 'Original title: ' . - $wgTitle->getPrefixedText() . "\n"; + if ( isset($wgTitle) ) { + $this->mDebugtext .= 'Original title: ' . $wgTitle->getPrefixedText() . "\n"; + } $this->setPageTitle( wfMsg( $title ) ); $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) ); $this->setRobotpolicy( 'noindex,nofollow' ); @@ -839,7 +870,7 @@ class OutputPage { global $wgTitle; $this->mDebugtext .= 'Original title: ' . - $wgTitle->getPrefixedText() . "\n"; + $wgTitle->getPrefixedText() . "\n"; $this->setPageTitle( wfMsg( 'permissionserrors' ) ); $this->setHTMLTitle( wfMsg( 'permissionserrors' ) ); $this->setRobotpolicy( 'noindex,nofollow' ); @@ -868,7 +899,7 @@ class OutputPage { $this->setArticleRelated( false ); $this->mBodytext = ''; - $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) ); + $this->addWikiMsg( 'versionrequiredtext', $version ); $this->returnToMain(); } @@ -967,36 +998,46 @@ class OutputPage { /** * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors - * @return string The error-messages, formatted into a list. + * @return string The wikitext error-messages, formatted into a list. */ public function formatPermissionsErrorMessage( $errors ) { - $text = ''; + $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n"; - if (sizeof( $errors ) > 1) { - - $text .= wfMsgExt( 'permissionserrorstext', array( 'parse' ), count( $errors ) ) . "\n"; + if (count( $errors ) > 1) { $text .= '<ul class="permissions-errors">' . "\n"; foreach( $errors as $error ) { $text .= '<li>'; - $text .= call_user_func_array( 'wfMsg', $error ); + $text .= call_user_func_array( 'wfMsgNoTrans', $error ); $text .= "</li>\n"; } $text .= '</ul>'; } else { - $text .= call_user_func_array( 'wfMsg', $errors[0]); + $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsgNoTrans', $errors[0]) . '</div>'; } return $text; } /** - * @todo document - * @param bool $protected Is the reason the page can't be reached because it's protected? - * @param mixed $source - * @param bool $protected, page is protected? - * @param array $reason, array of arrays( msg, args ) + * Display a page stating that the Wiki is in read-only mode, + * and optionally show the source of the page that the user + * was trying to edit. Should only be called (for this + * purpose) after wfReadOnly() has returned true. + * + * For historical reasons, this function is _also_ used to + * show the error message when a user tries to edit a page + * they are not allowed to edit. (Unless it's because they're + * blocked, then we show blockedPage() instead.) In this + * case, the second parameter should be set to true and a list + * of reasons supplied as the third parameter. + * + * @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(). */ public function readOnlyPage( $source = null, $protected = false, $reasons = array() ) { global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle; @@ -1004,61 +1045,59 @@ class OutputPage { $this->setRobotpolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); - - if ( !empty($reasons) ) { - $this->setPageTitle( wfMsg( 'viewsource' ) ); - $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) ); - $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons ) ); - } else if( $protected ) { - $this->setPageTitle( wfMsg( 'viewsource' ) ); - $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) ); - list( $cascadeSources, /* $restrictions */ ) = $wgTitle->getCascadeProtectionSources(); - - // Show an appropriate explanation depending upon the reason - // for the protection...all of these should be moved to the - // callers - if( $wgTitle->getNamespace() == NS_MEDIAWIKI ) { - // User isn't allowed to edit the interface - $this->addWikiText( wfMsg( 'protectedinterface' ) ); - } elseif( $cascadeSources && ( $count = count( $cascadeSources ) ) > 0 ) { - // Cascading protection - $titles = ''; - foreach( $cascadeSources as $title ) - $titles .= "* [[:" . $title->getPrefixedText() . "]]\n"; - $this->addWikiText( wfMsgExt( 'cascadeprotected', 'parsemag', $count ) . "\n{$titles}" ); - } elseif( !$wgTitle->isProtected( 'edit' ) && $wgTitle->isNamespaceProtected() ) { - // Namespace protection - $ns = $wgTitle->getNamespace() == NS_MAIN - ? wfMsg( 'nstab-main' ) - : $wgTitle->getNsText(); - $this->addWikiText( wfMsg( 'namespaceprotected', $ns ) ); + // 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) ) { + $reasons[] = array( 'badaccess-group0' ); + } + + if ( !empty($reasons) ) { + // Permissions error + if( $source ) { + $this->setPageTitle( wfMsg( 'viewsource' ) ); + $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) ); } else { - // Standard protection - $this->addWikiText( wfMsg( 'protectedpagetext' ) ); + $this->setPageTitle( wfMsg( 'badaccess' ) ); } + $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons ) ); } else { + // Wiki is read only $this->setPageTitle( wfMsg( 'readonly' ) ); if ( $wgReadOnly ) { $reason = $wgReadOnly; } else { + // Should not happen, user should have called wfReadOnly() first $reason = file_get_contents( $wgReadOnlyFile ); } - $this->addWikiText( wfMsg( 'readonlytext', $reason ) ); + $this->addWikiMsg( 'readonlytext', $reason ); } + // Show source, if supplied if( is_string( $source ) ) { - $this->addWikiText( wfMsg( 'viewsourcetext' ) ); - $rows = $wgUser->getIntOption( 'rows' ); - $cols = $wgUser->getIntOption( 'cols' ); - $text = "\n<textarea name='wpTextbox1' id='wpTextbox1' cols='$cols' rows='$rows' readonly='readonly'>" . - htmlspecialchars( $source ) . "\n</textarea>"; + $this->addWikiMsg( 'viewsourcetext' ); + $text = wfOpenElement( 'textarea', + array( 'id' => 'wpTextbox1', + 'name' => 'wpTextbox1', + 'cols' => $wgUser->getOption( 'cols' ), + 'rows' => $wgUser->getOption( 'rows' ), + 'readonly' => 'readonly' ) ); + $text .= htmlspecialchars( $source ); + $text .= wfCloseElement( 'textarea' ); $this->addHTML( $text ); + + // Show templates used by this article + $skin = $wgUser->getSkin(); + $article = new Article( $wgTitle ); + $this->addHTML( $skin->formatTemplates( $article->getUsedTemplates() ) ); } - $article = new Article( $wgTitle ); - $this->addHTML( $skin->formatTemplates( $article->getUsedTemplates() ) ); - $this->returnToMain( false ); + # If the title doesn't exist, it's fairly pointless to print a return + # link to it. After all, you just tried editing it and couldn't, so + # what's there to do there? + if( $wgTitle->exists() ) { + $this->returnToMain( false, $wgTitle ); + } } /** @deprecated */ @@ -1275,28 +1314,87 @@ class OutputPage { } $ret .= " />\n"; } - if( $this->isSyndicated() ) { - # FIXME: centralize the mime-type and name information in Feed.php - $link = $wgRequest->escapeAppendQuery( 'feed=rss' ); - $ret .= "<link rel='alternate' type='application/rss+xml' title='RSS 2.0' href='$link' />\n"; - $link = $wgRequest->escapeAppendQuery( 'feed=atom' ); - $ret .= "<link rel='alternate' type='application/atom+xml' title='Atom 1.0' href='$link' />\n"; + + foreach( $this->getSyndicationLinks() as $format => $link ) { + # Use the page name for the title (accessed through $wgTitle since + # there's no other way). In principle, this could lead to issues + # with having the same name for different feeds corresponding to + # the same page, but we can't avoid that at this low a level. + global $wgTitle; + + $ret .= $this->feedLink( + $format, + $link, + wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep) } + # Recent changes feed should appear on every page + # Put it after the per-page feed to avoid changing existing behavior. + # It's still available, probably via a menu in your browser. + global $wgSitename; + $rctitle = SpecialPage::getTitleFor( 'Recentchanges' ); + $ret .= $this->feedLink( + 'rss', + $rctitle->getFullURL( 'feed=rss' ), + wfMsg( 'site-rss-feed', $wgSitename ) ); + $ret .= $this->feedLink( + 'atom', + $rctitle->getFullURL( 'feed=atom' ), + wfMsg( 'site-atom-feed', $wgSitename ) ); + return $ret; } + + /** + * Return URLs for each supported syndication format for this page. + * @return array associating format keys with URLs + */ + public function getSyndicationLinks() { + global $wgTitle, $wgFeedClasses; + $links = array(); + + if( $this->isSyndicated() ) { + if( is_string( $this->getFeedAppendQuery() ) ) { + $appendQuery = "&" . $this->getFeedAppendQuery(); + } else { + $appendQuery = ""; + } + + foreach( $wgFeedClasses as $format => $class ) { + $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" ); + } + } + return $links; + } + + /** + * Generate a <link rel/> for an RSS feed. + */ + private function feedLink( $type, $url, $text ) { + return Xml::element( 'link', array( + 'rel' => 'alternate', + 'type' => "application/$type+xml", + 'title' => $text, + 'href' => $url ) ) . "\n"; + } /** * Turn off regular page output and return an error reponse * for when rate limiting has triggered. - * @todo i18n */ public function rateLimited() { - global $wgOut; - $wgOut->disable(); - wfHttpError( 500, 'Internal Server Error', - 'Sorry, the server has encountered an internal error. ' . - 'Please wait a moment and hit "refresh" to submit the request again.' ); + global $wgOut, $wgTitle; + + $this->setPageTitle(wfMsg('actionthrottled')); + $this->setRobotPolicy( 'noindex,follow' ); + $this->setArticleRelated( false ); + $this->enableClientCache( false ); + $this->mRedirect = ''; + $this->clearHTML(); + $this->setStatusCode(503); + $this->addWikiMsg( 'actionthrottledtext' ); + + $this->returnToMain( false, $wgTitle ); } /** @@ -1327,5 +1425,72 @@ class OutputPage { $this->addHtml( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" ); } } - + + /** + * Add a wikitext-formatted message to the output. + * This is equivalent to: + * + * $wgOut->addWikiText( wfMsgNoTrans( ... ) ) + */ + public function addWikiMsg( /*...*/ ) { + $args = func_get_args(); + $name = array_shift( $args ); + $this->addWikiMsgArray( $name, $args ); + } + + /** + * Add a wikitext-formatted message to the output. + * Like addWikiMsg() except the parameters are taken as an array + * instead of a variable argument list. + * + * $options is passed through to wfMsgExt(), see that function for details. + */ + public function addWikiMsgArray( $name, $args, $options = array() ) { + $options[] = 'parse'; + $text = wfMsgExt( $name, $options, $args ); + $this->addHTML( $text ); + } + + /** + * This function takes a number of message/argument specifications, wraps them in + * some overall structure, and then parses the result and adds it to the output. + * + * In the $wrap, $1 is replaced with the first message, $2 with the second, and so + * on. The subsequent arguments may either be strings, in which case they are the + * message names, or an arrays, in which case the first element is the message name, + * and subsequent elements are the parameters to that message. + * + * The special named parameter 'options' in a message specification array is passed + * through to the $options parameter of wfMsgExt(). + * + * For example: + * + * $wgOut->wrapWikiMsg( '<div class="error">$1</div>', 'some-error' ); + * + * Is equivalent to: + * + * $wgOut->addWikiText( '<div class="error">' . wfMsgNoTrans( 'some-error' ) . '</div>' ); + */ + public function wrapWikiMsg( $wrap /*, ...*/ ) { + $msgSpecs = func_get_args(); + array_shift( $msgSpecs ); + $msgSpecs = array_values( $msgSpecs ); + $s = $wrap; + foreach ( $msgSpecs as $n => $spec ) { + $options = array(); + if ( is_array( $spec ) ) { + $args = $spec; + $name = array_shift( $args ); + if ( isset( $args['options'] ) ) { + $options = $args['options']; + unset( $args['options'] ); + } + } else { + $args = array(); + $name = $spec; + } + $s = str_replace( '$' . ($n+1), wfMsgExt( $name, $options, $args ), $s ); + } + $this->addHTML( $this->parse( $s ) ); + } } |