MediaWiki  1.33.0
ApiFormatBase.php
Go to the documentation of this file.
1 <?php
28 abstract class ApiFormatBase extends ApiBase {
29  private $mIsHtml, $mFormat;
30  private $mBuffer, $mDisabled = false;
31  private $mIsWrappedHtml = false;
32  private $mHttpStatus = false;
33  protected $mForceDefaultParams = false;
34 
40  public function __construct( ApiMain $main, $format ) {
41  parent::__construct( $main, $format );
42 
43  $this->mIsHtml = ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'
44  if ( $this->mIsHtml ) {
45  $this->mFormat = substr( $format, 0, -2 ); // remove ending 'fm'
46  $this->mIsWrappedHtml = $this->getMain()->getCheck( 'wrappedhtml' );
47  } else {
48  $this->mFormat = $format;
49  }
50  $this->mFormat = strtoupper( $this->mFormat );
51  }
52 
61  abstract public function getMimeType();
62 
70  public function getFilename() {
71  if ( $this->getIsWrappedHtml() ) {
72  return 'api-result-wrapped.json';
73  } elseif ( $this->getIsHtml() ) {
74  return 'api-result.html';
75  } else {
76  $exts = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer()
77  ->getExtensionsForType( $this->getMimeType() );
78  $ext = $exts ? strtok( $exts, ' ' ) : strtolower( $this->mFormat );
79  return "api-result.$ext";
80  }
81  }
82 
87  public function getFormat() {
88  return $this->mFormat;
89  }
90 
97  public function getIsHtml() {
98  return $this->mIsHtml;
99  }
100 
106  protected function getIsWrappedHtml() {
107  return $this->mIsWrappedHtml;
108  }
109 
115  public function disable() {
116  $this->mDisabled = true;
117  }
118 
123  public function isDisabled() {
124  return $this->mDisabled;
125  }
126 
135  public function canPrintErrors() {
136  return true;
137  }
138 
145  public function forceDefaultParams() {
146  $this->mForceDefaultParams = true;
147  }
148 
154  protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
155  if ( !$this->mForceDefaultParams ) {
156  return parent::getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
157  }
158 
159  if ( !is_array( $paramSettings ) ) {
160  return $paramSettings;
161  }
162 
163  return $paramSettings[self::PARAM_DFLT] ?? null;
164  }
165 
171  public function setHttpStatus( $code ) {
172  if ( $this->mDisabled ) {
173  return;
174  }
175 
176  if ( $this->getIsHtml() ) {
177  $this->mHttpStatus = $code;
178  } else {
179  $this->getMain()->getRequest()->response()->statusHeader( $code );
180  }
181  }
182 
187  public function initPrinter( $unused = false ) {
188  if ( $this->mDisabled ) {
189  return;
190  }
191 
192  $mime = $this->getIsWrappedHtml()
193  ? 'text/mediawiki-api-prettyprint-wrapped'
194  : ( $this->getIsHtml() ? 'text/html' : $this->getMimeType() );
195 
196  // Some printers (ex. Feed) do their own header settings,
197  // in which case $mime will be set to null
198  if ( $mime === null ) {
199  return; // skip any initialization
200  }
201 
202  $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
203 
204  // Set X-Frame-Options API results (T41180)
205  $apiFrameOptions = $this->getConfig()->get( 'ApiFrameOptions' );
206  if ( $apiFrameOptions ) {
207  $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
208  }
209 
210  // Set a Content-Disposition header so something downloading an API
211  // response uses a halfway-sensible filename (T128209).
212  $header = 'Content-Disposition: inline';
213  $filename = $this->getFilename();
214  $compatFilename = mb_convert_encoding( $filename, 'ISO-8859-1' );
215  if ( preg_match( '/^[0-9a-zA-Z!#$%&\'*+\-.^_`|~]+$/', $compatFilename ) ) {
216  $header .= '; filename=' . $compatFilename;
217  } else {
218  $header .= '; filename="'
219  . preg_replace( '/([\0-\x1f"\x5c\x7f])/', '\\\\$1', $compatFilename ) . '"';
220  }
221  if ( $compatFilename !== $filename ) {
222  $value = "UTF-8''" . rawurlencode( $filename );
223  // rawurlencode() encodes more characters than RFC 5987 specifies. Unescape the ones it allows.
224  $value = strtr( $value, [
225  '%21' => '!', '%23' => '#', '%24' => '$', '%26' => '&', '%2B' => '+', '%5E' => '^',
226  '%60' => '`', '%7C' => '|',
227  ] );
228  $header .= '; filename*=' . $value;
229  }
230  $this->getMain()->getRequest()->response()->header( $header );
231  }
232 
236  public function closePrinter() {
237  if ( $this->mDisabled ) {
238  return;
239  }
240 
241  $mime = $this->getMimeType();
242  if ( $this->getIsHtml() && $mime !== null ) {
243  $format = $this->getFormat();
244  $lcformat = strtolower( $format );
245  $result = $this->getBuffer();
246 
247  $context = new DerivativeContext( $this->getMain() );
248  $context->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'apioutput' ) );
249  $context->setTitle( SpecialPage::getTitleFor( 'ApiHelp' ) );
250  $out = new OutputPage( $context );
251  $context->setOutput( $out );
252 
253  $out->setRobotPolicy( 'noindex,nofollow' );
254  $out->addModuleStyles( 'mediawiki.apipretty' );
255  $out->setPageTitle( $context->msg( 'api-format-title' ) );
256 
257  if ( !$this->getIsWrappedHtml() ) {
258  // When the format without suffix 'fm' is defined, there is a non-html version
259  if ( $this->getMain()->getModuleManager()->isDefined( $lcformat, 'format' ) ) {
260  if ( !$this->getRequest()->wasPosted() ) {
261  $nonHtmlUrl = strtok( $this->getRequest()->getFullRequestURL(), '?' )
262  . '?' . $this->getRequest()->appendQueryValue( 'format', $lcformat );
263  $msg = $context->msg( 'api-format-prettyprint-header-hyperlinked' )
264  ->params( $format, $lcformat, $nonHtmlUrl );
265  } else {
266  $msg = $context->msg( 'api-format-prettyprint-header' )->params( $format, $lcformat );
267  }
268  } else {
269  $msg = $context->msg( 'api-format-prettyprint-header-only-html' )->params( $format );
270  }
271 
272  $header = $msg->parseAsBlock();
273  $out->addHTML(
274  Html::rawElement( 'div', [ 'class' => 'api-pretty-header' ],
276  )
277  );
278 
279  if ( $this->mHttpStatus && $this->mHttpStatus !== 200 ) {
280  $out->addHTML(
281  Html::rawElement( 'div', [ 'class' => 'api-pretty-header api-pretty-status' ],
282  $this->msg(
283  'api-format-prettyprint-status',
284  $this->mHttpStatus,
285  HttpStatus::getMessage( $this->mHttpStatus )
286  )->parse()
287  )
288  );
289  }
290  }
291 
292  if ( Hooks::run( 'ApiFormatHighlight', [ $context, $result, $mime, $format ] ) ) {
293  $out->addHTML(
294  Html::element( 'pre', [ 'class' => 'api-pretty-content' ], $result )
295  );
296  }
297 
298  if ( $this->getIsWrappedHtml() ) {
299  // This is a special output mode mainly intended for ApiSandbox use
300  $time = $this->getMain()->getRequest()->getElapsedTime();
301  $json = FormatJson::encode(
302  [
303  'status' => (int)( $this->mHttpStatus ?: 200 ),
304  'statustext' => HttpStatus::getMessage( $this->mHttpStatus ?: 200 ),
305  'html' => $out->getHTML(),
306  'modules' => array_values( array_unique( array_merge(
307  $out->getModules(),
308  $out->getModuleStyles()
309  ) ) ),
310  'continue' => $this->getResult()->getResultData( 'continue' ),
311  'time' => round( $time * 1000 ),
312  ],
313  false, FormatJson::ALL_OK
314  );
315 
316  // T68776: OutputHandler::mangleFlashPolicy() avoids a nasty bug in
317  // Flash, but what it does isn't friendly for the API, so we need to
318  // work around it.
319  if ( preg_match( '/<\s*cross-domain-policy\s*>/i', $json ) ) {
320  $json = preg_replace(
321  '/<(\s*cross-domain-policy\s*)>/i', '\\u003C$1\\u003E', $json
322  );
323  }
324 
325  echo $json;
326  } else {
327  // API handles its own clickjacking protection.
328  // Note, that $wgBreakFrames will still override $wgApiFrameOptions for format mode.
329  $out->allowClickjacking();
330  $out->output();
331  }
332  } else {
333  // For non-HTML output, clear all errors that might have been
334  // displayed if display_errors=On
335  ob_clean();
336 
337  echo $this->getBuffer();
338  }
339  }
340 
345  public function printText( $text ) {
346  $this->mBuffer .= $text;
347  }
348 
353  public function getBuffer() {
354  return $this->mBuffer;
355  }
356 
357  public function getAllowedParams() {
358  $ret = [];
359  if ( $this->getIsHtml() ) {
360  $ret['wrappedhtml'] = [
361  ApiBase::PARAM_DFLT => false,
362  ApiBase::PARAM_HELP_MSG => 'apihelp-format-param-wrappedhtml',
363 
364  ];
365  }
366  return $ret;
367  }
368 
369  protected function getExamplesMessages() {
370  return [
371  'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
372  => [ 'apihelp-format-example-generic', $this->getFormat() ]
373  ];
374  }
375 
376  public function getHelpUrls() {
377  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Data_formats';
378  }
379 
380 }
381 
ApiFormatBase\forceDefaultParams
forceDefaultParams()
Ignore request parameters, force a default.
Definition: ApiFormatBase.php:145
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:41
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ApiFormatBase\isDisabled
isDisabled()
Whether the printer is disabled.
Definition: ApiFormatBase.php:123
ApiFormatBase\$mFormat
$mFormat
Definition: ApiFormatBase.php:29
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1983
ApiFormatBase
This is the abstract base class for API formatters.
Definition: ApiFormatBase.php:28
$out
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 it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:632
ApiFormatBase\$mForceDefaultParams
$mForceDefaultParams
Definition: ApiFormatBase.php:33
ApiFormatBase\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiFormatBase.php:369
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
ContextSource\getRequest
getRequest()
Definition: ContextSource.php:71
FormatJson\ALL_OK
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
ApiFormatBase\getMimeType
getMimeType()
Overriding class returns the MIME type that should be sent to the client.
ApiFormatBase\__construct
__construct(ApiMain $main, $format)
If $format ends with 'fm', pretty-print the output in HTML.
Definition: ApiFormatBase.php:40
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
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
DerivativeContext
An IContextSource implementation which will inherit context from another source but allow individual ...
Definition: DerivativeContext.php:30
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
ApiFormatBase\$mHttpStatus
$mHttpStatus
Definition: ApiFormatBase.php:32
$code
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 it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:780
ApiFormatBase\disable
disable()
Disable the formatter.
Definition: ApiFormatBase.php:115
MessageLocalizer\msg
msg( $key)
This is the method for getting translated interface messages.
ApiFormatBase\getIsWrappedHtml
getIsWrappedHtml()
Returns true when the special wrapped mode is enabled.
Definition: ApiFormatBase.php:106
ApiFormatBase\getBuffer
getBuffer()
Get the contents of the buffer.
Definition: ApiFormatBase.php:353
ApiFormatBase\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiFormatBase.php:357
ApiFormatBase\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiFormatBase.php:376
ApiFormatBase\$mIsWrappedHtml
$mIsWrappedHtml
Definition: ApiFormatBase.php:31
MediaWiki\MediaWikiServices\getInstance
static getInstance()
Returns the global default instance of the top level service locator.
Definition: MediaWikiServices.php:124
ApiFormatBase\$mBuffer
$mBuffer
Definition: ApiFormatBase.php:30
ApiHelp\fixHelpLinks
static fixHelpLinks( $html, $helptitle=null, $localModules=[])
Replace Special:ApiHelp links with links to api.php.
Definition: ApiHelp.php:171
$value
$value
Definition: styleTest.css.php:49
$header
$header
Definition: updateCredits.php:41
$ret
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1985
HttpStatus\getMessage
static getMessage( $code)
Get the message associated with an HTTP response status code.
Definition: HttpStatus.php:34
ApiFormatBase\$mDisabled
$mDisabled
Definition: ApiFormatBase.php:30
ApiFormatBase\printText
printText( $text)
Append text to the output buffer.
Definition: ApiFormatBase.php:345
ApiFormatBase\canPrintErrors
canPrintErrors()
Whether this formatter can handle printing API errors.
Definition: ApiFormatBase.php:135
ApiFormatBase\getParameterFromSettings
getParameterFromSettings( $paramName, $paramSettings, $parseLimit)
Overridden to honor $this->forceDefaultParams(), if applicable @inheritDoc.
Definition: ApiFormatBase.php:154
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:512
ApiFormatBase\getFormat
getFormat()
Get the internal format name.
Definition: ApiFormatBase.php:87
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:528
$ext
if(!is_readable( $file)) $ext
Definition: router.php:48
ApiFormatBase\setHttpStatus
setHttpStatus( $code)
Set the HTTP status code to be used for the response.
Definition: ApiFormatBase.php:171
ApiFormatBase\getIsHtml
getIsHtml()
Returns true when the HTML pretty-printer should be used.
Definition: ApiFormatBase.php:97
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1802
ApiFormatBase\getFilename
getFilename()
Return a filename for this module's output.
Definition: ApiFormatBase.php:70
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
ApiFormatBase\initPrinter
initPrinter( $unused=false)
Initialize the printer function and prepare the output headers.
Definition: ApiFormatBase.php:187
ApiFormatBase\closePrinter
closePrinter()
Finish printing and output buffered data.
Definition: ApiFormatBase.php:236
SkinFactory\getDefaultInstance
static getDefaultInstance()
Definition: SkinFactory.php:50
ApiFormatBase\$mIsHtml
$mIsHtml
Definition: ApiFormatBase.php:29