From 8770c361bc4cca64318fb60483b346207e0b2d3d Mon Sep 17 00:00:00 2001
From: Chris Boden <cboden@gmail.com>
Date: Thu, 14 Jun 2012 15:07:52 -0400
Subject: [PATCH] [WebSocket] Hixie refactoring

Created parent interface for messages and frames
Created Hixie Connection
Applied updated interfaces to Hixie versions
Removed __toString on msgs/frames since there could be 2-3 types returned
---
 Version/DataInterface.php      | 28 ++++++++++++++
 Version/FrameInterface.php     | 28 +++-----------
 Version/Hixie76.php            | 61 ++++++++++++++++++++++--------
 Version/Hixie76/Connection.php | 16 ++++++++
 Version/Hixie76/Frame.php      |  8 ++++
 Version/Hixie76/Message.php    | 68 ----------------------------------
 Version/MessageInterface.php   | 20 +---------
 Version/RFC6455/Connection.php |  4 +-
 Version/RFC6455/Message.php    | 24 ++++++++----
 Version/VersionInterface.php   | 13 +++++--
 WsServer.php                   |  2 +-
 11 files changed, 133 insertions(+), 139 deletions(-)
 create mode 100644 Version/DataInterface.php
 create mode 100644 Version/Hixie76/Connection.php
 delete mode 100644 Version/Hixie76/Message.php

diff --git a/Version/DataInterface.php b/Version/DataInterface.php
new file mode 100644
index 0000000..ef44565
--- /dev/null
+++ b/Version/DataInterface.php
@@ -0,0 +1,28 @@
+<?php
+namespace Ratchet\WebSocket\Version;
+
+interface DataInterface {
+    /**
+     * Determine if the message is complete or still fragmented
+     * @return bool
+     */
+    function isCoalesced();
+
+    /**
+     * Get the number of bytes the payload is set to be
+     * @return int
+     */
+    function getPayloadLength();
+
+    /**
+     * Get the payload (message) sent from peer
+     * @return string
+     */
+    function getPayload();
+
+    /**
+     * Get raw contents of the message
+     * @return string
+     */
+    function getContents();
+}
\ No newline at end of file
diff --git a/Version/FrameInterface.php b/Version/FrameInterface.php
index 61451cc..4198985 100644
--- a/Version/FrameInterface.php
+++ b/Version/FrameInterface.php
@@ -1,29 +1,21 @@
 <?php
 namespace Ratchet\WebSocket\Version;
 
-interface FrameInterface {
-    /**
-     * @return bool
-     */
-    function isCoalesced();
-
+interface FrameInterface extends DataInterface {
     /**
+     * Add incoming data to the frame from peer
      * @param string
-     * @todo Theoretically, there won't be a buffer overflow (end of frame + start of new frame) - but test later, return a string with overflow here
      */
     function addBuffer($buf);
 
     /**
-     * @return bool
-     */
-//    function isFragment();
-
-    /**
+     * Is this the final frame in a fragmented message?
      * @return bool
      */
     function isFinal();
 
     /**
+     * Was the payload masked?
      * @return bool
      */
     function isMasked();
@@ -36,21 +28,11 @@ interface FrameInterface {
     /**
      * @return int
      */
-    function getPayloadLength();
-
-    /**
-     * @return int
-     */
-//    function getReceivedPayloadLength();
+    //function getReceivedPayloadLength();
 
     /**
      * 32-big string
      * @return string
      */
     function getMaskingKey();
-
-    /**
-     * @param string
-     */
-    function getPayload();
 }
\ No newline at end of file
diff --git a/Version/Hixie76.php b/Version/Hixie76.php
index 4601b51..0e15153 100644
--- a/Version/Hixie76.php
+++ b/Version/Hixie76.php
@@ -1,7 +1,11 @@
 <?php
 namespace Ratchet\WebSocket\Version;
+use Ratchet\ConnectionInterface;
+use Ratchet\MessageInterface;
+use Ratchet\WebSocket\Version\Hixie76\Connection;
 use Guzzle\Http\Message\RequestInterface;
 use Guzzle\Http\Message\Response;
+use Ratchet\WebSocket\Version\Hixie76\Frame;
 
 /**
  * FOR THE LOVE OF BEER, PLEASE PLEASE PLEASE DON'T allow the use of this in your application!
@@ -22,6 +26,9 @@ class Hixie76 implements VersionInterface {
         return !(null === $request->getHeader('Sec-WebSocket-Key2', true));
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getVersionNumber() {
         return 0;
     }
@@ -46,25 +53,47 @@ class Hixie76 implements VersionInterface {
         return $response;
     }
 
-    /**
-     * @return Hixie76\Message
-     */
-    public function newMessage() {
-        return new Hixie76\Message;
-    }
-
-    /**
-     * @return Hixie76\Frame
-     */
-    public function newFrame() {
-        return new Hixie76\Frame;
-    }
-
     /**
      * {@inheritdoc}
      */
-    public function frame($message, $mask = true) {
-        return chr(0) . $message . chr(255);
+    public function upgradeConnection(ConnectionInterface $conn, MessageInterface $coalescedCallback) {
+        $upgraded = new Connection($conn);
+
+        if (!isset($upgraded->WebSocket)) {
+            $upgraded->WebSocket = new \StdClass;
+        }
+
+        $upgraded->WebSocket->coalescedCallback = $coalescedCallback;
+
+        return $upgraded;
+    }
+
+    public function onMessage(ConnectionInterface $from, $data) {
+        $overflow = '';
+
+        if (!isset($from->WebSocket->frame)) {
+            $from->WebSocket->frame = $this->newFrame();
+        }
+
+        $from->WebSocket->frame->addBuffer($data);
+        if ($from->WebSocket->frame->isCoalesced()) {
+            $overflow = $from->WebSocket->frame->extractOverflow();
+
+            $parsed = $from->WebSocket->frame->getPayload();
+            unset($from->WebSocket->frame);
+
+            $from->WebSocket->coalescedCallback->onMessage($from, $parsed);
+
+            unset($from->WebSocket->frame);
+        }
+
+        if (strlen($overflow) > 0) {
+            $this->onMessage($from, $overflow);
+        }
+    }
+
+    public function newFrame() {
+        return new Frame;
     }
 
     public function generateKeyNumber($key) {
diff --git a/Version/Hixie76/Connection.php b/Version/Hixie76/Connection.php
new file mode 100644
index 0000000..2011ac1
--- /dev/null
+++ b/Version/Hixie76/Connection.php
@@ -0,0 +1,16 @@
+<?php
+namespace Ratchet\WebSocket\Version\Hixie76;
+use Ratchet\AbstractConnectionDecorator;
+
+/**
+ * {@inheritdoc}
+ */
+class Connection extends AbstractConnectionDecorator {
+    public function send($msg) {
+        return $this->getConnection()->send(chr(0) . $msg . chr(255));
+    }
+
+    public function close() {
+        return $this->getConnection()->close();
+    }
+}
\ No newline at end of file
diff --git a/Version/Hixie76/Frame.php b/Version/Hixie76/Frame.php
index b9af87d..a172207 100644
--- a/Version/Hixie76/Frame.php
+++ b/Version/Hixie76/Frame.php
@@ -75,4 +75,12 @@ class Frame implements FrameInterface {
 
         return substr($this->_data, 1, strlen($this->_data) - 2);
     }
+
+    public function getContents() {
+        return $this->_data;
+    }
+
+    public function extractOverflow() {
+        return '';
+    }
 }
\ No newline at end of file
diff --git a/Version/Hixie76/Message.php b/Version/Hixie76/Message.php
deleted file mode 100644
index 818d95d..0000000
--- a/Version/Hixie76/Message.php
+++ /dev/null
@@ -1,68 +0,0 @@
-<?php
-namespace Ratchet\WebSocket\Version\Hixie76;
-use Ratchet\WebSocket\Version\MessageInterface;
-use Ratchet\WebSocket\Version\FrameInterface;
-
-class Message implements MessageInterface {
-    /**
-     * @var Ratchet\WebSocket\Version\FrameInterface
-     */
-    protected $_frame = null;
-
-    /**
-     * {@inheritdoc}
-     */
-    public function __toString() {
-        return $this->getPayload();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isCoalesced() {
-        if (!($this->_frame instanceof FrameInterface)) {
-            return false;
-        }
-
-        return $this->_frame->isCoalesced();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function addFrame(FrameInterface $fragment) {
-        if (null !== $this->_frame) {
-            throw new \OverflowException('Hixie76 does not support multiple framing of messages');
-        }
-
-        $this->_frame = $fragment;
-
-        return $this;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getOpcode() {
-        // Hixie76 only supported text messages
-        return 1;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPayloadLength() {
-        throw new \DomainException('Please sir, may I have some code? (' . __FUNCTION__ . ')');
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPayload() {
-        if (!$this->isCoalesced()) {
-            throw new \UnderflowException('Message has not been fully buffered yet');
-        }
-
-        return $this->_frame->getPayload();
-    }
-}
\ No newline at end of file
diff --git a/Version/MessageInterface.php b/Version/MessageInterface.php
index 1dc91fc..dc126d6 100644
--- a/Version/MessageInterface.php
+++ b/Version/MessageInterface.php
@@ -1,15 +1,7 @@
 <?php
 namespace Ratchet\WebSocket\Version;
 
-/**
- * @todo Consider making parent interface/composite for Message/Frame with (isCoalesced, getOpcdoe, getPayloadLength, getPayload)
- */
-interface MessageInterface {
-    /**
-     * @return bool
-     */
-    function isCoalesced();
-
+interface MessageInterface extends DataInterface {
     /**
      * @param FragmentInterface
      * @return MessageInterface
@@ -20,14 +12,4 @@ interface MessageInterface {
      * @return int
      */
     function getOpcode();
-
-    /**
-     * @return int
-     */
-    function getPayloadLength();
-
-    /**
-     * @return string
-     */
-    function getPayload();
 }
\ No newline at end of file
diff --git a/Version/RFC6455/Connection.php b/Version/RFC6455/Connection.php
index 1e1110b..88b0707 100644
--- a/Version/RFC6455/Connection.php
+++ b/Version/RFC6455/Connection.php
@@ -2,14 +2,14 @@
 namespace Ratchet\WebSocket\Version\RFC6455;
 use Ratchet\ConnectionInterface;
 use Ratchet\AbstractConnectionDecorator;
-use Ratchet\WebSocket\Version\FrameInterface;
+use Ratchet\WebSocket\Version\DataInterface;
 
 /**
  * {@inheritdoc}
  */
 class Connection extends AbstractConnectionDecorator {
     public function send($msg) {
-        if (!($msg instanceof FrameInterface)) {
+        if (!($msg instanceof DataInterface)) {
             $msg = new Frame($msg);
         }
 
diff --git a/Version/RFC6455/Message.php b/Version/RFC6455/Message.php
index 53bb8dd..14b3c9b 100644
--- a/Version/RFC6455/Message.php
+++ b/Version/RFC6455/Message.php
@@ -13,13 +13,6 @@ class Message implements MessageInterface {
         $this->_frames = new \SplDoublyLinkedList;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function __toString() {
-        return $this->getPayload();
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -87,4 +80,21 @@ class Message implements MessageInterface {
 
         return $buffer;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContents() {
+        if (!$this->isCoalesced()) {
+            throw new \UnderflowException("Message has not been put back together yet");
+        }
+
+        $buffer = '';
+
+        foreach ($this->_frames as $frame) {
+            $buffer .= $frame->getContents();
+        }
+
+        return $buffer;
+    }
 }
\ No newline at end of file
diff --git a/Version/VersionInterface.php b/Version/VersionInterface.php
index 630c62a..9a3c29e 100644
--- a/Version/VersionInterface.php
+++ b/Version/VersionInterface.php
@@ -1,6 +1,7 @@
 <?php
 namespace Ratchet\WebSocket\Version;
 use Ratchet\MessageInterface;
+use Ratchet\ConnectionInterface;
 use Guzzle\Http\Message\RequestInterface;
 
 /**
@@ -25,20 +26,26 @@ interface VersionInterface extends MessageInterface {
      * Perform the handshake and return the response headers
      * @param Guzzle\Http\Message\RequestInterface
      * @return Guzzle\Http\Message\Response
-     * @throws InvalidArgumentException If the HTTP handshake is mal-formed
      * @throws UnderflowException If the message hasn't finished buffering (not yet implemented, theoretically will only happen with Hixie version)
      */
     function handshake(RequestInterface $request);
 
+    /**
+     * @param Ratchet\ConnectionInterface
+     * @param Ratchet\MessageInterface
+     * @return Ratchet\ConnectionInterface
+     */
+    function upgradeConnection(ConnectionInterface $conn, MessageInterface $coalescedCallback);
+
     /**
      * @return MessageInterface
      */
-    function newMessage();
+    //function newMessage();
 
     /**
      * @return FrameInterface
      */
-    function newFrame();
+    //function newFrame();
 
     /**
      * @param string
diff --git a/WsServer.php b/WsServer.php
index 4108b76..90cf305 100644
--- a/WsServer.php
+++ b/WsServer.php
@@ -61,7 +61,7 @@ class WsServer implements MessageComponentInterface {
         $this->versioner
             ->enableVersion(new Version\RFC6455($component))
             ->enableVersion(new Version\HyBi10($component))
-            //->enableVersion(new Version\Hixie76)
+            ->enableVersion(new Version\Hixie76)
         ;
 
         $this->_decorating = $component;