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