src/Value.php

   1 <?php
   2
   3 namespace PhpXmlRpc;
   4
   5 use PhpXmlRpc\Helper\Charset;
   6
   7 /**
   8  * This class enables the creation of values for XML-RPC, by encapsulating plain php values.
   9  */
  10 class Value implements \Countable, \IteratorAggregate, \ArrayAccess
  11 {
  12     public static $xmlrpcI4 = "i4";
  13     public static $xmlrpcI8 = "i8";
  14     public static $xmlrpcInt = "int";
  15     public static $xmlrpcBoolean = "boolean";
  16     public static $xmlrpcDouble = "double";
  17     public static $xmlrpcString = "string";
  18     public static $xmlrpcDateTime = "dateTime.iso8601";
  19     public static $xmlrpcBase64 = "base64";
  20     public static $xmlrpcArray = "array";
  21     public static $xmlrpcStruct = "struct";
  22     public static $xmlrpcValue = "undefined";
  23     public static $xmlrpcNull = "null";
  24
  25     public static $xmlrpcTypes = array(
  26         "i4" => 1,
  27         "i8" => 1,
  28         "int" => 1,
  29         "boolean" => 1,
  30         "double" => 1,
  31         "string" => 1,
  32         "dateTime.iso8601" => 1,
  33         "base64" => 1,
  34         "array" => 2,
  35         "struct" => 3,
  36         "null" => 1,
  37     );
  38
  39     /// @todo: do these need to be public?
  40     public $me = array();
  41     public $mytype = 0;
  42     public $_php_class = null;
  43
  44     /**
  45      * Build an xmlrpc value.
  46      *
  47      * When no value or type is passed in, the value is left uninitialized, and the value can be added later.
  48      *
  49      * @param mixed $val if passing in an array, all array elements should be PhpXmlRpc\Value themselves
  50      * @param string $type any valid xmlrpc type name (lowercase): i4, int, boolean, string, double, dateTime.iso8601,
  51      *                     base64, array, struct, null.
  52      *                     If null, 'string' is assumed.
  53      *                     You should refer to http://www.xmlrpc.com/spec for more information on what each of these mean.
  54      */
  55     public function __construct($val = -1, $type = '')
  56     {
  57         // optimization creep - do not call addXX, do it all inline.
  58         // downside: booleans will not be coerced anymore
  59         if ($val !== -1 || $type != '') {
  60             switch ($type) {
  61                 case '':
  62                     $this->mytype = 1;
  63                     $this->me['string'] = $val;
  64                     break;
  65                 case 'i4':
  66                 case 'i8':
  67                 case 'int':
  68                 case 'double':
  69                 case 'string':
  70                 case 'boolean':
  71                 case 'dateTime.iso8601':
  72                 case 'base64':
  73                 case 'null':
  74                     $this->mytype = 1;
  75                     $this->me[$type] = $val;
  76                     break;
  77                 case 'array':
  78                     $this->mytype = 2;
  79                     $this->me['array'] = $val;
  80                     break;
  81                 case 'struct':
  82                     $this->mytype = 3;
  83                     $this->me['struct'] = $val;
  84                     break;
  85                 default:
  86                     error_log("XML-RPC: " . __METHOD__ . ": not a known type ($type)");
  87             }
  88         }
  89     }
  90
  91     /**
  92      * Add a single php value to an xmlrpc value.
  93      *
  94      * If the xmlrpc value is an array, the php value is added as its last element.
  95      * If the xmlrpc value is empty (uninitialized), this method makes it a scalar value, and sets that value.
  96      * Fails if the xmlrpc value is not an array and already initialized.
  97      *
  98      * @param mixed $val
  99      * @param string $type allowed values: i4, i8, int, boolean, string, double, dateTime.iso8601, base64, null.
 100      *
 101      * @return int 1 or 0 on failure
 102      */
 103     public function addScalar($val, $type = 'string')
 104     {
 105         $typeOf = null;
 106         if (isset(static::$xmlrpcTypes[$type])) {
 107             $typeOf = static::$xmlrpcTypes[$type];
 108         }
 109
 110         if ($typeOf !== 1) {
 111             error_log("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)");
 112             return 0;
 113         }
 114
 115         // coerce booleans into correct values
 116         // NB: we should either do it for datetimes, integers, i8 and doubles, too,
 117         // or just plain remove this check, implemented on booleans only...
 118         if ($type == static::$xmlrpcBoolean) {
 119             if (strcasecmp($val, 'true') == 0 || $val == 1 || ($val == true && strcasecmp($val, 'false'))) {
 120                 $val = true;
 121             } else {
 122                 $val = false;
 123             }
 124         }
 125
 126         switch ($this->mytype) {
 127             case 1:
 128                 error_log('XML-RPC: ' . __METHOD__ . ': scalar xmlrpc value can have only one value');
 129                 return 0;
 130             case 3:
 131                 error_log('XML-RPC: ' . __METHOD__ . ': cannot add anonymous scalar to struct xmlrpc value');
 132                 return 0;
 133             case 2:
 134                 // we're adding a scalar value to an array here
 135                 $this->me['array'][] = new Value($val, $type);
 136
 137                 return 1;
 138             default:
 139                 // a scalar, so set the value and remember we're scalar
 140                 $this->me[$type] = $val;
 141                 $this->mytype = $typeOf;
 142
 143                 return 1;
 144         }
 145     }
 146
 147     /**
 148      * Add an array of xmlrpc value objects to an xmlrpc value.
 149      *
 150      * If the xmlrpc value is an array, the elements are appended to the existing ones.
 151      * If the xmlrpc value is empty (uninitialized), this method makes it an array value, and sets that value.
 152      * Fails otherwise.
 153      *
 154      * @param Value[] $values
 155      *
 156      * @return int 1 or 0 on failure
 157      *
 158      * @todo add some checking for $values to be an array of xmlrpc values?
 159      */
 160     public function addArray($values)
 161     {
 162         if ($this->mytype == 0) {
 163             $this->mytype = static::$xmlrpcTypes['array'];
 164             $this->me['array'] = $values;
 165
 166             return 1;
 167         } elseif ($this->mytype == 2) {
 168             // we're adding to an array here
 169             $this->me['array'] = array_merge($this->me['array'], $values);
 170
 171             return 1;
 172         } else {
 173             error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
 174             return 0;
 175         }
 176     }
 177
 178     /**
 179      * Merges an array of named xmlrpc value objects into an xmlrpc value.
 180      *
 181      * If the xmlrpc value is a struct, the elements are merged with the existing ones (overwriting existing ones).
 182      * If the xmlrpc value is empty (uninitialized), this method makes it a struct value, and sets that value.
 183      * Fails otherwise.
 184      *
 185      * @param Value[] $values
 186      *
 187      * @return int 1 or 0 on failure
 188      *
 189      * @todo add some checking for $values to be an array?
 190      */
 191     public function addStruct($values)
 192     {
 193         if ($this->mytype == 0) {
 194             $this->mytype = static::$xmlrpcTypes['struct'];
 195             $this->me['struct'] = $values;
 196
 197             return 1;
 198         } elseif ($this->mytype == 3) {
 199             // we're adding to a struct here
 200             $this->me['struct'] = array_merge($this->me['struct'], $values);
 201
 202             return 1;
 203         } else {
 204             error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
 205             return 0;
 206         }
 207     }
 208
 209     /**
 210      * Returns a string containing either "struct", "array", "scalar" or "undef", describing the base type of the value.
 211      *
 212      * @return string
 213      */
 214     public function kindOf()
 215     {
 216         switch ($this->mytype) {
 217             case 3:
 218                 return 'struct';
 219                 break;
 220             case 2:
 221                 return 'array';
 222                 break;
 223             case 1:
 224                 return 'scalar';
 225                 break;
 226             default:
 227                 return 'undef';
 228         }
 229     }
 230
 231     protected function serializedata($typ, $val, $charsetEncoding = '')
 232     {
 233         $rs = '';
 234
 235         if (!isset(static::$xmlrpcTypes[$typ])) {
 236             return $rs;
 237         }
 238
 239         switch (static::$xmlrpcTypes[$typ]) {
 240             case 1:
 241                 switch ($typ) {
 242                     case static::$xmlrpcBase64:
 243                         $rs .= "<${typ}>" . base64_encode($val) . "</${typ}>";
 244                         break;
 245                     case static::$xmlrpcBoolean:
 246                         $rs .= "<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
 247                         break;
 248                     case static::$xmlrpcString:
 249                         // G. Giunta 2005/2/13: do NOT use htmlentities, since
 250                         // it will produce named html entities, which are invalid xml
 251                         $rs .= "<${typ}>" . Charset::instance()->encodeEntities($val, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</${typ}>";
 252                         break;
 253                     case static::$xmlrpcInt:
 254                     case static::$xmlrpcI4:
 255                     case static::$xmlrpcI8:
 256                         $rs .= "<${typ}>" . (int)$val . "</${typ}>";
 257                         break;
 258                     case static::$xmlrpcDouble:
 259                         // avoid using standard conversion of float to string because it is locale-dependent,
 260                         // and also because the xmlrpc spec forbids exponential notation.
 261                         // sprintf('%F') could be most likely ok but it fails eg. on 2e-14.
 262                         // The code below tries its best at keeping max precision while avoiding exp notation,
 263                         // but there is of course no limit in the number of decimal places to be used...
 264                         $rs .= "<${typ}>" . preg_replace('/\\.?0+$/', '', number_format((double)$val, 128, '.', '')) . "</${typ}>";
 265                         break;
 266                     case static::$xmlrpcDateTime:
 267                         if (is_string($val)) {
 268                             $rs .= "<${typ}>${val}</${typ}>";
 269                         } elseif (is_a($val, 'DateTime')) {
 270                             $rs .= "<${typ}>" . $val->format('Ymd\TH:i:s') . "</${typ}>";
 271                         } elseif (is_int($val)) {
 272                             $rs .= "<${typ}>" . strftime("%Y%m%dT%H:%M:%S", $val) . "</${typ}>";
 273                         } else {
 274                             // not really a good idea here: but what shall we output anyway? left for backward compat...
 275                             $rs .= "<${typ}>${val}</${typ}>";
 276                         }
 277                         break;
 278                     case static::$xmlrpcNull:
 279                         if (PhpXmlRpc::$xmlrpc_null_apache_encoding) {
 280                             $rs .= "<ex:nil/>";
 281                         } else {
 282                             $rs .= "<nil/>";
 283                         }
 284                         break;
 285                     default:
 286                         // no standard type value should arrive here, but provide a possibility
 287                         // for xmlrpc values of unknown type...
 288                         $rs .= "<${typ}>${val}</${typ}>";
 289                 }
 290                 break;
 291             case 3:
 292                 // struct
 293                 if ($this->_php_class) {
 294                     $rs .= '<struct php_class="' . $this->_php_class . "\">\n";
 295                 } else {
 296                     $rs .= "<struct>\n";
 297                 }
 298                 $charsetEncoder = Charset::instance();
 299                 /** @var Value $val2 */
 300                 foreach ($val as $key2 => $val2) {
 301                     $rs .= '<member><name>' . $charsetEncoder->encodeEntities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</name>\n";
 302                     //$rs.=$this->serializeval($val2);
 303                     $rs .= $val2->serialize($charsetEncoding);
 304                     $rs .= "</member>\n";
 305                 }
 306                 $rs .= '</struct>';
 307                 break;
 308             case 2:
 309                 // array
 310                 $rs .= "<array>\n<data>\n";
 311                 /** @var Value $element */
 312                 foreach ($val as $element) {
 313                     //$rs.=$this->serializeval($val[$i]);
 314                     $rs .= $element->serialize($charsetEncoding);
 315                 }
 316                 $rs .= "</data>\n</array>";
 317                 break;
 318             default:
 319                 break;
 320         }
 321
 322         return $rs;
 323     }
 324
 325     /**
 326      * Returns the xml representation of the value. XML prologue not included.
 327      *
 328      * @param string $charsetEncoding the charset to be used for serialization. if null, US-ASCII is assumed
 329      *
 330      * @return string
 331      */
 332     public function serialize($charsetEncoding = '')
 333     {
 334         $val = reset($this->me);
 335         $typ = key($this->me);
 336
 337         return '<value>' . $this->serializedata($typ, $val, $charsetEncoding) . "</value>\n";
 338     }
 339
 340     /**
 341      * Checks whether a struct member with a given name is present.
 342      *
 343      * Works only on xmlrpc values of type struct.
 344      *
 345      * @param string $key the name of the struct member to be looked up
 346      *
 347      * @return boolean
 348      *
 349      * @deprecated use array access, e.g. isset($val[$key])
 350      */
 351     public function structmemexists($key)
 352     {
 353         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 354
 355         return array_key_exists($key, $this->me['struct']);
 356     }
 357
 358     /**
 359      * Returns the value of a given struct member (an xmlrpc value object in itself).
 360      * Will raise a php warning if struct member of given name does not exist.
 361      *
 362      * @param string $key the name of the struct member to be looked up
 363      *
 364      * @return Value
 365      *
 366      * @deprecated use array access, e.g. $val[$key]
 367      */
 368     public function structmem($key)
 369     {
 370         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 371
 372         return $this->me['struct'][$key];
 373     }
 374
 375     /**
 376      * Reset internal pointer for xmlrpc values of type struct.
 377      * @deprecated iterate directly over the object using foreach instead
 378      */
 379     public function structreset()
 380     {
 381         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 382
 383         reset($this->me['struct']);
 384     }
 385
 386     /**
 387      * Return next member element for xmlrpc values of type struct.
 388      *
 389      * @return Value
 390      *
 391      * @deprecated iterate directly over the object using foreach instead
 392      */
 393     public function structeach()
 394     {
 395         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 396
 397         return @each($this->me['struct']);
 398     }
 399
 400     /**
 401      * Returns the value of a scalar xmlrpc value (base 64 decoding is automatically handled here)
 402      *
 403      * @return mixed
 404      */
 405     public function scalarval()
 406     {
 407         $b = reset($this->me);
 408
 409         return $b;
 410     }
 411
 412     /**
 413      * Returns the type of the xmlrpc value.
 414      *
 415      * For integers, 'int' is always returned in place of 'i4'. 'i8' is considered a separate type and returned as such
 416      *
 417      * @return string
 418      */
 419     public function scalartyp()
 420     {
 421         reset($this->me);
 422         $a = key($this->me);
 423         if ($a == static::$xmlrpcI4) {
 424             $a = static::$xmlrpcInt;
 425         }
 426
 427         return $a;
 428     }
 429
 430     /**
 431      * Returns the m-th member of an xmlrpc value of array type.
 432      *
 433      * @param integer $key the index of the value to be retrieved (zero based)
 434      *
 435      * @return Value
 436      *
 437      * @deprecated use array access, e.g. $val[$key]
 438      */
 439     public function arraymem($key)
 440     {
 441         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 442
 443         return $this->me['array'][$key];
 444     }
 445
 446     /**
 447      * Returns the number of members in an xmlrpc value of array type.
 448      *
 449      * @return integer
 450      *
 451      * @deprecated use count() instead
 452      */
 453     public function arraysize()
 454     {
 455         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 456
 457         return count($this->me['array']);
 458     }
 459
 460     /**
 461      * Returns the number of members in an xmlrpc value of struct type.
 462      *
 463      * @return integer
 464      *
 465      * @deprecated use count() instead
 466      */
 467     public function structsize()
 468     {
 469         //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
 470
 471         return count($this->me['struct']);
 472     }
 473
 474     /**
 475      * Returns the number of members in an xmlrpc value:
 476      * - 0 for uninitialized values
 477      * - 1 for scalar values
 478      * - the number of elements for struct and array values
 479      *
 480      * @return integer
 481      */
 482     public function count()
 483     {
 484         switch ($this->mytype) {
 485             case 3:
 486                 return count($this->me['struct']);
 487             case 2:
 488                 return count($this->me['array']);
 489             case 1:
 490                 return 1;
 491             default:
 492                 return 0;
 493         }
 494     }
 495
 496     /**
 497      * Implements the IteratorAggregate interface
 498      *
 499      * @return \ArrayIterator
 500      */
 501     public function getIterator() {
 502         switch ($this->mytype) {
 503             case 3:
 504                 return new \ArrayIterator($this->me['struct']);
 505             case 2:
 506                 return new \ArrayIterator($this->me['array']);
 507             case 1:
 508                 return new \ArrayIterator($this->me);
 509             default:
 510                 return new \ArrayIterator();
 511         }
 512     }
 513
 514     public function offsetSet($offset, $value) {
 515
 516         switch ($this->mytype) {
 517             case 3:
 518                 if (!($value instanceof \PhpXmlRpc\Value)) {
 519                     throw new \Exception('It is only possible to add Value objects to an XML-RPC Struct');
 520                 }
 521                 if (is_null($offset)) {
 522                     // disallow struct members with empty names
 523                     throw new \Exception('It is not possible to add anonymous members to an XML-RPC Struct');
 524                 } else {
 525                     $this->me['struct'][$offset] = $value;
 526                 }
 527                 return;
 528             case 2:
 529                 if (!($value instanceof \PhpXmlRpc\Value)) {
 530                     throw new \Exception('It is only possible to add Value objects to an XML-RPC Array');
 531                 }
 532                 if (is_null($offset)) {
 533                     $this->me['array'][] = $value;
 534                 } else {
 535                     // nb: we are not checking that $offset is above the existing array range...
 536                     $this->me['array'][$offset] = $value;
 537                 }
 538                 return;
 539             case 1:
 540 // todo: handle i4 vs int
 541                 reset($this->me);
 542                 $type = key($this->me);
 543                 if ($type != $offset) {
 544                     throw new \Exception('');
 545                 }
 546                 $this->me[$type] = $value;
 547                 return;
 548             default:
 549                 // it would be nice to allow empty values to be be turned into non-empty ones this way, but we miss info to do so
 550                 throw new \Exception("XML-RPC Value is of type 'undef' and its value can not be set using array index");
 551         }
 552     }
 553
 554     public function offsetExists($offset) {
 555         switch ($this->mytype) {
 556             case 3:
 557                 return isset($this->me['struct'][$offset]);
 558             case 2:
 559                 return isset($this->me['array'][$offset]);
 560             case 1:
 561 // todo: handle i4 vs int
 562                 return $offset == $this->scalartyp();
 563             default:
 564                 return false;
 565         }
 566     }
 567
 568     public function offsetUnset($offset) {
 569         switch ($this->mytype) {
 570             case 3:
 571                 unset($this->me['struct'][$offset]);
 572                 return;
 573             case 2:
 574                 unset($this->me['array'][$offset]);
 575                 return;
 576             case 1:
 577                 // can not remove value from a scalar
 578                 throw new \Exception("XML-RPC Value is of type 'scalar' and its value can not be unset using array index");
 579             default:
 580                 throw new \Exception("XML-RPC Value is of type 'undef' and its value can not be unset using array index");
 581         }
 582     }
 583
 584     public function offsetGet($offset) {
 585         switch ($this->mytype) {
 586             case 3:
 587                 return isset($this->me['struct'][$offset]) ? $this->me['struct'][$offset] : null;
 588             case 2:
 589                 return isset($this->me['array'][$offset]) ? $this->me['array'][$offset] : null;
 590             case 1:
 591 // on bad type: null or exception?
 592                 $value = reset($this->me);
 593                 $type = key($this->me);
 594                 return $type == $offset ? $value : null;
 595             default:
 596 // return null or exception?
 597                 throw new \Exception("XML-RPC Value is of type 'undef' and can not be accessed using array index");
 598         }
 599     }
 600 }