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>
29 use MediaWiki\Logger\LoggerFactory
;
32 * A simple method to retrieve the plain source of an article,
33 * using "action=raw" in the GET request string.
37 class RawAction
extends FormlessAction
{
38 public function getName() {
42 public function requiresWrite() {
46 public function requiresUnblock() {
51 * @suppress SecurityCheck-XSS Non html mime type
54 $this->getOutput()->disable();
55 $request = $this->getRequest();
56 $response = $request->response();
57 $config = $this->context
->getConfig();
59 if ( !$request->checkUrlExtension() ) {
63 if ( $this->getOutput()->checkLastModified( $this->page
->getTouched() ) ) {
64 return; // Client cache fresh and headers sent, nothing more to do.
67 $contentType = $this->getContentType();
69 $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
70 $smaxage = $request->getIntOrNull( 'smaxage' );
71 if ( $smaxage === null ) {
73 $contentType == 'text/css' ||
74 $contentType == 'application/json' ||
75 $contentType == 'text/javascript'
77 // CSS/JSON/JS raw content has its own CDN max age configuration.
78 // Note: Title::getCdnUrls() includes action=raw for css/json/js
79 // pages, so if using the canonical url, this will get HTCP purges.
80 $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
82 // No CDN cache for anything else
87 // Set standard Vary headers so cache varies on cookies and such (T125283)
88 $response->header( $this->getOutput()->getVaryHeader() );
89 if ( $config->get( 'UseKeyHeader' ) ) {
90 $response->header( $this->getOutput()->getKeyHeader() );
93 // Output may contain user-specific data;
94 // vary generated content for open sessions on private wikis
95 $privateCache = !User
::isEveryoneAllowed( 'read' ) &&
96 ( $smaxage == 0 || MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent() );
97 // Don't accidentally cache cookies if user is logged in (T55032)
98 $privateCache = $privateCache ||
$this->getUser()->isLoggedIn();
99 $mode = $privateCache ?
'private' : 'public';
101 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
104 // In the event of user JS, don't allow loading a user JS/CSS/Json
105 // subpage that has no registered user associated with, as
106 // someone could register the account and take control of the
108 $title = $this->getTitle();
109 if ( $title->isUserConfigPage() && $contentType !== 'text/x-wiki' ) {
110 // not using getRootText() as we want this to work
111 // even if subpages are disabled.
112 $rootPage = strtok( $title->getText(), '/' );
113 $userFromTitle = User
::newFromName( $rootPage, 'usable' );
114 if ( !$userFromTitle ||
$userFromTitle->getId() === 0 ) {
115 $elevated = $this->getUser()->isAllowed( 'editinterface' );
116 $elevatedText = $elevated ?
'by elevated ' : '';
117 $log = LoggerFactory
::getInstance( "security" );
119 "Unsafe JS/CSS/Json {$elevatedText}load - {user} loaded {title} with {ctype}",
121 'user' => $this->getUser()->getName(),
122 'title' => $title->getPrefixedDBKey(),
123 'ctype' => $contentType,
124 'elevated' => $elevated
127 $msg = wfMessage( 'unregistered-user-config' );
128 throw new HttpError( 403, $msg );
132 // Don't allow loading non-protected pages as javascript.
133 // In future we may further restrict this to only CONTENT_MODEL_JAVASCRIPT
134 // in NS_MEDIAWIKI or NS_USER, as well as including other config types,
135 // but for now be more permissive. Allowing protected pages outside of
136 // NS_USER and NS_MEDIAWIKI in particular should be considered a temporary
139 $contentType === 'text/javascript' &&
140 !$title->isUserJsConfigPage() &&
141 !$title->inNamespace( NS_MEDIAWIKI
) &&
142 !in_array( 'sysop', $title->getRestrictions( 'edit' ) ) &&
143 !in_array( 'editprotected', $title->getRestrictions( 'edit' ) )
146 $log = LoggerFactory
::getInstance( "security" );
147 $log->info( "Blocked loading unprotected JS {title} for {user}",
149 'user' => $this->getUser()->getName(),
150 'title' => $title->getPrefixedDBKey(),
153 throw new HttpError( 403, wfMessage( 'unprotected-js' ) );
156 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
158 $text = $this->getRawText();
160 // Don't return a 404 response for CSS or JavaScript;
161 // 404s aren't generally cached and it would create
162 // extra hits when user CSS/JS are on and the user doesn't
164 if ( $text === false && $contentType == 'text/x-wiki' ) {
165 $response->statusHeader( 404 );
168 // Avoid PHP 7.1 warning of passing $this by reference
170 if ( !Hooks
::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
171 wfDebug( __METHOD__
. ": RawPageViewBeforeOutput hook broke raw page output.\n" );
178 * Get the text that should be returned, or false if the page or revision
181 * @return string|bool
183 public function getRawText() {
187 $title = $this->getTitle();
188 $request = $this->getRequest();
190 // Get it from the DB
191 $rev = Revision
::newFromTitle( $title, $this->getOldId() );
193 $lastmod = wfTimestamp( TS_RFC2822
, $rev->getTimestamp() );
194 $request->response()->header( "Last-modified: $lastmod" );
196 // Public-only due to cache headers
197 $content = $rev->getContent();
199 if ( $content === null ) {
200 // revision not found (or suppressed)
202 } elseif ( !$content instanceof TextContent
) {
204 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
205 . $content->getModel() . "` which is not supported via this interface." );
209 $section = $request->getIntOrNull( 'section' );
210 if ( $section !== null ) {
211 $content = $content->getSection( $section );
214 if ( $content === null ||
$content === false ) {
215 // section not found (or section not supported, e.g. for JS, JSON, and CSS)
218 $text = $content->getText();
223 if ( $text !== false && $text !== '' && $request->getRawVal( 'templates' ) === 'expand' ) {
224 $text = $wgParser->preprocess(
227 ParserOptions
::newFromContext( $this->getContext() )
235 * Get the ID of the revision that should used to get the text.
239 public function getOldId() {
240 $oldid = $this->getRequest()->getInt( 'oldid' );
241 switch ( $this->getRequest()->getText( 'direction' ) ) {
243 # output next revision, or nothing if there isn't one
246 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
248 $oldid = $nextid ?
: -1;
251 # output previous revision, or nothing if there isn't one
253 # get the current revision so we can get the penultimate one
254 $oldid = $this->page
->getLatest();
256 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
257 $oldid = $previd ?
: -1;
268 * Get the content type to use for the response
272 public function getContentType() {
273 // Use getRawVal instead of getVal because we only
274 // need to match against known strings, there is no
275 // storing of localised content or other user input.
276 $ctype = $this->getRequest()->getRawVal( 'ctype' );
278 if ( $ctype == '' ) {
279 // Legacy compatibilty
280 $gen = $this->getRequest()->getRawVal( 'gen' );
281 if ( $gen == 'js' ) {
282 $ctype = 'text/javascript';
283 } elseif ( $gen == 'css' ) {
292 // FIXME: Should we still allow Zope editing? External editing feature was dropped
293 'application/x-zope-edit',
296 if ( $ctype == '' ||
!in_array( $ctype, $allowedCTypes ) ) {
297 $ctype = 'text/x-wiki';