Communication between versions

HyBi-10 and Hixie-76 can now talk to each other!

README.md

@@ -13,47 +13,48 @@ Re-use your application without changing any of its code just by wrapping it in
 
 ---
 
-###A Quick server example
+###A quick server example
 
 ```php
 <?php
-    namespace Me;
-    use Ratchet\SocketObserver, Ratchet\SocketInterface;
-    use Ratchet\Socket, Ratchet\Server, Ratchet\Protocol\WebSocket;
-    use Ratchet\SocketCollection, Ratchet\Command\SendMessage;
+namespace Me;
+use Ratchet\SocketObserver, Ratchet\SocketInterface;
+use Ratchet\Socket, Ratchet\Server, Ratchet\Protocol\WebSocket;
+use Ratchet\Command\Composite, Ratchet\Command\SendMessage;
 
-    /**
-     * Send any incoming messages to all connected clients (except sender)
-     */
-    class Chat implements SocketObserver {
-        protected $_clients;
+/**
+ * Send any incoming messages to all connected clients (except sender)
+ */
+class Chat implements SocketObserver {
+    protected $_clients;
 
-        public function __construct() {
-            $this->_clients = new \SplObjectStorage;
-        }
-
-        public function onOpen(SocketInterface $conn) {
-            $this->_clients->attach($conn);
-        }
-
-        public function onRecv(SocketInterface $from, $msg) {
-            $stack = new SocketCollection;
-            foreach ($this->_clients as $client) {
-                if ($from != $client) {
-                    $stack->enqueue($client);
-                }
-            }
-
-            $command = new SendMessage($stack);
-            $command->setMessage($msg);
-            return $command;
-        }
-
-        public function onClose(SocketInterface $conn) {
-            $this->_clients->detach($conn);
-        }
+    public function __construct() {
+        $this->_clients = new \SplObjectStorage;
     }
 
+    public function onOpen(SocketInterface $conn) {
+        $this->_clients->attach($conn);
+    }
+
+    public function onRecv(SocketInterface $from, $msg) {
+        $stack = new Composite;
+        foreach ($this->_clients as $client) {
+            if ($from != $client) {
+                $message = new SendMessage($client);
+                $message->setMessage($msg);
+
+                $stack->enqueue($message);
+            }
+        }
+
+        return $stack;
+    }
+
+    public function onClose(SocketInterface $conn) {
+        $this->_clients->detach($conn);
+    }
+}
+
     // Run the server application through the WebSocket protocol
     $server = new Server(new Socket, new WebSocket(new Chat));
     $server->run('0.0.0.0', 80);

lib/Ratchet/Command/CloseConnection.php

@@ -1,23 +1,21 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 /**
  * Close the connection to the sockets passed in the constructor
  */
 class CloseConnection implements CommandInterface {
     /**
-     * @var SocketCollection
+     * @var SocketInterface
      */
-    protected $_sockets;
+    protected $_socket;
 
-    public function __construct(SocketCollection $sockets) {
-        $this->_sockets = $sockets;
+    public function __construct(SocketInterface $sockets) {
+        $this->_socket = $sockets;
     }
 
     function execute() {
-        foreach ($this->_sockets as $socket) {
-            $socket->close();
-        }
+        $this->_socket->close();
     }
 }

lib/Ratchet/Command/CommandInterface.php

@@ -1,17 +1,16 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 /**
  * Socket implementation of the Command Pattern
  * User created applications are to return a Command to the server for execution
- * @todo Bad format - very limited
  */
 interface CommandInterface {
     /**
      * Pass the Sockets to execute the command on
      */
-    function __construct(SocketCollection $sockets);
+    function __construct(SocketInterface $socket);
 
     /**
      * The Server class will call the execution

lib/Ratchet/Command/Composite.php

@@ -0,0 +1,39 @@
+<?php
+namespace Ratchet\Command;
+use Ratchet\SocketInterface;
+
+class Composite extends \SplQueue {
+    /**
+     * @param string
+     * @param Ratchet\SocketInterface
+     * @return CommandInterface
+     */
+    public function create($name, SocketInterface $socket) {
+        $class = __NAMESPACE__ . "\\{$name}\\";
+        if (!class_exists($class)) {
+            throw new \UnexpectedValueException("Command {$name} not found");
+        }
+
+        $cmd = new $class($socket);
+
+        if ($cmd instanceof CommandInterface) {
+            throw new RuntimeException("{$name} is not a valid command");
+        }
+
+        $this->enqueue($cmd);
+
+        return $cmd;
+    }
+
+    public function enqueue(CommandInterface $command) {
+        return parent::enqueue($command);
+    }
+
+    public function execute() {
+        $this->setIteratorMode(static::IT_MODE_DELETE);
+
+        foreach ($this as $command) {
+            $command->execute();
+        }
+    }
+}

lib/Ratchet/Command/Null.php

@@ -1,12 +1,12 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 /**
  * Null pattern - execution does nothing, something needs to be passed back though
  */
 class Null implements CommandInterface {
-    public function __construct(SocketCollection $sockets) {
+    public function __construct(SocketInterface $socket) {
     }
 
     public function execute() {

lib/Ratchet/Command/Ping.php

@@ -1,12 +1,12 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 /**
  * @todo Move this command to the WebSocket protocol namespace
  */
 class Ping implements CommandInterface {
-    public function __construct(SocketCollection $sockets) {
+    public function __construct(SocketInterface $socket) {
     }
 
     public function execute() {

lib/Ratchet/Command/Pong.php

@@ -1,12 +1,12 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 /**
  * @todo Move this command to the WebSocket protocol namespace
  */
 class Pong implements CommandInterface {
-    public function __construct(SocketCollection $sockets) {
+    public function __construct(SocketInterface $socket) {
     }
 
     public function execute() {

lib/Ratchet/Command/Runtime.php

@@ -1,20 +1,20 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 class Runtime implements CommandInterface {
     /**
-     * @var SocketCollection
+     * @var SocketInterface
      */
-    protected $_sockets;
+    protected $_socket;
 
     /**
      * @var Closure
      */
     protected $_command = null;
 
-    public function __construct(SocketCollection $sockets) {
-        $this->_socket = $sockets;
+    public function __construct(SocketInterface $socket) {
+        $this->_socket = $socket;
     }
 
     /**
@@ -26,8 +26,6 @@ class Runtime implements CommandInterface {
     }
 
     public function execute() {
-        foreach ($this->_sockets as $socket) {
-            return call_user_func($this->_command, $socket);
-        }
+        return call_user_func($this->_command, $socket);
     }
 }

lib/Ratchet/Command/SendMessage.php

@@ -1,23 +1,23 @@
 <?php
 namespace Ratchet\Command;
-use Ratchet\SocketCollection;
+use Ratchet\SocketInterface;
 
 /**
  * Send text back to the client end of the socket(s)
  */
 class SendMessage implements CommandInterface {
     /**
-     * @var SocketCollection
+     * @var SocketInterface
      */
-    protected $_sockets;
+    public $_socket;
 
     /**
      * @var string
      */
     protected $_message = '';
 
-    public function __construct(SocketCollection $sockets) {
-        $this->_sockets = $sockets;
+    public function __construct(SocketInterface $socket) {
+        $this->_socket = $socket;
     }
 
     /**
@@ -45,8 +45,6 @@ class SendMessage implements CommandInterface {
             throw new \UnexpectedValueException("Message is empty");
         }
 
-        foreach ($this->_sockets as $current) {
-            $current->write($this->_message, strlen($this->_message));
-        }
+        $this->_socket->write($this->_message, strlen($this->_message));
     }
 }

lib/Ratchet/Protocol/WebSocket.php

@@ -8,6 +8,7 @@ use Ratchet\SocketInterface;
 use Ratchet\SocketObserver;
 use Ratchet\Command\CommandInterface;
 use Ratchet\Command\SendMessage;
+use Ratchet\Command\Composite;
 
 /**
  * The adapter to handle WebSocket requests/responses
@@ -16,7 +17,6 @@ use Ratchet\Command\SendMessage;
  * @todo Make sure this works both ways (client/server) as stack needs to exist on client for framing
  * @todo Clean up Client/Version stuff.  This should be a factory making single instances of Version classes, implement chain of reponsibility for version - client should implement an interface?
  * @todo Make sure all SendMessage Commands are framed, not just ones received from onRecv
- * @todo Logic is flawed with Command/SocketCollection and framing - framing is done based on the protocol version of the received, not individual receivers...
  */
 class WebSocket implements ProtocolInterface {
     /**
@@ -77,12 +77,12 @@ class WebSocket implements ProtocolInterface {
                 $header = $response;
             }
 
-            $to  = new \Ratchet\SocketCollection;
-            $to->enqueue($from);
-            $cmd = new \Ratchet\Command\SendMessage($to);
-            $cmd->setMessage($header);
+            $cmds = new Composite;
+            $mess = new SendMessage($from);
+            $mess->setMessage($header);
+            $cmds->enqueue($mess);
 
-            return $cmd;
+            return $cmds;
         }
 
         try {
@@ -91,19 +91,26 @@ class WebSocket implements ProtocolInterface {
                 $msg = $msg['payload'];
             }
         } catch (\UnexpectedValueException $e) {
-            $to  = new \Ratchet\SocketCollection;
-            $to->enqueue($from);
-            $cmd = new \Ratchet\Command\Close($to);
+            $cmd = new Composite;
+            $close = new \Ratchet\Command\Close($from);
+            $cmd->enqueue($close);
 
             return $cmd;
         }
 
-        $cmd = $this->_app->onRecv($from, $msg);
-        if ($cmd instanceof SendMessage) {
-            $cmd->setMessage($client->getVersion()->frame($cmd->getMessage()));
+        $cmds = $this->_app->onRecv($from, $msg);
+        if ($cmds instanceof Composite) {
+            foreach ($cmds as $cmd) {
+                if ($cmd instanceof SendMessage) {
+                    $sock = $cmd->_socket;
+                    $clnt = $this->_clients[$sock];
+
+                    $cmd->setMessage($clnt->getVersion()->frame($cmd->getMessage()));
+                }
+            }
         }
  
-        return $cmd;
+        return $cmds;
     }
 
     /**

lib/Ratchet/Server.php

@@ -4,7 +4,7 @@ use Ratchet\Server\Aggregator;
 use Ratchet\Protocol\ProtocolInterface;
 use Ratchet\Logging\LoggerInterface;
 use Ratchet\Logging\NullLogger;
-use Ratchet\Command\CommandInterface;
+use Ratchet\Command\Composite;
 
 /**
  * Creates an open-ended socket to listen on a port for incomming connections.  Events are delegated through this to attached applications
@@ -108,7 +108,7 @@ class Server implements SocketObserver, \IteratorAggregate {
                         }
                     }
 
-                    if ($res instanceof CommandInterface) {
+                    if ($res instanceof Composite) {
                         $res->execute();
                     }
                 }

lib/Ratchet/SocketCollection.php

@@ -1,18 +0,0 @@
-<?php
-namespace Ratchet;
-
-/**
- * A self-deprecating queue that can only hold Socket objects
- */
-class SocketCollection extends \SplQueue {
-    public function __construct() {
-        $this->setIteratorMode(static::IT_MODE_DELETE);
-    }
-
-    /**
-     * @param SocketInterface
-     */
-    public function enqueue(SocketInterface $value) {
-        parent::enqueue($value);
-    }
-}