MediaWiki  1.30.0
PageDataRequestHandler.php
Go to the documentation of this file.
1 <?php
2 
5 
15 
29  public function canHandleRequest( $subPage, WebRequest $request ) {
30  if ( $subPage === '' || $subPage === null ) {
31  if ( $request->getText( 'target', '' ) === '' ) {
32  return false;
33  } else {
34  return true;
35  }
36  }
37 
38  $parts = explode( '/', $subPage, 2 );
39  if ( $parts !== 2 ) {
40  $slot = $parts[0];
41  if ( $slot === 'main' || $slot === '' ) {
42  return true;
43  }
44  }
45 
46  return false;
47  }
48 
64  public function handleRequest( $subPage, WebRequest $request, OutputPage $output ) {
65  // No matter what: The response is always public
66  $output->getRequest()->response()->header( 'Access-Control-Allow-Origin: *' );
67 
68  if ( !$this->canHandleRequest( $subPage, $request ) ) {
69  throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $subPage ) );
70  }
71 
72  $revision = 0;
73 
74  $parts = explode( '/', $subPage, 2 );
75  if ( $subPage !== '' ) {
76  $title = $parts[1];
77  } else {
78  $title = $request->getText( 'target', '' );
79  }
80 
81  $revision = $request->getInt( 'oldid', $revision );
82  $revision = $request->getInt( 'revision', $revision );
83 
84  if ( $title === null || $title === '' ) {
85  //TODO: different error message?
86  throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $title ) );
87  }
88 
89  try {
91  } catch ( MalformedTitleException $ex ) {
92  throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $title ) );
93  }
94 
95  $this->httpContentNegotiation( $request, $output, $title, $revision );
96  }
97 
110  public function httpContentNegotiation(
113  Title $title,
114  $revision = 0
115  ) {
116  $contentHandler = ContentHandler::getForTitle( $title );
117  $mimeTypes = $contentHandler->getSupportedFormats();
118 
119  $headers = $request->getAllHeaders();
120  if ( isset( $headers['ACCEPT'] ) ) {
121  $parser = new HttpAcceptParser();
122  $accept = $parser->parseWeights( $headers['ACCEPT'] );
123  } else {
124  // anything goes
125  $accept = [
126  '*' => 0.1 // just to make extra sure
127  ];
128  // prefer the default
129  $accept[$mimeTypes[0]] = 1;
130  }
131 
132  $negotiator = new HttpAcceptNegotiator( $mimeTypes );
133  $format = $negotiator->getBestSupportedKey( $accept, null );
134 
135  if ( $format === null ) {
136  $format = isset( $accept['text/html'] ) ? 'text/html' : null;
137  }
138 
139  if ( $format === null ) {
140  $msg = wfMessage( 'pagedata-not-acceptable', implode( ', ', $mimeTypes ) );
141  throw new HttpError( 406, $msg );
142  }
143 
144  $url = $this->getDocUrl( $title, $format, $revision );
145  $output->redirect( $url, 303 );
146  }
147 
156  private function getDocUrl( Title $title, $format = '', $revision = 0 ) {
157  $params = [];
158 
159  if ( $revision > 0 ) {
160  $params['oldid'] = $revision;
161  }
162 
163  if ( $format === 'text/html' ) {
164  return $title->getFullURL( $params );
165  }
166 
167  $params[ 'action' ] = 'raw';
168 
169  return $title->getFullURL( $params );
170  }
171 
172 }
PageDataRequestHandler
Request handler implementing a data interface for mediawiki pages.
Definition: PageDataRequestHandler.php:14
Wikimedia\Http\HttpAcceptParser
Definition: HttpAcceptParser.php:13
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$params
$params
Definition: styleTest.css.php:40
ContentHandler\getForTitle
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
Definition: ContentHandler.php:240
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2198
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:35
PageDataRequestHandler\getDocUrl
getDocUrl(Title $title, $format='', $revision=0)
Returns a url representing the given title.
Definition: PageDataRequestHandler.php:156
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
Wikimedia\Http\HttpAcceptNegotiator
Definition: HttpAcceptNegotiator.php:18
$parser
do that in ParserLimitReportFormat instead $parser
Definition: hooks.txt:2572
PageDataRequestHandler\httpContentNegotiation
httpContentNegotiation(WebRequest $request, OutputPage $output, Title $title, $revision=0)
Applies HTTP content negotiation.
Definition: PageDataRequestHandler.php:110
OutputPage
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:44
Title\newFromTextThrow
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,...
Definition: Title.php:301
$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:2581
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
Title
Represents a title within MediaWiki.
Definition: Title.php:39
PageDataRequestHandler\handleRequest
handleRequest( $subPage, WebRequest $request, OutputPage $output)
Main method for handling requests.
Definition: PageDataRequestHandler.php:64
MalformedTitleException
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
Definition: MalformedTitleException.php:25
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
PageDataRequestHandler\canHandleRequest
canHandleRequest( $subPage, WebRequest $request)
Checks whether the request is complete, i.e.
Definition: PageDataRequestHandler.php:29