MediaWiki  REL1_31
RawAction.php
Go to the documentation of this file.
1 <?php
30 
37 class RawAction extends FormlessAction {
38  public function getName() {
39  return 'raw';
40  }
41 
42  public function requiresWrite() {
43  return false;
44  }
45 
46  public function requiresUnblock() {
47  return false;
48  }
49 
50  function onView() {
51  $this->getOutput()->disable();
52  $request = $this->getRequest();
53  $response = $request->response();
54  $config = $this->context->getConfig();
55 
56  if ( !$request->checkUrlExtension() ) {
57  return;
58  }
59 
60  if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
61  return; // Client cache fresh and headers sent, nothing more to do.
62  }
63 
64  $contentType = $this->getContentType();
65 
66  $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
67  $smaxage = $request->getIntOrNull( 'smaxage' );
68  if ( $smaxage === null ) {
69  if (
70  $contentType == 'text/css' ||
71  $contentType == 'application/json' ||
72  $contentType == 'text/javascript'
73  ) {
74  // CSS/JSON/JS raw content has its own CDN max age configuration.
75  // Note: Title::getCdnUrls() includes action=raw for css/json/js
76  // pages, so if using the canonical url, this will get HTCP purges.
77  $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
78  } else {
79  // No CDN cache for anything else
80  $smaxage = 0;
81  }
82  }
83 
84  // Set standard Vary headers so cache varies on cookies and such (T125283)
85  $response->header( $this->getOutput()->getVaryHeader() );
86  if ( $config->get( 'UseKeyHeader' ) ) {
87  $response->header( $this->getOutput()->getKeyHeader() );
88  }
89 
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
99  );
100 
101  // In the event of user JS, don't allow loading a user JS/CSS/Json
102  // subpage that has no registered user associated with, as
103  // someone could register the account and take control of the
104  // JS/CSS/Json page.
105  $title = $this->getTitle();
106  if ( $title->isUserConfigPage() && $contentType !== 'text/x-wiki' ) {
107  // not using getRootText() as we want this to work
108  // even if subpages are disabled.
109  $rootPage = strtok( $title->getText(), '/' );
110  $userFromTitle = User::newFromName( $rootPage, 'usable' );
111  if ( !$userFromTitle || $userFromTitle->getId() === 0 ) {
112  $log = LoggerFactory::getInstance( "security" );
113  $log->warning(
114  "Unsafe JS/CSS/Json load - {user} loaded {title} with {ctype}",
115  [
116  'user' => $this->getUser()->getName(),
117  'title' => $title->getPrefixedDBKey(),
118  'ctype' => $contentType,
119  ]
120  );
121  $msg = wfMessage( 'unregistered-user-config' );
122  throw new HttpError( 403, $msg );
123  }
124  }
125 
126  // Don't allow loading non-protected pages as javascript.
127  // In future we may further restrict this to only CONTENT_MODEL_JAVASCRIPT
128  // in NS_MEDIAWIKI or NS_USER, as well as including other config types,
129  // but for now be more permissive. Allowing protected pages outside of
130  // NS_USER and NS_MEDIAWIKI in particular should be considered a temporary
131  // allowance.
132  if (
133  $contentType === 'text/javascript' &&
134  !$title->isUserJsConfigPage() &&
135  !$title->inNamespace( NS_MEDIAWIKI ) &&
136  !in_array( 'sysop', $title->getRestrictions( 'edit' ) ) &&
137  !in_array( 'editprotected', $title->getRestrictions( 'edit' ) )
138  ) {
139 
140  $log = LoggerFactory::getInstance( "security" );
141  $log->info( "Blocked loading unprotected JS {title} for {user}",
142  [
143  'user' => $this->getUser()->getName(),
144  'title' => $title->getPrefixedDBKey(),
145  ]
146  );
147  throw new HttpError( 403, wfMessage( 'unprotected-js' ) );
148  }
149 
150  $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
151 
152  $text = $this->getRawText();
153 
154  // Don't return a 404 response for CSS or JavaScript;
155  // 404s aren't generally cached and it would create
156  // extra hits when user CSS/JS are on and the user doesn't
157  // have the pages.
158  if ( $text === false && $contentType == 'text/x-wiki' ) {
159  $response->statusHeader( 404 );
160  }
161 
162  // Avoid PHP 7.1 warning of passing $this by reference
163  $rawAction = $this;
164  if ( !Hooks::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
165  wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
166  }
167 
168  echo $text;
169  }
170 
177  public function getRawText() {
179 
180  $text = false;
181  $title = $this->getTitle();
182  $request = $this->getRequest();
183 
184  // If it's a MediaWiki message we can just hit the message cache
185  if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI ) {
186  // The first "true" is to use the database, the second is to use
187  // the content langue and the last one is to specify the message
188  // key already contains the language in it ("/de", etc.).
189  $text = MessageCache::singleton()->get( $title->getDBkey(), true, true, true );
190  // If the message doesn't exist, return a blank
191  if ( $text === false ) {
192  $text = '';
193  }
194  } else {
195  // Get it from the DB
197  if ( $rev ) {
198  $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
199  $request->response()->header( "Last-modified: $lastmod" );
200 
201  // Public-only due to cache headers
202  $content = $rev->getContent();
203 
204  if ( $content === null ) {
205  // revision not found (or suppressed)
206  $text = false;
207  } elseif ( !$content instanceof TextContent ) {
208  // non-text content
209  wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
210  . $content->getModel() . "` which is not supported via this interface." );
211  die();
212  } else {
213  // want a section?
214  $section = $request->getIntOrNull( 'section' );
215  if ( $section !== null ) {
216  $content = $content->getSection( $section );
217  }
218 
219  if ( $content === null || $content === false ) {
220  // section not found (or section not supported, e.g. for JS, JSON, and CSS)
221  $text = false;
222  } else {
223  $text = $content->getNativeData();
224  }
225  }
226  }
227  }
228 
229  if ( $text !== false && $text !== '' && $request->getRawVal( 'templates' ) === 'expand' ) {
230  $text = $wgParser->preprocess(
231  $text,
232  $title,
234  );
235  }
236 
237  return $text;
238  }
239 
245  public function getOldId() {
246  $oldid = $this->getRequest()->getInt( 'oldid' );
247  switch ( $this->getRequest()->getText( 'direction' ) ) {
248  case 'next':
249  # output next revision, or nothing if there isn't one
250  $nextid = 0;
251  if ( $oldid ) {
252  $nextid = $this->getTitle()->getNextRevisionID( $oldid );
253  }
254  $oldid = $nextid ?: -1;
255  break;
256  case 'prev':
257  # output previous revision, or nothing if there isn't one
258  if ( !$oldid ) {
259  # get the current revision so we can get the penultimate one
260  $oldid = $this->page->getLatest();
261  }
262  $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
263  $oldid = $previd ?: -1;
264  break;
265  case 'cur':
266  $oldid = 0;
267  break;
268  }
269 
270  return $oldid;
271  }
272 
278  public function getContentType() {
279  // Use getRawVal instead of getVal because we only
280  // need to match against known strings, there is no
281  // storing of localised content or other user input.
282  $ctype = $this->getRequest()->getRawVal( 'ctype' );
283 
284  if ( $ctype == '' ) {
285  // Legacy compatibilty
286  $gen = $this->getRequest()->getRawVal( 'gen' );
287  if ( $gen == 'js' ) {
288  $ctype = 'text/javascript';
289  } elseif ( $gen == 'css' ) {
290  $ctype = 'text/css';
291  }
292  }
293 
294  $allowedCTypes = [
295  'text/x-wiki',
296  'text/javascript',
297  'text/css',
298  // FIXME: Should we still allow Zope editing? External editing feature was dropped
299  'application/x-zope-edit',
300  'application/json'
301  ];
302  if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
303  $ctype = 'text/x-wiki';
304  }
305 
306  return $ctype;
307  }
308 }
RawAction
A simple method to retrieve the plain source of an article, using "action=raw" in the GET request str...
Definition: RawAction.php:37
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
RawAction\getOldId
getOldId()
Get the ID of the revision that should used to get the text.
Definition: RawAction.php:245
RawAction\getName
getName()
Return the name of the action this object responds to.
Definition: RawAction.php:38
$wgParser
$wgParser
Definition: Setup.php:917
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
FormlessAction
An action which just does something, without showing a form first.
Definition: FormlessAction.php:28
$response
this hook is for auditing only $response
Definition: hooks.txt:783
Action\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: Action.php:197
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
page
target page
Definition: All_system_messages.txt:1267
RawAction\getRawText
getRawText()
Get the text that should be returned, or false if the page or revision was not found.
Definition: RawAction.php:177
HttpError
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Revision\newFromTitle
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Definition: Revision.php:133
Action\getContext
getContext()
Get the IContextSource in use here.
Definition: Action.php:178
RawAction\getContentType
getContentType()
Get the content type to use for the response.
Definition: RawAction.php:278
RawAction\requiresUnblock
requiresUnblock()
Whether this action can still be executed by a blocked user.
Definition: RawAction.php:46
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
MessageCache\singleton
static singleton()
Get the signleton instance of this class.
Definition: MessageCache.php:113
RawAction\onView
onView()
Show something on GET request.
Definition: RawAction.php:50
Action\getUser
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:217
MediaWiki\Session\SessionManager\getGlobalSession
static getGlobalSession()
Get the "global" session.
Definition: SessionManager.php:107
ParserOptions\newFromContext
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
Definition: ParserOptions.php:1005
Action\getTitle
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:246
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:35
$rev
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1777
User\isEveryoneAllowed
static isEveryoneAllowed( $right)
Check if all users may be assumed to have the given permission.
Definition: User.php:5011
wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:1751
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3022
LoggerFactory
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
Action\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: Action.php:207
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:82
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
RawAction\requiresWrite
requiresWrite()
Whether this action requires the wiki not to be locked.
Definition: RawAction.php:42