MediaWiki  master
RawAction.php
Go to the documentation of this file.
1 <?php
31 
38 class RawAction extends FormlessAction {
39  public function getName() {
40  return 'raw';
41  }
42 
43  public function requiresWrite() {
44  return false;
45  }
46 
47  public function requiresUnblock() {
48  return false;
49  }
50 
54  function onView() {
55  $this->getOutput()->disable();
56  $request = $this->getRequest();
57  $response = $request->response();
58  $config = $this->context->getConfig();
59 
60  if ( !$request->checkUrlExtension() ) {
61  return;
62  }
63 
64  if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
65  return; // Client cache fresh and headers sent, nothing more to do.
66  }
67 
68  $contentType = $this->getContentType();
69 
70  $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
71  $smaxage = $request->getIntOrNull( 'smaxage' );
72  if ( $smaxage === null ) {
73  if (
74  $contentType == 'text/css' ||
75  $contentType == 'application/json' ||
76  $contentType == 'text/javascript'
77  ) {
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' ) );
82  } else {
83  // No CDN cache for anything else
84  $smaxage = 0;
85  }
86  }
87 
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() );
92  }
93 
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';
101  $response->header(
102  'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
103  );
104 
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
108  // JS/CSS/Json page.
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" );
119  $log->warning(
120  "Unsafe JS/CSS/Json {$elevatedText}load - {user} loaded {title} with {ctype}",
121  [
122  'user' => $this->getUser()->getName(),
123  'title' => $title->getPrefixedDBkey(),
124  'ctype' => $contentType,
125  'elevated' => $elevated
126  ]
127  );
128  $msg = wfMessage( 'unregistered-user-config' );
129  throw new HttpError( 403, $msg );
130  }
131  }
132 
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
138  // allowance.
139  if (
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' ) )
145  ) {
146 
147  $log = LoggerFactory::getInstance( "security" );
148  $log->info( "Blocked loading unprotected JS {title} for {user}",
149  [
150  'user' => $this->getUser()->getName(),
151  'title' => $title->getPrefixedDBkey(),
152  ]
153  );
154  throw new HttpError( 403, wfMessage( 'unprotected-js' ) );
155  }
156 
157  $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
158 
159  $text = $this->getRawText();
160 
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
164  // have the pages.
165  if ( $text === false && $contentType == 'text/x-wiki' ) {
166  $response->statusHeader( 404 );
167  }
168 
169  // Avoid PHP 7.1 warning of passing $this by reference
170  $rawAction = $this;
171  if ( !Hooks::run( 'RawPageViewBeforeOutput', [ &$rawAction, &$text ] ) ) {
172  wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
173  }
174 
175  echo $text;
176  }
177 
184  public function getRawText() {
185  $text = false;
186  $title = $this->getTitle();
187  $request = $this->getRequest();
188 
189  // Get it from the DB
191  if ( $rev ) {
192  $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
193  $request->response()->header( "Last-modified: $lastmod" );
194 
195  // Public-only due to cache headers
196  $content = $rev->getContent();
197 
198  if ( $content === null ) {
199  // revision not found (or suppressed)
200  $text = false;
201  } elseif ( !$content instanceof TextContent ) {
202  // non-text content
203  wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
204  . $content->getModel() . "` which is not supported via this interface." );
205  die();
206  } else {
207  // want a section?
208  $section = $request->getIntOrNull( 'section' );
209  if ( $section !== null ) {
210  $content = $content->getSection( $section );
211  }
212 
213  if ( $content === null || $content === false ) {
214  // section not found (or section not supported, e.g. for JS, JSON, and CSS)
215  $text = false;
216  } else {
217  $text = $content->getText();
218  }
219  }
220  }
221 
222  if ( $text !== false && $text !== '' && $request->getRawVal( 'templates' ) === 'expand' ) {
223  $text = MediaWikiServices::getInstance()->getParser()->preprocess(
224  $text,
225  $title,
227  );
228  }
229 
230  return $text;
231  }
232 
238  public function getOldId() {
239  $oldid = $this->getRequest()->getInt( 'oldid' );
240  switch ( $this->getRequest()->getText( 'direction' ) ) {
241  case 'next':
242  # output next revision, or nothing if there isn't one
243  $nextid = 0;
244  if ( $oldid ) {
245  $nextid = $this->getTitle()->getNextRevisionID( $oldid );
246  }
247  $oldid = $nextid ?: -1;
248  break;
249  case 'prev':
250  # output previous revision, or nothing if there isn't one
251  if ( !$oldid ) {
252  # get the current revision so we can get the penultimate one
253  $oldid = $this->page->getLatest();
254  }
255  $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
256  $oldid = $previd ?: -1;
257  break;
258  case 'cur':
259  $oldid = 0;
260  break;
261  }
262 
263  return $oldid;
264  }
265 
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' );
276 
277  if ( $ctype == '' ) {
278  // Legacy compatibilty
279  $gen = $this->getRequest()->getRawVal( 'gen' );
280  if ( $gen == 'js' ) {
281  $ctype = 'text/javascript';
282  } elseif ( $gen == 'css' ) {
283  $ctype = 'text/css';
284  }
285  }
286 
287  $allowedCTypes = [
288  'text/x-wiki',
289  'text/javascript',
290  'text/css',
291  // FIXME: Should we still allow Zope editing? External editing feature was dropped
292  'application/x-zope-edit',
293  'application/json'
294  ];
295  if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
296  $ctype = 'text/x-wiki';
297  }
298 
299  return $ctype;
300  }
301 }
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
getOutput()
Get the OutputPage being used for this instance.
Definition: Action.php:208
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:247
static isEveryoneAllowed( $right)
Check if all users may be assumed to have the given permission.
Definition: User.php:5076
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:218
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 MediaWikiServices
Definition: injection.txt:23
this hook is for auditing only $response
Definition: hooks.txt:780
getContentType()
Get the content type to use for the response.
Definition: RawAction.php:271
target page
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that&#39;s attached to a given link target...
Definition: Revision.php:137
requiresUnblock()
Definition: RawAction.php:47
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
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 use $formDescriptor instead 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
getRawText()
Get the text that should be returned, or false if the page or revision was not found.
Definition: RawAction.php:184
requiresWrite()
Definition: RawAction.php:43
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getContext()
Get the IContextSource in use here.
Definition: Action.php:179
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:1766
const NS_MEDIAWIKI
Definition: Defines.php:72
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:3050
An action which just does something, without showing a form first.
static getGlobalSession()
Get the "global" session.
onView()
SecurityCheck-XSS Non html mime type
Definition: RawAction.php:54
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:35
getOldId()
Get the ID of the revision that should used to get the text.
Definition: RawAction.php:238
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
A simple method to retrieve the plain source of an article, using "action=raw" in the GET request str...
Definition: RawAction.php:38
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:587
getRequest()
Get the WebRequest being used for this instance.
Definition: Action.php:198
$content
Definition: pageupdater.txt:72
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:2633
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200