web/Obj/transports.phh

   1 <?php
   2 /*
   3  *  sac-a-push - Obj/transports.phh
   4  *
   5  *  Copyright (C) 2012 Matteo Nastasi
   6  *                          mailto: nastasi@alternativeoutput.it
   7  *                                  matteo.nastasi@milug.org
   8  *                          web: http://www.alternativeoutput.it
   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, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABLILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18  * General Public License for more details. You should have received a
  19  * copy of the GNU General Public License along with this program; if
  20  * not, write to the Free Software Foundation, Inc, 59 Temple Place -
  21  * Suite 330, Boston, MA 02111-1307, USA.
  22  *
  23  */
  24
  25 /*
  26  *  test: SO x Browser
  27  *  Values: Y: works, N: not works, @: continuous download,
  28  *          D: continuous download after first reload
  29  *
  30  *  Stream IFRAME:
  31  *
  32  * Iframe| IW | FF | Ch | Op | Ko | IE
  33  * ------+----+----+----+----+----+----
  34  *   Lnx | D  |    | @  |    | @  | x
  35  *   Win | x  | D  | @  | @  |    | D
  36  *   Mac | x  |    |    |    |    |
  37  *
  38  *
  39  *   WS  | IW | FF | Ch | Op | Ko | IE
  40  * ------+----+----+----+----+----+----
  41  *   Lnx |    |    |    |    |    |
  42  *   Win |    |    |    |    |    |
  43  *   Mac |    |    |    |    |    |
  44  *
  45  *
  46  *   XHR | IW | FF | Ch | Op | Ko | IE
  47  * ------+----+----+----+----+----+----
  48  *   Lnx | Y  |    | ^D |    | Y  | x
  49  *   Win | x  | Y  | Y  |    |    | N
  50  *   Mac | x  |    |    |    |    |
  51  *
  52  *
  53  * HtmlFl| IW | FF | Ch | Op | Ko | IE
  54  * ------+----+----+----+----+----+----
  55  *   Lnx | N  |    |    |    | N  |
  56  *   Win | x  | N  | N  |    |    | Y* (* seems delay between click and load of a new page)
  57  *   Mac | x  |    |    |    |    |
  58  *
  59  *
  60  */
  61
  62 class Transport_template {
  63
  64     function Transport_template() {
  65     }
  66
  67     // return string value is appended to the content of the returned page
  68     // return FALSE if fails
  69     // check with '===' operator to disambiguation between "" and FALSE return value
  70     function init($enc, $header, &$header_out, $init_string, $base, $step)
  71     {
  72     }
  73
  74     function close()
  75     {
  76     }
  77
  78     function chunk($step, $cont)
  79     {
  80     }
  81
  82     function is_chunked()
  83     {
  84     }
  85
  86     // return string to add to the stream to perform something to the engine
  87     static function fini($init_string, $base, $blockerr)
  88     {
  89         return "";
  90     }
  91 }
  92
  93 class Transport_websocket {
  94     protected $magicGUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  95
  96     function Transport_websocket() {
  97         $this->headerOriginRequired                 = false;
  98         $this->headerSecWebSocketProtocolRequired   = false;
  99         $this->headerSecWebSocketExtensionsRequired = false;
 100
 101         $this->sendingContinuous = false;
 102         $this->sendingContinuous = false;
 103         $this->partialMessage = "";
 104
 105         $this->hasSentClose = false;
 106     }
 107
 108     protected function extractHeaders($message) {
 109         $header = array('fin'     => $message[0] & chr(128),
 110                         'rsv1'    => $message[0] & chr(64),
 111                         'rsv2'    => $message[0] & chr(32),
 112                         'rsv3'    => $message[0] & chr(16),
 113                         'opcode'  => ord($message[0]) & 15,
 114                         'hasmask' => $message[1] & chr(128),
 115                         'length'  => 0,
 116                         'mask'    => "");
 117         $header['length'] = (ord($message[1]) >= 128) ? ord($message[1]) - 128 : ord($message[1]);
 118
 119         if ($header['length'] == 126) {
 120             if ($header['hasmask']) {
 121                 $header['mask'] = $message[4] . $message[5] . $message[6] . $message[7];
 122             }
 123             $header['length'] = ord($message[2]) * 256
 124                 + ord($message[3]);
 125         } elseif ($header['length'] == 127) {
 126             if ($header['hasmask']) {
 127                 $header['mask'] = $message[10] . $message[11] . $message[12] . $message[13];
 128             }
 129             $header['length'] = ord($message[2]) * 65536 * 65536 * 65536 * 256
 130                 + ord($message[3]) * 65536 * 65536 * 65536
 131                 + ord($message[4]) * 65536 * 65536 * 256
 132                 + ord($message[5]) * 65536 * 65536
 133                 + ord($message[6]) * 65536 * 256
 134                 + ord($message[7]) * 65536
 135                 + ord($message[8]) * 256
 136                 + ord($message[9]);
 137         } elseif ($header['hasmask']) {
 138             $header['mask'] = $message[2] . $message[3] . $message[4] . $message[5];
 139         }
 140         //echo $this->strtohex($message);
 141         //$this->printHeaders($header);
 142         return $header;
 143     }
 144
 145     protected function extractPayload($message,$headers) {
 146         $offset = 2;
 147         if ($headers['hasmask']) {
 148             $offset += 4;
 149         }
 150         if ($headers['length'] > 65535) {
 151             $offset += 8;
 152         } elseif ($headers['length'] > 125) {
 153             $offset += 2;
 154         }
 155         return substr($message,$offset);
 156     }
 157
 158     protected function applyMask($headers,$payload) {
 159         $effectiveMask = "";
 160         if ($headers['hasmask']) {
 161             $mask = $headers['mask'];
 162         } else {
 163             return $payload;
 164         }
 165
 166         while (mb_strlen($effectiveMask, "ASCII") < mb_strlen($payload, "ASCII")) {
 167             $effectiveMask .= $mask;
 168         }
 169         while (mb_strlen($effectiveMask, "ASCII") > mb_strlen($payload, "ASCII")) {
 170             $effectiveMask = substr($effectiveMask,0,-1);
 171         }
 172         return $effectiveMask ^ $payload;
 173     }
 174
 175     protected function checkRSVBits($headers,$user) { // override this method if you are using an extension where the RSV bits are used.
 176         if (ord($headers['rsv1']) + ord($headers['rsv2']) + ord($headers['rsv3']) > 0) {
 177             //$this->disconnect($user); // todo: fail connection
 178             return true;
 179         }
 180         return false;
 181     }
 182
 183     protected function strtohex($str) {
 184         $strout = "";
 185         for ($i = 0; $i < mb_strlen($str, "ASCII"); $i++) {
 186             $strout .= (ord($str[$i])<16) ? "0" . dechex(ord($str[$i])) : dechex(ord($str[$i]));
 187             $strout .= " ";
 188             if ($i%32 == 7) {
 189                 $strout .= ": ";
 190             }
 191             if ($i%32 == 15) {
 192                 $strout .= ": ";
 193             }
 194             if ($i%32 == 23) {
 195                 $strout .= ": ";
 196             }
 197             if ($i%32 == 31) {
 198                 $strout .= "\n";
 199             }
 200         }
 201         return $strout . "\n";
 202     }
 203
 204     function chunk($step, $cont)
 205     {
 206         return $this->frame('@BEGIN@'.$cont.'@END@'); // , 'text', TRUE);
 207     }
 208
 209     protected function frame($message, $messageType='text', $messageContinues=false) {
 210         switch ($messageType) {
 211         case 'continuous':
 212             $b1 = 0;
 213             break;
 214         case 'text':
 215             $b1 = ($this->sendingContinuous) ? 0 : 1;
 216             break;
 217         case 'binary':
 218             $b1 = ($this->sendingContinuous) ? 0 : 2;
 219             break;
 220         case 'close':
 221             $b1 = 8;
 222             break;
 223         case 'ping':
 224             $b1 = 9;
 225             break;
 226         case 'pong':
 227             $b1 = 10;
 228             break;
 229         }
 230         if ($messageContinues) {
 231             $this->sendingContinuous = true;
 232         } else {
 233             $b1 += 128;
 234             $this->sendingContinuous = false;
 235         }
 236
 237         $length = mb_strlen($message, "ASCII");
 238         $lengthField = "";
 239         if ($length < 126) {
 240             $b2 = $length;
 241         } elseif ($length <= 65536) {
 242             $b2 = 126;
 243             $hexLength = dechex($length);
 244             //$this->stdout("Hex Length: $hexLength");
 245             if (mb_strlen($hexLength, "ASCII")%2 == 1) {
 246                 $hexLength = '0' . $hexLength;
 247             }
 248             $n = mb_strlen($hexLength, "ASCII") - 2;
 249
 250             for ($i = $n; $i >= 0; $i=$i-2) {
 251                 $lengthField = chr(hexdec(substr($hexLength, $i, 2))) . $lengthField;
 252             }
 253             while (mb_strlen($lengthField, "ASCII") < 2) {
 254                 $lengthField = chr(0) . $lengthField;
 255             }
 256         } else {
 257             $b2 = 127;
 258             $hexLength = dechex($length);
 259             if (mb_strlen($hexLength, "ASCII")%2 == 1) {
 260                 $hexLength = '0' . $hexLength;
 261             }
 262             $n = mb_strlen($hexLength, "ASCII") - 2;
 263
 264             for ($i = $n; $i >= 0; $i=$i-2) {
 265                 $lengthField = chr(hexdec(substr($hexLength, $i, 2))) . $lengthField;
 266             }
 267             while (mb_strlen($lengthField, "ASCII") < 8) {
 268                 $lengthField = chr(0) . $lengthField;
 269             }
 270         }
 271
 272         return chr($b1) . chr($b2) . $lengthField . $message;
 273     }
 274
 275     protected function deframe($message) {
 276         //echo $this->strtohex($message);
 277         $headers = $this->extractHeaders($message);
 278         $pongReply = false;
 279         $willClose = false;
 280         switch($headers['opcode']) {
 281         case 0:
 282         case 1:
 283         case 2:
 284             break;
 285         case 8:
 286             // todo: close the connection
 287             $this->hasSentClose = true;
 288             return "";
 289         case 9:
 290             $pongReply = true;
 291         case 10:
 292             break;
 293         default:
 294             //$this->disconnect($user); // todo: fail connection
 295             $willClose = true;
 296             break;
 297         }
 298
 299         if ($this->handlingPartialPacket) {
 300             $message = $this->partialBuffer . $message;
 301             $this->handlingPartialPacket = false;
 302             return $this->deframe($message);
 303         }
 304
 305         if ($this->checkRSVBits($headers,$this)) {
 306             return false;
 307         }
 308
 309         if ($willClose) {
 310             // todo: fail the connection
 311             return false;
 312         }
 313
 314         $payload = $this->partialMessage . $this->extractPayload($message,$headers);
 315
 316         if ($pongReply) {
 317             $reply = $this->frame($payload,$this,'pong');
 318             // TODO FIXME ALL socket_write management
 319             socket_write($user->socket,$reply,mb_strlen($reply, "ASCII"));
 320             return false;
 321         }
 322         if (extension_loaded('mbstring')) {
 323             if ($headers['length'] > mb_strlen($payload, "ASCII")) {
 324                 $this->handlingPartialPacket = true;
 325                 $this->partialBuffer = $message;
 326                 return false;
 327             }
 328         } else {
 329             if ($headers['length'] > mb_strlen($payload, "ASCII")) {
 330                 $this->handlingPartialPacket = true;
 331                 $this->partialBuffer = $message;
 332                 return false;
 333             }
 334         }
 335
 336         $payload = $this->applyMask($headers,$payload);
 337
 338         if ($headers['fin']) {
 339             $this->partialMessage = "";
 340             return $payload;
 341         }
 342         $this->partialMessage = $payload;
 343         return false;
 344     }
 345
 346
 347     protected function checkHost($hostName) {
 348         return true; // Override and return false if the host is not one that you would expect.
 349         // Ex: You only want to accept hosts from the my-domain.com domain,
 350         // but you receive a host from malicious-site.com instead.
 351     }
 352
 353     protected function checkOrigin($origin) {
 354         return true; // Override and return false if the origin is not one that you would expect.
 355     }
 356
 357     protected function checkWebsocProtocol($protocol) {
 358         return true; // Override and return false if a protocol is not found that you would expect.
 359     }
 360
 361     protected function checkWebsocExtensions($extensions) {
 362         return true; // Override and return false if an extension is not found that you would expect.
 363     }
 364
 365     protected function processProtocol($protocol) {
 366         return ""; // return either "Sec-WebSocket-Protocol: SelectedProtocolFromClientList\r\n" or return an empty string.
 367         // The carriage return/newline combo must appear at the end of a non-empty string, and must not
 368         // appear at the beginning of the string nor in an otherwise empty string, or it will be considered part of
 369         // the response body, which will trigger an error in the client as it will not be formatted correctly.
 370     }
 371
 372     protected function processExtensions($extensions) {
 373         return ""; // return either "Sec-WebSocket-Extensions: SelectedExtensions\r\n" or return an empty string.
 374     }
 375
 376     function init($enc, $headers, &$headers_out, $init_string, $base, $step)
 377     {
 378         if (0) { // TODO: what is ?
 379             if (isset($headers['get'])) {
 380                 $this->requestedResource = $headers['get'];
 381             } else {
 382                 // todo: fail the connection
 383                 $headers_out['HTTP-Response'] = "405 Method Not Allowed";
 384             }
 385         }
 386
 387         if (!isset($headers['Host']) || !$this->checkHost($headers['Host'])) {
 388             $headers_out['HTTP-Response'] = "400 Bad Request";
 389         }
 390         if (!isset($headers['Upgrade']) || strtolower($headers['Upgrade']) != 'websocket') {
 391             $headers_out['HTTP-Response'] = "400 Bad Request";
 392         }
 393         if (!isset($headers['Connection']) || strpos(strtolower($headers['Connection']), 'upgrade') === FALSE) {
 394             $headers_out['HTTP-Response'] = "400 Bad Request";
 395         }
 396         if (!isset($headers['Sec-Websocket-Key'])) {
 397             $headers_out['HTTP-Response'] = "400 Bad Request";
 398         } else {
 399         }
 400
 401         if (!isset($headers['Sec-Websocket-Version']) || strtolower($headers['Sec-Websocket-Version']) != 13) {
 402             $headers_out['HTTP-Response'] = "426 Upgrade Required";
 403             $headers_out['Sec-WebSocketVersion'] = "13";
 404         }
 405         if ( ($this->headerOriginRequired && !isset($headers['Origin']) )
 406              || ($this->headerOriginRequired && !$this->checkOrigin($headers['Origin'])) ) {
 407             $headers_out['HTTP-Response'] = "403 Forbidden";
 408         }
 409         if ( ($this->headerSecWebSocketProtocolRequired && !isset($headers['Sec-Websocket-Protocol']))
 410              || ($this->headerSecWebSocketProtocolRequired &&
 411                  !$this->checkWebsocProtocol($headers['Sec-Websocket-Protocol']))) {
 412             $headers_out['HTTP-Response'] = "400 Bad Request";
 413         }
 414         if ( ($this->headerSecWebSocketExtensionsRequired  && !isset($headers['Sec-Websocket-Extensions']))
 415              || ($this->headerSecWebSocketExtensionsRequired &&
 416                  !$this->checkWebsocExtensions($headers['Sec-Websocket-Extensions'])) ) {
 417             $headers_out['HTTP-Response'] = "400 Bad Request";
 418         }
 419
 420         if (isset($headers_out['HTTP-Response'])) {
 421             // TODO: check return management
 422             return (FALSE);
 423         }
 424
 425         // TODO: verify both variables
 426         // here there is a change of the socket status from start to handshaked
 427         // th headers are saved too but without any further access so we skip it
 428
 429
 430
 431         $inno = 'x3JJHMbDL1EzLkh9GBhXDw==';
 432         $outo = sha1($inno . $this->magicGUID);
 433         $rawToken = "";
 434         for ($i = 0; $i < 20; $i++) {
 435             $rawToken .= chr(hexdec(substr($outo,$i*2, 2)));
 436         }
 437
 438         $outo = base64_encode($rawToken);
 439
 440         $webSocketKeyHash = sha1($headers['Sec-Websocket-Key'] . $this->magicGUID);
 441         $rawToken = "";
 442         for ($i = 0; $i < 20; $i++) {
 443             $rawToken .= chr(hexdec(substr($webSocketKeyHash,$i*2, 2)));
 444         }
 445         $handshakeToken = base64_encode($rawToken);
 446         $subProtocol = (isset($headers['Sec-Websocket-Protocol'])) ?
 447             $this->processProtocol($headers['Sec-Websocket-Protocol']) : "";
 448         $extensions = (isset($headers['Sec-Websocket-Extensions'])) ?
 449             $this->processExtensions($headers['Sec-Websocket-Extensions']) : "";
 450
 451         $headers_out['HTTP-Response'] = "101 Switching Protocols";
 452         $headers_out['Upgrade']       = 'websocket';
 453         $headers_out['Connection']    = 'Upgrade';
 454         $headers_out['Sec-WebSocket-Accept'] = "$handshakeToken$subProtocol$extensions";
 455
 456         return ("");
 457     }
 458
 459     static function close()
 460     {
 461         return(chr(0x88).chr(0x02).chr(0xe8).chr(0x03));
 462     }
 463
 464     static function fini($init_string, $base, $blockerr)
 465     {
 466         return (sprintf('@BEGIN@ %s window.onbeforeunload = null; window.onunload = null; document.location.assign("%sindex.php"); @END@',  ($blockerr ? 'xstm.stop(); ' : ''), $base).self::close());
 467     }
 468
 469     function is_chunked()
 470     {
 471         return FALSE;
 472     }
 473
 474 }
 475
 476 class Transport_xhr {
 477
 478     function Transport_xhr() {
 479     }
 480
 481     function init($enc, $header, &$header_out, $init_string, $base, $step)
 482     {
 483         $ret = sprintf("@BEGIN@ /* %s */ @END@", $init_string);
 484         if ($enc != 'plain')
 485             $header_out['Content-Encoding'] = $enc;
 486         $header_out['Cache-Control'] = 'no-cache, must-revalidate';     // HTTP/1.1
 487         $header_out['Expires']       = 'Mon, 26 Jul 1997 05:00:00 GMT'; // Date in the past
 488         $header_out['Content-type']  = 'application/xml; charset="utf-8"';
 489
 490         return ($ret);
 491     }
 492
 493     function close()
 494     {
 495         return "";
 496     }
 497
 498     static function fini($init_string, $base, $blockerr)
 499     {
 500         return (sprintf('@BEGIN@ %s window.onbeforeunload = null; window.onunload = null; document.location.assign("%sindex.php"); @END@',  ($blockerr ? 'xstm.stop(); ' : ''), $base));
 501         return ("");
 502     }
 503
 504     function chunk($step, $cont)
 505     {
 506         return ("@BEGIN@".$cont."@END@");
 507     }
 508
 509     function is_chunked()
 510     {
 511         return TRUE;
 512     }
 513 }
 514
 515 class Transport_iframe {
 516
 517     function Transport_iframe() {
 518     }
 519
 520     function init($enc, $header, &$header_out, $init_string, $base, $step)
 521     {
 522         $ret = "";
 523
 524         if ($enc != 'plain')
 525             $header_out['Content-Encoding'] = $enc;
 526         $header_out['Cache-Control'] = 'no-cache, must-revalidate';     // HTTP/1.1
 527         $header_out['Expires']       = 'Mon, 26 Jul 1997 05:00:00 GMT'; // Date in the past
 528         $header_out['Content-type']  = 'text/html; charset="utf-8"';
 529
 530         $ret .= sprintf("<html>
 531 <head>
 532 <script type=\"text/javascript\" src=\"%scommons.js\"></script>
 533 <script type=\"text/javascript\" src=\"%sxynt-streaming-ifra.js\"></script>
 534 <script type=\"text/javascript\">
 535 var xynt_streaming = \"ready\";", $base, $base);
 536         if ($step > 0)
 537             $ret .= sprintf("last_clean = %d;\n", ($step-1));
 538         $ret .= sprintf("
 539 window.onload = function () { try { if (xynt_streaming != \"ready\") { xynt_streaming.transp.stopped = true; } } catch(e) { /* console.log(\"catcha\"); */ } };
 540 </script>
 541 </head>
 542 <body>");
 543         $ret .= sprintf("<!-- \n%s -->\n", $init_string);
 544
 545         return ($ret);
 546     }
 547
 548     function close()
 549     {
 550         return "";
 551     }
 552
 553     static function fini($init_string, $base, $blockerr)
 554     {
 555         $ret = "";
 556         $ret .= sprintf("<html>
 557 <head>
 558 <script type=\"text/javascript\" src=\"%scommons.js\"></script>
 559 <script type=\"text/javascript\" src=\"%sxynt-streaming-ifra.js\"></script>
 560 <script type=\"text/javascript\">
 561 var xynt_streaming = \"ready\";", $base, $base);
 562         $ret .= sprintf("
 563 window.onload = function () { try { if (xynt_streaming != \"ready\") { xynt_streaming.reload(); } } catch(e) { /* console.log(\"catcha\"); */ } };
 564 </script>
 565 </head>
 566 <body>");
 567         $ret .= sprintf("<!-- \n%s -->\n", $init_string);
 568         $ret .= sprintf("<script id='hs%d' type='text/javascript'><!--
 569 push(\"%s\");
 570 // -->
 571 </script>", 0, escpush($blockerr) );
 572         return ($ret);
 573     }
 574
 575     function chunk($step, $cont)
 576     {
 577         if ($cont == NULL) {
 578             return sprintf("<script id='hs%d' type='text/javascript'><!--
 579 push(null);\n// -->\n</script>", $step);
 580         }
 581         else {
 582             return sprintf("<script id='hs%d' type='text/javascript'><!--
 583 push(\"%s\");\n// -->\n</script>", $step, escpush($cont) );
 584         }
 585     }
 586
 587     function is_chunked()
 588     {
 589         return TRUE;
 590     }
 591 }
 592
 593 class Transport_htmlfile extends Transport_iframe {
 594 }
 595
 596 class Transport {
 597     function Transport()
 598     {
 599     }
 600
 601     static function create($transp)
 602     {
 603         if ($transp == 'websocket') {
 604             return new Transport_websocket();
 605         }
 606         else if ($transp == 'xhr') {
 607             return new Transport_xhr();
 608         }
 609         else if ($transp == 'htmlfile') {
 610             return new Transport_htmlfile();
 611         }
 612         else  {
 613             return new Transport_iframe();
 614         }
 615     }
 616     static function gettype($transp)
 617     {
 618         if ($transp == 'websocket' || $transp == 'xhr' || $transp == 'htmlfile') {
 619             return "Transport_".$transp;
 620         }
 621         else {
 622             return 'Transport_iframe';
 623         }
 624     }
 625 }
 626 ?>