/usr/share/php/Horde/ActiveSync/Wbxml/Decoder.php is in php-horde-activesync 2.19.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 | <?php
/**
* Horde_ActiveSync_Wbxml_Decoder::
*
* Portions of this class were ported from the Z-Push project:
* File : wbxml.php
* Project : Z-Push
* Descr : WBXML mapping file
*
* Created : 01.10.2007
*
* © Zarafa Deutschland GmbH, www.zarafaserver.de
* This file is distributed under GPL-2.0.
* Consult COPYING file for details
*
* @license http://www.horde.org/licenses/gpl GPLv2
* NOTE: According to sec. 8 of the GENERAL PUBLIC LICENSE (GPL),
* Version 2, the distribution of the Horde_ActiveSync module in or
* to the United States of America is excluded from the scope of this
* license.
* @copyright 2009-2014 Horde LLC (http://www.horde.org)
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*/
/**
* ActiveSync specific WBXML decoder.
*
* @license http://www.horde.org/licenses/gpl GPLv2
* NOTE: According to sec. 8 of the GENERAL PUBLIC LICENSE (GPL),
* Version 2, the distribution of the Horde_ActiveSync module in or
* to the United States of America is excluded from the scope of this
* license.
* @copyright 2009-2014 Horde LLC (http://www.horde.org)
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*/
class Horde_ActiveSync_Wbxml_Decoder extends Horde_ActiveSync_Wbxml
{
/**
* Store the wbxml version value. Used to verify we have a valid wbxml
* input stream.
*
* @todo H6 Make this (and most of the other) properties protected.
*
* @var integer
*/
public $version;
public $publicid;
public $publicstringid;
public $charsetid;
public $stringtable;
/**
* Temporary string buffer
*
* @var stream
*/
protected $_buffer;
/**
* Flag to indicate we have a valid wbxml input stream
*
* @var boolean
*/
protected $_isWbxml;
protected $_attrcp = 0;
protected $_ungetbuffer;
protected $_readHeader = false;
/**
* Cache the last successfully fetched start tag array. Used to be able
* to easily detected emtpy nodes after the element was already fetched.
*
* @var array
*/
protected $_lastStartElement;
/**
* Start reading the wbxml stream, pulling off the initial header and
* populate the properties.
*/
public function readWbxmlHeader()
{
$this->_readHeader = true;
$this->_readVersion();
if ($this->version != self::WBXML_VERSION) {
// Not Wbxml - save the byte we already read.
$this->_getTempStream();
$this->_buffer->add(chr($this->version));
$this->_isWbxml = false;
return;
} else {
$this->_isWbxml = true;
}
$this->publicid = $this->_getMBUInt();
if ($this->publicid == 0) {
$this->publicstringid = $this->_getMBUInt();
}
$this->charsetid = $this->_getMBUInt();
$this->stringtable = $this->_getStringTable();
}
/**
* Check that the input stream contains wbxml. Basically looks for a valid
* WBXML_VERSION header. self::readWbxmlHeader MUST have been called already.
*
* @return boolean
*/
public function isWbxml()
{
if (!$this->_readHeader) {
throw new Horde_ActiveSync_Exception('Failed to read WBXML header prior to calling isWbxml()');
}
return $this->_isWbxml;
}
/**
* Return the full, raw, input stream. Used for things like SendMail request
* where we don't have wbxml to parse. The calling code is responsible for
* closing the stream.
*
* @return resource
*/
public function getFullInputStream()
{
// Ensure the buffer was created
$this->_getTempStream();
$this->_buffer->add($this->_stream);
$this->_buffer->rewind();
return $this->_buffer->stream;
}
/**
* Returns either start, content or end, and auto-concatenates successive
* content.
*
* @return array|boolean The element structure or false on failure.
*/
public function getElement()
{
$element = $this->getToken();
switch ($element[self::EN_TYPE]) {
case self::EN_TYPE_STARTTAG:
return $element;
case self::EN_TYPE_ENDTAG:
return $element;
case self::EN_TYPE_CONTENT:
while (1) {
$next = $this->getToken();
if ($next == false) {
return false;
} elseif ($next[self::EN_TYPE] == self::EN_CONTENT) {
$element[self::EN_CONTENT] .= $next[self::EN_CONTENT];
} else {
$this->_ungetElement($next);
break;
}
}
return $element;
}
return false;
}
/**
* Returns whether or not the passed in element array represents an
* empty tag.
*
* @param array $el The element array.
*
* @return boolean True if $el is an empty start tag, otherwise false.
*/
public function isEmptyElement($el)
{
if (!is_array($el)) {
return false;
}
switch ($el[self::EN_TYPE]) {
case self::EN_TYPE_STARTTAG:
return !($el[self::EN_FLAGS] & self::EN_FLAGS_CONTENT);
default:
// Not applicable.
return false;
}
}
/**
* Returns the last element array fetched using getElementStartTag()
*
* @return array|boolean The element array, or false if none available.
*/
public function getLastStartElement()
{
return $this->_lastStartElement;
}
/**
* Peek at the next element in the stream.
*
* @return array The next element in the stream.
*/
public function peek()
{
$element = $this->getElement();
$this->_ungetElement($element);
return $element;
}
/**
* Get the next tag, which is assumed to be a start tag.
*
* @param string $tag The element that this should be a start tag for.
*
* @return array|boolean The start tag array | false on failure.
*/
public function getElementStartTag($tag)
{
$element = $this->getToken();
if ($element[self::EN_TYPE] == self::EN_TYPE_STARTTAG &&
$element[self::EN_TAG] == $tag) {
$this->_lastStartElement = $element;
return $element;
} else {
$this->_lastStartElement = false;
$this->_ungetElement($element);
}
return false;
}
/**
* Get the next tag, which is assumed to be an end tag.
*
* @return array|boolean The element array | false on failure.
*/
public function getElementEndTag()
{
$element = $this->getToken();
if ($element[self::EN_TYPE] == self::EN_TYPE_ENDTAG) {
return $element;
} else {
$this->_logger->err(sprintf(
'[%s] Unmatched end tag:',
$this->_procid));
$this->_logger->err(print_r($element, true));
$this->_ungetElement($element);
}
return false;
}
/**
* Get the element contents
*
* @return mixed The content of the current element | false on failure.
*/
public function getElementContent()
{
$element = $this->getToken();
if ($element[self::EN_TYPE] == self::EN_TYPE_CONTENT) {
return $element[self::EN_CONTENT];
}
$this->_ungetElement($element);
return false;
}
/**
* Get the next [start | content | end] tag.
*
* @return array The next, complete, token array.
*/
public function getToken()
{
// See if there's something in the ungetBuffer
if ($this->_ungetbuffer) {
$element = $this->_ungetbuffer;
$this->_ungetbuffer = false;
return $element;
}
$el = $this->_getToken();
$this->_logToken($el);
return $el;
}
/**
* Log the token.
*
* @param array The element array.
*
* @return void
*/
protected function _logToken($el)
{
switch ($el[self::EN_TYPE]) {
case self::EN_TYPE_STARTTAG:
if ($el[self::EN_FLAGS] & self::EN_FLAGS_CONTENT) {
$spaces = str_repeat(' ', count($this->_logStack));
$this->_logStack[] = $el[self::EN_TAG];
$this->_logger->debug(sprintf(
'[%s] I %s <%s>',
$this->_procid,
$spaces,
$el[self::EN_TAG]));
} else {
$spaces = str_repeat(' ', count($this->_logStack));
$this->_logger->debug(sprintf(
'[%s] I %s <%s />',
$this->_procid,
$spaces,
$el[self::EN_TAG]));
}
break;
case self::EN_TYPE_ENDTAG:
$tag = array_pop($this->_logStack);
$spaces = str_repeat(' ', count($this->_logStack));
$this->_logger->debug(sprintf(
'[%s] I %s </%s>',
$this->_procid,
$spaces,
$tag));
break;
case self::EN_TYPE_CONTENT:
$spaces = str_repeat(' ', count($this->_logStack) + 1);
if ($this->_logLevel == self::LOG_PROTOCOL &&
($l = Horde_String::length($el[self::EN_CONTENT])) > self::LOG_MAXCONTENT) {
$this->_logger->debug(sprintf(
'[%s] I %s %s',
$this->_procid,
$spaces,
sprintf('[%d bytes of content]', $l)
));
} else {
$this->_logger->debug(sprintf(
'[%s] I %s %s',
$this->_procid,
$spaces,
$el[self::EN_CONTENT])
);
}
break;
}
}
/**
* Get the next start tag, content or end tag
*
* @return array The element array.
*/
protected function _getToken() {
// Get the data from the input stream
$element = array();
while (1) {
$byte = $this->_getByte();
if (!isset($byte)) {
break;
}
switch ($byte) {
case self::SWITCH_PAGE:
$this->_tagcp = $this->_getByte();
continue;
case self::END:
$element[self::EN_TYPE] = self::EN_TYPE_ENDTAG;
return $element;
case self::ENTITY:
$entity = $this->_getMBUInt();
$element[self::EN_TYPE] = self::EN_TYPE_CONTENT;
$element[self::EN_CONTENT] = $this->entityToCharset($entity);
return $element;
case self::STR_I:
$element[self::EN_TYPE] = self::EN_TYPE_CONTENT;
$element[self::EN_CONTENT] = $this->_getTermStr();
return $element;
case self::LITERAL:
$element[self::EN_TYPE] = self::EN_TYPE_STARTTAG;
$element[self::EN_TAG] = $this->_getStringTableEntry($this->_getMBUInt());
$element[self::EN_FLAGS] = 0;
return $element;
case self::EXT_I_0:
case self::EXT_I_1:
case self::EXT_I_2:
$this->_getTermStr();
// Ignore extensions
continue;
case self::PI:
// Ignore PI
$this->_getAttributes();
continue;
case self::LITERAL_C:
$element[self::EN_TYPE] = self::EN_TYPE_STARTTAG;
$element[self::EN_TAG] = $this->_getStringTableEntry($this->_getMBUInt());
$element[self::EN_FLAGS] = self::EN_FLAGS_CONTENT;
return $element;
case self::EXT_T_0:
case self::EXT_T_1:
case self::EXT_T_2:
$this->_getMBUInt();
// Ingore extensions;
continue;
case self::STR_T:
$element[self::EN_TYPE] = self::EN_TYPE_CONTENT;
$element[self::EN_CONTENT] = $this->_getStringTableEntry($this->_getMBUInt());
return $element;
case self::LITERAL_A:
$element[self::EN_TYPE] = self::EN_TYPE_STARTTAG;
$element[self::EN_TAG] = $this->_getStringTableEntry($this->_getMBUInt());
$element[self::EN_ATTRIBUTES] = $this->_getAttributes();
$element[self::EN_FLAGS] = self::EN_FLAGS_ATTRIBUTES;
return $element;
case self::EXT_0:
case self::EXT_1:
case self::EXT_2:
continue;
case self::OPAQUE:
$length = $this->_getMBUInt();
$element[self::EN_TYPE] = self::EN_TYPE_CONTENT;
$element[self::EN_CONTENT] = $this->_getOpaque($length);
return $element;
case self::LITERAL_AC:
$element[self::EN_TYPE] = self::EN_TYPE_STARTTAG;
$element[self::EN_TAG] = $this->_getStringTableEntry($this->_getMBUInt());
$element[self::EN_ATTRIBUTES] = $this->_getAttributes();
$element[self::EN_FLAGS] = self::EN_FLAGS_ATTRIBUTES | self::EN_FLAGS_CONTENT;
return $element;
default:
$element[self::EN_TYPE] = self::EN_TYPE_STARTTAG;
$element[self::EN_TAG] = $this->_getMapping($this->_tagcp, $byte & 0x3f);
$element[self::EN_FLAGS] = ($byte & 0x80 ? self::EN_FLAGS_ATTRIBUTES : 0) | ($byte & 0x40 ? self::EN_FLAGS_CONTENT : 0);
if ($byte & 0x80) {
$element[self::EN_ATTRIBUTES] = $this->_getAttributes();
}
return $element;
}
}
}
/**
* Unget the specified element from the stream. Places the element into
* the unget buffer.
*
* @param array $element The element array to unget.
*
* @return void
*/
public function _ungetElement($element)
{
if ($this->_ungetbuffer) {
$this->_logger->err('Double unget!');
}
$this->_ungetbuffer = $element;
}
/**
* Read the Wbxml version header byte, and buffer the input incase we
* need the full stream later.
*/
protected function _readVersion()
{
$b = $this->_getByte();
if ($b != NULL) {
$this->version = $b;
}
}
/**
* Get the element attributes
*
* @return mixed The value of the element's attributes.
*/
protected function _getAttributes()
{
$attributes = array();
$attr = '';
while (1) {
$byte = $this->_getByte();
if (count($byte) == 0) {
break;
}
switch($byte) {
case self::SWITCH_PAGE:
$this->_attrcp = $this->_getByte();
break;
case self::END:
if ($attr != '') {
$attributes += $this->_splitAttribute($attr);
}
return $attributes;
case self::ENTITY:
$entity = $this->_getMBUInt();
$attr .= $this->entityToCharset($entity);
return $element;
case self::STR_I:
$attr .= $this->_getTermStr();
return $element;
case self::LITERAL:
if ($attr != '') {
$attributes += $this->_splitAttribute($attr);
}
$attr = $this->_getStringTableEntry($this->_getMBUInt());
return $element;
case self::EXT_I_0:
case self::EXT_I_1:
case self::EXT_I_2:
$this->_getTermStr();
continue;
case self::PI:
case self::LITERAL_C:
// Invalid
return false;
case self::EXT_T_0:
case self::EXT_T_1:
case self::EXT_T_2:
$this->_getMBUInt();
continue;
case self::STR_T:
$attr .= $this->_getStringTableEntry($this->_getMBUInt());
return $element;
case self::LITERAL_A:
return false;
case self::EXT_0:
case self::EXT_1:
case self::EXT_2:
continue;
case self::OPAQUE:
$length = $this->_getMBUInt();
$attr .= $this->_getOpaque($length);
return $element;
case self::LITERAL_AC:
return false;
default:
if ($byte < 128) {
if ($attr != '') {
$attributes += $this->_splitAttribute($attr);
$attr = '';
}
}
$attr .= $this->_getMapping($this->_attrcp, $byte);
break;
}
}
}
/**
* Parses an attribute string
*
* @param string $attr The raw attribute value.
*
* @return array The attribute hash
*/
protected function _splitAttribute($attr)
{
$attributes = array();
$pos = strpos($attr,chr(61)); // equals sign
if ($pos) {
$attributes[substr($attr, 0, $pos)] = substr($attr, $pos+1);
} else {
$attributes[$attr] = null;
}
return $attributes;
}
/**
* Get a null terminated string from the stream.
*
* @return string The string
*/
protected function _getTermStr()
{
$str = '';
while(1) {
$in = $this->_getByte();
if ($in == 0) {
break;
} else {
$str .= chr($in);
}
}
return $str;
}
/**
* Get an opaque value from the stream of the specified length.
*
* @param integer $len The length of the data to fetch.
*
* @return string A string of bytes representing the opaque value.
*/
protected function _getOpaque($len)
{
// See http://php.net/fread for why we can't simply use a single fread()
// here. Bottom line, for buffered network streams it may be possible
// that fread will only return a portion of the stream if chunk
// is smaller then $len, so we use a loop to reach $len.
$d = '';
while (1) {
$l = (($len - strlen($d)) > 8192) ? 8192 : ($len - strlen($d));
if ($l > 0) {
$data = $this->_stream->substring(0, $l);
// Stream ends prematurely on instable connections and big mails
if ($data === false || $this->_stream->eof()) {
throw new Horde_ActiveSync_Exception(sprintf(
'Connection unavailable while trying to read %d bytes from stream. Aborting after %d bytes read.',
$len,
strlen($d)));
} else {
$d .= $data;
}
}
if (strlen($d) >= $len) {
break;
}
}
return $d;
}
/**
* Fetch a single byte from the stream.
*
* @return string The single byte.
*/
protected function _getByte()
{
$ch = $this->_stream->getChar();
if (strlen($ch) > 0) {
$ch = ord($ch);
return $ch;
} else {
return;
}
}
/**
* Get an MBU integer
*
* @return integer
*/
protected function _getMBUInt()
{
$uint = 0;
while (1) {
$byte = $this->_getByte();
$uint |= $byte & 0x7f;
if ($byte & 0x80) {
$uint = $uint << 7;
} else {
break;
}
}
return $uint;
}
/**
* Fetch the string table. Don't think we use the results anywhere though.
*
* @return string The string table.
*/
protected function _getStringTable()
{
$stringtable = '';
$length = $this->_getMBUInt();
if ($length > 0) {
$stringtable = $this->_stream->substring(0, $length);
}
return $stringtable;
}
/**
* Really don't know for sure what this method is supposed to do, it is
* called from numerous places in this class, but the original zpush code
* did not contain this method...so, either it's completely broken, or
* normal use-cases do not reach the calling code. Either way, it needs to
* eventually be fixed.
*
* @param integer $id The entry to return??
*
* @return string
*/
protected function _getStringTableEntry($id)
{
throw new Horde_ActiveSync_Exception('Not implemented');
}
/**
* Get a dtd mapping
*
* @param integer $cp The codepage to use.
* @param integer $id The property.
*
* @return mixed The mapped value.
*/
protected function _getMapping($cp, $id)
{
if (!isset($this->_dtd['codes'][$cp]) || !isset($this->_dtd['codes'][$cp][$id])) {
return false;
} else {
if (isset($this->_dtd['namespaces'][$cp])) {
return $this->_dtd['namespaces'][$cp] . ':' . $this->_dtd['codes'][$cp][$id];
} else {
return $this->_dtd['codes'][$cp][$id];
}
}
}
/**
* Return the temporary buffer stream.
*
* @return stream
*/
protected function _getTempStream()
{
if (!isset($this->_buffer)) {
$this->_buffer = new Horde_Stream_Temp();
}
return $this->_buffer;
}
}
|