wfMsgForContentNoTrans() was removed
[mediawiki.git] / includes / actions / RawAction.php
blob69cd7aa1bd1ea5b893db252452c91fb59ad5e388
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 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
84 // Output may contain user-specific data;
85 // vary generated content for open sessions on private wikis
86 $privateCache = !User::isEveryoneAllowed( 'read' ) && ( $smaxage == 0 || session_id() != '' );
87 // Don't accidentally cache cookies if user is logged in (T55032)
88 $privateCache = $privateCache || $this->getUser()->isLoggedIn();
89 $mode = $privateCache ? 'private' : 'public';
90 $response->header(
91 'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
94 $text = $this->getRawText();
96 // Don't return a 404 response for CSS or JavaScript;
97 // 404s aren't generally cached and it would create
98 // extra hits when user CSS/JS are on and the user doesn't
99 // have the pages.
100 if ( $text === false && $contentType == 'text/x-wiki' ) {
101 $response->statusHeader( 404 );
104 if ( !Hooks::run( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
105 wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
108 echo $text;
112 * Get the text that should be returned, or false if the page or revision
113 * was not found.
115 * @return string|bool
117 public function getRawText() {
118 global $wgParser;
120 $text = false;
121 $title = $this->getTitle();
122 $request = $this->getRequest();
124 // If it's a MediaWiki message we can just hit the message cache
125 if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI ) {
126 // The first "true" is to use the database, the second is to use
127 // the content langue and the last one is to specify the message
128 // key already contains the language in it ("/de", etc.).
129 $text = MessageCache::singleton()->get( $title->getDBkey(), true, true, true );
130 // If the message doesn't exist, return a blank
131 if ( $text === false ) {
132 $text = '';
134 } else {
135 // Get it from the DB
136 $rev = Revision::newFromTitle( $title, $this->getOldId() );
137 if ( $rev ) {
138 $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
139 $request->response()->header( "Last-modified: $lastmod" );
141 // Public-only due to cache headers
142 $content = $rev->getContent();
144 if ( $content === null ) {
145 // revision not found (or suppressed)
146 $text = false;
147 } elseif ( !$content instanceof TextContent ) {
148 // non-text content
149 wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
150 . $content->getModel() . "` which is not supported via this interface." );
151 die();
152 } else {
153 // want a section?
154 $section = $request->getIntOrNull( 'section' );
155 if ( $section !== null ) {
156 $content = $content->getSection( $section );
159 if ( $content === null || $content === false ) {
160 // section not found (or section not supported, e.g. for JS and CSS)
161 $text = false;
162 } else {
163 $text = $content->getNativeData();
169 if ( $text !== false && $text !== '' && $request->getVal( 'templates' ) === 'expand' ) {
170 $text = $wgParser->preprocess(
171 $text,
172 $title,
173 ParserOptions::newFromContext( $this->getContext() )
177 return $text;
181 * Get the ID of the revision that should used to get the text.
183 * @return int
185 public function getOldId() {
186 $oldid = $this->getRequest()->getInt( 'oldid' );
187 switch ( $this->getRequest()->getText( 'direction' ) ) {
188 case 'next':
189 # output next revision, or nothing if there isn't one
190 $nextid = 0;
191 if ( $oldid ) {
192 $nextid = $this->getTitle()->getNextRevisionID( $oldid );
194 $oldid = $nextid ?: -1;
195 break;
196 case 'prev':
197 # output previous revision, or nothing if there isn't one
198 if ( !$oldid ) {
199 # get the current revision so we can get the penultimate one
200 $oldid = $this->page->getLatest();
202 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
203 $oldid = $previd ?: -1;
204 break;
205 case 'cur':
206 $oldid = 0;
207 break;
210 return $oldid;
214 * Get the content type to use for the response
216 * @return string
218 public function getContentType() {
219 $ctype = $this->getRequest()->getVal( 'ctype' );
221 if ( $ctype == '' ) {
222 $gen = $this->getRequest()->getVal( 'gen' );
223 if ( $gen == 'js' ) {
224 $ctype = 'text/javascript';
225 } elseif ( $gen == 'css' ) {
226 $ctype = 'text/css';
230 $allowedCTypes = array( 'text/x-wiki', 'text/javascript', 'text/css', 'application/x-zope-edit' );
231 if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
232 $ctype = 'text/x-wiki';
235 return $ctype;