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