includes/api/ApiFormatBase.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 19, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( 'ApiBase.php' );
  29 }
  30
  31 /**
  32  * This is the abstract base class for API formatters.
  33  *
  34  * @ingroup API
  35  */
  36 abstract class ApiFormatBase extends ApiBase {
  37
  38         private $mIsHtml, $mFormat, $mUnescapeAmps, $mHelp, $mCleared;
  39         private $mBufferResult = false, $mBuffer;
  40
  41         /**
  42          * Constructor
  43          * If $format ends with 'fm', pretty-print the output in HTML.
  44          * @param $main ApiMain
  45          * @param $format string Format name
  46          */
  47         public function __construct( $main, $format ) {
  48                 parent :: __construct( $main, $format );
  49
  50                 $this->mIsHtml = ( substr( $format, - 2, 2 ) === 'fm' ); // ends with 'fm'
  51                 if ( $this->mIsHtml )
  52                         $this->mFormat = substr( $format, 0, - 2 ); // remove ending 'fm'
  53                 else
  54                         $this->mFormat = $format;
  55                 $this->mFormat = strtoupper( $this->mFormat );
  56                 $this->mCleared = false;
  57         }
  58
  59         /**
  60          * Overriding class returns the mime type that should be sent to the client.
  61          * This method is not called if getIsHtml() returns true.
  62          * @return string
  63          */
  64         public abstract function getMimeType();
  65
  66         /**
  67          * Whether this formatter needs raw data such as _element tags
  68          * @return bool
  69          */
  70         public function getNeedsRawData() {
  71                 return false;
  72         }
  73
  74         /**
  75          * Get the internal format name
  76          * @return string
  77          */
  78         public function getFormat() {
  79                 return $this->mFormat;
  80         }
  81
  82         /**
  83          * Specify whether or not sequences like &amp;quot; should be unescaped
  84          * to &quot; . This should only be set to true for the help message
  85          * when rendered in the default (xmlfm) format. This is a temporary
  86          * special-case fix that should be removed once the help has been
  87          * reworked to use a fully HTML interface.
  88          *
  89          * @param $b bool Whether or not ampersands should be escaped.
  90          */
  91         public function setUnescapeAmps ( $b ) {
  92                 $this->mUnescapeAmps = $b;
  93         }
  94
  95         /**
  96          * Returns true when the HTML pretty-printer should be used.
  97          * The default implementation assumes that formats ending with 'fm'
  98          * should be formatted in HTML.
  99          * @return bool
 100          */
 101         public function getIsHtml() {
 102                 return $this->mIsHtml;
 103         }
 104
 105         /**
 106          * Whether this formatter can format the help message in a nice way.
 107          * By default, this returns the same as getIsHtml().
 108          * When action=help is set explicitly, the help will always be shown
 109          * @return bool
 110          */
 111         public function getWantsHelp() {
 112                 return $this->getIsHtml();
 113         }
 114
 115         /**
 116          * Initialize the printer function and prepare the output headers, etc.
 117          * This method must be the first outputing method during execution.
 118          * A help screen's header is printed for the HTML-based output
 119          * @param $isError bool Whether an error message is printed
 120          */
 121         function initPrinter( $isError ) {
 122                 $isHtml = $this->getIsHtml();
 123                 $mime = $isHtml ? 'text/html' : $this->getMimeType();
 124                 $script = wfScript( 'api' );
 125
 126                 // Some printers (ex. Feed) do their own header settings,
 127                 // in which case $mime will be set to null
 128                 if ( is_null( $mime ) )
 129                         return; // skip any initialization
 130
 131                 header( "Content-Type: $mime; charset=utf-8" );
 132
 133                 if ( $isHtml ) {
 134 ?>
 135 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 136 <html>
 137 <head>
 138 <?php if ( $this->mUnescapeAmps ) {
 139 ?>      <title>MediaWiki API</title>
 140 <?php } else {
 141 ?>      <title>MediaWiki API Result</title>
 142 <?php } ?>
 143 </head>
 144 <body>
 145 <?php
 146
 147
 148                         if ( !$isError ) {
 149 ?>
 150 <br />
 151 <small>
 152 You are looking at the HTML representation of the <?php echo( $this->mFormat ); ?> format.<br />
 153 HTML is good for debugging, but probably is not suitable for your application.<br />
 154 See <a href='http://www.mediawiki.org/wiki/API'>complete documentation</a>, or
 155 <a href='<?php echo( $script ); ?>'>API help</a> for more information.
 156 </small>
 157 <?php
 158
 159
 160                         }
 161 ?>
 162 <pre>
 163 <?php
 164
 165
 166                 }
 167         }
 168
 169         /**
 170          * Finish printing. Closes HTML tags.
 171          */
 172         public function closePrinter() {
 173                 if ( $this->getIsHtml() ) {
 174 ?>
 175
 176 </pre>
 177 </body>
 178 </html>
 179 <?php
 180
 181
 182                 }
 183         }
 184
 185         /**
 186          * The main format printing function. Call it to output the result
 187          * string to the user. This function will automatically output HTML
 188          * when format name ends in 'fm'.
 189          * @param $text string
 190          */
 191         public function printText( $text ) {
 192                 if ( $this->mBufferResult ) {
 193                         $this->mBuffer = $text;
 194                 } elseif ( $this->getIsHtml() ) {
 195                         echo $this->formatHTML( $text );
 196                 } else {
 197                         // For non-HTML output, clear all errors that might have been
 198                         // displayed if display_errors=On
 199                         // Do this only once, of course
 200                         if ( !$this->mCleared )
 201                         {
 202                                 ob_clean();
 203                                 $this->mCleared = true;
 204                         }
 205                         echo $text;
 206                 }
 207         }
 208
 209         /**
 210          * Get the contents of the buffer.
 211          */
 212         public function getBuffer() {
 213                 return $this->mBuffer;
 214         }
 215         /**
 216          * Set the flag to buffer the result instead of printing it.
 217          */
 218         public function setBufferResult( $value ) {
 219                 $this->mBufferResult = $value;
 220         }
 221
 222         /**
 223          * Sets whether the pretty-printer should format *bold* and $italics$
 224          * @param $help bool
 225          */
 226         public function setHelp( $help = true ) {
 227                 $this->mHelp = true;
 228         }
 229
 230         /**
 231         * Prety-print various elements in HTML format, such as xml tags and
 232         * URLs. This method also escapes characters like <
 233         * @param $text string
 234         * @return string
 235         */
 236         protected function formatHTML( $text ) {
 237                 global $wgUrlProtocols;
 238
 239                 // Escape everything first for full coverage
 240                 $text = htmlspecialchars( $text );
 241
 242                 // encode all comments or tags as safe blue strings
 243                 $text = preg_replace( '/\&lt;(!--.*?--|.*?)\&gt;/', '<span style="color:blue;">&lt;\1&gt;</span>', $text );
 244                 // identify URLs
 245                 $protos = implode( "|", $wgUrlProtocols );
 246                 # This regex hacks around bug 13218 (&quot; included in the URL)
 247                 $text = preg_replace( "#(($protos).*?)(&quot;)?([ \\'\"<>\n]|&lt;|&gt;|&quot;)#", '<a href="\\1">\\1</a>\\3\\4', $text );
 248                 // identify requests to api.php
 249                 $text = preg_replace( "#api\\.php\\?[^ \\()<\n\t]+#", '<a href="\\0">\\0</a>', $text );
 250                 if ( $this->mHelp ) {
 251                         // make strings inside * bold
 252                         $text = preg_replace( "#\\*[^<>\n]+\\*#", '<b>\\0</b>', $text );
 253                         // make strings inside $ italic
 254                         $text = preg_replace( "#\\$[^<>\n]+\\$#", '<b><i>\\0</i></b>', $text );
 255                 }
 256
 257                 /* Temporary fix for bad links in help messages. As a special case,
 258                  * XML-escaped metachars are de-escaped one level in the help message
 259                  * for legibility. Should be removed once we have completed a fully-html
 260                  * version of the help message. */
 261                 if ( $this->mUnescapeAmps )
 262                         $text = preg_replace( '/&amp;(amp|quot|lt|gt);/', '&\1;', $text );
 263
 264                 return $text;
 265         }
 266
 267         protected function getExamples() {
 268                 return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName();
 269         }
 270
 271         public function getDescription() {
 272                 return $this->getIsHtml() ? ' (pretty-print in HTML)' : '';
 273         }
 274
 275         public static function getBaseVersion() {
 276                 return __CLASS__ . ': $Id$';
 277         }
 278 }
 279
 280 /**
 281  * This printer is used to wrap an instance of the Feed class
 282  * @ingroup API
 283  */
 284 class ApiFormatFeedWrapper extends ApiFormatBase {
 285
 286         public function __construct( $main ) {
 287                 parent :: __construct( $main, 'feed' );
 288         }
 289
 290         /**
 291          * Call this method to initialize output data. See execute()
 292          * @param $result ApiResult
 293          * @param $feed object an instance of one of the $wgFeedClasses classes
 294          * @param $feedItems array of FeedItem objects
 295          */
 296         public static function setResult( $result, $feed, $feedItems ) {
 297                 // Store output in the Result data.
 298                 // This way we can check during execution if any error has occured
 299                 // Disable size checking for this because we can't continue
 300                 // cleanly; size checking would cause more problems than it'd
 301                 // solve
 302                 $result->disableSizeCheck();
 303                 $result->addValue( null, '_feed', $feed );
 304                 $result->addValue( null, '_feeditems', $feedItems );
 305                 $result->enableSizeCheck();
 306         }
 307
 308         /**
 309          * Feed does its own headers
 310          */
 311         public function getMimeType() {
 312                 return null;
 313         }
 314
 315         /**
 316          * Optimization - no need to sanitize data that will not be needed
 317          */
 318         public function getNeedsRawData() {
 319                 return true;
 320         }
 321
 322         /**
 323          * This class expects the result data to be in a custom format set by self::setResult()
 324          * $result['_feed']             - an instance of one of the $wgFeedClasses classes
 325          * $result['_feeditems']        - an array of FeedItem instances
 326          */
 327         public function execute() {
 328                 $data = $this->getResultData();
 329                 if ( isset ( $data['_feed'] ) && isset ( $data['_feeditems'] ) ) {
 330                         $feed = $data['_feed'];
 331                         $items = $data['_feeditems'];
 332
 333                         $feed->outHeader();
 334                         foreach ( $items as & $item )
 335                                 $feed->outItem( $item );
 336                         $feed->outFooter();
 337                 } else {
 338                         // Error has occured, print something useful
 339                         ApiBase::dieDebug( __METHOD__, 'Invalid feed class/item' );
 340                 }
 341         }
 342
 343         public function getVersion() {
 344                 return __CLASS__ . ': $Id$';
 345         }
 346 }