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
  40         public function getMimeType() {
  41                 $params = $this->extractRequestParams();
  42                 // callback:
  43                 if ( isset( $params['callback'] ) ) {
  44                         return 'text/javascript';
  45                 }
  46
  47                 return 'application/json';
  48         }
  49
  50         /**
  51          * @deprecated since 1.25
  52          */
  53         public function getNeedsRawData() {
  54                 return $this->isRaw;
  55         }
  56
  57         /**
  58          * @deprecated since 1.25
  59          */
  60         public function getWantsHelp() {
  61                 wfDeprecated( __METHOD__, '1.25' );
  62                 // Help is always ugly in JSON
  63                 return false;
  64         }
  65
  66         public function execute() {
  67                 $params = $this->extractRequestParams();
  68
  69                 $opt = 0;
  70                 if ( $this->isRaw ) {
  71                         $opt |= FormatJson::ALL_OK;
  72                         $transform = array();
  73                 } else {
  74                         switch ( $params['formatversion'] ) {
  75                                 case 1:
  76                                         $opt |= $params['utf8'] ? FormatJson::ALL_OK : FormatJson::XMLMETA_OK;
  77                                         $transform = array(
  78                                                 'BC' => array(),
  79                                                 'Types' => array( 'AssocAsObject' => true ),
  80                                                 'Strip' => 'all',
  81                                         );
  82                                         break;
  83
  84                                 case 2:
  85                                 case 'latest':
  86                                         $opt |= $params['ascii'] ? FormatJson::XMLMETA_OK : FormatJson::ALL_OK;
  87                                         $transform = array(
  88                                                 'Types' => array( 'AssocAsObject' => true ),
  89                                                 'Strip' => 'all',
  90                                         );
  91                                         break;
  92
  93                                 default:
  94                                         $this->dieUsage( __METHOD__ . ': Unknown value for \'formatversion\'', 'unknownformatversion' );
  95                         }
  96                 }
  97                 $data = $this->getResult()->getResultData( null, $transform );
  98                 $json = FormatJson::encode( $data, $this->getIsHtml(), $opt );
  99
 100                 // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
 101                 // Flash, but what it does isn't friendly for the API, so we need to
 102                 // work around it.
 103                 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
 104                         $json = preg_replace(
 105                                 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
 106                         );
 107                 }
 108
 109                 if ( isset( $params['callback'] ) ) {
 110                         $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $params['callback'] );
 111                         # Prepend a comment to try to avoid attacks against content
 112                         # sniffers, such as bug 68187.
 113                         $this->printText( "/**/$callback($json)" );
 114                 } else {
 115                         $this->printText( $json );
 116                 }
 117         }
 118
 119         public function getAllowedParams() {
 120                 if ( $this->isRaw ) {
 121                         return array();
 122                 }
 123
 124                 $ret = array(
 125                         'callback' => array(
 126                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback',
 127                         ),
 128                         'utf8' => array(
 129                                 ApiBase::PARAM_DFLT => false,
 130                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8',
 131                         ),
 132                         'ascii' => array(
 133                                 ApiBase::PARAM_DFLT => false,
 134                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-ascii',
 135                         ),
 136                         'formatversion' => array(
 137                                 ApiBase::PARAM_TYPE => array( 1, 2, 'latest' ),
 138                                 ApiBase::PARAM_DFLT => 1,
 139                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-formatversion',
 140                         ),
 141                 );
 142                 return $ret;
 143         }
 144 }