includes/api/ApiFormatJson.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 19, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * API JSON output formatter
  29  * @ingroup API
  30  */
  31 class ApiFormatJson extends ApiFormatBase {
  32
  33         private $isRaw;
  34
  35         public function __construct( ApiMain $main, $format ) {
  36                 parent::__construct( $main, $format );
  37                 $this->isRaw = ( $format === 'rawfm' );
  38
  39                 if ( $this->getMain()->getCheck( 'callback' ) ) {
  40                         # T94015: jQuery appends a useless '_' parameter in jsonp mode.
  41                         # Mark the parameter as used in that case to avoid a warning that's
  42                         # outside the control of the end user.
  43                         # (and do it here because ApiMain::reportUnusedParams() gets called
  44                         # before our ::execute())
  45                         $this->getMain()->getCheck( '_' );
  46                 }
  47         }
  48
  49         public function getMimeType() {
  50                 $params = $this->extractRequestParams();
  51                 // callback:
  52                 if ( isset( $params['callback'] ) ) {
  53                         return 'text/javascript';
  54                 }
  55
  56                 return 'application/json';
  57         }
  58
  59         /**
  60          * @deprecated since 1.25
  61          */
  62         public function getNeedsRawData() {
  63                 return $this->isRaw;
  64         }
  65
  66         /**
  67          * @deprecated since 1.25
  68          */
  69         public function getWantsHelp() {
  70                 wfDeprecated( __METHOD__, '1.25' );
  71                 // Help is always ugly in JSON
  72                 return false;
  73         }
  74
  75         public function execute() {
  76                 $params = $this->extractRequestParams();
  77
  78                 $opt = 0;
  79                 if ( $this->isRaw ) {
  80                         $opt |= FormatJson::ALL_OK;
  81                         $transform = array();
  82                 } else {
  83                         switch ( $params['formatversion'] ) {
  84                                 case 1:
  85                                         $opt |= $params['utf8'] ? FormatJson::ALL_OK : FormatJson::XMLMETA_OK;
  86                                         $transform = array(
  87                                                 'BC' => array(),
  88                                                 'Types' => array( 'AssocAsObject' => true ),
  89                                                 'Strip' => 'all',
  90                                         );
  91                                         break;
  92
  93                                 case 2:
  94                                 case 'latest':
  95                                         $opt |= $params['ascii'] ? FormatJson::XMLMETA_OK : FormatJson::ALL_OK;
  96                                         $transform = array(
  97                                                 'Types' => array( 'AssocAsObject' => true ),
  98                                                 'Strip' => 'all',
  99                                         );
 100                                         break;
 101
 102                                 default:
 103                                         $this->dieUsage( __METHOD__ . ': Unknown value for \'formatversion\'', 'unknownformatversion' );
 104                         }
 105                 }
 106                 $data = $this->getResult()->getResultData( null, $transform );
 107                 $json = FormatJson::encode( $data, $this->getIsHtml(), $opt );
 108
 109                 // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
 110                 // Flash, but what it does isn't friendly for the API, so we need to
 111                 // work around it.
 112                 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
 113                         $json = preg_replace(
 114                                 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
 115                         );
 116                 }
 117
 118                 if ( isset( $params['callback'] ) ) {
 119                         $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
 120                         # Prepend a comment to try to avoid attacks against content
 121                         # sniffers, such as bug 68187.
 122                         $this->printText( "/**/$callback($json)" );
 123                 } else {
 124                         $this->printText( $json );
 125                 }
 126         }
 127
 128         public function getAllowedParams() {
 129                 if ( $this->isRaw ) {
 130                         return array();
 131                 }
 132
 133                 $ret = array(
 134                         'callback' => array(
 135                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback',
 136                         ),
 137                         'utf8' => array(
 138                                 ApiBase::PARAM_DFLT => false,
 139                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8',
 140                         ),
 141                         'ascii' => array(
 142                                 ApiBase::PARAM_DFLT => false,
 143                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-ascii',
 144                         ),
 145                         'formatversion' => array(
 146                                 ApiBase::PARAM_TYPE => array( 1, 2, 'latest' ),
 147                                 ApiBase::PARAM_DFLT => 1,
 148                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-formatversion',
 149                         ),
 150                 );
 151                 return $ret;
 152         }
 153 }