initial commit

Author: prophet777

.gitignore

@@ -0,0 +1 @@
+/vendor/

.php_cs

@@ -0,0 +1,15 @@
+<?php
+
+return Symfony\CS\Config\Config::create()
+    ->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL)
+    ->fixers(array(
+        'ordered_use',
+        'multiline_spaces_before_semicolon',
+        'concat_with_spaces'
+    ))
+    ->finder(
+        Symfony\CS\Finder\DefaultFinder::create()
+            ->exclude(['vendor', 'app/cache'])
+            ->in(__DIR__)
+    )
+;

Exception/BadResponseException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Gos\Component\WebSocketClient\Exception;
+
+/**
+ * @author Johann Saunier <[email protected]>
+ */
+class BadResponseException extends WebsocketException
+{
+}

Exception/WebsocketException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Gos\Component\WebSocketClient\Exception;
+
+/**
+ * @author Johann Saunier <[email protected]>
+ */
+class WebsocketException extends \Exception
+{
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Johann Saunier <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,46 @@
+# Gos WebSocket Client
+
+## About
+
+This library has been tested with Ratchet WAMP server. It can only send messages to the server, listening for replies is not implemented.
+Supported functions:
+ - prefix
+ - call
+ - publish
+ - event
+
+## Usage
+
+```php
+use Gos\Component\WebSocketClient\Wamp\Client;
+
+$client = new Client('http://localhost:8080');
+$sessionId = $client->connect();
+
+//establish a prefix on server
+$client->prefix("calc", "http://example.com/simple/calc#");
+
+//you can send arbitrary number of arguments
+$client->call('calc', 12,14,15);
+
+$data = [0, 1, 2];
+
+//or array
+$client->call('calc', $data);
+
+$exclude = array($sessionId); //no sense in sending the payload to ourselves
+$eligible = [...] //list of other clients ids that are eligible to receive this payload
+
+//$payload can be scalar or array
+$client->publish('topic', $payload, $exclude, $eligible);
+
+//publish an event
+$client->event('topic', $payload);
+$client->disconnect();
+```
+
+## License
+This software is distributed under MIT License. See LICENSE for more info.
+
+## Original Project
+[https://github.com/bazo/wamp-client](https://github.com/bazo/wamp-client)

Wamp/Client.php

@@ -0,0 +1,286 @@
+<?php
+
+namespace Gos\Component\WebSocketClient\Wamp;
+
+use Gos\Component\WebSocketClient\Exception\BadResponseException;
+use Gos\Component\WebSocketClient\Exception\WebsocketException;
+
+/**
+ * WS Client
+ *
+ * @author Martin Bažík <[email protected]>
+ * @author Johann Saunier <[email protected]>
+ */
+class Client
+{
+    /** @var string */
+    protected $endpoint;
+
+    /** @var string */
+    protected $serverHost;
+
+    /** @var int */
+    protected $serverPort;
+
+    /** @var resource */
+    protected $socket;
+
+    /** @var bool  */
+    protected $connected;
+
+    /** @var string */
+    protected $sessionId;
+
+    /**
+     * @param string $endpoint
+     */
+    public function __construct($endpoint)
+    {
+        $this->endpoint = $endpoint;
+        $this->parseUrl();
+        $this->connected = false;
+        $this->serverPort = 80;
+    }
+
+    /**
+     * @param string $target
+     *
+     * @return string
+     * @throws BadResponseException
+     * @throws WebsocketException
+     */
+    public function connect($target = '/websocket/')
+    {
+        if ($this->connected) {
+            return $this->sessionId;
+        }
+
+        $this->socket = stream_socket_client($this->serverHost . ':' . $this->serverPort, $errno, $errstr);
+
+        if (!$this->socket) {
+            throw new BadResponseException('Could not open socket. Reason: ' . $errstr);
+        }
+
+        $response = $this->upgradeProtocol($target);
+
+        $this->verifyResponse($response);
+
+        $payload = json_decode($this->read());
+
+        if ($payload[0] != Protocol::MSG_WELCOME) {
+            throw new BadResponseException('WAMP Server did not send welcome message.');
+        }
+
+        $this->sessionId = $payload[1];
+
+        return $this->sessionId;
+    }
+
+    /**
+     * @param string $target
+     *
+     * @return string
+     *
+     * @throws WebsocketException
+     */
+    protected function upgradeProtocol($target)
+    {
+        $key = $this->generateKey();
+
+        if (false === strpos($target, '/')) {
+            throw new WebsocketException('Wamp Server Target is wrong.');
+        }
+
+        $out = "GET " . $target . " HTTP/1.1\r\n";
+        $out .= "Host: {$this->serverHost} \r\n";
+        $out .= "Upgrade: WebSocket\r\n";
+        $out .= "Connection: Upgrade\r\n";
+        $out .= "Sec-WebSocket-Key: $key \r\n";
+        $out .= "Sec-WebSocket-Version: 13\r\n";
+        $out .= "Origin: *\r\n\r\n";
+
+        fwrite($this->socket, $out);
+
+        return fgets($this->socket);
+    }
+
+    /**
+     * @param $response
+     *
+     * @throws BadResponseException
+     */
+    protected function verifyResponse($response)
+    {
+        if (false === $response) {
+            throw new BadResponseException('WAMP Server did not respond properly');
+        }
+
+        $subres = substr($response, 0, 12);
+
+        if ($subres != 'HTTP/1.1 101') {
+            throw new BadResponseException('Unexpected Response. Expected HTTP/1.1 101 got ' . $subres);
+        }
+    }
+
+    /**
+     * Read the buffer and return the oldest event in stack
+     *
+     * @see https://tools.ietf.org/html/rfc6455#section-5.2
+     * @return string
+     */
+    protected function read()
+    {
+        // Ignore first byte
+        fread($this->socket, 1);
+
+        // There is also masking bit, as MSB, bit it's 0
+        $payloadLength = ord(fread($this->socket, 1));
+
+        switch ($payloadLength) {
+            case 126:
+                $payloadLength = unpack("n", fread($this->socket, 2));
+                $payloadLength = $payloadLength[1];
+                break;
+            case 127:
+                //$this->stdout('error', "Next 8 bytes are 64bit uint payload length, not yet implemented, since PHP can't handle 64bit longs!");
+                break;
+        }
+
+        return fread($this->socket, $payloadLength);
+    }
+
+    /**
+     * Disconnect
+     *
+     * @return boolean
+     */
+    public function disconnect()
+    {
+        if ($this->socket) {
+            fclose($this->socket);
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Send message to the websocket
+     *
+     * @access private
+     * @param  array        $data
+     * @return $this|Client
+     */
+    protected function send($data)
+    {
+        $rawMessage = json_encode($data);
+        $payload = new WebsocketPayload();
+        $payload
+            ->setOpcode(WebsocketPayload::OPCODE_TEXT)
+            ->setMask(true)
+            ->setPayload($rawMessage);
+
+        $encoded = $payload->encodePayload();
+        fwrite($this->socket, $encoded);
+
+        return $this;
+    }
+
+    /**
+     * Establish a prefix on server
+     * @see http://wamp.ws/spec#prefix_message
+     * @param string $prefix
+     * @param string $uri
+     */
+    public function prefix($prefix, $uri)
+    {
+        $type = Protocol::MSG_PREFIX;
+        $data = [$type, $prefix, $uri];
+        $this->send($data);
+    }
+
+    /**
+     * Call a procedure on server
+     * @see http://wamp.ws/spec#call_message
+     * @param string $procURI
+     * @param mixed  $arguments
+     */
+    public function call($procUri, $arguments = [])
+    {
+        $args = func_get_args();
+        array_shift($args);
+        $type = Protocol::MSG_CALL;
+        $callId = uniqid("", $moreEntropy = true);
+        $data = array_merge(array($type, $callId, $procUri), $args);
+
+        $this->send($data);
+    }
+
+    /**
+     * The client will send an event to all clients connected to the server who have subscribed to the topicURI
+     * @see http://wamp.ws/spec#publish_message
+     * @param string $topicUri
+     * @param string $payload
+     * @param string $exclude
+     * @param string $eligible
+     */
+    public function publish($topicUri, $payload, $exclude = [], $eligible = [])
+    {
+        $type = Protocol::MSG_PUBLISH;
+        $data = array($type, $topicUri, $payload, $exclude, $eligible);
+        $this->send($data);
+    }
+
+    /**
+     * Subscribers receive PubSub events published by subscribers via the EVENT message. The EVENT message contains the topicURI, the topic under which the event was published, and event, the PubSub event payload.
+     * @param string $topicUri
+     * @param string $payload
+     */
+    public function event($topicUri, $payload)
+    {
+        $type = Protocol::MSG_EVENT;
+        $data = array($type, $topicUri, $payload);
+        $this->send($data);
+    }
+
+    /**
+     * @param int $length
+     *
+     * @return string
+     */
+    protected function generateKey($length = 16)
+    {
+        $c = 0;
+        $tmp = '';
+
+        while ($c++ * 16 < $length) {
+            $tmp .= md5(mt_rand(), true);
+        }
+
+        return base64_encode(substr($tmp, 0, $length));
+    }
+
+    /**
+     * Parse the url and set server parameters
+     *
+     * @access private
+     * @return bool
+     */
+    protected function parseUrl()
+    {
+        $url = parse_url($this->endpoint);
+
+        $this->serverHost = $url['host'];
+        $this->serverPort = isset($url['port']) ? $url['port'] : null;
+
+        if (array_key_exists('scheme', $url) && $url['scheme'] == 'https') {
+            $this->serverHost = 'ssl://' . $this->serverHost;
+            if (!$this->serverPort) {
+                $this->serverPort = 443;
+            }
+        }
+
+        return true;
+    }
+}