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
;
30 use MediaWiki\MediaWikiServices
;
33 * A simple method to retrieve the plain source of an article,
34 * using "action=raw" in the GET request string.
38 class RawAction
extends FormlessAction
{
39 public function getName() {
43 public function requiresWrite() {
47 public function requiresUnblock() {
52 * @suppress SecurityCheck-XSS Non html mime type
55 $this->getOutput()->disable();
56 $request = $this->getRequest();
57 $response = $request->response();
58 $config = $this->context
->getConfig();
60 if ( !$request->checkUrlExtension() ) {
64 if ( $this->getOutput()->checkLastModified( $this->page
->getTouched() ) ) {
65 return; // Client cache fresh and headers sent, nothing more to do.
68 $contentType = $this->getContentType();
70 $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
71 $smaxage = $request->getIntOrNull( 'smaxage' );
72 if ( $smaxage === null ) {
74 $contentType == 'text/css' ||
75 $contentType == 'application/json' ||
76 $contentType == 'text/javascript'
78 // CSS/JSON/JS raw content has its own CDN max age configuration.
79 // Note: Title::getCdnUrls() includes action=raw for css/json/js
80 // pages, so if using the canonical url, this will get HTCP purges.
81 $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
83 // No CDN cache for anything else
88 // Set standard Vary headers so cache varies on cookies and such (T125283)
89 $response->header( $this->getOutput()->getVaryHeader() );
90 if ( $config->get( 'UseKeyHeader' ) ) {
91 $response->header( $this->getOutput()->getKeyHeader() );
94 // Output may contain user-specific data;
95 // vary generated content for open sessions on private wikis
96 $privateCache = !User
::isEveryoneAllowed( 'read' ) &&
97 ( $smaxage == 0 || MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent() );
98 // Don't accidentally cache cookies if user is logged in (T55032)
99 $privateCache = $privateCache ||
$this->getUser()->isLoggedIn();
100 $mode = $privateCache ?
'private' : 'public';
102 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
105 // In the event of user JS, don't allow loading a user JS/CSS/Json
106 // subpage that has no registered user associated with, as
107 // someone could register the account and take control of the
109 $title = $this->getTitle();
110 if ( $title->isUserConfigPage() && $contentType !== 'text/x-wiki' ) {
111 // not using getRootText() as we want this to work
112 // even if subpages are disabled.
113 $rootPage = strtok( $title->getText(), '/' );
114 $userFromTitle = User
::newFromName( $rootPage, 'usable' );
115 if ( !$userFromTitle ||
$userFromTitle->getId() === 0 ) {
116 $elevated = $this->getUser()->isAllowed( 'editinterface' );
117 $elevatedText = $elevated ?
'by elevated ' : '';
118 $log = LoggerFactory
::getInstance( "security" );
120 "Unsafe JS/CSS/Json {$elevatedText}load - {user} loaded {title} with {ctype}",
122 'user' => $this->getUser()->getName(),
123 'title' => $title->getPrefixedDBkey(),
124 'ctype' => $contentType,
125 'elevated' => $elevated
128 $msg = wfMessage( 'unregistered-user-config' );
129 throw new HttpError( 403, $msg );
133 // Don't allow loading non-protected pages as javascript.
134 // In future we may further restrict this to only CONTENT_MODEL_JAVASCRIPT
135 // in NS_MEDIAWIKI or NS_USER, as well as including other config types,
136 // but for now be more permissive. Allowing protected pages outside of
137 // NS_USER and NS_MEDIAWIKI in particular should be considered a temporary
140 $contentType === 'text/javascript' &&
141 !$title->isUserJsConfigPage() &&
142 !$title->inNamespace( NS_MEDIAWIKI
) &&
143 !in_array( 'sysop', $title->getRestrictions( 'edit' ) ) &&
144 !in_array( 'editprotected', $title->getRestrictions( 'edit' ) )
147 $log = LoggerFactory
::getInstance( "security" );
148 $log->info( "Blocked loading unprotected JS {title} for {user}",
150 'user' => $this->getUser()->getName(),
151 'title' => $title->getPrefixedDBkey(),
154 throw new HttpError( 403, wfMessage( 'unprotected-js' ) );
157 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
159 $text = $this->getRawText();
161 // Don't return a 404 response for CSS or JavaScript;
162 // 404s aren't generally cached and it would create
163 // extra hits when user CSS/JS are on and the user doesn't
165 if ( $text === false && $contentType == 'text/x-wiki' ) {
166 $response->statusHeader( 404 );
169 // Avoid PHP 7.1 warning of passing $this by reference
171 if ( !Hooks
::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
172 wfDebug( __METHOD__
. ": RawPageViewBeforeOutput hook broke raw page output.\n" );
179 * Get the text that should be returned, or false if the page or revision
182 * @return string|bool
184 public function getRawText() {
186 $title = $this->getTitle();
187 $request = $this->getRequest();
189 // Get it from the DB
190 $rev = Revision
::newFromTitle( $title, $this->getOldId() );
192 $lastmod = wfTimestamp( TS_RFC2822
, $rev->getTimestamp() );
193 $request->response()->header( "Last-modified: $lastmod" );
195 // Public-only due to cache headers
196 $content = $rev->getContent();
198 if ( $content === null ) {
199 // revision not found (or suppressed)
201 } elseif ( !$content instanceof TextContent
) {
203 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
204 . $content->getModel() . "` which is not supported via this interface." );
208 $section = $request->getIntOrNull( 'section' );
209 if ( $section !== null ) {
210 $content = $content->getSection( $section );
213 if ( $content === null ||
$content === false ) {
214 // section not found (or section not supported, e.g. for JS, JSON, and CSS)
217 $text = $content->getText();
222 if ( $text !== false && $text !== '' && $request->getRawVal( 'templates' ) === 'expand' ) {
223 $text = MediaWikiServices
::getInstance()->getParser()->preprocess(
226 ParserOptions
::newFromContext( $this->getContext() )
234 * Get the ID of the revision that should used to get the text.
238 public function getOldId() {
239 $oldid = $this->getRequest()->getInt( 'oldid' );
240 switch ( $this->getRequest()->getText( 'direction' ) ) {
242 # output next revision, or nothing if there isn't one
245 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
247 $oldid = $nextid ?
: -1;
250 # output previous revision, or nothing if there isn't one
252 # get the current revision so we can get the penultimate one
253 $oldid = $this->page
->getLatest();
255 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
256 $oldid = $previd ?
: -1;
267 * Get the content type to use for the response
271 public function getContentType() {
272 // Use getRawVal instead of getVal because we only
273 // need to match against known strings, there is no
274 // storing of localised content or other user input.
275 $ctype = $this->getRequest()->getRawVal( 'ctype' );
277 if ( $ctype == '' ) {
278 // Legacy compatibilty
279 $gen = $this->getRequest()->getRawVal( 'gen' );
280 if ( $gen == 'js' ) {
281 $ctype = 'text/javascript';
282 } elseif ( $gen == 'css' ) {
291 // FIXME: Should we still allow Zope editing? External editing feature was dropped
292 'application/x-zope-edit',
295 if ( $ctype == '' ||
!in_array( $ctype, $allowedCTypes ) ) {
296 $ctype = 'text/x-wiki';