MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
32 abstract class ApiFormatBase extends ApiBase {
34  private $mBuffer, $mDisabled = false;
35  private $mIsWrappedHtml = false;
36  protected $mForceDefaultParams = false;
43  public function __construct( ApiMain $main, $format ) {
44  parent::__construct( $main, $format );
46  $this->mIsHtml = ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'
47  if ( $this->mIsHtml ) {
48  $this->mFormat = substr( $format, 0, -2 ); // remove ending 'fm'
49  $this->mIsWrappedHtml = $this->getMain()->getCheck( 'wrappedhtml' );
50  } else {
51  $this->mFormat = $format;
52  }
53  $this->mFormat = strtoupper( $this->mFormat );
54  }
64  abstract public function getMimeType();
70  public function getFormat() {
71  return $this->mFormat;
72  }
80  public function getIsHtml() {
81  return $this->mIsHtml;
82  }
89  protected function getIsWrappedHtml() {
90  return $this->mIsWrappedHtml;
91  }
98  public function disable() {
99  $this->mDisabled = true;
100  }
106  public function isDisabled() {
107  return $this->mDisabled;
108  }
118  public function canPrintErrors() {
119  return true;
120  }
128  public function forceDefaultParams() {
129  $this->mForceDefaultParams = true;
130  }
136  protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
137  if ( !$this->mForceDefaultParams ) {
138  return parent::getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
139  }
141  if ( !is_array( $paramSettings ) ) {
142  return $paramSettings;
143  } elseif ( isset( $paramSettings[self::PARAM_DFLT] ) ) {
144  return $paramSettings[self::PARAM_DFLT];
145  } else {
146  return null;
147  }
148  }
154  public function initPrinter( $unused = false ) {
155  if ( $this->mDisabled ) {
156  return;
157  }
159  $mime = $this->getIsWrappedHtml()
160  ? 'text/mediawiki-api-prettyprint-wrapped'
161  : ( $this->getIsHtml() ? 'text/html' : $this->getMimeType() );
163  // Some printers (ex. Feed) do their own header settings,
164  // in which case $mime will be set to null
165  if ( $mime === null ) {
166  return; // skip any initialization
167  }
169  $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
171  // Set X-Frame-Options API results (bug 39180)
172  $apiFrameOptions = $this->getConfig()->get( 'ApiFrameOptions' );
173  if ( $apiFrameOptions ) {
174  $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
175  }
176  }
181  public function closePrinter() {
182  if ( $this->mDisabled ) {
183  return;
184  }
186  $mime = $this->getMimeType();
187  if ( $this->getIsHtml() && $mime !== null ) {
188  $format = $this->getFormat();
189  $lcformat = strtolower( $format );
190  $result = $this->getBuffer();
192  $context = new DerivativeContext( $this->getMain() );
193  $context->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'apioutput' ) );
194  $context->setTitle( SpecialPage::getTitleFor( 'ApiHelp' ) );
195  $out = new OutputPage( $context );
196  $context->setOutput( $out );
198  $out->addModuleStyles( 'mediawiki.apipretty' );
199  $out->setPageTitle( $context->msg( 'api-format-title' ) );
201  if ( !$this->getIsWrappedHtml() ) {
202  // When the format without suffix 'fm' is defined, there is a non-html version
203  if ( $this->getMain()->getModuleManager()->isDefined( $lcformat, 'format' ) ) {
204  $msg = $context->msg( 'api-format-prettyprint-header' )->params( $format, $lcformat );
205  } else {
206  $msg = $context->msg( 'api-format-prettyprint-header-only-html' )->params( $format );
207  }
209  $header = $msg->parseAsBlock();
210  $out->addHTML(
211  Html::rawElement( 'div', [ 'class' => 'api-pretty-header' ],
213  )
214  );
215  }
217  if ( Hooks::run( 'ApiFormatHighlight', [ $context, $result, $mime, $format ] ) ) {
218  $out->addHTML(
219  Html::element( 'pre', [ 'class' => 'api-pretty-content' ], $result )
220  );
221  }
223  if ( $this->getIsWrappedHtml() ) {
224  // This is a special output mode mainly intended for ApiSandbox use
225  $time = microtime( true ) - $this->getConfig()->get( 'RequestTime' );
226  $json = FormatJson::encode(
227  [
228  'html' => $out->getHTML(),
229  'modules' => array_values( array_unique( array_merge(
230  $out->getModules(),
231  $out->getModuleScripts(),
232  $out->getModuleStyles()
233  ) ) ),
234  'continue' => $this->getResult()->getResultData( 'continue' ),
235  'time' => round( $time * 1000 ),
236  ],
237  false, FormatJson::ALL_OK
238  );
240  // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
241  // Flash, but what it does isn't friendly for the API, so we need to
242  // work around it.
243  if ( preg_match( '/<\s*cross-domain-policy\s*>/i', $json ) ) {
244  $json = preg_replace(
245  '/<(\s*cross-domain-policy\s*)>/i', '\\u003C$1\\u003E', $json
246  );
247  }
249  echo $json;
250  } else {
251  // API handles its own clickjacking protection.
252  // Note, that $wgBreakFrames will still override $wgApiFrameOptions for format mode.
253  $out->allowClickjacking();
254  $out->output();
255  }
256  } else {
257  // For non-HTML output, clear all errors that might have been
258  // displayed if display_errors=On
259  ob_clean();
261  echo $this->getBuffer();
262  }
263  }
269  public function printText( $text ) {
270  $this->mBuffer .= $text;
271  }
277  public function getBuffer() {
278  return $this->mBuffer;
279  }
281  public function getAllowedParams() {
282  $ret = [];
283  if ( $this->getIsHtml() ) {
284  $ret['wrappedhtml'] = [
285  ApiBase::PARAM_DFLT => false,
286  ApiBase::PARAM_HELP_MSG => 'apihelp-format-param-wrappedhtml',
288  ];
289  }
290  return $ret;
291  }
293  protected function getExamplesMessages() {
294  return [
295  'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
296  => [ 'apihelp-format-example-generic', $this->getFormat() ]
297  ];
298  }
300  public function getHelpUrls() {
301  return '';
302  }
304 }
Whether the printer is disabled.
Disable the formatter.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:802
getParameterFromSettings($paramName, $paramSettings, $parseLimit)
Overridden to honor $this->forceDefaultParams(), if applicable.
Get the result object.
Definition: ApiBase.php:584
Initialize the printer function and prepare the output headers.
Returns true when the special wrapped mode is enabled.
__construct(ApiMain $main, $format)
If $format ends with 'fm', pretty-print the output in HTML.
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:1936
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
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
Get the main module.
Definition: ApiBase.php:480
Get a Message object with context set.
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
An IContextSource implementation which will inherit context from another source but allow individual ...
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
Finish printing and output buffered data.
if($ext== 'php'||$ext== 'php5') $mime
Definition: router.php:65
static fixHelpLinks($html, $helptitle=null, $localModules=[])
Replace Special:ApiHelp links with links to api.php.
Definition: ApiHelp.php:172
This is the abstract base class for API formatters.
IContextSource $context
Append text to the output buffer.
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 '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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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:1934
Overriding class returns the MIME type that should be sent to the client.
Returns true when the HTML pretty-printer should be used.
Get the Config object.
static encode($value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
Whether this formatter can handle printing API errors.
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:43
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
Get the contents of the buffer.
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
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
Ignore request parameters, force a default.
Get the internal format name.
static getDefaultInstance()
Definition: SkinFactory.php:50
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1749