MediaWiki  master
PageDataRequestHandler.php
Go to the documentation of this file.
1 <?php
23 
31 
44  public function canHandleRequest( $subPage, WebRequest $request ) {
45  if ( $subPage === '' || $subPage === null ) {
46  return $request->getText( 'target' ) !== '';
47  }
48 
49  $parts = explode( '/', $subPage, 2 );
50  $slot = $parts[0];
51  $title = $parts[1] ?? '';
52  return ( $slot === 'main' || $slot === '' ) && $title !== '';
53  }
54 
70  public function handleRequest( $subPage, WebRequest $request, OutputPage $output ) {
71  // No matter what: The response is always public
72  $output->getRequest()->response()->header( 'Access-Control-Allow-Origin: *' );
73 
74  if ( !$this->canHandleRequest( $subPage, $request ) ) {
75  throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $subPage ) );
76  }
77 
78  $revision = 0;
79 
80  if ( $subPage !== '' ) {
81  $parts = explode( '/', $subPage, 2 );
82  $title = $parts[1] ?? '';
83  } else {
84  $title = $request->getText( 'target' );
85  }
86 
87  $revision = $request->getInt( 'oldid', $revision );
88  $revision = $request->getInt( 'revision', $revision );
89 
90  if ( $title === null || $title === '' ) {
91  //TODO: different error message?
92  throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $title ) );
93  }
94 
95  try {
97  } catch ( MalformedTitleException $ex ) {
98  throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $title ) );
99  }
100 
101  $this->httpContentNegotiation( $request, $output, $title, $revision );
102  }
103 
116  public function httpContentNegotiation(
119  Title $title,
120  $revision = 0
121  ) {
122  $contentHandler = ContentHandler::getForTitle( $title );
123  $mimeTypes = $contentHandler->getSupportedFormats();
124 
125  $acceptHeader = $request->getHeader( 'Accept' );
126  if ( $acceptHeader !== false ) {
127  $parser = new HttpAcceptParser();
128  $accept = $parser->parseWeights( $acceptHeader );
129  } else {
130  // anything goes
131  $accept = [
132  '*' => 0.1 // just to make extra sure
133  ];
134  // prefer the default
135  $accept[$mimeTypes[0]] = 1;
136  }
137 
138  $negotiator = new HttpAcceptNegotiator( $mimeTypes );
139  $format = $negotiator->getBestSupportedKey( $accept );
140 
141  if ( $format === null ) {
142  $format = isset( $accept['text/html'] ) ? 'text/html' : null;
143  }
144 
145  if ( $format === null ) {
146  $msg = wfMessage( 'pagedata-not-acceptable', implode( ', ', $mimeTypes ) );
147  throw new HttpError( 406, $msg );
148  }
149 
150  $url = $this->getDocUrl( $title, $format, $revision );
151  $output->redirect( $url, 303 );
152  }
153 
162  private function getDocUrl( Title $title, $format = '', $revision = 0 ) {
163  $params = [];
164 
165  if ( $revision > 0 ) {
166  $params['oldid'] = $revision;
167  }
168 
169  if ( $format === 'text/html' ) {
170  return $title->getFullURL( $params );
171  }
172 
173  $params[ 'action' ] = 'raw';
174 
175  return $title->getFullURL( $params );
176  }
177 
178 }
Utility for negotiating a value from a set of supported values using a preference list...
handleRequest( $subPage, WebRequest $request, OutputPage $output)
Main method for handling requests.
getInt( $name, $default=0)
Fetch an integer value from the input or return $default if not set.
Definition: WebRequest.php:534
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
getHeader( $name, $flags=0)
Get a request header, or false if it isn&#39;t set.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
redirect( $url, $responsecode='302')
Redirect to $url rather than displaying the normal page.
Definition: OutputPage.php:344
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1780
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2204
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
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
httpContentNegotiation(WebRequest $request, OutputPage $output, Title $title, $revision=0)
Applies HTTP content negotiation.
$params
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:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
getFullURL( $query='', $query2=false, $proto=PROTO_RELATIVE)
Get a real URL referring to this title, with interwiki link and fragment.
Definition: Title.php:1972
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Definition: Title.php:357
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
getText( $name, $default='')
Fetch a text string from the given array or return $default if it&#39;s not set.
Definition: WebRequest.php:618
getDocUrl(Title $title, $format='', $revision=0)
Returns a url representing the given title.
Request handler implementing a data interface for mediawiki pages.
canHandleRequest( $subPage, WebRequest $request)
Checks whether the request is complete, i.e.
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:2620