/usr/share/z-push/lib/wbxml/wbxmlencoder.php is in z-push-common 2.3.8-2ubuntu1.
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 | <?php
/***********************************************
* File : wbxmlencoder.php
* Project : Z-Push
* Descr : WBXMLEncoder encodes to Wap Binary XML
*
* Created : 01.10.2007
*
* Copyright 2007 - 2016 Zarafa Deutschland GmbH
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Consult LICENSE file for details
************************************************/
class WBXMLEncoder extends WBXMLDefs {
private $_dtd;
private $_out;
private $_tagcp = 0;
private $log = false;
private $logStack = array();
// We use a delayed output mechanism in which we only output a tag when it actually has something
// in it. This can cause entire XML trees to disappear if they don't have output data in them; Ie
// calling 'startTag' 10 times, and then 'endTag' will cause 0 bytes of output apart from the header.
// Only when content() is called do we output the current stack of tags
private $_stack;
private $multipart; // the content is multipart
private $bodyparts;
public function __construct($output, $multipart = false) {
$this->log = ZLog::IsWbxmlDebugEnabled();
$this->_out = $output;
// reverse-map the DTD
foreach($this->dtd["namespaces"] as $nsid => $nsname) {
$this->_dtd["namespaces"][$nsname] = $nsid;
}
foreach($this->dtd["codes"] as $cp => $value) {
$this->_dtd["codes"][$cp] = array();
foreach($this->dtd["codes"][$cp] as $tagid => $tagname) {
$this->_dtd["codes"][$cp][$tagname] = $tagid;
}
}
$this->_stack = array();
$this->multipart = $multipart;
$this->bodyparts = array();
}
/**
* Puts the WBXML header on the stream
*
* @access public
* @return
*/
public function startWBXML() {
if ($this->multipart) {
header("Content-Type: application/vnd.ms-sync.multipart");
ZLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.multipart");
}
else {
header("Content-Type: application/vnd.ms-sync.wbxml");
ZLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->startWBXML() type: vnd.ms-sync.wbxml");
}
$this->outByte(0x03); // WBXML 1.3
$this->outMBUInt(0x01); // Public ID 1
$this->outMBUInt(106); // UTF-8
$this->outMBUInt(0x00); // string table length (0)
}
/**
* Puts a StartTag on the output stack
*
* @param $tag
* @param $attributes
* @param $nocontent
*
* @access public
* @return
*/
public function startTag($tag, $attributes = false, $nocontent = false) {
$stackelem = array();
if(!$nocontent) {
$stackelem['tag'] = $tag;
$stackelem['nocontent'] = $nocontent;
$stackelem['sent'] = false;
array_push($this->_stack, $stackelem);
// If 'nocontent' is specified, then apparently the user wants to force
// output of an empty tag, and we therefore output the stack here
} else {
$this->_outputStack();
$this->_startTag($tag, $nocontent);
}
}
/**
* Puts an EndTag on the stack
*
* @access public
* @return
*/
public function endTag() {
$stackelem = array_pop($this->_stack);
// Only output end tags for items that have had a start tag sent
if($stackelem['sent']) {
$this->_endTag();
if(count($this->_stack) == 0)
ZLog::Write(LOGLEVEL_DEBUG, "WBXMLEncoder->endTag() WBXML output completed");
if(count($this->_stack) == 0 && $this->multipart == true) {
$this->processMultipart();
}
if(count($this->_stack) == 0)
$this->writeLog();
}
}
/**
* Puts content on the output stack.
*
* @param string $content
*
* @access public
* @return
*/
public function content($content) {
// We need to filter out any \0 chars because it's the string terminator in WBXML. We currently
// cannot send \0 characters within the XML content anywhere.
$content = str_replace("\0","",$content);
if("x" . $content == "x")
return;
$this->_outputStack();
$this->_content($content);
}
/**
* Puts content of a stream on the output stack AND closes it.
*
* @param resource $stream
* @param boolean $asBase64 if true, the data will be encoded as base64, default: false
*
* @access public
* @return
*/
public function contentStream($stream, $asBase64 = false) {
if (!$asBase64) {
stream_filter_register('replacenullchar', 'ReplaceNullcharFilter');
$rnc_filter = stream_filter_append($stream, 'replacenullchar');
}
$this->_outputStack();
$this->_contentStream($stream, $asBase64);
if (!$asBase64) {
stream_filter_remove($rnc_filter);
}
fclose($stream);
}
/**
* Gets the value of multipart
*
* @access public
* @return boolean
*/
public function getMultipart() {
return $this->multipart;
}
/**
* Adds a bodypart
*
* @param Stream $bp
*
* @access public
* @return void
*/
public function addBodypartStream($bp) {
if (!is_resource($bp))
throw new WBXMLException("WBXMLEncoder->addBodypartStream(): trying to add a ".gettype($bp)." instead of a stream");
if ($this->multipart)
$this->bodyparts[] = $bp;
}
/**
* Gets the number of bodyparts
*
* @access public
* @return int
*/
public function getBodypartsCount() {
return count($this->bodyparts);
}
/**----------------------------------------------------------------------------------------------------------
* Private WBXMLEncoder stuff
*/
/**
* Output any tags on the stack that haven't been output yet
*
* @access private
* @return
*/
private function _outputStack() {
for($i=0;$i<count($this->_stack);$i++) {
if(!$this->_stack[$i]['sent']) {
$this->_startTag($this->_stack[$i]['tag'], $this->_stack[$i]['nocontent']);
$this->_stack[$i]['sent'] = true;
}
}
}
/**
* Outputs an actual start tag
*
* @access private
* @return
*/
private function _startTag($tag, $nocontent = false) {
if ($this->log)
$this->logStartTag($tag, $nocontent);
$mapping = $this->getMapping($tag);
if(!$mapping)
return false;
if($this->_tagcp != $mapping["cp"]) {
$this->outSwitchPage($mapping["cp"]);
$this->_tagcp = $mapping["cp"];
}
$code = $mapping["code"];
if(!isset($nocontent) || !$nocontent)
$code |= 0x40;
$this->outByte($code);
}
/**
* Outputs actual data.
*
* @access private
* @param string $content
* @return
*/
private function _content($content) {
if ($this->log)
$this->logContent($content);
$this->outByte(self::WBXML_STR_I);
$this->outTermStr($content);
}
/**
* Outputs actual data coming from a stream, optionally encoded as base64.
*
* @access private
* @param resource $stream
* @param boolean $asBase64
* @return
*/
private function _contentStream($stream, $asBase64) {
// write full stream, including the finalizing terminator to the output stream (stuff outTermStr() would do)
$this->outByte(self::WBXML_STR_I);
if ($asBase64) {
$out_filter = stream_filter_append($this->_out, 'convert.base64-encode');
}
$written = stream_copy_to_stream($stream, $this->_out);
if ($asBase64) {
stream_filter_remove($out_filter);
}
fwrite($this->_out, chr(0));
if ($this->log) {
// data is out, do some logging
$stat = fstat($stream);
$this->logContent(sprintf("<<< written %d of %d bytes of %s data >>>", $written, $stat['size'], $asBase64 ? "base64 encoded":"plain"));
}
}
/**
* Outputs an actual end tag
*
* @access private
* @return
*/
private function _endTag() {
if ($this->log)
$this->logEndTag();
$this->outByte(self::WBXML_END);
}
/**
* Outputs a byte
*
* @param $byte
*
* @access private
* @return
*/
private function outByte($byte) {
fwrite($this->_out, chr($byte));
}
/**
* Outputs a string table
*
* @param $uint
*
* @access private
* @return
*/
private function outMBUInt($uint) {
while(1) {
$byte = $uint & 0x7f;
$uint = $uint >> 7;
if($uint == 0) {
$this->outByte($byte);
break;
} else {
$this->outByte($byte | 0x80);
}
}
}
/**
* Outputs content with string terminator
*
* @param $content
*
* @access private
* @return
*/
private function outTermStr($content) {
fwrite($this->_out, $content);
fwrite($this->_out, chr(0));
}
/**
* Switches the codepage
*
* @param $page
*
* @access private
* @return
*/
private function outSwitchPage($page) {
$this->outByte(self::WBXML_SWITCH_PAGE);
$this->outByte($page);
}
/**
* Get the mapping for a tag
*
* @param $tag
*
* @access private
* @return array
*/
private function getMapping($tag) {
$mapping = array();
$split = $this->splitTag($tag);
if(isset($split["ns"])) {
$cp = $this->_dtd["namespaces"][$split["ns"]];
}
else {
$cp = 0;
}
$code = $this->_dtd["codes"][$cp][$split["tag"]];
$mapping["cp"] = $cp;
$mapping["code"] = $code;
return $mapping;
}
/**
* Split a tag from a the fulltag (namespace + tag)
*
* @param $fulltag
*
* @access private
* @return array keys: 'ns' (namespace), 'tag' (tag)
*/
private function splitTag($fulltag) {
$ns = false;
$pos = strpos($fulltag, chr(58)); // chr(58) == ':'
if($pos) {
$ns = substr($fulltag, 0, $pos);
$tag = substr($fulltag, $pos+1);
}
else {
$tag = $fulltag;
}
$ret = array();
if($ns)
$ret["ns"] = $ns;
$ret["tag"] = $tag;
return $ret;
}
/**
* Logs a StartTag to ZLog
*
* @param $tag
* @param $nocontent
*
* @access private
* @return
*/
private function logStartTag($tag, $nocontent) {
$spaces = str_repeat(" ", count($this->logStack));
if($nocontent)
ZLog::Write(LOGLEVEL_WBXML,"O " . $spaces . " <$tag/>");
else {
array_push($this->logStack, $tag);
ZLog::Write(LOGLEVEL_WBXML,"O " . $spaces . " <$tag>");
}
}
/**
* Logs a EndTag to ZLog
*
* @access private
* @return
*/
private function logEndTag() {
$spaces = str_repeat(" ", count($this->logStack));
$tag = array_pop($this->logStack);
ZLog::Write(LOGLEVEL_WBXML,"O " . $spaces . "</$tag>");
}
/**
* Logs content to ZLog
*
* @param string $content
*
* @access private
* @return
*/
private function logContent($content) {
$spaces = str_repeat(" ", count($this->logStack));
ZLog::Write(LOGLEVEL_WBXML,"O " . $spaces . $content);
}
/**
* Processes the multipart response
*
* @access private
* @return void
*/
private function processMultipart() {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("WBXMLEncoder->processMultipart() with %d parts to be processed", $this->getBodypartsCount()));
$len = ob_get_length();
$buffer = ob_get_clean();
$nrBodyparts = $this->getBodypartsCount();
$blockstart = (($nrBodyparts + 1) * 2) * 4 + 4;
fwrite($this->_out, pack("iii", ($nrBodyparts + 1), $blockstart, $len));
foreach ($this->bodyparts as $i=>$bp) {
$blockstart = $blockstart + $len;
$len = fstat($bp);
$len = (isset($len['size'])) ? $len['size'] : 0;
if ($len == 0) {
ZLog::Write(LOGLEVEL_WARN, sprintf("WBXMLEncoder->processMultipart(): the length of the body part at position %d is 0", $i));
}
fwrite($this->_out, pack("ii", $blockstart, $len));
}
fwrite($this->_out, $buffer);
foreach($this->bodyparts as $bp) {
stream_copy_to_stream($bp, $this->_out);
fclose($bp);
}
}
/**
* Writes the sent WBXML data to the log if it is not bigger than 512K.
*
* @access private
* @return void
*/
private function writeLog() {
if (ob_get_length() === false) {
$data = "output buffer disabled";
} elseif (ob_get_length() < 524288) {
$data = base64_encode(ob_get_contents());
} else {
$data = "more than 512K of data";
}
ZLog::Write(LOGLEVEL_WBXML, "WBXML-OUT: ". $data, false);
}
}
|