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
{
36 public function getName() {
40 public function requiresWrite() {
44 public function requiresUnblock() {
49 $this->getOutput()->disable();
50 $request = $this->getRequest();
51 $response = $request->response();
52 $config = $this->context
->getConfig();
54 if ( !$request->checkUrlExtension() ) {
58 if ( $this->getOutput()->checkLastModified( $this->page
->getTouched() ) ) {
59 return; // Client cache fresh and headers sent, nothing more to do.
62 $contentType = $this->getContentType();
64 $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
65 $smaxage = $request->getIntOrNull( 'smaxage' );
66 if ( $smaxage === null ) {
67 if ( $contentType == 'text/css' ||
$contentType == 'text/javascript' ) {
68 // CSS/JS raw content has its own CDN max age configuration.
69 // Note: Title::getCdnUrls() includes action=raw for css/js pages,
70 // so if using the canonical url, this will get HTCP purges.
71 $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
73 // No CDN cache for anything else
78 // Set standard Vary headers so cache varies on cookies and such (T125283)
79 $response->header( $this->getOutput()->getVaryHeader() );
80 if ( $config->get( 'UseKeyHeader' ) ) {
81 $response->header( $this->getOutput()->getKeyHeader() );
84 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
85 // Output may contain user-specific data;
86 // vary generated content for open sessions on private wikis
87 $privateCache = !User
::isEveryoneAllowed( 'read' ) &&
88 ( $smaxage == 0 || MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent() );
89 // Don't accidentally cache cookies if user is logged in (T55032)
90 $privateCache = $privateCache ||
$this->getUser()->isLoggedIn();
91 $mode = $privateCache ?
'private' : 'public';
93 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
96 $text = $this->getRawText();
98 // Don't return a 404 response for CSS or JavaScript;
99 // 404s aren't generally cached and it would create
100 // extra hits when user CSS/JS are on and the user doesn't
102 if ( $text === false && $contentType == 'text/x-wiki' ) {
103 $response->statusHeader( 404 );
106 // Avoid PHP 7.1 warning of passing $this by reference
108 if ( !Hooks
::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
109 wfDebug( __METHOD__
. ": RawPageViewBeforeOutput hook broke raw page output.\n" );
116 * Get the text that should be returned, or false if the page or revision
119 * @return string|bool
121 public function getRawText() {
125 $title = $this->getTitle();
126 $request = $this->getRequest();
128 // If it's a MediaWiki message we can just hit the message cache
129 if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI
) {
130 // The first "true" is to use the database, the second is to use
131 // the content langue and the last one is to specify the message
132 // key already contains the language in it ("/de", etc.).
133 $text = MessageCache
::singleton()->get( $title->getDBkey(), true, true, true );
134 // If the message doesn't exist, return a blank
135 if ( $text === false ) {
139 // Get it from the DB
140 $rev = Revision
::newFromTitle( $title, $this->getOldId() );
142 $lastmod = wfTimestamp( TS_RFC2822
, $rev->getTimestamp() );
143 $request->response()->header( "Last-modified: $lastmod" );
145 // Public-only due to cache headers
146 $content = $rev->getContent();
148 if ( $content === null ) {
149 // revision not found (or suppressed)
151 } elseif ( !$content instanceof TextContent
) {
153 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
154 . $content->getModel() . "` which is not supported via this interface." );
158 $section = $request->getIntOrNull( 'section' );
159 if ( $section !== null ) {
160 $content = $content->getSection( $section );
163 if ( $content === null ||
$content === false ) {
164 // section not found (or section not supported, e.g. for JS and CSS)
167 $text = $content->getNativeData();
173 if ( $text !== false && $text !== '' && $request->getRawVal( 'templates' ) === 'expand' ) {
174 $text = $wgParser->preprocess(
177 ParserOptions
::newFromContext( $this->getContext() )
185 * Get the ID of the revision that should used to get the text.
189 public function getOldId() {
190 $oldid = $this->getRequest()->getInt( 'oldid' );
191 switch ( $this->getRequest()->getText( 'direction' ) ) {
193 # output next revision, or nothing if there isn't one
196 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
198 $oldid = $nextid ?
: -1;
201 # output previous revision, or nothing if there isn't one
203 # get the current revision so we can get the penultimate one
204 $oldid = $this->page
->getLatest();
206 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
207 $oldid = $previd ?
: -1;
218 * Get the content type to use for the response
222 public function getContentType() {
223 // Use getRawVal instead of getVal because we only
224 // need to match against known strings, there is no
225 // storing of localised content or other user input.
226 $ctype = $this->getRequest()->getRawVal( 'ctype' );
228 if ( $ctype == '' ) {
229 // Legacy compatibilty
230 $gen = $this->getRequest()->getRawVal( 'gen' );
231 if ( $gen == 'js' ) {
232 $ctype = 'text/javascript';
233 } elseif ( $gen == 'css' ) {
242 'application/x-zope-edit',
245 if ( $ctype == '' ||
!in_array( $ctype, $allowedCTypes ) ) {
246 $ctype = 'text/x-wiki';