7bbd9687095ecb7e7fa22c817566e352ddb6713a
5 * Created on Sep 19, 2006
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * This is the abstract base class for API formatters.
32 abstract class ApiFormatBase
extends ApiBase
{
33 private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp;
34 private $mBuffer, $mDisabled = false;
37 * If $format ends with 'fm', pretty-print the output in HTML.
38 * @param ApiMain $main
39 * @param string $format Format name
41 public function __construct( ApiMain
$main, $format ) {
42 parent
::__construct( $main, $format );
44 $this->mIsHtml
= ( substr( $format, -2, 2 ) === 'fm' ); // ends with 'fm'
45 if ( $this->mIsHtml
) {
46 $this->mFormat
= substr( $format, 0, -2 ); // remove ending 'fm'
48 $this->mFormat
= $format;
50 $this->mFormat
= strtoupper( $this->mFormat
);
54 * Overriding class returns the MIME type that should be sent to the client.
56 * When getIsHtml() returns true, the return value here is used for syntax
57 * highlighting but the client sees text/html.
61 abstract public function getMimeType();
64 * Whether this formatter needs raw data such as _element tags
67 public function getNeedsRawData() {
72 * Get the internal format name
75 public function getFormat() {
76 return $this->mFormat
;
80 * Returns true when the HTML pretty-printer should be used.
81 * The default implementation assumes that formats ending with 'fm'
82 * should be formatted in HTML.
85 public function getIsHtml() {
86 return $this->mIsHtml
;
90 * Disable the formatter.
92 * This causes calls to initPrinter() and closePrinter() to be ignored.
94 public function disable() {
95 $this->mDisabled
= true;
99 * Whether the printer is disabled
102 public function isDisabled() {
103 return $this->mDisabled
;
107 * Whether this formatter can handle printing API errors.
109 * If this returns false, then on API errors the default printer will be
114 public function canPrintErrors() {
119 * Initialize the printer function and prepare the output headers.
120 * @param bool $unused Always false since 1.25
122 function initPrinter( $unused = false ) {
123 if ( $this->mDisabled
) {
127 $mime = $this->getIsHtml() ?
'text/html' : $this->getMimeType();
129 // Some printers (ex. Feed) do their own header settings,
130 // in which case $mime will be set to null
131 if ( $mime === null ) {
132 return; // skip any initialization
135 $this->getMain()->getRequest()->response()->header( "Content-Type: $mime; charset=utf-8" );
137 //Set X-Frame-Options API results (bug 39180)
138 $apiFrameOptions = $this->getConfig()->get( 'ApiFrameOptions' );
139 if ( $apiFrameOptions ) {
140 $this->getMain()->getRequest()->response()->header( "X-Frame-Options: $apiFrameOptions" );
145 * Finish printing and output buffered data.
147 public function closePrinter() {
148 if ( $this->mDisabled
) {
152 $mime = $this->getMimeType();
153 if ( $this->getIsHtml() && $mime !== null ) {
154 $format = $this->getFormat();
155 $result = $this->getBuffer();
157 $context = new DerivativeContext( $this->getMain() );
158 $context->setSkin( SkinFactory
::getDefaultInstance()->makeSkin( 'apioutput' ) );
159 $context->setTitle( SpecialPage
::getTitleFor( 'ApiHelp' ) );
160 $out = new OutputPage( $context );
161 $context->setOutput( $out );
163 $out->addModules( 'mediawiki.apipretty' );
164 $out->setPageTitle( $context->msg( 'api-format-title' ) );
166 $header = $context->msg( 'api-format-prettyprint-header' )
167 ->params( $format, strtolower( $format ) )
170 Html
::rawElement( 'div', array( 'class' => 'api-pretty-header' ),
171 ApiHelp
::fixHelpLinks( $header )
175 if ( Hooks
::run( 'ApiFormatHighlight', array( $context, $result, $mime, $format ) ) ) {
177 Html
::element( 'pre', array( 'class' => 'api-pretty-content' ), $result )
181 // API handles its own clickjacking protection.
182 // Note, that $wgBreakFrames will still override $wgApiFrameOptions for format mode.
183 $out->allowClickJacking();
186 // For non-HTML output, clear all errors that might have been
187 // displayed if display_errors=On
190 echo $this->getBuffer();
195 * Append text to the output buffer.
196 * @param string $text
198 public function printText( $text ) {
199 $this->mBuffer
.= $text;
203 * Get the contents of the buffer.
206 public function getBuffer() {
207 return $this->mBuffer
;
210 protected function getExamplesMessages() {
212 'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
213 => array( 'apihelp-format-example-generic', $this->getFormat() )
217 public function getHelpUrls() {
218 return 'https://www.mediawiki.org/wiki/API:Data_formats';
222 * To avoid code duplication with the deprecation of dbg, dump, txt, wddx,
223 * and yaml, this method is added to do the necessary work. It should be
224 * removed when those deprecated formats are removed.
226 protected function markDeprecated() {
227 $fm = $this->getIsHtml() ?
'fm' : '';
228 $name = $this->getModuleName();
229 $this->logFeatureUsage( "format=$name" );
230 $this->setWarning( "format=$name has been deprecated. Please use format=json$fm instead." );
233 /************************************************************************//**
239 * Specify whether or not sequences like &quot; should be unescaped
240 * to " . This should only be set to true for the help message
241 * when rendered in the default (xmlfm) format. This is a temporary
242 * special-case fix that should be removed once the help has been
243 * reworked to use a fully HTML interface.
245 * @deprecated since 1.25
246 * @param bool $b Whether or not ampersands should be escaped.
248 public function setUnescapeAmps( $b ) {
249 wfDeprecated( __METHOD__
, '1.25' );
250 $this->mUnescapeAmps
= $b;
254 * Whether this formatter can format the help message in a nice way.
255 * By default, this returns the same as getIsHtml().
256 * When action=help is set explicitly, the help will always be shown
257 * @deprecated since 1.25
260 public function getWantsHelp() {
261 wfDeprecated( __METHOD__
, '1.25' );
262 return $this->getIsHtml();
266 * Sets whether the pretty-printer should format *bold*
267 * @deprecated since 1.25
270 public function setHelp( $help = true ) {
271 wfDeprecated( __METHOD__
, '1.25' );
272 $this->mHelp
= $help;
276 * Pretty-print various elements in HTML format, such as xml tags and
277 * URLs. This method also escapes characters like <
278 * @deprecated since 1.25
279 * @param string $text
282 protected function formatHTML( $text ) {
283 wfDeprecated( __METHOD__
, '1.25' );
285 // Escape everything first for full coverage
286 $text = htmlspecialchars( $text );
288 if ( $this->mFormat
=== 'XML' ||
$this->mFormat
=== 'WDDX' ) {
289 // encode all comments or tags as safe blue strings
290 $text = str_replace( '<', '<span style="color:blue;"><', $text );
291 $text = str_replace( '>', '></span>', $text );
294 // identify requests to api.php
295 $text = preg_replace( '#^(\s*)(api\.php\?[^ <\n\t]+)$#m', '\1<a href="\2">\2</a>', $text );
296 if ( $this->mHelp
) {
297 // make lines inside * bold
298 $text = preg_replace( '#^(\s*)(\*[^<>\n]+\*)(\s*)$#m', '$1<b>$2</b>$3', $text );
301 // Armor links (bug 61362)
303 $text = preg_replace_callback( '#<a .*?</a>#', function ( $matches ) use ( &$masked ) {
304 $sha = sha1( $matches[0] );
305 $masked[$sha] = $matches[0];
310 $protos = wfUrlProtocolsWithoutProtRel();
311 // This regex hacks around bug 13218 (" included in the URL)
312 $text = preg_replace(
313 "#(((?i)$protos).*?)(")?([ \\'\"<>\n]|<|>|")#",
314 '<a href="\\1">\\1</a>\\3\\4',
319 $text = preg_replace_callback( '#<([0-9a-f]{40})>#', function ( $matches ) use ( &$masked ) {
321 return isset( $masked[$sha] ) ?
$masked[$sha] : $matches[0];
325 * Temporary fix for bad links in help messages. As a special case,
326 * XML-escaped metachars are de-escaped one level in the help message
327 * for legibility. Should be removed once we have completed a fully-HTML
328 * version of the help message.
330 if ( $this->mUnescapeAmps
) {
331 $text = preg_replace( '/&(amp|quot|lt|gt);/', '&\1;', $text );
338 * @see ApiBase::getDescription
339 * @deprecated since 1.25
341 public function getDescription() {
342 return $this->getIsHtml() ?
' (pretty-print in HTML)' : '';
346 * Set the flag to buffer the result instead of printing it.
347 * @deprecated since 1.25, output is always buffered
350 public function setBufferResult( $value ) {
357 * For really cool vim folding this needs to be at the end:
358 * vim: foldmarker=@{,@} foldmethod=marker