* using htmlspecialchars() for safe XHTML output
[lhc/web/wiklou.git] / includes / OutputPage.php
index 3272713..aa46207 100644 (file)
@@ -21,9 +21,9 @@ class OutputPage {
        var $mLinktags, $mPagetitle, $mBodytext, $mDebugtext;
        var $mHTMLtitle, $mRobotpolicy, $mIsarticle, $mPrintable;
        var $mSubtitle, $mRedirect;
-       var $mLastModified, $mCategoryLinks;
+       var $mLastModified, $mETag, $mCategoryLinks;
        var $mScripts, $mLinkColours;
-       
+
        var $mSuppressQuickbar;
        var $mOnloadHandler;
        var $mDoNothing;
@@ -32,6 +32,7 @@ class OutputPage {
        var $mParserOptions;
        var $mShowFeedLinks = false;
        var $mEnableClientCache = true;
+       var $mArticleBodyOnly = false;
 
        /**
         * Constructor
@@ -53,6 +54,7 @@ class OutputPage {
                $this->mParserOptions = ParserOptions::newFromUser( $temp = NULL );
                $this->mSquidMaxage = 0;
                $this->mScripts = '';
+               $this->mETag = false;
        }
 
        function addHeader( $name, $val ) { array_push( $this->mHeaders, $name.': '.$val ) ; }
@@ -65,6 +67,10 @@ class OutputPage {
        function addScript( $script ) { $this->mScripts .= $script; }
        function getScript() { return $this->mScripts; }
 
+       function setETag($tag) { $this->mETag = $tag; }
+       function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; }
+       function getArticleBodyOnly($only) { return $this->mArticleBodyOnly; }
+
        function addLink( $linkarr ) {
                # $linkarr should be an associative array of attributes. We'll escape on output.
                array_push( $this->mLinktags, $linkarr );
@@ -107,7 +113,8 @@ class OutputPage {
                        # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
                        # this breaks strtotime().
                        $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
-                       $ismodsince = wfTimestamp( TS_MW, strtotime( $modsince ) );
+                       $modsinceTime = strtotime( $modsince );
+                       $ismodsince = wfTimestamp( TS_MW, $modsinceTime ? $modsinceTime : 1 );
                        wfDebug( "-- client send If-Modified-Since: " . $modsince . "\n", false );
                        wfDebug( "--  we might send Last-Modified : $lastmod\n", false );
                        if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) ) {
@@ -117,6 +124,7 @@ class OutputPage {
                                $this->sendCacheControl();
                                wfDebug( "CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp\n", false );
                                $this->disable();
+                               @ob_end_clean(); // Don't output compressed blob
                                return true;
                        } else {
                                wfDebug( "READY  client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp\n", false );
@@ -166,11 +174,12 @@ class OutputPage {
                                $name .= ' - '.$taction;
                        }
                }
-               $this->setHTMLTitle( $name . ' - ' . wfMsg( 'wikititlesuffix' ) );
+               
+               $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
        }
        function getHTMLTitle() { return $this->mHTMLtitle; }
        function getPageTitle() { return $this->mPagetitle; }
-       function setSubtitle( $str ) { $this->mSubtitle = $str; }
+       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; }
@@ -219,6 +228,7 @@ class OutputPage {
 
        function addHTML( $text ) { $this->mBodytext .= $text; }
        function clearHTML() { $this->mBodytext = ''; }
+       function getHTML() { return $this->mBodytext; }
        function debug( $text ) { $this->mDebugtext .= $text; }
 
        function setParserOptions( $options ) {
@@ -238,15 +248,18 @@ class OutputPage {
        function addWikiTextWithTitle($text, &$title, $linestart = true) {
                $this->addWikiTextTitle($text, $title, $linestart);
        }
-       
+
        function addWikiTextTitle($text, &$title, $linestart) {
                global $wgParser, $wgUseTidy;
                $parserOutput = $wgParser->parse( $text, $title, $this->mParserOptions, $linestart );
                $this->mLanguageLinks += $parserOutput->getLanguageLinks();
                $this->mCategoryLinks += $parserOutput->getCategoryLinks();
+               if ( $parserOutput->getCacheTime() == -1 ) {
+                       $this->enableClientCache( false );
+               }
                $this->addHTML( $parserOutput->getText() );
-       }       
-               
+       }
+
        /**
         * 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
@@ -257,13 +270,16 @@ class OutputPage {
                $parserOutput = $wgParser->parse( $text, $wgTitle, $this->mParserOptions, true );
 
                $text = $parserOutput->getText();
-               
-               if ( $cacheArticle ) {
+
+               if ( $cacheArticle && $parserOutput->getCacheTime() != -1 ) {
                        $wgParserCache->save( $parserOutput, $cacheArticle, $wgUser );
                }
 
                $this->mLanguageLinks += $parserOutput->getLanguageLinks();
                $this->mCategoryLinks += $parserOutput->getCategoryLinks();
+               if ( $parserOutput->getCacheTime() == -1 ) {
+                       $this->enableClientCache( false );
+               }
                $this->addHTML( $text );
        }
 
@@ -286,7 +302,7 @@ class OutputPage {
                $parserOutput = $wgParser->parse( $text, $wgTitle, $this->mParserOptions, $linestart );
                return $parserOutput->getText();
        }
-       
+
        /**
         * @param $article
         * @param $user
@@ -326,12 +342,22 @@ class OutputPage {
                return wfSetVar( $this->mEnableClientCache, $state );
        }
 
+       function uncacheableBecauseRequestvars() {
+               global $wgRequest;
+               return  $wgRequest->getText('useskin', false) === false
+                       && $wgRequest->getText('uselang', false) === false;
+       }
+
        function sendCacheControl() {
                global $wgUseSquid, $wgUseESI;
+
+               if ($this->mETag)
+                       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->mEnableClientCache ) {
+               if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache ) {
                        if( $wgUseSquid && ! isset( $_COOKIE[ini_get( 'session.name') ] ) &&
                          ! $this->isPrintable() && $this->mSquidMaxage != 0 )
                        {
@@ -413,6 +439,7 @@ class OutputPage {
                                header( 'Location: '.$this->mRedirect );
                        }
                        if ( isset( $wgProfiler ) ) { wfDebug( $wgProfiler->getOutput() ); }
+                       wfProfileOut( $fname );
                        return;
                }
 
@@ -421,7 +448,7 @@ class OutputPage {
                ob_start();
 
                $this->transformBuffer();
-               
+
                # Disable temporary placeholders, so that the skin produces HTML
                $sk->postParseLinkColour( false );
 
@@ -433,12 +460,17 @@ class OutputPage {
                        setcookie( $name, $val, $exp, '/' );
                }
 
-               wfProfileIn( 'Output-skin' );
-               $sk->outputPage( $this );
-               wfProfileOut( 'Output-skin' );
-               
+               if ($this->mArticleBodyOnly) {
+                       $this->out($this->mBodytext);
+               } else {
+                       wfProfileIn( 'Output-skin' );
+                       $sk->outputPage( $this );
+                       wfProfileOut( 'Output-skin' );
+               }
+
                $this->sendCacheControl();
                ob_end_flush();
+               wfProfileOut( $fname );
        }
 
        function out( $ins ) {
@@ -467,35 +499,6 @@ class OutputPage {
                        $wgOutputEncoding = strtolower( $wgOutputEncoding );
                        return;
                }
-
-               /*
-               # This code is unused anyway!
-               # Commenting out. --bv 2003-11-15
-
-               $a = explode( ",", $_SERVER['HTTP_ACCEPT_CHARSET'] );
-               $best = 0.0;
-               $bestset = "*";
-
-               foreach ( $a as $s ) {
-                       if ( preg_match( "/(.*);q=(.*)/", $s, $m ) ) {
-                               $set = $m[1];
-                               $q = (float)($m[2]);
-                       } else {
-                               $set = $s;
-                               $q = 1.0;
-                       }
-                       if ( $q > $best ) {
-                               $bestset = $set;
-                               $best = $q;
-                       }
-               }
-               #if ( "*" == $bestset ) { $bestset = "iso-8859-1"; }
-               if ( "*" == $bestset ) { $bestset = $wgOutputEncoding; }
-               $wgOutputEncoding = strtolower( $bestset );
-
-# Disable for now
-#
-               */
                $wgOutputEncoding = $wgInputEncoding;
        }
 
@@ -553,6 +556,49 @@ class OutputPage {
                wfErrorExit();
        }
 
+       /**
+        * 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 ) {
+               global $wgUser;
+
+               $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
+               $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
+               $this->setRobotpolicy( 'noindex,nofollow' );
+               $this->setArticleRelated( false );
+               $this->mBodytext = '';
+
+               $sk = $wgUser->getSkin();
+               $this->addWikiText( wfMsg( '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 ) {
+               global $wgUser;
+
+               $this->setPageTitle( wfMsg( 'badaccess' ) );
+               $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
+               $this->setRobotpolicy( 'noindex,nofollow' );
+               $this->setArticleRelated( false );
+               $this->mBodytext = '';
+
+               $sk = $wgUser->getSkin();
+               $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ) );
+               $this->addHTML( wfMsgHtml( 'badaccesstext', $ap, $permission ) );
+               $this->returnToMain();
+       }
+
+       /**
+        * @deprecated
+        */
        function sysopRequired() {
                global $wgUser;
 
@@ -564,10 +610,13 @@ class OutputPage {
 
                $sk = $wgUser->getSkin();
                $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ), '' );
-               $this->addHTML( wfMsg( 'sysoptext', $ap ) );
+               $this->addHTML( wfMsgHtml( 'sysoptext', $ap ) );
                $this->returnToMain();
        }
 
+       /**
+        * @deprecated
+        */
        function developerRequired() {
                global $wgUser;
 
@@ -579,7 +628,7 @@ class OutputPage {
 
                $sk = $wgUser->getSkin();
                $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ), '' );
-               $this->addHTML( wfMsg( 'developertext', $ap ) );
+               $this->addHTML( wfMsgHtml( 'developertext', $ap ) );
                $this->returnToMain();
        }
 
@@ -591,7 +640,11 @@ class OutputPage {
                $this->setRobotpolicy( 'noindex,nofollow' );
                $this->setArticleFlag( false );
                $this->mBodytext = '';
-               $this->addWikiText( wfMsg( 'loginreqtext' ) );
+               $loginpage = Title::makeTitle(NS_SPECIAL, 'Userlogin');
+               $sk = $wgUser->getSkin();
+               $loginlink = $sk->makeKnownLinkObj($loginpage, wfMsg('loginreqlink'), 
+                       'returnto=' . htmlspecialchars($wgTitle->getPrefixedDBkey()));
+               $this->addHTML( wfMsgHtml( 'loginreqpagetext', $loginlink ) );
 
                # We put a comment in the .html file so a Sysop can diagnose the page the
                # user can't see.
@@ -633,7 +686,7 @@ class OutputPage {
        }
 
        function readOnlyPage( $source = null, $protected = false ) {
-               global $wgUser, $wgReadOnlyFile;
+               global $wgUser, $wgReadOnlyFile, $wgReadOnly;
 
                $this->setRobotpolicy( 'noindex,nofollow' );
                $this->setArticleRelated( false );
@@ -643,7 +696,11 @@ class OutputPage {
                        $this->addWikiText( wfMsg( 'protectedtext' ) );
                } else {
                        $this->setPageTitle( wfMsg( 'readonly' ) );
-                       $reason = file_get_contents( $wgReadOnlyFile );
+                       if ( $wgReadOnly ) {
+                               $reason = $wgReadOnly;
+                       } else {
+                               $reason = file_get_contents( $wgReadOnlyFile );
+                       }
                        $this->addWikiText( wfMsg( 'readonlytext', $reason ) );
                }
 
@@ -721,14 +778,15 @@ class OutputPage {
        }
 
        /**
-        * This function takes the existing and broken links for the page
+        * 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
         */
        function addMetaTags () {
                global $wgLinkCache , $wgOut ;
+               $categories = array_keys ( $wgLinkCache->mCategoryLinks ) ;
                $good = array_keys ( $wgLinkCache->mGoodLinks ) ;
                $bad = array_keys ( $wgLinkCache->mBadLinks ) ;
-               $a = array_merge ( $good , $bad ) ;
+               $a = array_merge ( array_slice ( $good , 0 , 1 ), $categories, array_slice ( $good , 1 , 9 ) , $bad ) ;
                $a = array_slice ( $a , 0 , 10 ) ; # 10 keywords max
                $a = implode ( ',' , $a ) ;
                $strip = array(
@@ -746,7 +804,7 @@ class OutputPage {
         */
        function headElement() {
                global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
-               global $wgUser, $wgContLang, $wgRequest;
+               global $wgUser, $wgContLang, $wgRequest, $wgUseTrackbacks, $wgTitle;
 
                if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
                        $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
@@ -756,13 +814,13 @@ class OutputPage {
 
                $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
 
-               if ( "" == $this->mHTMLtitle ) {
-                       $this->mHTMLtitle = wfMsg( "pagetitle", $this->mPagetitle );
+               if ( '' == $this->getHTMLTitle() ) {
+                       $this->setHTMLTitle(  wfMsg( 'pagetitle', $this->getPageTitle() ));
                }
 
                $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
                $ret .= "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
-               $ret .= "<head>\n<title>" . htmlspecialchars( $this->mHTMLtitle ) . "</title>\n";
+               $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
                array_push( $this->mMetatags, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
 
                $ret .= $this->getHeadLinks();
@@ -780,6 +838,9 @@ class OutputPage {
                $ret .= $this->mScripts;
                $ret .= $sk->getUserStyles();
 
+               if ($wgUseTrackbacks && $this->isArticleRelated())
+                       $ret .= $wgTitle->trackbackRDF();
+
                $ret .= "</head>\n";
                return $ret;
        }
@@ -820,23 +881,23 @@ class OutputPage {
                        $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/rss+atom' title='Atom 0.3' href='$link' />\n";
+                       $ret .= "<link rel='alternate' type='application/atom+xml' title='Atom 0.3' href='$link' />\n";
                }
 
                return $ret;
        }
-       
+
        /**
         * Run any necessary pre-output transformations on the buffer text
         */
        function transformBuffer( $options = 0 ) {
        }
 
-       
+
        /**
         * Turn off regular page output and return an error reponse
         * for when rate limiting has triggered.
-        * @todo: i18n
+        * @todo i18n
         * @access public
         */
        function rateLimited() {