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