3 * Raw page text accessor
5 * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
8 * Based on HistoryPage and SpecialExport
10 * License: GPL (http://www.gnu.org/copyleft/gpl.html)
12 * @author Gabriel Wicke <wicke@wikidev.net>
17 * A simple method to retrieve the plain source of an article,
18 * using "action=raw" in the GET request string.
21 var $mArticle, $mTitle, $mRequest;
22 var $mOldId, $mGen, $mCharset, $mSection;
23 var $mSmaxage, $mMaxage;
24 var $mContentType, $mExpandTemplates;
26 function __construct( Article
$article, $request = false ) {
27 global $wgRequest, $wgSquidMaxage, $wgJsMimeType, $wgGroupPermissions;
29 $allowedCTypes = array( 'text/x-wiki', $wgJsMimeType, 'text/css', 'application/x-zope-edit' );
30 $this->mArticle
= $article;
31 $this->mTitle
= $article->mTitle
;
33 if( $request === false ) {
34 $this->mRequest
= $wgRequest;
36 $this->mRequest
= $request;
39 $ctype = $this->mRequest
->getVal( 'ctype' );
40 $smaxage = $this->mRequest
->getIntOrNull( 'smaxage' );
41 $maxage = $this->mRequest
->getInt( 'maxage', $wgSquidMaxage );
43 $this->mExpandTemplates
= $this->mRequest
->getVal( 'templates' ) === 'expand';
44 $this->mUseMessageCache
= $this->mRequest
->getBool( 'usemsgcache' );
46 $this->mSection
= $this->mRequest
->getIntOrNull( 'section' );
48 $oldid = $this->mRequest
->getInt( 'oldid' );
50 switch( $wgRequest->getText( 'direction' ) ) {
52 # output next revision, or nothing if there isn't one
54 $oldid = $this->mTitle
->getNextRevisionId( $oldid );
56 $oldid = $oldid ?
$oldid : -1;
59 # output previous revision, or nothing if there isn't one
61 # get the current revision so we can get the penultimate one
62 $this->mArticle
->getTouched();
63 $oldid = $this->mArticle
->mLatest
;
65 $prev = $this->mTitle
->getPreviousRevisionId( $oldid );
66 $oldid = $prev ?
$prev : -1 ;
72 $this->mOldId
= $oldid;
74 # special case for 'generated' raw things: user css/js
75 $gen = $this->mRequest
->getVal( 'gen' );
79 if( is_null( $smaxage ) ) {
80 $smaxage = $wgSquidMaxage;
85 } elseif( $gen == 'js' ) {
87 if( is_null( $smaxage ) ) $smaxage = $wgSquidMaxage;
88 if($ctype == '') $ctype = $wgJsMimeType;
92 $this->mCharset
= 'UTF-8';
94 # Force caching for CSS and JS raw content, default: 5 minutes
95 if( is_null( $smaxage ) && ( $ctype == 'text/css' ||
$ctype == $wgJsMimeType ) ) {
96 global $wgForcedRawSMaxage;
97 $this->mSmaxage
= intval( $wgForcedRawSMaxage );
99 $this->mSmaxage
= intval( $smaxage );
101 $this->mMaxage
= $maxage;
103 # Output may contain user-specific data;
104 # vary generated content for open sessions and private wikis
105 if( $this->mGen ||
!$wgGroupPermissions['*']['read'] ) {
106 $this->mPrivateCache
= $this->mSmaxage
== 0 ||
session_id() != '';
108 $this->mPrivateCache
= false;
111 if( $ctype == '' ||
!in_array( $ctype, $allowedCTypes ) ) {
112 $this->mContentType
= 'text/x-wiki';
114 $this->mContentType
= $ctype;
119 global $wgOut, $wgRequest;
121 if( $wgRequest->isPathInfoBad() ) {
122 # Internet Explorer will ignore the Content-Type header if it
123 # thinks it sees a file extension it recognizes. Make sure that
124 # all raw requests are done through the script node, which will
125 # have eg '.php' and should remain safe.
127 # We used to redirect to a canonical-form URL as a general
128 # backwards-compatibility / good-citizen nice thing. However
129 # a lot of servers are set up in buggy ways, resulting in
130 # redirect loops which hang the browser until the CSS load
133 # Just return a 403 Forbidden and get it over with.
134 wfHttpError( 403, 'Forbidden',
135 'Invalid file extension found in PATH_INFO or QUERY_STRING. ' .
136 'Raw pages must be accessed through the primary script entry point.' );
140 header( 'Content-type: ' . $this->mContentType
. '; charset=' . $this->mCharset
);
141 # allow the client to cache this for 24 hours
142 $mode = $this->mPrivateCache ?
'private' : 'public';
143 header( 'Cache-Control: ' . $mode . ', s-maxage=' . $this->mSmaxage
. ', max-age=' . $this->mMaxage
);
145 global $wgUseFileCache;
146 if( $wgUseFileCache && HTMLFileCache
::useFileCache() ) {
147 $cache = new HTMLFileCache( $this->mTitle
, 'raw' );
148 if( $cache->isFileCacheGood( /* Assume up to date */ ) ) {
149 $cache->loadFromFileCache();
153 ob_start( array( &$cache, 'saveToFileCache' ) );
157 $text = $this->getRawText();
159 if( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
160 wfDebug( __METHOD__
. ": RawPageViewBeforeOutput hook broke raw page output.\n" );
167 function getRawText() {
168 global $wgUser, $wgOut;
170 $sk = $wgUser->getSkin();
171 if( !StubObject
::isRealObject( $wgOut ) ) {
172 $wgOut->_unstub( 2 );
174 $sk->initPage( $wgOut );
175 if( $this->mGen
== 'css' ) {
176 return $sk->generateUserStylesheet();
177 } else if( $this->mGen
== 'js' ) {
178 return $sk->generateUserJs();
181 return $this->getArticleText();
185 function getArticleText() {
188 if( $this->mTitle
) {
189 // If it's a MediaWiki message we can just hit the message cache
190 if( $this->mUseMessageCache
&& $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
191 $key = $this->mTitle
->getDBkey();
192 $msg = wfMessage( $key )->inContentLanguage();
193 # If the message doesn't exist, return a blank
194 $text = !$msg->exists() ?
'' : $msg->plain();
197 // Get it from the DB
198 $rev = Revision
::newFromTitle( $this->mTitle
, $this->mOldId
);
200 $lastmod = wfTimestamp( TS_RFC2822
, $rev->getTimestamp() );
201 header( "Last-modified: $lastmod" );
203 if( !is_null( $this->mSection
) ) {
205 $text = $wgParser->getSection( $rev->getText(), $this->mSection
);
207 $text = $rev->getText();
214 # Bad title or page does not exist
215 if( !$found && $this->mContentType
== 'text/x-wiki' ) {
216 # Don't return a 404 response for CSS or JavaScript;
217 # 404s aren't generally cached and it would create
218 # extra hits when user CSS/JS are on and the user doesn't
220 header( 'HTTP/1.0 404 Not Found' );
223 return $this->parseArticleText( $text );
230 function parseArticleText( $text ) {
234 if( $this->mExpandTemplates
) {
236 return $wgParser->preprocess( $text, $this->mTitle
, new ParserOptions() );