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 $mIsRaw;
  34
  35         public function __construct( ApiMain $main, $format ) {
  36                 parent::__construct( $main, $format );
  37                 $this->mIsRaw = ( $format === 'rawfm' );
  38         }
  39
  40         public function getMimeType() {
  41                 $params = $this->extractRequestParams();
  42                 // callback:
  43                 if ( $params['callback'] ) {
  44                         return 'text/javascript';
  45                 }
  46
  47                 return 'application/json';
  48         }
  49
  50         public function getNeedsRawData() {
  51                 return $this->mIsRaw;
  52         }
  53
  54         /**
  55          * @deprecated since 1.25
  56          */
  57         public function getWantsHelp() {
  58                 wfDeprecated( __METHOD__, '1.25' );
  59                 // Help is always ugly in JSON
  60                 return false;
  61         }
  62
  63         public function execute() {
  64                 $params = $this->extractRequestParams();
  65                 $json = FormatJson::encode(
  66                         $this->getResultData(),
  67                         $this->getIsHtml(),
  68                         $params['utf8'] ? FormatJson::ALL_OK : FormatJson::XMLMETA_OK
  69                 );
  70
  71                 // Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
  72                 // Flash, but what it does isn't friendly for the API, so we need to
  73                 // work around it.
  74                 if ( preg_match( '/\<\s*cross-domain-policy\s*\>/i', $json ) ) {
  75                         $json = preg_replace(
  76                                 '/\<(\s*cross-domain-policy\s*)\>/i', '\\u003C$1\\u003E', $json
  77                         );
  78                 }
  79
  80                 $callback = $params['callback'];
  81                 if ( $callback !== null ) {
  82                         $callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $callback );
  83                         # Prepend a comment to try to avoid attacks against content
  84                         # sniffers, such as bug 68187.
  85                         $this->printText( "/**/$callback($json)" );
  86                 } else {
  87                         $this->printText( $json );
  88                 }
  89         }
  90
  91         public function getAllowedParams() {
  92                 return array(
  93                         'callback' => array(
  94                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-callback',
  95                         ),
  96                         'utf8' => array(
  97                                 ApiBase::PARAM_DFLT => false,
  98                                 ApiBase::PARAM_HELP_MSG => 'apihelp-json-param-utf8',
  99                         ),
 100                 );
 101         }
 102 }