includes/api/ApiFormatJson.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 ('ApiFormatBase.php');
  29 }
  30
  31 /**
  32  * @ingroup API
  33  */
  34 class ApiFormatJson extends ApiFormatBase {
  35
  36         private $mIsRaw;
  37
  38         public function __construct($main, $format) {
  39                 parent :: __construct($main, $format);
  40                 $this->mIsRaw = ($format === 'rawfm');
  41         }
  42
  43         public function getMimeType() {
  44                 $params = $this->extractRequestParams();
  45                 //callback:
  46                 if( $params['callback']){
  47                         return 'text/javascript';
  48                 }
  49                 return 'application/json';
  50         }
  51
  52         public function getNeedsRawData() {
  53                 return $this->mIsRaw;
  54         }
  55
  56         public function getWantsHelp() {
  57                 // Help is always ugly in JSON
  58                 return false;
  59         }
  60
  61         public function execute() {
  62                 $prefix = $suffix = "";
  63
  64                 $params = $this->extractRequestParams();
  65                 $callback = $params['callback'];
  66                 if(!is_null($callback)) {
  67                         $prefix = preg_replace("/[^][.\\'\\\"_A-Za-z0-9]/", "", $callback ) . "(";
  68                         $suffix = ")";
  69                 }
  70
  71                 // Some versions of PHP have a broken json_encode, see PHP bug
  72                 // 46944. Test encoding an affected character (U+20000) to
  73                 // avoid this.
  74                 $this->printText( $prefix . $this->getJsonEncode($this->getResultData(),   $this->getIsHtml() )  . $suffix);
  75         }
  76         /*
  77          * static to support static calls to json output (instead of json_encode function)
  78          * @param array $results  the results array to output as a json string
  79          * @parm isHTML if the output is html
  80          */
  81         public static function getJsonEncode($value, $isHtml=false){
  82                 if (!function_exists('json_encode') || $isHtml || strtolower(json_encode("\xf0\xa0\x80\x80")) != '\ud840\udc00') {
  83                         $json = new Services_JSON();
  84                         return $json->encode($value, $isHtml) ;
  85                 } else {
  86                         return json_encode($value);
  87                 }
  88         }
  89
  90         public function getAllowedParams() {
  91                 return array (
  92                         'callback'  => null,
  93                 );
  94         }
  95
  96         public function getParamDescription() {
  97                 return array (
  98                         'callback' => 'If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.',
  99                 );
 100         }
 101
 102         public function getDescription() {
 103                 if ($this->mIsRaw)
 104                         return 'Output data with the debuging elements in JSON format' . parent :: getDescription();
 105                 else
 106                         return 'Output data in JSON format' . parent :: getDescription();
 107         }
 108
 109         public function getVersion() {
 110                 return __CLASS__ . ': $Id$';
 111         }
 112 }