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 ) {
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->setUser( new User
); // anon to avoid caching issues
159 $context->setSkin( SkinFactory
::getDefaultInstance()->makeSkin( 'apioutput' ) );
160 $out = new OutputPage( $context );
161 $out->addModules( 'mediawiki.apipretty' );
162 $out->setPageTitle( $context->msg( 'api-format-title' ) );
163 $context->setOutput( $out );
165 $header = $context->msg( 'api-format-prettyprint-header' )
166 ->params( $format, strtolower( $format ) )
169 Html
::rawElement( 'div', array( 'class' => 'api-pretty-header' ),
170 ApiHelp
::fixHelpLinks( $header )
174 if ( wfRunHooks( 'ApiFormatHighlight', array( $context, $result, $mime, $format ) ) ) {
176 Html
::element( 'pre', array( 'class' => 'api-pretty-content' ), $result )
182 // For non-HTML output, clear all errors that might have been
183 // displayed if display_errors=On
186 echo $this->getBuffer();
191 * Append text to the output buffer.
192 * @param string $text
194 public function printText( $text ) {
195 $this->mBuffer
.= $text;
199 * Get the contents of the buffer.
202 public function getBuffer() {
203 return $this->mBuffer
;
206 public function getExamplesMessages() {
208 'action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName()
209 => array( 'apihelp-format-example-generic', $this->getFormat() )
213 public function getHelpUrls() {
214 return 'https://www.mediawiki.org/wiki/API:Data_formats';
218 * To avoid code duplication with the deprecation of dbg, dump, txt, wddx,
219 * and yaml, this method is added to do the necessary work. It should be
220 * removed when those deprecated formats are removed.
222 protected function markDeprecated() {
223 $fm = $this->getIsHtml() ?
'fm' : '';
224 $name = $this->getModuleName();
225 $this->logFeatureUsage( "format=$name" );
226 $this->setWarning( "format=$name has been deprecated. Please use format=json$fm instead." );
229 /************************************************************************//**
235 * Specify whether or not sequences like &quot; should be unescaped
236 * to " . This should only be set to true for the help message
237 * when rendered in the default (xmlfm) format. This is a temporary
238 * special-case fix that should be removed once the help has been
239 * reworked to use a fully HTML interface.
241 * @deprecated since 1.25
242 * @param bool $b Whether or not ampersands should be escaped.
244 public function setUnescapeAmps( $b ) {
245 wfDeprecated( __METHOD__
, '1.25' );
246 $this->mUnescapeAmps
= $b;
250 * Whether this formatter can format the help message in a nice way.
251 * By default, this returns the same as getIsHtml().
252 * When action=help is set explicitly, the help will always be shown
253 * @deprecated since 1.25
256 public function getWantsHelp() {
257 wfDeprecated( __METHOD__
, '1.25' );
258 return $this->getIsHtml();
262 * Sets whether the pretty-printer should format *bold*
263 * @deprecated since 1.25
266 public function setHelp( $help = true ) {
267 wfDeprecated( __METHOD__
, '1.25' );
268 $this->mHelp
= $help;
272 * Pretty-print various elements in HTML format, such as xml tags and
273 * URLs. This method also escapes characters like <
274 * @deprecated since 1.25
275 * @param string $text
278 protected function formatHTML( $text ) {
279 wfDeprecated( __METHOD__
, '1.25' );
281 // Escape everything first for full coverage
282 $text = htmlspecialchars( $text );
284 if ( $this->mFormat
=== 'XML' ||
$this->mFormat
=== 'WDDX' ) {
285 // encode all comments or tags as safe blue strings
286 $text = str_replace( '<', '<span style="color:blue;"><', $text );
287 $text = str_replace( '>', '></span>', $text );
290 // identify requests to api.php
291 $text = preg_replace( '#^(\s*)(api\.php\?[^ <\n\t]+)$#m', '\1<a href="\2">\2</a>', $text );
292 if ( $this->mHelp
) {
293 // make lines inside * bold
294 $text = preg_replace( '#^(\s*)(\*[^<>\n]+\*)(\s*)$#m', '$1<b>$2</b>$3', $text );
297 // Armor links (bug 61362)
299 $text = preg_replace_callback( '#<a .*?</a>#', function ( $matches ) use ( &$masked ) {
300 $sha = sha1( $matches[0] );
301 $masked[$sha] = $matches[0];
306 $protos = wfUrlProtocolsWithoutProtRel();
307 // This regex hacks around bug 13218 (" included in the URL)
308 $text = preg_replace(
309 "#(((?i)$protos).*?)(")?([ \\'\"<>\n]|<|>|")#",
310 '<a href="\\1">\\1</a>\\3\\4',
315 $text = preg_replace_callback( '#<([0-9a-f]{40})>#', function ( $matches ) use ( &$masked ) {
317 return isset( $masked[$sha] ) ?
$masked[$sha] : $matches[0];
321 * Temporary fix for bad links in help messages. As a special case,
322 * XML-escaped metachars are de-escaped one level in the help message
323 * for legibility. Should be removed once we have completed a fully-HTML
324 * version of the help message.
326 if ( $this->mUnescapeAmps
) {
327 $text = preg_replace( '/&(amp|quot|lt|gt);/', '&\1;', $text );
334 * @see ApiBase::getDescription
335 * @deprecated since 1.25
337 public function getDescription() {
338 return $this->getIsHtml() ?
' (pretty-print in HTML)' : '';
342 * Set the flag to buffer the result instead of printing it.
343 * @deprecated since 1.25, output is always buffered
346 public function setBufferResult( $value ) {
353 * For really cool vim folding this needs to be at the end:
354 * vim: foldmarker=@{,@} foldmethod=marker