includes/api/ApiFormatWddx.php

   1 <?php
   2
   3 /**
   4  * Created on Oct 22, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright © 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  * API WDDX output formatter
  33  * @ingroup API
  34  */
  35 class ApiFormatWddx extends ApiFormatBase {
  36
  37         public function __construct( $main, $format ) {
  38                 parent::__construct( $main, $format );
  39         }
  40
  41         public function getMimeType() {
  42                 return 'text/xml';
  43         }
  44
  45         public function execute() {
  46                 // Some versions of PHP have a broken wddx_serialize_value, see
  47                 // PHP bug 45314. Test encoding an affected character (U+00A0)
  48                 // to avoid this.
  49                 $expected = "<wddxPacket version='1.0'><header/><data><string>\xc2\xa0</string></data></wddxPacket>";
  50                 if ( function_exists( 'wddx_serialize_value' )
  51                                 && !$this->getIsHtml()
  52                                 && wddx_serialize_value( "\xc2\xa0" ) == $expected ) {
  53                         $this->printText( wddx_serialize_value( $this->getResultData() ) );
  54                 } else {
  55                         // Don't do newlines and indentation if we weren't asked
  56                         // for pretty output
  57                         $nl = ( $this->getIsHtml() ? '' : "\n" );
  58                         $indstr = ' ';
  59                         $this->printText( "<?xml version=\"1.0\"?>$nl" );
  60                         $this->printText( "<wddxPacket version=\"1.0\">$nl" );
  61                         $this->printText( "$indstr<header/>$nl" );
  62                         $this->printText( "$indstr<data>$nl" );
  63                         $this->slowWddxPrinter( $this->getResultData(), 4 );
  64                         $this->printText( "$indstr</data>$nl" );
  65                         $this->printText( "</wddxPacket>$nl" );
  66                 }
  67         }
  68
  69         /**
  70          * Recursively go through the object and output its data in WDDX format.
  71          */
  72         function slowWddxPrinter( $elemValue, $indent = 0 ) {
  73                 $indstr = ( $this->getIsHtml() ? '' : str_repeat( ' ', $indent ) );
  74                 $indstr2 = ( $this->getIsHtml() ? '' : str_repeat( ' ', $indent + 2 ) );
  75                 $nl = ( $this->getIsHtml() ? '' : "\n" );
  76                 switch ( gettype( $elemValue ) ) {
  77                         case 'array':
  78                                 // Check whether we've got an associative array (<struct>)
  79                                 // or a regular array (<array>)
  80                                 $cnt = count( $elemValue );
  81                                 if ( $cnt == 0 || array_keys( $elemValue ) === range( 0, $cnt - 1 ) ) {
  82                                         // Regular array
  83                                         $this->printText( $indstr . Xml::element( 'array', array(
  84                                                 'length' => $cnt ), null ) . $nl );
  85                                         foreach ( $elemValue as $subElemValue ) {
  86                                                 $this->slowWddxPrinter( $subElemValue, $indent + 2 );
  87                                         }
  88                                         $this->printText( "$indstr</array>$nl" );
  89                                 } else {
  90                                         // Associative array (<struct>)
  91                                         $this->printText( "$indstr<struct>$nl" );
  92                                         foreach ( $elemValue as $subElemName => $subElemValue ) {
  93                                                 $this->printText( $indstr2 . Xml::element( 'var', array(
  94                                                         'name' => $subElemName
  95                                                 ), null ) . $nl );
  96                                                 $this->slowWddxPrinter( $subElemValue, $indent + 4 );
  97                                                 $this->printText( "$indstr2</var>$nl" );
  98                                         }
  99                                         $this->printText( "$indstr</struct>$nl" );
 100                                 }
 101                                 break;
 102                         case 'integer':
 103                         case 'double':
 104                                 $this->printText( $indstr . Xml::element( 'number', null, $elemValue ) . $nl );
 105                                 break;
 106                         case 'string':
 107                                 $this->printText( $indstr . Xml::element( 'string', null, $elemValue ) . $nl );
 108                                 break;
 109                         default:
 110                                 ApiBase::dieDebug( __METHOD__, 'Unknown type ' . gettype( $elemValue ) );
 111                 }
 112         }
 113
 114         public function getDescription() {
 115                 return 'Output data in WDDX format' . parent::getDescription();
 116         }
 117
 118         public function getVersion() {
 119                 return __CLASS__ . ': $Id$';
 120         }
 121 }