Added release notes for 'ContentHandler::runLegacyHooks' removal
[mediawiki.git] / includes / actions / RawAction.php
blobd8c8bc3213eee560d4136e11d1e4429bc347d05c
1 <?php
2 /**
3 * Raw page text accessor
5 * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
6 * http://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>
26 * @file
29 /**
30 * A simple method to retrieve the plain source of an article,
31 * using "action=raw" in the GET request string.
33 * @ingroup Actions
35 class RawAction extends FormlessAction {
36 public function getName() {
37 return 'raw';
40 public function requiresWrite() {
41 return false;
44 public function requiresUnblock() {
45 return false;
48 function onView() {
49 $this->getOutput()->disable();
50 $request = $this->getRequest();
51 $response = $request->response();
52 $config = $this->context->getConfig();
54 if ( !$request->checkUrlExtension() ) {
55 return;
58 if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
59 return; // Client cache fresh and headers sent, nothing more to do.
62 $gen = $request->getVal( 'gen' );
63 if ( $gen == 'css' || $gen == 'js' ) {
64 $this->gen = true;
67 $contentType = $this->getContentType();
69 $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
70 $smaxage = $request->getIntOrNull( 'smaxage' );
71 if ( $smaxage === null ) {
72 if ( $contentType == 'text/css' || $contentType == 'text/javascript' ) {
73 // CSS/JS raw content has its own CDN max age configuration.
74 // Note: Title::getCdnUrls() includes action=raw for css/js pages,
75 // so if using the canonical url, this will get HTCP purges.
76 $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
77 } else {
78 // No CDN cache for anything else
79 $smaxage = 0;
83 // Set standard Vary headers so cache varies on cookies and such (T125283)
84 $response->header( $this->getOutput()->getVaryHeader() );
85 if ( $config->get( 'UseKeyHeader' ) ) {
86 $response->header( $this->getOutput()->getKeyHeader() );
89 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
90 // Output may contain user-specific data;
91 // vary generated content for open sessions on private wikis
92 $privateCache = !User::isEveryoneAllowed( 'read' ) &&
93 ( $smaxage == 0 || MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent() );
94 // Don't accidentally cache cookies if user is logged in (T55032)
95 $privateCache = $privateCache || $this->getUser()->isLoggedIn();
96 $mode = $privateCache ? 'private' : 'public';
97 $response->header(
98 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
101 $text = $this->getRawText();
103 // Don't return a 404 response for CSS or JavaScript;
104 // 404s aren't generally cached and it would create
105 // extra hits when user CSS/JS are on and the user doesn't
106 // have the pages.
107 if ( $text === false && $contentType == 'text/x-wiki' ) {
108 $response->statusHeader( 404 );
111 // Avoid PHP 7.1 warning of passing $this by reference
112 $rawAction = $this;
113 if ( !Hooks::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
114 wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
117 echo $text;
121 * Get the text that should be returned, or false if the page or revision
122 * was not found.
124 * @return string|bool
126 public function getRawText() {
127 global $wgParser;
129 $text = false;
130 $title = $this->getTitle();
131 $request = $this->getRequest();
133 // If it's a MediaWiki message we can just hit the message cache
134 if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI ) {
135 // The first "true" is to use the database, the second is to use
136 // the content langue and the last one is to specify the message
137 // key already contains the language in it ("/de", etc.).
138 $text = MessageCache::singleton()->get( $title->getDBkey(), true, true, true );
139 // If the message doesn't exist, return a blank
140 if ( $text === false ) {
141 $text = '';
143 } else {
144 // Get it from the DB
145 $rev = Revision::newFromTitle( $title, $this->getOldId() );
146 if ( $rev ) {
147 $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
148 $request->response()->header( "Last-modified: $lastmod" );
150 // Public-only due to cache headers
151 $content = $rev->getContent();
153 if ( $content === null ) {
154 // revision not found (or suppressed)
155 $text = false;
156 } elseif ( !$content instanceof TextContent ) {
157 // non-text content
158 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
159 . $content->getModel() . "` which is not supported via this interface." );
160 die();
161 } else {
162 // want a section?
163 $section = $request->getIntOrNull( 'section' );
164 if ( $section !== null ) {
165 $content = $content->getSection( $section );
168 if ( $content === null || $content === false ) {
169 // section not found (or section not supported, e.g. for JS and CSS)
170 $text = false;
171 } else {
172 $text = $content->getNativeData();
178 if ( $text !== false && $text !== '' && $request->getVal( 'templates' ) === 'expand' ) {
179 $text = $wgParser->preprocess(
180 $text,
181 $title,
182 ParserOptions::newFromContext( $this->getContext() )
186 return $text;
190 * Get the ID of the revision that should used to get the text.
192 * @return int
194 public function getOldId() {
195 $oldid = $this->getRequest()->getInt( 'oldid' );
196 switch ( $this->getRequest()->getText( 'direction' ) ) {
197 case 'next':
198 # output next revision, or nothing if there isn't one
199 $nextid = 0;
200 if ( $oldid ) {
201 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
203 $oldid = $nextid ?: -1;
204 break;
205 case 'prev':
206 # output previous revision, or nothing if there isn't one
207 if ( !$oldid ) {
208 # get the current revision so we can get the penultimate one
209 $oldid = $this->page->getLatest();
211 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
212 $oldid = $previd ?: -1;
213 break;
214 case 'cur':
215 $oldid = 0;
216 break;
219 return $oldid;
223 * Get the content type to use for the response
225 * @return string
227 public function getContentType() {
228 $ctype = $this->getRequest()->getVal( 'ctype' );
230 if ( $ctype == '' ) {
231 $gen = $this->getRequest()->getVal( 'gen' );
232 if ( $gen == 'js' ) {
233 $ctype = 'text/javascript';
234 } elseif ( $gen == 'css' ) {
235 $ctype = 'text/css';
239 $allowedCTypes = [ 'text/x-wiki', 'text/javascript', 'text/css', 'application/x-zope-edit' ];
240 if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
241 $ctype = 'text/x-wiki';
244 return $ctype;