fetch commons descriptions for display on local wikis
[lhc/web/wiklou.git] / includes / OutputPage.php
index aa3d46f..f58fde9 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,9 @@ 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 addLink( $linkarr ) {
                # $linkarr should be an associative array of attributes. We'll escape on output.
                array_push( $this->mLinktags, $linkarr );
@@ -170,7 +175,7 @@ class OutputPage {
        }
        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 +224,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 ) {
@@ -227,13 +233,26 @@ class OutputPage {
 
        /**
         * Convert wikitext to HTML and add it to the buffer
+        * Default assumes that the current page title will
+        * be used.
         */
        function addWikiText( $text, $linestart = true ) {
-               global $wgParser, $wgTitle, $wgUseTidy;
+               global $wgTitle;
+               $this->addWikiTextTitle($text, $wgTitle, $linestart);
+       }
 
-               $parserOutput = $wgParser->parse( $text, $wgTitle, $this->mParserOptions, $linestart );
+       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() );
        }
 
@@ -247,13 +266,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 );
        }
 
@@ -276,7 +298,7 @@ class OutputPage {
                $parserOutput = $wgParser->parse( $text, $wgTitle, $this->mParserOptions, $linestart );
                return $parserOutput->getText();
        }
-       
+
        /**
         * @param $article
         * @param $user
@@ -318,6 +340,10 @@ class OutputPage {
 
        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' );
@@ -411,7 +437,7 @@ class OutputPage {
                ob_start();
 
                $this->transformBuffer();
-               
+
                # Disable temporary placeholders, so that the skin produces HTML
                $sk->postParseLinkColour( false );
 
@@ -423,10 +449,14 @@ 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();
        }
@@ -457,35 +487,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;
        }
 
@@ -543,6 +544,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;
 
@@ -554,10 +598,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;
 
@@ -569,7 +616,7 @@ class OutputPage {
 
                $sk = $wgUser->getSkin();
                $ap = $sk->makeKnownLink( wfMsgForContent( 'administrators' ), '' );
-               $this->addHTML( wfMsg( 'developertext', $ap ) );
+               $this->addHTML( wfMsgHtml( 'developertext', $ap ) );
                $this->returnToMain();
        }
 
@@ -623,7 +670,7 @@ class OutputPage {
        }
 
        function readOnlyPage( $source = null, $protected = false ) {
-               global $wgUser, $wgReadOnlyFile;
+               global $wgUser, $wgReadOnlyFile, $wgReadOnly;
 
                $this->setRobotpolicy( 'noindex,nofollow' );
                $this->setArticleRelated( false );
@@ -633,7 +680,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 ) );
                }
 
@@ -815,13 +866,28 @@ class OutputPage {
 
                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
+        * @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.' );
+       }
+
 }
 
 } // MediaWiki