RawAction: Remove unused $gen variable
[lhc/web/wiklou.git] / includes / actions / RawAction.php
1 <?php
2 /**
3 * Raw page text accessor
4 *
5 * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
6 * http://wikidev.net/
7 *
8 * Based on HistoryAction and SpecialExport
9 *
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.
14 *
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.
19 *
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
24 *
25 * @author Gabriel Wicke <wicke@wikidev.net>
26 * @file
27 */
28
29 /**
30 * A simple method to retrieve the plain source of an article,
31 * using "action=raw" in the GET request string.
32 *
33 * @ingroup Actions
34 */
35 class RawAction extends FormlessAction {
36 public function getName() {
37 return 'raw';
38 }
39
40 public function requiresWrite() {
41 return false;
42 }
43
44 public function requiresUnblock() {
45 return false;
46 }
47
48 function onView() {
49 $this->getOutput()->disable();
50 $request = $this->getRequest();
51 $response = $request->response();
52 $config = $this->context->getConfig();
53
54 if ( !$request->checkUrlExtension() ) {
55 return;
56 }
57
58 if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
59 return; // Client cache fresh and headers sent, nothing more to do.
60 }
61
62 $contentType = $this->getContentType();
63
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' ) );
72 } else {
73 // No CDN cache for anything else
74 $smaxage = 0;
75 }
76 }
77
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() );
82 }
83
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';
92 $response->header(
93 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
94 );
95
96 $text = $this->getRawText();
97
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
101 // have the pages.
102 if ( $text === false && $contentType == 'text/x-wiki' ) {
103 $response->statusHeader( 404 );
104 }
105
106 // Avoid PHP 7.1 warning of passing $this by reference
107 $rawAction = $this;
108 if ( !Hooks::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
109 wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
110 }
111
112 echo $text;
113 }
114
115 /**
116 * Get the text that should be returned, or false if the page or revision
117 * was not found.
118 *
119 * @return string|bool
120 */
121 public function getRawText() {
122 global $wgParser;
123
124 $text = false;
125 $title = $this->getTitle();
126 $request = $this->getRequest();
127
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 ) {
136 $text = '';
137 }
138 } else {
139 // Get it from the DB
140 $rev = Revision::newFromTitle( $title, $this->getOldId() );
141 if ( $rev ) {
142 $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
143 $request->response()->header( "Last-modified: $lastmod" );
144
145 // Public-only due to cache headers
146 $content = $rev->getContent();
147
148 if ( $content === null ) {
149 // revision not found (or suppressed)
150 $text = false;
151 } elseif ( !$content instanceof TextContent ) {
152 // non-text content
153 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
154 . $content->getModel() . "` which is not supported via this interface." );
155 die();
156 } else {
157 // want a section?
158 $section = $request->getIntOrNull( 'section' );
159 if ( $section !== null ) {
160 $content = $content->getSection( $section );
161 }
162
163 if ( $content === null || $content === false ) {
164 // section not found (or section not supported, e.g. for JS and CSS)
165 $text = false;
166 } else {
167 $text = $content->getNativeData();
168 }
169 }
170 }
171 }
172
173 if ( $text !== false && $text !== '' && $request->getRawVal( 'templates' ) === 'expand' ) {
174 $text = $wgParser->preprocess(
175 $text,
176 $title,
177 ParserOptions::newFromContext( $this->getContext() )
178 );
179 }
180
181 return $text;
182 }
183
184 /**
185 * Get the ID of the revision that should used to get the text.
186 *
187 * @return int
188 */
189 public function getOldId() {
190 $oldid = $this->getRequest()->getInt( 'oldid' );
191 switch ( $this->getRequest()->getText( 'direction' ) ) {
192 case 'next':
193 # output next revision, or nothing if there isn't one
194 $nextid = 0;
195 if ( $oldid ) {
196 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
197 }
198 $oldid = $nextid ?: -1;
199 break;
200 case 'prev':
201 # output previous revision, or nothing if there isn't one
202 if ( !$oldid ) {
203 # get the current revision so we can get the penultimate one
204 $oldid = $this->page->getLatest();
205 }
206 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
207 $oldid = $previd ?: -1;
208 break;
209 case 'cur':
210 $oldid = 0;
211 break;
212 }
213
214 return $oldid;
215 }
216
217 /**
218 * Get the content type to use for the response
219 *
220 * @return string
221 */
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' );
227
228 if ( $ctype == '' ) {
229 // Legacy compatibilty
230 $gen = $this->getRequest()->getRawVal( 'gen' );
231 if ( $gen == 'js' ) {
232 $ctype = 'text/javascript';
233 } elseif ( $gen == 'css' ) {
234 $ctype = 'text/css';
235 }
236 }
237
238 $allowedCTypes = [
239 'text/x-wiki',
240 'text/javascript',
241 'text/css',
242 'application/x-zope-edit',
243 'application/json'
244 ];
245 if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
246 $ctype = 'text/x-wiki';
247 }
248
249 return $ctype;
250 }
251 }