Oops, forgot to change this in r71426
[lhc/web/wiklou.git] / includes / RawPage.php
index 2c9b8c5..03cb4a1 100644 (file)
 <?php
 /**
- * Copyright (C) 2004 Gabriel Wicke <gw@wikidev.net>
- * http://www.aulinx.de/
- * Based on PageHistory and SpecialExport
- * 
+ * Raw page text accessor
+ *
+ * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
+ * http://wikidev.net/
+ *
+ * Based on HistoryPage and SpecialExport
+ *
  * License: GPL (http://www.gnu.org/copyleft/gpl.html)
  *
- * @author Gabriel Wicke <gw@wikidev.net>
- * @package MediaWiki
+ * @author Gabriel Wicke <wicke@wikidev.net>
+ * @file
  */
 
-require_once( 'Revision.php' );
-
 /**
- * @todo document
- * @package MediaWiki
+ * A simple method to retrieve the plain source of an article,
+ * using "action=raw" in the GET request string.
  */
 class RawPage {
+       var $mArticle, $mTitle, $mRequest;
+       var $mOldId, $mGen, $mCharset, $mSection;
+       var $mSmaxage, $mMaxage;
+       var $mContentType, $mExpandTemplates;
+
+       function __construct( Article $article, $request = false ) {
+               global $wgRequest, $wgInputEncoding, $wgSquidMaxage, $wgJsMimeType, $wgGroupPermissions;
+
+               $allowedCTypes = array('text/x-wiki', $wgJsMimeType, 'text/css', 'application/x-zope-edit');
+               $this->mArticle = $article;
+               $this->mTitle = $article->mTitle;
+
+               if( $request === false ) {
+                       $this->mRequest = $wgRequest;
+               } else {
+                       $this->mRequest = $request;
+               }
+
+               $ctype = $this->mRequest->getVal( 'ctype' );
+               $smaxage = $this->mRequest->getIntOrNull( 'smaxage' );
+               $maxage = $this->mRequest->getInt( 'maxage', $wgSquidMaxage );
+
+               $this->mExpandTemplates = $this->mRequest->getVal( 'templates' ) === 'expand';
+               $this->mUseMessageCache = $this->mRequest->getBool( 'usemsgcache' );
+
+               $this->mSection = $this->mRequest->getIntOrNull( 'section' );
+
+               $oldid = $this->mRequest->getInt( 'oldid' );
+
+               switch( $wgRequest->getText( 'direction' ) ) {
+                       case 'next':
+                               # output next revision, or nothing if there isn't one
+                               if( $oldid ) {
+                                       $oldid = $this->mTitle->getNextRevisionId( $oldid );
+                               }
+                               $oldid = $oldid ? $oldid : -1;
+                               break;
+                       case 'prev':
+                               # output previous revision, or nothing if there isn't one
+                               if( ! $oldid ) {
+                                       # get the current revision so we can get the penultimate one
+                                       $this->mArticle->getTouched();
+                                       $oldid = $this->mArticle->mLatest;
+                               }
+                               $prev = $this->mTitle->getPreviousRevisionId( $oldid );
+                               $oldid = $prev ? $prev : -1 ;
+                               break;
+                       case 'cur':
+                               $oldid = 0;
+                               break;
+               }
+               $this->mOldId = $oldid;
 
-       function RawPage( $article ) {
-               global $wgRequest, $wgInputEncoding, $wgSquidMaxage;
-               $allowedCTypes = array('text/x-wiki', 'text/javascript', 'text/css', 'application/x-zope-edit');
-               $this->mArticle =& $article;
-               $this->mTitle =& $article->mTitle;
-                       
-               $ctype = $wgRequest->getText( 'ctype' );
-               $smaxage = $wgRequest->getInt( 'smaxage', $wgSquidMaxage );
-               $maxage = $wgRequest->getInt( 'maxage', $wgSquidMaxage );
-               $this->mOldId = $wgRequest->getInt( 'oldid' );
                # special case for 'generated' raw things: user css/js
-               $gen = $wgRequest->getText( 'gen' );
-               if($gen == 'css') {
+               $gen = $this->mRequest->getVal( 'gen' );
+
+               if( $gen == 'css' ) {
                        $this->mGen = $gen;
-                       if($smaxage == '') $smaxage = $wgSquidMaxage;
+                       if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
                        if($ctype == '') $ctype = 'text/css';
-               } else if ($gen == 'js') {
+               } elseif( $gen == 'js' ) {
                        $this->mGen = $gen;
-                       if($smaxage == '') $smaxage = $wgSquidMaxage;
-                       if($ctype == '') $ctype = 'text/javascript';
+                       if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
+                       if($ctype == '') $ctype = $wgJsMimeType;
                } else {
                        $this->mGen = false;
                }
                $this->mCharset = $wgInputEncoding;
-               $this->mSmaxage = $smaxage;
+
+               # Force caching for CSS and JS raw content, default: 5 minutes
+               if( is_null($smaxage) and ($ctype=='text/css' or $ctype==$wgJsMimeType) ) {
+                       global $wgForcedRawSMaxage;
+                       $this->mSmaxage = intval($wgForcedRawSMaxage);
+               } else {
+                       $this->mSmaxage = intval( $smaxage );
+               }
                $this->mMaxage = $maxage;
-               if(empty($ctype) or !in_array($ctype, $allowedCTypes)) {
+
+               # Output may contain user-specific data;
+               # vary generated content for open sessions and private wikis
+               if( $this->mGen or !$wgGroupPermissions['*']['read'] ) {
+                       $this->mPrivateCache = $this->mSmaxage == 0 || session_id() != '';
+               } else {
+                       $this->mPrivateCache = false;
+               }
+
+               if( $ctype == '' or ! in_array( $ctype, $allowedCTypes ) ) {
                        $this->mContentType = 'text/x-wiki';
                } else {
                        $this->mContentType = $ctype;
                }
        }
-       
+
        function view() {
-               global $wgUser, $wgOut, $wgScript;
+               global $wgOut, $wgRequest;
 
-               if( strcmp( $wgScript, $_SERVER['PHP_SELF'] ) ) {
+               if( $wgRequest->isPathInfoBad() ) {
                        # Internet Explorer will ignore the Content-Type header if it
                        # thinks it sees a file extension it recognizes. Make sure that
                        # all raw requests are done through the script node, which will
                        # have eg '.php' and should remain safe.
-                       
-                       $destUrl = $this->mTitle->getFullUrl(
-                               'action=raw' .
-                               '&ctype=' . urlencode( $this->mContentType ) .
-                               '&smaxage=' . urlencode( $this->mSmaxage ) .
-                               '&maxage=' . urlencode( $this->mMaxage ) .
-                               '&gen=' . urlencode( $this->mGen ) .
-                               '&oldid=' . urlencode( $this->mOldId ) );
-                       header( 'Location: ' . $destUrl );
-                       $wgOut->disable();
+                       #
+                       # We used to redirect to a canonical-form URL as a general
+                       # backwards-compatibility / good-citizen nice thing. However
+                       # a lot of servers are set up in buggy ways, resulting in
+                       # redirect loops which hang the browser until the CSS load
+                       # times out.
+                       #
+                       # Just return a 403 Forbidden and get it over with.
+                       wfHttpError( 403, 'Forbidden',
+                               'Invalid file extension found in PATH_INFO. ' . 
+                               'Raw pages must be accessed through the primary script entry point.' );
                        return;
                }
-               
+
                header( "Content-type: ".$this->mContentType.'; charset='.$this->mCharset );
                # allow the client to cache this for 24 hours
-               header( 'Cache-Control: s-maxage='.$this->mSmaxage.', max-age='.$this->mMaxage );
-               if($this->mGen) {
+               $mode = $this->mPrivateCache ? 'private' : 'public';
+               header( 'Cache-Control: '.$mode.', s-maxage='.$this->mSmaxage.', max-age='.$this->mMaxage );
+               
+               global $wgUseFileCache;
+               if( $wgUseFileCache and HTMLFileCache::useFileCache() ) {
+                       $cache = new HTMLFileCache( $this->mTitle, 'raw' );
+                       if( $cache->isFileCacheGood( /* Assume up to date */ ) ) {
+                               $cache->loadFromFileCache();
+                               $wgOut->disable();
+                               return;
+                       } else {
+                               ob_start( array(&$cache, 'saveToFileCache' ) );
+                       }
+               }
+               
+               $text = $this->getRawText();
+
+               if( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
+                       wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
+               }
+
+               echo $text;
+               $wgOut->disable();
+       }
+
+       function getRawText() {
+               global $wgUser, $wgOut;
+               if( $this->mGen ) {
                        $sk = $wgUser->getSkin();
-                       $sk->initPage($wgOut);
-                       if($this->mGen == 'css') {
-                               echo $sk->getUserStylesheet();
-                       } else if($this->mGen == 'js') {
-                               echo $sk->getUserJs();
+                       if( !StubObject::isRealObject( $wgOut ) )
+                               $wgOut->_unstub( 2 );
+                       $sk->initPage( $wgOut );
+                       if( $this->mGen == 'css' ) {
+                               return $sk->generateUserStylesheet();
+                       } else if( $this->mGen == 'js' ) {
+                               return $sk->generateUserJs();
                        }
                } else {
-                       echo $this->getrawtext();
+                       return $this->getArticleText();
                }
-               $wgOut->disable();
        }
-       
-       function getrawtext () {
-               global $wgInputEncoding, $wgContLang;
-               $fname = 'RawPage::getrawtext';
-               
-               if( !$this->mTitle ) return '';
-               
-               # Special case for MediaWiki: messages; we can hit the message cache.
-               if( $this->mTitle->getNamespace() == NS_MEDIAWIKI) {
-                       $rawtext = wfMsg( $this->mTitle->getDbkey() );
-                       return $rawtext;
+
+       function getArticleText() {
+               $found = false;
+               $text = '';
+               if( $this->mTitle ) {
+                       // If it's a MediaWiki message we can just hit the message cache
+                       if( $this->mUseMessageCache && $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
+                               $key = $this->mTitle->getDBkey();
+                               $text = wfMsgForContentNoTrans( $key );
+                               # If the message doesn't exist, return a blank
+                               if( wfEmptyMsg( $key, $text ) )
+                                       $text = '';
+                               $found = true;
+                       } else {
+                               // Get it from the DB
+                               $rev = Revision::newFromTitle( $this->mTitle, $this->mOldId );
+                               if( $rev ) {
+                                       $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
+                                       header( "Last-modified: $lastmod" );
+
+                                       if( !is_null($this->mSection ) ) {
+                                               global $wgParser;
+                                               $text = $wgParser->getSection ( $rev->getText(), $this->mSection );
+                                       } else
+                                               $text = $rev->getText();
+                                       $found = true;
+                               }
+                       }
                }
-               
-               # else get it from the DB
-               $rev = Revision::newFromTitle( $this->mTitle, $this->mOldId );
-               if( $rev ) {
-                       $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
-                       header( 'Last-modified: ' . $lastmod );
-                       return $rev->getText();
-               } else {
-                       return '';
+
+               # Bad title or page does not exist
+               if( !$found && $this->mContentType == 'text/x-wiki' ) {
+                       # Don't return a 404 response for CSS or JavaScript;
+                       # 404s aren't generally cached and it would create
+                       # extra hits when user CSS/JS are on and the user doesn't
+                       # have the pages.
+                       header( "HTTP/1.0 404 Not Found" );
                }
+
+               // Special-case for empty CSS/JS
+               //
+               // Internet Explorer for Mac handles empty files badly;
+               // particularly so when keep-alive is active. It can lead
+               // to long timeouts as it seems to sit there waiting for
+               // more data that never comes.
+               //
+               // Give it a comment...
+               if( strlen( $text ) == 0 &&
+                       ($this->mContentType == 'text/css' ||
+                               $this->mContentType == 'text/javascript' ) ) {
+                       return "/* Empty */";
+               }
+
+               return $this->parseArticleText( $text );
+       }
+
+       function parseArticleText( $text ) {
+               if( $text === '' )
+                       return '';
+               else
+                       if( $this->mExpandTemplates ) {
+                               global $wgParser;
+                               return $wgParser->preprocess( $text, $this->mTitle, new ParserOptions() );
+                       } else
+                               return $text;
        }
 }
-?>