includes/RawPage.php

   1 <?php
   2 /**
   3  * Copyright (C) 2004 Gabriel Wicke <wicke@wikidev.net>
   4  * http://wikidev.net/
   5  * Based on HistoryPage and SpecialExport
   6  *
   7  * License: GPL (http://www.gnu.org/copyleft/gpl.html)
   8  *
   9  * @author Gabriel Wicke <wicke@wikidev.net>
  10  * @file
  11  */
  12
  13 /**
  14  * A simple method to retrieve the plain source of an article,
  15  * using "action=raw" in the GET request string.
  16  */
  17 class RawPage {
  18         var $mArticle, $mTitle, $mRequest;
  19         var $mOldId, $mGen, $mCharset, $mSection;
  20         var $mSmaxage, $mMaxage;
  21         var $mContentType, $mExpandTemplates;
  22
  23         function __construct( &$article, $request = false ) {
  24                 global $wgRequest, $wgInputEncoding, $wgSquidMaxage, $wgJsMimeType, $wgGroupPermissions;
  25
  26                 $allowedCTypes = array('text/x-wiki', $wgJsMimeType, 'text/css', 'application/x-zope-edit');
  27                 $this->mArticle =& $article;
  28                 $this->mTitle =& $article->mTitle;
  29
  30                 if( $request === false ) {
  31                         $this->mRequest =& $wgRequest;
  32                 } else {
  33                         $this->mRequest = $request;
  34                 }
  35
  36                 $ctype = $this->mRequest->getVal( 'ctype' );
  37                 $smaxage = $this->mRequest->getIntOrNull( 'smaxage' );
  38                 $maxage = $this->mRequest->getInt( 'maxage', $wgSquidMaxage );
  39
  40                 $this->mExpandTemplates = $this->mRequest->getVal( 'templates' ) === 'expand';
  41                 $this->mUseMessageCache = $this->mRequest->getBool( 'usemsgcache' );
  42
  43                 $this->mSection = $this->mRequest->getIntOrNull( 'section' );
  44
  45                 $oldid = $this->mRequest->getInt( 'oldid' );
  46
  47                 switch( $wgRequest->getText( 'direction' ) ) {
  48                         case 'next':
  49                                 # output next revision, or nothing if there isn't one
  50                                 if( $oldid ) {
  51                                         $oldid = $this->mTitle->getNextRevisionId( $oldid );
  52                                 }
  53                                 $oldid = $oldid ? $oldid : -1;
  54                                 break;
  55                         case 'prev':
  56                                 # output previous revision, or nothing if there isn't one
  57                                 if( ! $oldid ) {
  58                                         # get the current revision so we can get the penultimate one
  59                                         $this->mArticle->getTouched();
  60                                         $oldid = $this->mArticle->mLatest;
  61                                 }
  62                                 $prev = $this->mTitle->getPreviousRevisionId( $oldid );
  63                                 $oldid = $prev ? $prev : -1 ;
  64                                 break;
  65                         case 'cur':
  66                                 $oldid = 0;
  67                                 break;
  68                 }
  69                 $this->mOldId = $oldid;
  70
  71                 # special case for 'generated' raw things: user css/js
  72                 $gen = $this->mRequest->getVal( 'gen' );
  73
  74                 if( $gen == 'css' ) {
  75                         $this->mGen = $gen;
  76                         if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
  77                         if($ctype == '') $ctype = 'text/css';
  78                 } elseif( $gen == 'js' ) {
  79                         $this->mGen = $gen;
  80                         if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
  81                         if($ctype == '') $ctype = $wgJsMimeType;
  82                 } else {
  83                         $this->mGen = false;
  84                 }
  85                 $this->mCharset = $wgInputEncoding;
  86
  87                 # Force caching for CSS and JS raw content, default: 5 minutes
  88                 if( is_null($smaxage) and ($ctype=='text/css' or $ctype==$wgJsMimeType) ) {
  89                         global $wgForcedRawSMaxage;
  90                         $this->mSmaxage = intval($wgForcedRawSMaxage);
  91                 } else {
  92                         $this->mSmaxage = intval( $smaxage );
  93                 }
  94                 $this->mMaxage = $maxage;
  95
  96                 # Output may contain user-specific data;
  97                 # vary generated content for open sessions and private wikis
  98                 if( $this->mGen or !$wgGroupPermissions['*']['read'] ) {
  99                         $this->mPrivateCache = $this->mSmaxage == 0 || session_id() != '';
 100                 } else {
 101                         $this->mPrivateCache = false;
 102                 }
 103
 104                 if( $ctype == '' or ! in_array( $ctype, $allowedCTypes ) ) {
 105                         $this->mContentType = 'text/x-wiki';
 106                 } else {
 107                         $this->mContentType = $ctype;
 108                 }
 109         }
 110
 111         function view() {
 112                 global $wgOut, $wgScript, $wgRequest;
 113
 114                 if( $wgRequest->isPathInfoBad() ) {
 115                         # Internet Explorer will ignore the Content-Type header if it
 116                         # thinks it sees a file extension it recognizes. Make sure that
 117                         # all raw requests are done through the script node, which will
 118                         # have eg '.php' and should remain safe.
 119                         #
 120                         # We used to redirect to a canonical-form URL as a general
 121                         # backwards-compatibility / good-citizen nice thing. However
 122                         # a lot of servers are set up in buggy ways, resulting in
 123                         # redirect loops which hang the browser until the CSS load
 124                         # times out.
 125                         #
 126                         # Just return a 403 Forbidden and get it over with.
 127                         wfHttpError( 403, 'Forbidden',
 128                                 'Invalid file extension found in PATH_INFO. ' .
 129                                 'Raw pages must be accessed through the primary script entry point.' );
 130                         return;
 131                 }
 132
 133                 header( "Content-type: ".$this->mContentType.'; charset='.$this->mCharset );
 134                 # allow the client to cache this for 24 hours
 135                 $mode = $this->mPrivateCache ? 'private' : 'public';
 136                 header( 'Cache-Control: '.$mode.', s-maxage='.$this->mSmaxage.', max-age='.$this->mMaxage );
 137
 138                 global $wgUseFileCache;
 139                 if( $wgUseFileCache and HTMLFileCache::useFileCache() ) {
 140                         $cache = new HTMLFileCache( $this->mTitle, 'raw' );
 141                         if( $cache->isFileCacheGood( /* Assume up to date */ ) ) {
 142                                 $cache->loadFromFileCache();
 143                                 $wgOut->disable();
 144                                 return;
 145                         } else {
 146                                 ob_start( array(&$cache, 'saveToFileCache' ) );
 147                         }
 148                 }
 149
 150                 $text = $this->getRawText();
 151
 152                 if( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
 153                         wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
 154                 }
 155
 156                 echo $text;
 157                 $wgOut->disable();
 158         }
 159
 160         function getRawText() {
 161                 global $wgUser, $wgOut, $wgRequest;
 162                 if( $this->mGen ) {
 163                         $sk = $wgUser->getSkin();
 164                         if( !StubObject::isRealObject( $wgOut ) )
 165                                 $wgOut->_unstub( 2 );
 166                         $sk->initPage( $wgOut );
 167                         if( $this->mGen == 'css' ) {
 168                                 return $sk->generateUserStylesheet();
 169                         } else if( $this->mGen == 'js' ) {
 170                                 return $sk->generateUserJs();
 171                         }
 172                 } else {
 173                         return $this->getArticleText();
 174                 }
 175         }
 176
 177         function getArticleText() {
 178                 $found = false;
 179                 $text = '';
 180                 if( $this->mTitle ) {
 181                         // If it's a MediaWiki message we can just hit the message cache
 182                         if( $this->mUseMessageCache && $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
 183                                 $key = $this->mTitle->getDBkey();
 184                                 $text = wfMsgForContentNoTrans( $key );
 185                                 # If the message doesn't exist, return a blank
 186                                 if( wfEmptyMsg( $key, $text ) )
 187                                         $text = '';
 188                                 $found = true;
 189                         } else {
 190                                 // Get it from the DB
 191                                 $rev = Revision::newFromTitle( $this->mTitle, $this->mOldId );
 192                                 if( $rev ) {
 193                                         $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
 194                                         header( "Last-modified: $lastmod" );
 195
 196                                         if( !is_null($this->mSection ) ) {
 197                                                 global $wgParser;
 198                                                 $text = $wgParser->getSection ( $rev->getText(), $this->mSection );
 199                                         } else
 200                                                 $text = $rev->getText();
 201                                         $found = true;
 202                                 }
 203                         }
 204                 }
 205
 206                 # Bad title or page does not exist
 207                 if( !$found && $this->mContentType == 'text/x-wiki' ) {
 208                         # Don't return a 404 response for CSS or JavaScript;
 209                         # 404s aren't generally cached and it would create
 210                         # extra hits when user CSS/JS are on and the user doesn't
 211                         # have the pages.
 212                         header( "HTTP/1.0 404 Not Found" );
 213                 }
 214
 215                 // Special-case for empty CSS/JS
 216                 //
 217                 // Internet Explorer for Mac handles empty files badly;
 218                 // particularly so when keep-alive is active. It can lead
 219                 // to long timeouts as it seems to sit there waiting for
 220                 // more data that never comes.
 221                 //
 222                 // Give it a comment...
 223                 if( strlen( $text ) == 0 &&
 224                         ($this->mContentType == 'text/css' ||
 225                                 $this->mContentType == 'text/javascript' ) ) {
 226                         return "/* Empty */";
 227                 }
 228
 229                 return $this->parseArticleText( $text );
 230         }
 231
 232         function parseArticleText( $text ) {
 233                 if( $text === '' )
 234                         return '';
 235                 else
 236                         if( $this->mExpandTemplates ) {
 237                                 global $wgParser;
 238                                 return $wgParser->preprocess( $text, $this->mTitle, new ParserOptions() );
 239                         } else
 240                                 return $text;
 241         }
 242 }