3 * Raw page text accessor
5 * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
8 * Based on HistoryAction and SpecialExport
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
25 * @author Gabriel Wicke <wicke@wikidev.net>
30 * A simple method to retrieve the plain source of an article,
31 * using "action=raw" in the GET request string.
35 class RawAction
extends FormlessAction
{
37 * @var bool Does the request include a gen=css|javascript parameter
38 * @deprecated This used to be a string for "css" or "javascript" but
39 * it is no longer used. Setting this parameter results in empty content
44 public function getName() {
48 public function requiresWrite() {
52 public function requiresUnblock() {
57 $this->getOutput()->disable();
58 $request = $this->getRequest();
59 $config = $this->context
->getConfig();
61 if ( !$request->checkUrlExtension() ) {
65 if ( $this->getOutput()->checkLastModified( $this->page
->getTouched() ) ) {
66 return; // Client cache fresh and headers sent, nothing more to do.
69 # special case for 'generated' raw things: user css/js
70 # This is deprecated and will only return empty content
71 $gen = $request->getVal( 'gen' );
72 $smaxage = $request->getIntOrNull( 'smaxage' );
74 if ( $gen == 'css' ||
$gen == 'js' ) {
76 if ( $smaxage === null ) {
77 $smaxage = $config->get( 'SquidMaxage' );
81 $contentType = $this->getContentType();
83 # Force caching for CSS and JS raw content, default: 5 minutes.
84 # Note: If using a canonical url for userpage css/js, we send an HTCP purge.
85 if ( $smaxage === null ) {
86 if ( $contentType == 'text/css' ||
$contentType == 'text/javascript' ) {
87 $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
93 $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
95 $response = $request->response();
97 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
98 # Output may contain user-specific data;
99 # vary generated content for open sessions on private wikis
100 $privateCache = !User
::isEveryoneAllowed( 'read' ) && ( $smaxage == 0 ||
session_id() != '' );
101 // Bug 53032 - make this private if user is logged in,
102 // so we don't accidentally cache cookies
103 $privateCache = $privateCache ?
: $this->getUser()->isLoggedIn();
104 # allow the client to cache this for 24 hours
105 $mode = $privateCache ?
'private' : 'public';
107 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
110 $text = $this->getRawText();
112 if ( $text === false && $contentType == 'text/x-wiki' ) {
113 # Don't return a 404 response for CSS or JavaScript;
114 # 404s aren't generally cached and it would create
115 # extra hits when user CSS/JS are on and the user doesn't
117 $response->header( 'HTTP/1.x 404 Not Found' );
120 if ( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
121 wfDebug( __METHOD__
. ": RawPageViewBeforeOutput hook broke raw page output.\n" );
128 * Get the text that should be returned, or false if the page or revision
131 * @return string|bool
133 public function getRawText() {
142 $title = $this->getTitle();
143 $request = $this->getRequest();
145 // If it's a MediaWiki message we can just hit the message cache
146 if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI
) {
147 // The first "true" is to use the database, the second is to use
148 // the content langue and the last one is to specify the message
149 // key already contains the language in it ("/de", etc.).
150 $text = MessageCache
::singleton()->get( $title->getDBkey(), true, true, true );
151 // If the message doesn't exist, return a blank
152 if ( $text === false ) {
156 // Get it from the DB
157 $rev = Revision
::newFromTitle( $title, $this->getOldId() );
159 $lastmod = wfTimestamp( TS_RFC2822
, $rev->getTimestamp() );
160 $request->response()->header( "Last-modified: $lastmod" );
162 // Public-only due to cache headers
163 $content = $rev->getContent();
165 if ( $content === null ) {
166 // revision not found (or suppressed)
168 } elseif ( !$content instanceof TextContent
) {
170 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
171 . $content->getModel() . "` which is not supported via this interface." );
175 $section = $request->getIntOrNull( 'section' );
176 if ( $section !== null ) {
177 $content = $content->getSection( $section );
180 if ( $content === null ||
$content === false ) {
181 // section not found (or section not supported, e.g. for JS and CSS)
184 $text = $content->getNativeData();
190 if ( $text !== false && $text !== '' && $request->getVal( 'templates' ) === 'expand' ) {
191 $text = $wgParser->preprocess(
194 ParserOptions
::newFromContext( $this->getContext() )
202 * Get the ID of the revision that should used to get the text.
206 public function getOldId() {
207 $oldid = $this->getRequest()->getInt( 'oldid' );
208 switch ( $this->getRequest()->getText( 'direction' ) ) {
210 # output next revision, or nothing if there isn't one
213 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
215 $oldid = $nextid ?
: -1;
218 # output previous revision, or nothing if there isn't one
220 # get the current revision so we can get the penultimate one
221 $oldid = $this->page
->getLatest();
223 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
224 $oldid = $previd ?
: -1;
235 * Get the content type to use for the response
239 public function getContentType() {
240 $ctype = $this->getRequest()->getVal( 'ctype' );
242 if ( $ctype == '' ) {
243 $gen = $this->getRequest()->getVal( 'gen' );
244 if ( $gen == 'js' ) {
245 $ctype = 'text/javascript';
246 } elseif ( $gen == 'css' ) {
251 $allowedCTypes = array( 'text/x-wiki', 'text/javascript', 'text/css', 'application/x-zope-edit' );
252 if ( $ctype == '' ||
!in_array( $ctype, $allowedCTypes ) ) {
253 $ctype = 'text/x-wiki';