Frame WebSocket outgoing messages

Implemented framing/unframing code from @lemmingzshadow for HyBi-10 protocol

lib/Ratchet/Protocol/WebSocket.php

@@ -5,6 +5,7 @@ use Ratchet\Protocol\WebSocket\Client;
 use Ratchet\Protocol\WebSocket\Version;
 use Ratchet\SocketInterface;
 use Ratchet\ReceiverInterface;
+use Ratchet\Command\SendMessage;
 
 /**
  * The adapter to handle WebSocket requests/responses
@@ -74,8 +75,6 @@ class WebSocket implements ProtocolInterface {
         $client = $this->_lookup[$from];
         if (true !== $client->isHandshakeComplete()) {
 
-// remove client, get protocol, do handshake, return, etc
-
             $headers  = $this->getHeaders($msg);
             $response = $client->setVersion($this->getVersion($headers))->doHandshake($headers);
 
@@ -88,18 +87,12 @@ class WebSocket implements ProtocolInterface {
                 $header .= "{$val}\r\n";
             }
             $header .= "\r\n";
-//            $header   = implode("\r\n", $response) . "\r\n";
 
-//            $from->write($header, strlen($header));
             $to  = new \Ratchet\SocketCollection;
             $to->enqueue($from);
             $cmd = new \Ratchet\Command\SendMessage($to);
             $cmd->setMessage($header);
 
-            // call my decorated onRecv()
-
-$this->_server->log('Returning handshake: ' . $header);
-
             return $cmd;
         }
 
@@ -108,7 +101,6 @@ $this->_server->log('Returning handshake: ' . $header);
             if (is_array($msg)) { // temporary
                 $msg = $msg['payload'];
             }
-
         } catch (\UnexpectedValueException $e) {
             $to  = new \Ratchet\SocketCollection;
             $to->enqueue($from);
@@ -117,7 +109,12 @@ $this->_server->log('Returning handshake: ' . $header);
             return $cmd;
         }
 
-        return $this->_app->onRecv($from, $msg);
+        $cmd = $this->_app->onRecv($from, $msg);
+        if ($cmd instanceof SendMessage) {
+            $cmd->setMessage($client->getVersion()->frame($cmd->getMessage()));
+        }
+
+        return $cmd;
     }
 
     public function onClose(SocketInterface $conn) {

lib/Ratchet/Protocol/WebSocket/Version/Hybi10.php

@@ -102,10 +102,85 @@ class Hybi10 implements VersionInterface {
     }
 
     /**
-     * @todo Complete this method
+     * Thanks to @lemmingzshadow for the code on decoding a HyBi-10 frame
+     * @link https://github.com/lemmingzshadow/php-websocket
+     * @todo look into what happens when false is returned here
+     * @param string
+     * @return string
      */
     public function frame($message) {
-        return $message;
+        $payload = $message;
+        $type    = 'text';
+        $masked  = true;
+
+		$frameHead = array();
+		$frame = '';
+		$payloadLength = strlen($payload);
+
+		switch($type) {
+			case 'text':
+				// first byte indicates FIN, Text-Frame (10000001):
+				$frameHead[0] = 129;				
+			break;			
+		
+			case 'close':
+				// first byte indicates FIN, Close Frame(10001000):
+				$frameHead[0] = 136;
+			break;
+		
+			case 'ping':
+				// first byte indicates FIN, Ping frame (10001001):
+				$frameHead[0] = 137;
+			break;
+		
+			case 'pong':
+				// first byte indicates FIN, Pong frame (10001010):
+				$frameHead[0] = 138;
+			break;
+		}
+		
+		// set mask and payload length (using 1, 3 or 9 bytes) 
+		if($payloadLength > 65535) {
+			$payloadLengthBin = str_split(sprintf('%064b', $payloadLength), 8);
+			$frameHead[1] = ($masked === true) ? 255 : 127;
+			for($i = 0; $i < 8; $i++) {
+				$frameHead[$i+2] = bindec($payloadLengthBin[$i]);
+			}
+			// most significant bit MUST be 0 (return false if to much data)
+			if($frameHead[2] > 127) {
+				return false;
+			}
+		} elseif($payloadLength > 125) {
+			$payloadLengthBin = str_split(sprintf('%016b', $payloadLength), 8);
+			$frameHead[1] = ($masked === true) ? 254 : 126;
+			$frameHead[2] = bindec($payloadLengthBin[0]);
+			$frameHead[3] = bindec($payloadLengthBin[1]);
+		} else {
+			$frameHead[1] = ($masked === true) ? $payloadLength + 128 : $payloadLength;
+		}
+
+		// convert frame-head to string:
+		foreach(array_keys($frameHead) as $i) {
+			$frameHead[$i] = chr($frameHead[$i]);
+		} if($masked === true) {
+			// generate a random mask:
+			$mask = array();
+			for($i = 0; $i < 4; $i++)
+			{
+				$mask[$i] = chr(rand(0, 255));
+			}
+			
+			$frameHead = array_merge($frameHead, $mask);			
+		}						
+		$frame = implode('', $frameHead);
+
+		// append payload to frame:
+		$framePayload = array();
+		for($i = 0; $i < $payloadLength; $i++) {		
+			$frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
+		}
+
+		return $frame;
     }
 
     public function sign($key) {

lib/Ratchet/Server.php

@@ -196,7 +196,7 @@ class Server implements SocketObserver, \IteratorAggregate {
     }
 
     public function onRecv(SocketInterface $from, $msg) {
-        $this->_log->note('New message "' . $msg . '"');
+        $this->_log->note('New message "' . trim($msg) . '"');
 
         $this->_app->onRecv($from, $msg)->execute();
     }