3 * Copyright (C) 2004 Gabriel Wicke <wicke@wikidev.net>
5 * Based on PageHistory and SpecialExport
7 * License: GPL (http://www.gnu.org/copyleft/gpl.html)
9 * @author Gabriel Wicke <wicke@wikidev.net>
14 * A simple method to retrieve the plain source of an article,
15 * using "action=raw" in the GET request string.
18 var $mArticle, $mTitle, $mRequest;
19 var $mOldId, $mGen, $mCharset, $mSection;
20 var $mSmaxage, $mMaxage;
21 var $mContentType, $mExpandTemplates;
23 function __construct( &$article, $request = false ) {
24 global $wgRequest, $wgInputEncoding, $wgSquidMaxage, $wgJsMimeType, $wgGroupPermissions;
26 $allowedCTypes = array('text/x-wiki', $wgJsMimeType, 'text/css', 'application/x-zope-edit');
27 $this->mArticle =& $article;
28 $this->mTitle =& $article->mTitle;
30 if( $request === false ) {
31 $this->mRequest =& $wgRequest;
33 $this->mRequest = $request;
36 $ctype = $this->mRequest->getVal( 'ctype' );
37 $smaxage = $this->mRequest->getIntOrNull( 'smaxage' );
38 $maxage = $this->mRequest->getInt( 'maxage', $wgSquidMaxage );
40 $this->mExpandTemplates = $this->mRequest->getVal( 'templates' ) === 'expand';
41 $this->mUseMessageCache = $this->mRequest->getBool( 'usemsgcache' );
43 $this->mSection = $this->mRequest->getIntOrNull( 'section' );
45 $oldid = $this->mRequest->getInt( 'oldid' );
47 switch( $wgRequest->getText( 'direction' ) ) {
49 # output next revision, or nothing if there isn't one
51 $oldid = $this->mTitle->getNextRevisionId( $oldid );
53 $oldid = $oldid ? $oldid : -1;
56 # output previous revision, or nothing if there isn't one
58 # get the current revision so we can get the penultimate one
59 $this->mArticle->getTouched();
60 $oldid = $this->mArticle->mLatest;
62 $prev = $this->mTitle->getPreviousRevisionId( $oldid );
63 $oldid = $prev ? $prev : -1 ;
69 $this->mOldId = $oldid;
71 # special case for 'generated' raw things: user css/js
72 $gen = $this->mRequest->getVal( 'gen' );
76 if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
77 if($ctype == '') $ctype = 'text/css';
78 } elseif( $gen == 'js' ) {
80 if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
81 if($ctype == '') $ctype = $wgJsMimeType;
85 $this->mCharset = $wgInputEncoding;
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);
92 $this->mSmaxage = intval( $smaxage );
94 $this->mMaxage = $maxage;
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() != '';
101 $this->mPrivateCache = false;
104 if( $ctype == '' or ! in_array( $ctype, $allowedCTypes ) ) {
105 $this->mContentType = 'text/x-wiki';
107 $this->mContentType = $ctype;
112 global $wgOut, $wgScript;
114 if( isset( $_SERVER['SCRIPT_URL'] ) ) {
115 # Normally we use PHP_SELF to get the URL to the script
116 # as it was called, minus the query string.
118 # Some sites use Apache rewrite rules to handle subdomains,
119 # and have PHP set up in a weird way that causes PHP_SELF
120 # to contain the rewritten URL instead of the one that the
121 # outside world sees.
123 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
124 # provides containing the "before" URL.
125 $url = $_SERVER['SCRIPT_URL'];
127 $url = $_SERVER['PHP_SELF'];
130 if( strcmp( $wgScript, $url ) ) {
131 # Internet Explorer will ignore the Content-Type header if it
132 # thinks it sees a file extension it recognizes. Make sure that
133 # all raw requests are done through the script node, which will
134 # have eg '.php' and should remain safe.
136 # We used to redirect to a canonical-form URL as a general
137 # backwards-compatibility / good-citizen nice thing. However
138 # a lot of servers are set up in buggy ways, resulting in
139 # redirect loops which hang the browser until the CSS load
142 # Just return a 403 Forbidden and get it over with.
143 wfHttpError( 403, 'Forbidden',
144 'Raw pages must be accessed through the primary script entry point.' );
148 header( "Content-type: ".$this->mContentType.'; charset='.$this->mCharset );
149 # allow the client to cache this for 24 hours
150 $mode = $this->mPrivateCache ? 'private' : 'public';
151 header( 'Cache-Control: '.$mode.', s-maxage='.$this->mSmaxage.', max-age='.$this->mMaxage );
153 if( HTMLFileCache::useFileCache() ) {
154 $cache = new HTMLFileCache( $this->mTitle, 'raw' );
155 if( $cache->isFileCacheGood( /* Assume up to date */ ) ) {
156 $cache->loadFromFileCache();
160 ob_start( array(&$cache, 'saveToFileCache' ) );
164 $text = $this->getRawText();
166 if( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
167 wfDebug( __METHOD__ . ': RawPageViewBeforeOutput hook broke raw page output.' );
174 function getRawText() {
175 global $wgUser, $wgOut, $wgRequest;
177 $sk = $wgUser->getSkin();
178 if( !StubObject::isRealObject( $wgOut ) )
179 $wgOut->_unstub( 2 );
180 $sk->initPage( $wgOut );
181 if( $this->mGen == 'css' ) {
182 return $sk->generateUserStylesheet();
183 } else if( $this->mGen == 'js' ) {
184 return $sk->generateUserJs();
187 return $this->getArticleText();
191 function getArticleText() {
194 if( $this->mTitle ) {
195 // If it's a MediaWiki message we can just hit the message cache
196 if( $this->mUseMessageCache && $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
197 $key = $this->mTitle->getDBkey();
198 $text = wfMsgForContentNoTrans( $key );
199 # If the message doesn't exist, return a blank
200 if( wfEmptyMsg( $key, $text ) )
204 // Get it from the DB
205 $rev = Revision::newFromTitle( $this->mTitle, $this->mOldId );
207 $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
208 header( "Last-modified: $lastmod" );
210 if( !is_null($this->mSection ) ) {
212 $text = $wgParser->getSection ( $rev->getText(), $this->mSection );
214 $text = $rev->getText();
220 # Bad title or page does not exist
221 if( !$found && $this->mContentType == 'text/x-wiki' ) {
222 # Don't return a 404 response for CSS or JavaScript;
223 # 404s aren't generally cached and it would create
224 # extra hits when user CSS/JS are on and the user doesn't
226 header( "HTTP/1.0 404 Not Found" );
229 // Special-case for empty CSS/JS
231 // Internet Explorer for Mac handles empty files badly;
232 // particularly so when keep-alive is active. It can lead
233 // to long timeouts as it seems to sit there waiting for
234 // more data that never comes.
236 // Give it a comment...
237 if( strlen( $text ) == 0 &&
238 ($this->mContentType == 'text/css' ||
239 $this->mContentType == 'text/javascript' ) ) {
240 return "/* Empty */";
243 return $this->parseArticleText( $text );
246 function parseArticleText( $text ) {
250 if( $this->mExpandTemplates ) {
252 return $wgParser->preprocess( $text, $this->mTitle, new ParserOptions() );