X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FOutputPage.php;h=f90febbe777adebc0f2c23ee6bf16f7c94a0d037;hb=f9da6c460b6f4cfd457b0ebf1a6e7a347755706b;hp=e677dcbacdc4af136b40f93a89e26e8f7af51cb8;hpb=6a64a7eaee23b892637d977320f097a4fe207afc;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/OutputPage.php b/includes/OutputPage.php index e677dcbacd..f90febbe77 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -1,72 +1,138 @@ addStyle() + */ + var $styles = array(); + + private $mIndexPolicy = 'index'; + private $mFollowPolicy = 'follow'; /** * Constructor * Initialise private variables */ - function OutputPage() { - $this->mMetatags = $this->mKeywords = $this->mLinktags = array(); - $this->mHTMLtitle = $this->mPagetitle = $this->mBodytext = - $this->mRedirect = $this->mLastModified = - $this->mSubtitle = $this->mDebugtext = $this->mRobotpolicy = - $this->mOnloadHandler = $this->mPageLinkTitle = ''; - $this->mIsArticleRelated = $this->mIsarticle = $this->mPrintable = true; - $this->mSuppressQuickbar = $this->mPrintable = false; - $this->mLanguageLinks = array(); - $this->mCategoryLinks = array(); - $this->mDoNothing = false; - $this->mContainsOldMagic = $this->mContainsNewMagic = 0; - $this->mParserOptions = null; - $this->mSquidMaxage = 0; - $this->mScripts = ''; - $this->mETag = false; - $this->mRevisionId = null; - $this->mNewSectionLink = false; + function __construct() { + global $wgAllowUserJs; + $this->mAllowUserJs = $wgAllowUserJs; } - - function redirect( $url, $responsecode = '302' ) { + + 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; } + public function getRedirect() { + return $this->mRedirect; + } + + /** + * Set the HTTP status code to send with the output. + * + * @param int $statusCode + * @return nothing + */ function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; } - # To add an http-equiv meta tag, precede the name with "http:" - function addMeta( $name, $val ) { array_push( $this->mMetatags, array( $name, $val ) ); } + /** + * Add a new tag + * To add an http-equiv meta tag, precede the name with "http:" + * + * @param $name tag name + * @param $val tag value + */ + function addMeta( $name, $val ) { + array_push( $this->mMetatags, array( $name, $val ) ); + } + function addKeyword( $text ) { array_push( $this->mKeywords, $text ); } - function addScript( $script ) { $this->mScripts .= $script; } - function getScript() { return $this->mScripts; } + function addScript( $script ) { $this->mScripts .= "\t\t".$script; } + + function addExtensionStyle( $url ) { + $linkarr = array( 'rel' => 'stylesheet', 'href' => $url, 'type' => 'text/css' ); + array_push( $this->mExtStyles, $linkarr ); + } + + /** + * 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) + */ + function addScriptFile( $file ) { + global $wgStylePath, $wgStyleVersion, $wgJsMimeType; + if( substr( $file, 0, 1 ) == '/' ) { + $path = $file; + } else { + $path = "{$wgStylePath}/common/{$file}"; + } + $this->addScript( "\n" ); + } + + /** + * Add a self-contained script tag with the given contents + * @param string $script JavaScript text, no "; + } + + function getScript() { + return $this->mScripts . $this->getHeadItems(); + } + + function getHeadItems() { + $s = ''; + foreach ( $this->mHeadItems as $item ) { + $s .= $item; + } + return $s; + } + + function addHeadItem( $name, $value ) { + $this->mHeadItems[$name] = $value; + } + + function hasHeadItem( $name ) { + return isset( $this->mHeadItems[$name] ); + } function setETag($tag) { $this->mETag = $tag; } function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; } @@ -76,6 +142,11 @@ class OutputPage { # $linkarr should be an associative array of attributes. We'll escape on output. array_push( $this->mLinktags, $linkarr ); } + + # Get all links added by extensions + function getExtStyle() { + return $this->mExtStyles; + } function addMetadataLink( $linkarr ) { # note: buggy CC software only reads first "meta" link @@ -88,83 +159,158 @@ class OutputPage { /** * checkLastModified tells the client to use the client-cached page if * possible. If sucessful, the OutputPage is disabled so that - * any future call to OutputPage->output() have no effect. The method - * returns true iff cache-ok headers was sent. + * any future call to OutputPage->output() have no effect. + * + * Side effect: sets mLastModified for Last-Modified header + * + * @return bool True iff cache-ok headers was sent. */ function checkLastModified ( $timestamp ) { - global $wgCachePages, $wgCacheEpoch, $wgUser; - $fname = 'OutputPage::checkLastModified'; - + global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest; + if ( !$timestamp || $timestamp == '19700101000000' ) { - wfDebug( "$fname: CACHE DISABLED, NO TIMESTAMP\n" ); - return; + wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" ); + return false; } if( !$wgCachePages ) { - wfDebug( "$fname: CACHE DISABLED\n", false ); - return; + wfDebug( __METHOD__ . ": CACHE DISABLED\n", false ); + return false; } if( $wgUser->getOption( 'nocache' ) ) { - wfDebug( "$fname: USER DISABLED CACHE\n", false ); - return; + wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false ); + return false; } - $timestamp=wfTimestamp(TS_MW,$timestamp); - $lastmod = wfTimestamp( TS_RFC2822, max( $timestamp, $wgUser->mTouched, $wgCacheEpoch ) ); - - if( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) { - # IE sends sizes after the date like this: - # Wed, 20 Aug 2003 06:51:19 GMT; length=5202 - # this breaks strtotime(). - $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] ); - $modsinceTime = strtotime( $modsince ); - $ismodsince = wfTimestamp( TS_MW, $modsinceTime ? $modsinceTime : 1 ); - wfDebug( "$fname: -- client send If-Modified-Since: " . $modsince . "\n", false ); - wfDebug( "$fname: -- we might send Last-Modified : $lastmod\n", false ); - if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) && $ismodsince >= $wgCacheEpoch ) { - # Make sure you're in a place you can leave when you call us! - header( "HTTP/1.0 304 Not Modified" ); - $this->mLastModified = $lastmod; - $this->sendCacheControl(); - wfDebug( "$fname: CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false ); - $this->disable(); - @ob_end_clean(); // Don't output compressed blob - return true; - } else { - wfDebug( "$fname: READY client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false ); - $this->mLastModified = $lastmod; + $timestamp = wfTimestamp( TS_MW, $timestamp ); + $modifiedTimes = array( + 'page' => $timestamp, + 'user' => $wgUser->getTouched(), + 'epoch' => $wgCacheEpoch + ); + wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) ); + + $maxModified = max( $modifiedTimes ); + $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified ); + + if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) { + wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false ); + return false; + } + + # Make debug info + $info = ''; + foreach ( $modifiedTimes as $name => $value ) { + if ( $info !== '' ) { + $info .= ', '; } - } else { - wfDebug( "$fname: client did not send If-Modified-Since header\n", false ); - $this->mLastModified = $lastmod; + $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value ); + } + + # IE sends sizes after the date like this: + # Wed, 20 Aug 2003 06:51:19 GMT; length=5202 + # this breaks strtotime(). + $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] ); + + wfSuppressWarnings(); // E_STRICT system time bitching + $clientHeaderTime = strtotime( $clientHeader ); + wfRestoreWarnings(); + if ( !$clientHeaderTime ) { + wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" ); + return false; } + $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime ); + + wfDebug( __METHOD__ . ": client sent If-Modified-Since: " . + wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false ); + wfDebug( __METHOD__ . ": effective Last-Modified: " . + wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false ); + if( $clientHeaderTime < $maxModified ) { + wfDebug( __METHOD__ . ": STALE, $info\n", false ); + return false; + } + + # Not modified + # Give a 304 response code and disable body output + wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false ); + $wgRequest->response()->header( "HTTP/1.1 304 Not Modified" ); + $this->sendCacheControl(); + $this->disable(); + + // Don't output a compressed blob when using ob_gzhandler; + // it's technically against HTTP spec and seems to confuse + // Firefox when the response gets split over two packets. + wfClearOutputBuffers(); + + return true; + } + + function setPageTitleActionText( $text ) { + $this->mPageTitleActionText = $text; } function getPageTitleActionText () { - global $action; - switch($action) { - case 'edit': - case 'delete': - case 'protect': - case 'unprotect': - case 'watch': - case 'unwatch': - // Display title is already customized - return ''; - case 'history': - return wfMsg('history_short'); - case 'submit': - // FIXME: bug 2735; not correct for special pages etc - return wfMsg('preview'); - case 'info': - return wfMsg('info_short'); - default: - return ''; + if ( isset( $this->mPageTitleActionText ) ) { + return $this->mPageTitleActionText; + } + } + + /** + * Set the robot policy for the page: + * + * @param $policy string The literal string to output as the contents of + * the meta tag. Will be parsed according to the spec and output in + * standardized form. + * @return null + */ + public function setRobotPolicy( $policy ) { + $policy = explode( ',', $policy ); + $policy = array_map( 'trim', $policy ); + + # The default policy is follow, so if nothing is said explicitly, we + # do that. + if( in_array( 'nofollow', $policy ) ) { + $this->mFollowPolicy = 'nofollow'; + } else { + $this->mFollowPolicy = 'follow'; + } + + if( in_array( 'noindex', $policy ) ) { + $this->mIndexPolicy = 'noindex'; + } else { + $this->mIndexPolicy = 'index'; } } - function setRobotpolicy( $str ) { $this->mRobotpolicy = $str; } - function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; } - function setPageTitle( $name ) { + /** + * Set the index policy for the page, but leave the follow policy un- + * touched. + * + * @param $policy string Either 'index' or 'noindex'. + * @return null + */ + public function setIndexPolicy( $policy ) { + $policy = trim( $policy ); + if( in_array( $policy, array( 'index', 'noindex' ) ) ) { + $this->mIndexPolicy = $policy; + } + } + + /** + * Set the follow policy for the page, but leave the index policy un- + * touched. + * + * @param $policy string Either 'follow' or 'nofollow'. + * @return null + */ + public function setFollowPolicy( $policy ) { + $policy = trim( $policy ); + if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) { + $this->mFollowPolicy = $policy; + } + } + + public function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; } + public function setPageTitle( $name ) { global $action, $wgContLang; $name = $wgContLang->convert($name, true); $this->mPagetitle = $name; @@ -177,88 +323,122 @@ class OutputPage { $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) ); } - function getHTMLTitle() { return $this->mHTMLtitle; } - function getPageTitle() { return $this->mPagetitle; } - function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514 - function getSubtitle() { return $this->mSubtitle; } - function isArticle() { return $this->mIsarticle; } - function setPrintable() { $this->mPrintable = true; } - function isPrintable() { return $this->mPrintable; } - function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; } - function isSyndicated() { return $this->mShowFeedLinks; } - function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; } - function getOnloadHandler() { return $this->mOnloadHandler; } - function disable() { $this->mDoNothing = true; } - - function setArticleRelated( $v ) { + 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 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; } + + public function setArticleRelated( $v ) { $this->mIsArticleRelated = $v; if ( !$v ) { $this->mIsarticle = false; } } - function setArticleFlag( $v ) { + public function setArticleFlag( $v ) { $this->mIsarticle = $v; if ( $v ) { $this->mIsArticleRelated = $v; } } - function isArticleRelated() { return $this->mIsArticleRelated; } + public function isArticleRelated() { return $this->mIsArticleRelated; } - function getLanguageLinks() { return $this->mLanguageLinks; } - function addLanguageLinks($newLinkArray) { + public function getLanguageLinks() { return $this->mLanguageLinks; } + public function addLanguageLinks($newLinkArray) { $this->mLanguageLinks += $newLinkArray; } - function setLanguageLinks($newLinkArray) { + public function setLanguageLinks($newLinkArray) { $this->mLanguageLinks = $newLinkArray; } - function getCategoryLinks() { + public function getCategoryLinks() { return $this->mCategoryLinks; } /** * Add an array of categories, with names in the keys */ - function addCategoryLinks($categories) { + public function addCategoryLinks( $categories ) { global $wgUser, $wgContLang; - if ( !is_array( $categories ) ) { + if ( !is_array( $categories ) || count( $categories ) == 0 ) { return; } - # Add the links to the link cache in a batch + + # Add the links to a LinkBatch $arr = array( NS_CATEGORY => $categories ); $lb = new LinkBatch; $lb->setArray( $arr ); - $lb->execute(); - $sk =& $wgUser->getSkin(); - foreach ( $categories as $category => $arbitrary ) { - $title = Title::makeTitleSafe( NS_CATEGORY, $category ); - $text = $wgContLang->convertHtml( $title->getText() ); - $this->mCategoryLinks[] = $sk->makeLinkObj( $title, $text ); + # Fetch existence plus the hiddencat property + $dbr = wfGetDB( DB_SLAVE ); + $pageTable = $dbr->tableName( 'page' ); + $where = $lb->constructSet( 'page', $dbr ); + $propsTable = $dbr->tableName( 'page_props' ); + $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, pp_value + FROM $pageTable LEFT JOIN $propsTable ON pp_propname='hiddencat' AND pp_page=page_id WHERE $where"; + $res = $dbr->query( $sql, __METHOD__ ); + + # Add the results to the link cache + $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' ) ); + + # 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 ) { + $title = Title::makeTitleSafe( NS_CATEGORY, $category ); + $text = $wgContLang->convertHtml( $title->getText() ); + $this->mCategoryLinks[$type][] = $sk->makeLinkObj( $title, $text ); + } } } - function setCategoryLinks($categories) { + public function setCategoryLinks($categories) { $this->mCategoryLinks = array(); $this->addCategoryLinks($categories); } - function suppressQuickbar() { $this->mSuppressQuickbar = true; } - function isQuickbarSuppressed() { return $this->mSuppressQuickbar; } + public function suppressQuickbar() { $this->mSuppressQuickbar = true; } + public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; } - function addHTML( $text ) { $this->mBodytext .= $text; } - function clearHTML() { $this->mBodytext = ''; } - function getHTML() { return $this->mBodytext; } - function debug( $text ) { $this->mDebugtext .= $text; } + 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; } /* @deprecated */ - function setParserOptions( $options ) { + public function setParserOptions( $options ) { + wfDeprecated( __METHOD__ ); return $this->parserOptions( $options ); } - function parserOptions( $options = null ) { + public function parserOptions( $options = null ) { if ( !$this->mParserOptions ) { $this->mParserOptions = new ParserOptions; } @@ -271,99 +451,166 @@ class OutputPage { * @param mixed $revid an integer, or NULL * @return mixed previous value */ - function setRevisionId( $revid ) { + public function setRevisionId( $revid ) { $val = is_null( $revid ) ? null : intval( $revid ); return wfSetVar( $this->mRevisionId, $val ); } + + 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. + * + * @param string $text + * @param bool $linestart */ - function addWikiText( $text, $linestart = true ) { + public function addWikiText( $text, $linestart = true ) { global $wgTitle; $this->addWikiTextTitle($text, $wgTitle, $linestart); } - function addWikiTextWithTitle($text, &$title, $linestart = true) { + public function addWikiTextWithTitle($text, &$title, $linestart = true) { $this->addWikiTextTitle($text, $title, $linestart); } - function addWikiTextTitle($text, &$title, $linestart) { + function addWikiTextTitleTidy($text, &$title, $linestart = true) { + $this->addWikiTextTitle( $text, $title, $linestart, true ); + } + + public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) { global $wgParser; - $fname = 'OutputPage:addWikiTextTitle'; - wfProfileIn($fname); - wfIncrStats('pcache_not_possible'); - $parserOutput = $wgParser->parse( $text, $title, $this->parserOptions(), + + wfProfileIn( __METHOD__ ); + + wfIncrStats( 'pcache_not_possible' ); + + $popts = $this->parserOptions(); + $oldTidy = $popts->setTidy( $tidy ); + + $parserOutput = $wgParser->parse( $text, $title, $popts, $linestart, true, $this->mRevisionId ); + + $popts->setTidy( $oldTidy ); + $this->addParserOutput( $parserOutput ); - wfProfileOut($fname); + + wfProfileOut( __METHOD__ ); } - function addParserOutputNoText( &$parserOutput ) { + /** + * @todo document + * @param ParserOutput object &$parserOutput + */ + public function addParserOutputNoText( &$parserOutput ) { + global $wgTitle, $wgExemptFromUserRobotsControl, $wgContentNamespaces; + $this->mLanguageLinks += $parserOutput->getLanguageLinks(); $this->addCategoryLinks( $parserOutput->getCategories() ); $this->mNewSectionLink = $parserOutput->getNewSection(); + + if( is_null( $wgExemptFromUserRobotsControl ) ) { + $bannedNamespaces = $wgContentNamespaces; + } else { + $bannedNamespaces = $wgExemptFromUserRobotsControl; + } + if( !in_array( $wgTitle->getNamespace(), $bannedNamespaces ) ) { + # FIXME (bug 14900): This overrides $wgArticleRobotPolicies, and it + # shouldn't + $this->setIndexPolicy( $parserOutput->getIndexPolicy() ); + } + $this->addKeywords( $parserOutput ); + $this->mParseWarnings = $parserOutput->getWarnings(); if ( $parserOutput->getCacheTime() == -1 ) { $this->enableClientCache( false ); } - if ( $parserOutput->mHTMLtitle != "" ) { - $this->mPagetitle = $parserOutput->mHTMLtitle ; - } - if ( $parserOutput->mSubtitle != '' ) { - $this->mSubtitle .= $parserOutput->mSubtitle ; + $this->mNoGallery = $parserOutput->getNoGallery(); + $this->mHeadItems = array_merge( $this->mHeadItems, (array)$parserOutput->mHeadItems ); + // Versioning... + $this->mTemplateIds = wfArrayMerge( $this->mTemplateIds, (array)$parserOutput->mTemplateIds ); + + // Display title + if( ( $dt = $parserOutput->getDisplayTitle() ) !== false ) + $this->setPageTitle( $dt ); + + // Hooks registered in the object + global $wgParserOutputHooks; + foreach ( $parserOutput->getOutputHooks() as $hookInfo ) { + list( $hookName, $data ) = $hookInfo; + if ( isset( $wgParserOutputHooks[$hookName] ) ) { + call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data ); + } } + + wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) ); } + /** + * @todo document + * @param ParserOutput &$parserOutput + */ function addParserOutput( &$parserOutput ) { $this->addParserOutputNoText( $parserOutput ); - $this->addHTML( $parserOutput->getText() ); + $text = $parserOutput->getText(); + 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 + * Saves the text into the parser cache if possible. + * + * @param string $text + * @param Article $article + * @param bool $cache + * @deprecated Use Article::outputWikitext */ - function addPrimaryWikiText( $text, $article, $cache = true ) { + public function addPrimaryWikiText( $text, $article, $cache = true ) { global $wgParser, $wgUser; + 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 = ParserCache::singleton(); $parserCache->save( $parserOutput, $article, $wgUser ); } - $this->addParserOutputNoText( $parserOutput ); - $text = $parserOutput->getText(); - $this->mNoGallery = $parserOutput->getNoGallery(); - wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) ); - $parserOutput->setText( $text ); - $this->addHTML( $parserOutput->getText() ); + $this->addParserOutput( $parserOutput ); } /** - * For anything that isn't primary text or interface message + * @deprecated use addWikiTextTidy() */ - function addSecondaryWikiText( $text, $linestart = true ) { + public function addSecondaryWikiText( $text, $linestart = true ) { global $wgTitle; - $popts = $this->parserOptions(); - $popts->setTidy(true); - $this->addWikiTextTitle($text, $wgTitle, $linestart); - $popts->setTidy(false); + wfDeprecated( __METHOD__ ); + $this->addWikiTextTitleTidy($text, $wgTitle, $linestart); + } + + /** + * Add wikitext with tidy enabled + */ + public function addWikiTextTidy( $text, $linestart = true ) { + global $wgTitle; + $this->addWikiTextTitleTidy($text, $wgTitle, $linestart); } /** * Add the output of a QuickTemplate to the output buffer + * * @param QuickTemplate $template */ - function addTemplate( &$template ) { + public function addTemplate( &$template ) { ob_start(); $template->execute(); $this->addHTML( ob_get_contents() ); @@ -372,8 +619,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 ?? */ - function parse( $text, $linestart = true, $interface = false ) { + public function parse( $text, $linestart = true, $interface = false ) { global $wgParser, $wgTitle; $popts = $this->parserOptions(); if ( $interface) { $popts->setInterfaceMessage(true); } @@ -384,19 +635,16 @@ class OutputPage { } /** - * @param $article - * @param $user + * @param Article $article + * @param User $user * - * @return bool + * @return bool True if successful, else false. */ - function tryParserCache( &$article, $user ) { - $parserCache =& ParserCache::singleton(); + public function tryParserCache( &$article, $user ) { + $parserCache = ParserCache::singleton(); $parserOutput = $parserCache->get( $article, $user ); if ( $parserOutput !== false ) { - $this->addParserOutputNoText( $parserOutput ); - $text = $parserOutput->getText(); - wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) ); - $this->addHTML( $text ); + $this->addParserOutput( $parserOutput ); return true; } else { return false; @@ -404,76 +652,137 @@ class OutputPage { } /** - * Set the maximum cache time on the Squid in seconds - * @param $maxage + * @param int $maxage Maximum cache time on the Squid, in seconds. */ - function setSquidMaxage( $maxage ) { + public function setSquidMaxage( $maxage ) { $this->mSquidMaxage = $maxage; } /** * Use enableClientCache(false) to force it to send nocache headers - * @param $state + * @param $state ?? */ - function enableClientCache( $state ) { + public function enableClientCache( $state ) { return wfSetVar( $this->mEnableClientCache, $state ); } - function uncacheableBecauseRequestvars() { + function getCacheVaryCookies() { + global $wgCookiePrefix, $wgCacheVaryCookies; + static $cookies; + if ( $cookies === null ) { + $cookies = array_merge( + array( + "{$wgCookiePrefix}Token", + "{$wgCookiePrefix}LoggedOut", + session_name() + ), + $wgCacheVaryCookies + ); + wfRunHooks('GetCacheVaryCookies', array( $this, &$cookies ) ); + } + return $cookies; + } + + function uncacheableBecauseRequestVars() { global $wgRequest; return $wgRequest->getText('useskin', false) === false && $wgRequest->getText('uselang', false) === false; } - function sendCacheControl() { - global $wgUseSquid, $wgUseESI, $wgSquidMaxage; - $fname = 'OutputPage::sendCacheControl'; + /** + * Check if the request has a cache-varying cookie header + * If it does, it's very important that we don't allow public caching + */ + function haveCacheVaryCookies() { + global $wgRequest, $wgCookiePrefix; + $cookieHeader = $wgRequest->getHeader( 'cookie' ); + if ( $cookieHeader === false ) { + return false; + } + $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" ); + return true; + } + } + wfDebug( __METHOD__.": no cache-varying cookies found\n" ); + return false; + } + + /** Get a complete X-Vary-Options header */ + public function getXVO() { + global $wgCookiePrefix; + $cvCookies = $this->getCacheVaryCookies(); + $xvo = 'X-Vary-Options: Accept-Encoding;list-contains=gzip,Cookie;'; + $first = true; + foreach ( $cvCookies as $cookieName ) { + if ( $first ) { + $first = false; + } else { + $xvo .= ';'; + } + $xvo .= 'string-contains=' . $cookieName; + } + return $xvo; + } - if ($this->mETag) - header("ETag: $this->mETag"); + public function sendCacheControl() { + global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest; + + $response = $wgRequest->response(); + if ($wgUseETag && $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 - header( 'Vary: Accept-Encoding, Cookie' ); - if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache ) { - if( $wgUseSquid && ! isset( $_COOKIE[ini_get( 'session.name') ] ) && - ! $this->isPrintable() && $this->mSquidMaxage != 0 ) + $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 && !$this->haveCacheVaryCookies() ) { if ( $wgUseESI ) { # We'll purge the proxy cache explicitly, but require end user agents # to revalidate against the proxy on each visit. # Surrogate-Control controls our Squid, Cache-Control downstream caches - wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false ); + wfDebug( __METHOD__ . ": 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"'); - header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"'); - 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. # IMPORTANT! The Squid needs to replace the Cache-Control header with # Cache-Control: s-maxage=0, must-revalidate, max-age=0 - wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false ); + wfDebug( __METHOD__ . ": 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" ); - 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 ); - header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' ); - header( "Cache-Control: private, must-revalidate, max-age=0" ); + wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false ); + $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) { + $response->header( "Last-Modified: {$this->mLastModified}" ); } - if($this->mLastModified) header( "Last-modified: {$this->mLastModified}" ); } else { - wfDebug( "$fname: no caching **\n", false ); + wfDebug( __METHOD__ . ": 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. - header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' ); - header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' ); - 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' ); } } @@ -481,51 +790,40 @@ class OutputPage { * Finally, all the text has been munged and accumulated into * the object, let's actually output it: */ - function output() { - global $wgUser, $wgOutputEncoding; + public function output() { + global $wgUser, $wgOutputEncoding, $wgRequest; global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType; - global $wgJsMimeType, $wgStylePath, $wgUseAjax, $wgAjaxSearch, $wgScriptPath, $wgServer; + global $wgJsMimeType, $wgUseAjax, $wgAjaxWatch; + global $wgEnableMWSuggest; if( $this->mDoNothing ){ return; } - $fname = 'OutputPage::output'; - wfProfileIn( $fname ); - $sk = $wgUser->getSkin(); - - if ( $wgUseAjax ) { - $this->addScript( "\n" ); - } - if ( $wgUseAjax && $wgAjaxSearch ) { - $this->addScript( "\n" ); - $this->addScript( "\n" ); - } + wfProfileIn( __METHOD__ ); 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 ) { - header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently"); + $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently"); } $this->mLastModified = wfTimestamp( TS_RFC2822 ); } $this->sendCacheControl(); + $wgRequest->response()->header("Content-Type: text/html; charset=utf-8"); if( $wgDebugRedirects ) { $url = htmlspecialchars( $this->mRedirect ); print "\n\nRedirect\n\n\n"; print "

Location: $url

\n"; print "\n\n"; } else { - header( 'Location: '.$this->mRedirect ); + $wgRequest->response()->header( 'Location: '.$this->mRedirect ); } - wfProfileOut( $fname ); + wfProfileOut( __METHOD__ ); return; } elseif ( $this->mStatusCode ) @@ -580,21 +878,42 @@ class OutputPage { ); if ( $statusMessage[$this->mStatusCode] ) - header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] ); + $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] ); + } + + $sk = $wgUser->getSkin(); + + if ( $wgUseAjax ) { + $this->addScriptFile( 'ajax.js' ); + + wfRunHooks( 'AjaxAddScript', array( &$this ) ); + + if( $wgAjaxWatch && $wgUser->isLoggedIn() ) { + $this->addScriptFile( 'ajaxwatch.js' ); + } + + if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){ + $this->addScriptFile( 'mwsuggest.js' ); + } + } + + if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) { + $this->addScriptFile( 'rightclickedit.js' ); } # Buffer output; final headers may depend on later processing ob_start(); - # Disable temporary placeholders, so that the skin produces HTML - $sk->postParseLinkColour( false ); - - header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" ); - header( 'Content-language: '.$wgContLanguageCode ); + $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" ); + $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode ); 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. + wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) ); + wfProfileIn( 'Output-skin' ); $sk->outputPage( $this ); wfProfileOut( 'Output-skin' ); @@ -602,10 +921,14 @@ class OutputPage { $this->sendCacheControl(); ob_end_flush(); - wfProfileOut( $fname ); + wfProfileOut( __METHOD__ ); } - function out( $ins ) { + /** + * @todo document + * @param string $ins + */ + public function out( $ins ) { global $wgInputEncoding, $wgOutputEncoding, $wgContLang; if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) { $outs = $ins; @@ -616,7 +939,10 @@ class OutputPage { print $outs; } - function setEncodings() { + /** + * @todo document + */ + public static function setEncodings() { global $wgInputEncoding, $wgOutputEncoding; global $wgUser, $wgContLang; @@ -630,291 +956,427 @@ class OutputPage { } /** - * Returns a HTML comment with the elapsed time since request. - * This method has no side effects. - * Use wfReportTime() instead. + * Deprecated, use wfReportTime() instead. * @return string * @deprecated */ - function reportTime() { + public function reportTime() { + wfDeprecated( __METHOD__ ); $time = wfReportTime(); return $time; } /** - * Produce a "user is blocked" page + * Produce a "user is blocked" page. + * + * @param bool $return Whether to have a "return to $wgTitle" message or not. + * @return nothing */ function blockedPage( $return = true ) { - global $wgUser, $wgContLang, $wgTitle; + global $wgUser, $wgContLang, $wgTitle, $wgLang; $this->setPageTitle( wfMsg( 'blockedtitle' ) ); - $this->setRobotpolicy( 'noindex,nofollow' ); + $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); - $id = $wgUser->blockedBy(); + $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(); - if ( is_numeric( $id ) ) { - $name = User::whoIs( $id ); + $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]"; + + $blockid = $wgUser->mBlock->mId; + + $blockExpiry = $wgUser->mBlock->mExpiry; + if ( $blockExpiry == 'infinity' ) { + // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite' + // Search for localization in 'ipboptions' + $scBlockExpiryOptions = wfMsg( 'ipboptions' ); + foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) { + if ( strpos( $option, ":" ) === false ) + continue; + list( $show, $value ) = explode( ":", $option ); + if ( $value == 'infinite' || $value == 'indefinite' ) { + $blockExpiry = $show; + break; + } + } } else { - $name = $id; + $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true ); } - $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]"; - $this->addWikiText( wfMsg( 'blockedtext', $link, $reason, $ip, $name ) ); - + if ( $wgUser->mBlock->mAuto ) { + $msg = 'autoblockedtext'; + } else { + $msg = 'blockedtext'; + } + + /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked. + * This could be a username, an ip range, or a single ip. */ + $intended = $wgUser->mBlock->mAddress; + + $this->addWikiMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp ); + # Don't auto-return to special pages if( $return ) { - $return = $wgTitle->getNamespace() > -1 ? $wgTitle->getPrefixedText() : NULL; - $this->returnToMain( false, $return ); + $return = $wgTitle->getNamespace() > -1 ? $wgTitle : NULL; + $this->returnToMain( null, $return ); } } /** - * Note: these arguments are keys into wfMsg(), not text! + * 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 */ - function showErrorPage( $title, $msg ) { + 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' ); + $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); $this->enableClientCache( false ); $this->mRedirect = ''; + $this->mBodytext = ''; + + array_unshift( $params, 'parse' ); + array_unshift( $params, $msg ); + $this->addHtml( call_user_func_array( 'wfMsgExt', $params ) ); + + $this->returnToMain(); + } + + /** + * Output a standard permission error page + * + * @param array $errors Error message keys + */ + public function showPermissionsErrorPage( $errors, $action = null ) + { + global $wgTitle; + $this->mDebugtext .= 'Original title: ' . + $wgTitle->getPrefixedText() . "\n"; + $this->setPageTitle( wfMsg( 'permissionserrors' ) ); + $this->setHTMLTitle( wfMsg( 'permissionserrors' ) ); + $this->setRobotPolicy( 'noindex,nofollow' ); + $this->setArticleRelated( false ); + $this->enableClientCache( false ); + $this->mRedirect = ''; $this->mBodytext = ''; - $this->addWikiText( wfMsg( $msg ) ); - $this->returnToMain( false ); + $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) ); } - /** @obsolete */ - function errorpage( $title, $msg ) { + /** @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 */ - function versionRequired( $version ) { + public function versionRequired( $version ) { $this->setPageTitle( wfMsg( 'versionrequired', $version ) ); $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) ); - $this->setRobotpolicy( 'noindex,nofollow' ); + $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); $this->mBodytext = ''; - $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) ); + $this->addWikiMsg( 'versionrequiredtext', $version ); $this->returnToMain(); } /** * Display an error page noting that a given permission bit is required. - * This should generally replace the sysopRequired, developerRequired etc. + * * @param string $permission key required */ - function permissionRequired( $permission ) { + public function permissionRequired( $permission ) { global $wgUser; $this->setPageTitle( wfMsg( 'badaccess' ) ); $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) ); - $this->setRobotpolicy( 'noindex,nofollow' ); + $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); $this->mBodytext = ''; - $sk = $wgUser->getSkin(); - $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ) ); - $this->addHTML( wfMsgHtml( 'badaccesstext', $ap, $permission ) ); + $groups = array_map( array( 'User', 'makeGroupLinkWiki' ), + User::getGroupsWithPermission( $permission ) ); + if( $groups ) { + $this->addWikiMsg( 'badaccess-groups', + implode( ', ', $groups ), + count( $groups) ); + } else { + $this->addWikiMsg( 'badaccess-group0' ); + } $this->returnToMain(); } /** + * Use permissionRequired. * @deprecated */ - function sysopRequired() { - global $wgUser; - - $this->setPageTitle( wfMsg( 'sysoptitle' ) ); - $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) ); - $this->setRobotpolicy( 'noindex,nofollow' ); - $this->setArticleRelated( false ); - $this->mBodytext = ''; - - $sk = $wgUser->getSkin(); - $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ), '' ); - $this->addHTML( wfMsgHtml( 'sysoptext', $ap ) ); - $this->returnToMain(); + public function sysopRequired() { + throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" ); } /** + * Use permissionRequired. * @deprecated */ - function developerRequired() { - global $wgUser; - - $this->setPageTitle( wfMsg( 'developertitle' ) ); - $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) ); - $this->setRobotpolicy( 'noindex,nofollow' ); - $this->setArticleRelated( false ); - $this->mBodytext = ''; - - $sk = $wgUser->getSkin(); - $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ), '' ); - $this->addHTML( wfMsgHtml( 'developertext', $ap ) ); - $this->returnToMain(); + public function developerRequired() { + throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" ); } /** * Produce the stock "please login to use the wiki" page */ - function loginToUse() { + public function loginToUse() { global $wgUser, $wgTitle, $wgContLang; + + if( $wgUser->isLoggedIn() ) { + $this->permissionRequired( 'read' ); + return; + } + $skin = $wgUser->getSkin(); - + $this->setPageTitle( wfMsg( 'loginreqtitle' ) ); $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) ); $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleFlag( false ); - - $loginTitle = Title::makeTitle( NS_SPECIAL, 'Userlogin' ); + + $loginTitle = SpecialPage::getTitleFor( 'Userlogin' ); $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() ); $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) ); $this->addHtml( "\n" ); - - $this->returnToMain(); + + # 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() ) + $this->returnToMain( null, $mainPage ); } - /** @obsolete */ - function databaseError( $fname, $sql, $error, $errno ) { + /** @deprecated */ + public function databaseError( $fname, $sql, $error, $errno ) { throw new MWException( "OutputPage::databaseError is obsolete\n" ); } - function readOnlyPage( $source = null, $protected = false ) { - global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle; + /** + * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors + * @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"; + } else { + global $wgLang; + $action_desc = wfMsg( "right-$action" ); + $action_desc = $wgLang->lcfirst( $action_desc ); // FIXME: TERRIBLE HACK + $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n"; + } - $this->setRobotpolicy( 'noindex,nofollow' ); + if (count( $errors ) > 1) { + $text .= ''; + } else { + $text .= '
' . call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . '
'; + } + + return $text; + } + + /** + * 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(), $action = null ) { + global $wgUser, $wgTitle; + $skin = $wgUser->getSkin(); + + $this->setRobotPolicy( 'noindex,nofollow' ); $this->setArticleRelated( false ); - if( $protected ) { - $skin = $wgUser->getSkin(); - $this->setPageTitle( wfMsg( 'viewsource' ) ); - $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) ); - - # Determine if protection is due to the page being a system message - # and show an appropriate explanation - if( $wgTitle->getNamespace() == NS_MEDIAWIKI && !$wgUser->isAllowed( 'editinterface' ) ) { - $this->addWikiText( wfMsg( 'protectedinterface' ) ); + // 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 { - $this->addWikiText( wfMsg( 'protectedtext' ) ); + $this->setPageTitle( wfMsg( 'badaccess' ) ); } + $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) ); } else { + // Wiki is read only $this->setPageTitle( wfMsg( 'readonly' ) ); - if ( $wgReadOnly ) { - $reason = $wgReadOnly; - } else { - $reason = file_get_contents( $wgReadOnlyFile ); - } - $this->addWikiText( wfMsg( 'readonlytext', $reason ) ); + $reason = wfReadOnlyReason(); + $this->addWikiMsg( 'readonlytext', $reason ); } + // Show source, if supplied if( is_string( $source ) ) { - if( strcmp( $source, '' ) == 0 ) { - global $wgTitle; - if ( $wgTitle->getNamespace() == NS_MEDIAWIKI ) { - $source = wfMsgWeirdKey ( $wgTitle->getText() ); - } else { - $source = ''; - } - } - $rows = $wgUser->getIntOption( 'rows' ); - $cols = $wgUser->getIntOption( 'cols' ); - - $text = "\n"; + $this->addWikiMsg( 'viewsourcetext' ); + $text = Xml::openElement( 'textarea', + array( 'id' => 'wpTextbox1', + 'name' => 'wpTextbox1', + 'cols' => $wgUser->getOption( 'cols' ), + 'rows' => $wgUser->getOption( 'rows' ), + 'readonly' => 'readonly' ) ); + $text .= htmlspecialchars( $source ); + $text .= Xml::closeElement( 'textarea' ); $this->addHTML( $text ); + + // Show templates used by this article + $skin = $wgUser->getSkin(); + $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( null, $wgTitle ); + } } - /** @obsolete */ - function fatalError( $message ) { - throw new FatalError( $message ); + /** @deprecated */ + public function fatalError( $message ) { + wfDeprecated( __METHOD__ ); + throw new FatalError( $message ); } - - /** @obsolete */ - function unexpectedValueError( $name, $val ) { + + /** @deprecated */ + public function unexpectedValueError( $name, $val ) { + wfDeprecated( __METHOD__ ); throw new FatalError( wfMsg( 'unexpected', $name, $val ) ); } - /** @obsolete */ - function fileCopyError( $old, $new ) { + /** @deprecated */ + public function fileCopyError( $old, $new ) { + wfDeprecated( __METHOD__ ); throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) ); } - /** @obsolete */ - function fileRenameError( $old, $new ) { + /** @deprecated */ + public function fileRenameError( $old, $new ) { + wfDeprecated( __METHOD__ ); throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) ); } - /** @obsolete */ - function fileDeleteError( $name ) { + /** @deprecated */ + public function fileDeleteError( $name ) { + wfDeprecated( __METHOD__ ); throw new FatalError( wfMsg( 'filedeleteerror', $name ) ); } - /** @obsolete */ - function fileNotFoundError( $name ) { + /** @deprecated */ + public function fileNotFoundError( $name ) { + wfDeprecated( __METHOD__ ); throw new FatalError( wfMsg( 'filenotfound', $name ) ); } - function showFatalError( $message ) { + public function showFatalError( $message ) { $this->setPageTitle( wfMsg( "internalerror" ) ); - $this->setRobotpolicy( "noindex,nofollow" ); + $this->setRobotPolicy( "noindex,nofollow" ); $this->setArticleRelated( false ); $this->enableClientCache( false ); $this->mRedirect = ''; $this->mBodytext = $message; } - function showUnexpectedValueError( $name, $val ) { + public function showUnexpectedValueError( $name, $val ) { $this->showFatalError( wfMsg( 'unexpected', $name, $val ) ); } - function showFileCopyError( $old, $new ) { + public function showFileCopyError( $old, $new ) { $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) ); } - function showFileRenameError( $old, $new ) { + public function showFileRenameError( $old, $new ) { $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) ); } - function showFileDeleteError( $name ) { + public function showFileDeleteError( $name ) { $this->showFatalError( wfMsg( 'filedeleteerror', $name ) ); } - function showFileNotFoundError( $name ) { + public function showFileNotFoundError( $name ) { $this->showFatalError( wfMsg( 'filenotfound', $name ) ); } /** - * return from error messages or notes - * @param $auto automatically redirect the user after 10 seconds - * @param $returnto page title to return to. Default is Main Page. + * Add a "return to" link pointing to a specified title + * + * @param Title $title Title to link */ - function returnToMain( $auto = true, $returnto = NULL ) { - global $wgUser, $wgOut, $wgRequest; - + public function addReturnTo( $title ) { + global $wgUser; + $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) ); + $this->addHtml( "

{$link}

\n" ); + } + + /** + * Add a "return to" link pointing to a specified title, + * or the title indicated in the request, or else the main page + * + * @param null $unused No longer used + * @param Title $returnto Title to return to + */ + public function returnToMain( $unused = null, $returnto = NULL ) { + global $wgRequest; + if ( $returnto == NULL ) { $returnto = $wgRequest->getText( 'returnto' ); } - + if ( '' === $returnto ) { - $returnto = wfMsgForContent( 'mainpage' ); + $returnto = Title::newMainPage(); } if ( is_object( $returnto ) ) { @@ -926,21 +1388,16 @@ class OutputPage { $titleObj = Title::newMainPage(); } - $sk = $wgUser->getSkin(); - $link = $sk->makeLinkObj( $titleObj, '' ); - - $r = wfMsg( 'returnto', $link ); - if ( $auto ) { - $wgOut->addMeta( 'http:Refresh', '10;url=' . $titleObj->escapeFullURL() ); - } - $wgOut->addHTML( "\n

$r

\n" ); + $this->addReturnTo( $titleObj ); } /** * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page * and uses the first 10 of them for META keywords + * + * @param ParserOutput &$parserOutput */ - function addKeywords( &$parserOutput ) { + private function addKeywords( &$parserOutput ) { global $wgTitle; $this->addKeyword( $wgTitle->getPrefixedText() ); $count = 1; @@ -948,8 +1405,8 @@ class OutputPage { if ( !is_array( $links2d ) ) { return; } - foreach ( $links2d as $ns => $dbkeys ) { - foreach( $dbkeys as $dbkey => $id ) { + foreach ( $links2d as $dbkeys ) { + foreach( $dbkeys as $dbkey => $unused ) { $this->addKeyword( $dbkey ); if ( ++$count > 10 ) { break 2; @@ -959,17 +1416,21 @@ class OutputPage { } /** - * @access private - * @return string + * @return string The doctype, opening , and head element. */ - function headElement() { + public function headElement( Skin $sk ) { global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType; - global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle; + global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces; + global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion; + + $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ); + $this->addStyle( 'common/wikiprintable.css', 'print' ); + $sk->setupUserCss( $this ); + + $ret = ''; if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) { - $ret = "\n"; - } else { - $ret = ''; + $ret .= "\n"; } $ret .= "\n"; @@ -979,24 +1440,22 @@ class OutputPage { } $rtl = $wgContLang->isRTL() ? " dir='RTL'" : ''; - $ret .= "\n"; - $ret .= "\n" . htmlspecialchars( $this->getHTMLTitle() ) . "\n"; - array_push( $this->mMetatags, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) ); - - $ret .= $this->getHeadLinks(); - global $wgStylePath; - if( $this->isPrintable() ) { - $media = ''; - } else { - $media = "media='print'"; + $ret .= " $ns) { + $ret .= "xmlns:{$tag}=\"{$ns}\" "; + } + $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n"; + $ret .= "\n" . htmlspecialchars( $this->getHTMLTitle() ) . "\n\t\t"; + $ret .= implode( "\t\t", array( + $this->getHeadLinks(), + $this->buildCssLinks(), + $sk->getHeadScripts( $this->mAllowUserJs ), + $this->mScripts, + $this->getHeadItems(), + )); + if( $sk->usercss ){ + $ret .= ""; } - $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css" ); - $ret .= "\n"; - - $sk = $wgUser->getSkin(); - $ret .= $sk->getHeadScripts(); - $ret .= $this->mScripts; - $ret .= $sk->getUserStyles(); if ($wgUseTrackbacks && $this->isArticleRelated()) $ret .= $wgTitle->trackbackRDF(); @@ -1004,10 +1463,38 @@ class OutputPage { $ret .= "\n"; return $ret; } + + protected function addDefaultMeta() { + global $wgVersion; + $this->addMeta( "generator", "MediaWiki $wgVersion" ); + + $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}"; + if( $p !== 'index,follow' ) { + // http://www.robotstxt.org/wc/meta-user.html + // Only show if it's different from the default robots policy + $this->addMeta( 'robots', $p ); + } + + if ( count( $this->mKeywords ) > 0 ) { + $strip = array( + "/<.*?>/" => '', + "/_/" => ' ' + ); + $this->addMeta( 'keywords', preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ) ) ); + } + } - function getHeadLinks() { - global $wgRequest; - $ret = ''; + /** + * @return string HTML tag links to be put in the header. + */ + public function getHeadLinks() { + global $wgRequest, $wgFeed; + + // Ideally this should happen earlier, somewhere. :P + $this->addDefaultMeta(); + + $tags = array(); + foreach ( $this->mMetatags as $tag ) { if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) { $a = 'http-equiv'; @@ -1015,64 +1502,323 @@ class OutputPage { } else { $a = 'name'; } - $ret .= "\n"; + $tags[] = Xml::element( 'meta', + array( + $a => $tag[0], + 'content' => $tag[1] ) ); + } + foreach ( $this->mLinktags as $tag ) { + $tags[] = Xml::element( 'link', $tag ); } - $p = $this->mRobotpolicy; - if( $p !== '' && $p != 'index,follow' ) { - // http://www.robotstxt.org/wc/meta-user.html - // Only show if it's different from the default robots policy - $ret .= "\n"; + if( $wgFeed ) { + global $wgTitle; + 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. + + $tags[] = $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 (except recentchanges, + # that would be redundant). Put it after the per-page feed to avoid + # changing existing behavior. It's still available, probably via a + # menu in your browser. Some sites might have a different feed they'd + # like to promote instead of the RC feed (maybe like a "Recent New Articles" + # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined. + # If so, use it instead. + + global $wgOverrideSiteFeed, $wgSitename; + $rctitle = SpecialPage::getTitleFor( 'Recentchanges' ); + + if ( $wgOverrideSiteFeed ) { + foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) { + $tags[] = $this->feedLink ( + $type, + htmlspecialchars( $feedUrl ), + wfMsg( "site-{$type}-feed", $wgSitename ) ); + } + } + else if ( $wgTitle->getPrefixedText() != $rctitle->getPrefixedText() ) { + $tags[] = $this->feedLink( + 'rss', + $rctitle->getFullURL( 'feed=rss' ), + wfMsg( 'site-rss-feed', $wgSitename ) ); + $tags[] = $this->feedLink( + 'atom', + $rctitle->getFullURL( 'feed=atom' ), + wfMsg( 'site-atom-feed', $wgSitename ) ); + } } - if ( count( $this->mKeywords ) > 0 ) { - $strip = array( - "/<.*?>/" => '', - "/_/" => ' ' - ); - $ret .= "mKeywords ))) . "\" />\n"; + return implode( "\n\t\t", $tags ) . "\n"; + } + + /** + * 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}" ); + } } - foreach ( $this->mLinktags as $tag ) { - $ret .= ' $val ) { - $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\""; + return $links; + } + + /** + * Generate a 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 ) ); + } + + /** + * 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 + */ + public function addStyle( $style, $media='', $condition='', $dir='' ) { + $options = array(); + if( $media ) + $options['media'] = $media; + if( $condition ) + $options['condition'] = $condition; + if( $dir ) + $options['dir'] = $dir; + $this->styles[$style] = $options; + } + + /** + * Build a set of s for the stylesheets specified in the $this->styles array. + * These will be applied to various media & IE conditionals. + */ + public function buildCssLinks() { + $links = array(); + foreach( $this->styles as $file => $options ) { + $link = $this->styleLink( $file, $options ); + if( $link ) + $links[] = $link; + } + + return implode( "\n\t\t", $links ); + } + + protected function styleLink( $style, $options ) { + global $wgRequest; + + if( isset( $options['dir'] ) ) { + global $wgContLang; + $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr'; + if( $siteDir != $options['dir'] ) + return ''; + } + + if( isset( $options['media'] ) ) { + $media = $this->transformCssMedia( $options['media'] ); + if( is_null( $media ) ) { + return ''; } - $ret .= " />\n"; + } else { + $media = ''; } - if( $this->isSyndicated() ) { - # FIXME: centralize the mime-type and name information in Feed.php - $link = $wgRequest->escapeAppendQuery( 'feed=rss' ); - $ret .= "\n"; - $link = $wgRequest->escapeAppendQuery( 'feed=atom' ); - $ret .= "\n"; + + if( substr( $style, 0, 1 ) == '/' || + substr( $style, 0, 5 ) == 'http:' || + substr( $style, 0, 6 ) == 'https:' ) { + $url = $style; + } else { + global $wgStylePath, $wgStyleVersion; + $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion; } - return $ret; + $attribs = array( + 'rel' => 'stylesheet', + 'href' => $url, + 'type' => 'text/css' ); + if( $media ) { + $attribs['media'] = $media; + } + + $link = Xml::element( 'link', $attribs ); + + if( isset( $options['condition'] ) ) { + $condition = htmlspecialchars( $options['condition'] ); + $link = ""; + } + return $link; + } + + function transformCssMedia( $media ) { + global $wgRequest, $wgHandheldForIPhone; + + // Switch in on-screen display for media testing + $switches = array( + 'printable' => 'print', + 'handheld' => 'handheld', + ); + foreach( $switches as $switch => $targetMedia ) { + if( $wgRequest->getBool( $switch ) ) { + if( $media == $targetMedia ) { + $media = ''; + } elseif( $media == 'screen' ) { + return null; + } + } + } + + // Expand longer media queries as iPhone doesn't grok 'handheld' + if( $wgHandheldForIPhone ) { + $mediaAliases = array( + 'screen' => 'screen and (min-device-width: 481px)', + 'handheld' => 'handheld, only screen and (max-device-width: 480px)', + ); + + if( isset( $mediaAliases[$media] ) ) { + $media = $mediaAliases[$media]; + } + } + + return $media; } /** * Turn off regular page output and return an error reponse * for when rate limiting has triggered. - * @todo i18n - * @access 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.' ); + public function rateLimited() { + global $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( null, $wgTitle ); } - + /** * Show an "add new section" link? * - * @return bool True if the parser output instructs us to add one + * @return bool */ - function showNewSectionLink() { + public function showNewSectionLink() { return $this->mNewSectionLink; } + /** + * Show a warning about slave lag + * + * If the lag is higher than $wgSlaveLagCritical seconds, + * then the warning is a bit more obvious. If the lag is + * lower than $wgSlaveLagWarning, then no warning is shown. + * + * @param int $lag Slave lag + */ + public function showLagWarning( $lag ) { + global $wgSlaveLagWarning, $wgSlaveLagCritical; + if( $lag >= $wgSlaveLagWarning ) { + $message = $lag < $wgSlaveLagCritical + ? 'lag-warn-normal' + : 'lag-warn-high'; + $warning = wfMsgExt( $message, 'parse', $lag ); + $this->addHtml( "
\n{$warning}\n
\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(). + * + * Don't use this for messages that are not in users interface language. + * + * For example: + * + * $wgOut->wrapWikiMsg( '
$1
', 'some-error' ); + * + * Is equivalent to: + * + * $wgOut->addWikiText( '
' . wfMsgNoTrans( 'some-error' ) . '
' ); + */ + 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, /*linestart*/true, /*uilang*/true ) ); + } } -?>