Merge pull request #17 from swooletw/develop

Develop

Author: albertcht

config/swoole_http.php

@@ -39,14 +39,14 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Laravel app will be cloned on every requset.
+    | Laravel app will be cloned on every request.
     |--------------------------------------------------------------------------
     */
     'sandbox_mode' => env('SWOOLE_SANDBOX_MODE', true),
 
     /*
     |--------------------------------------------------------------------------
-    | Console output will be transfered to response content if enabled.
+    | Console output will be transferred to response content if enabled.
     |--------------------------------------------------------------------------
     */
     'ob_output' => env('SWOOLE_OB_OUTPUT', true),

src/Websocket/Authenticatable.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace SwooleTW\Http\Websocket;
+
+use InvalidArgumentException;
+use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
+
+trait Authenticatable
+{
+    /**
+     * Login using current user.
+     */
+    public function loginUsing(AuthenticatableContract $user)
+    {
+        return $this->loginUsingId($user->getAuthIdentifier());
+    }
+
+    /**
+     * Login using current userId.
+     */
+    public function loginUsingId($userId)
+    {
+        return $this->join(static::USER_PREFIX . $userId);
+    }
+
+    /**
+     * Set multiple recepients' fds by users.
+     */
+    public function toUser($users)
+    {
+        $users = is_object($users) ? func_get_args() : $users;
+
+        $userIds = array_map(function ($user) {
+            $this->checkUser($user);
+            return $user->getAuthIdentifier();
+        }, $users);
+
+        return $this->toUserId($userIds);
+    }
+
+    /**
+     * Set multiple recepients' fds by userIds.
+     */
+    public function toUserId($userIds)
+    {
+        $userIds = is_string($userIds) || is_integer($userIds) ? func_get_args() : $userIds;
+
+        foreach ($userIds as $userId) {
+            $fds = $this->room->getClients(static::USER_PREFIX . $userId);
+            $this->to($fds);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Check if user object implements AuthenticatableContract.
+     */
+    protected function checkUser($user)
+    {
+        if (! $user instanceOf AuthenticatableContract) {
+            throw new InvalidArgumentException('user object must implement ' . AuthenticatableContract::class);
+        }
+    }
+}

src/Websocket/Rooms/RedisRoom.php

@@ -63,28 +63,22 @@ public function getRedis()
         return $this->redis;
     }
 
-    public function add(int $fd, string $room)
+    public function add(int $fd, $roomNames)
     {
-        $this->addAll($fd, [$room]);
-    }
+        $roomNames = is_array($roomNames) ? $roomNames : [$roomNames];
 
-    public function addAll(int $fd, array $roomNames)
-    {
         $this->addValue($fd, $roomNames, 'fds');
 
         foreach ($roomNames as $room) {
             $this->addValue($room, [$fd], 'rooms');
         }
     }
 
-    public function delete(int $fd, string $room)
-    {
-        $this->deleteAll($fd, [$room]);
-    }
-
-    public function deleteAll(int $fd, array $roomNames = [])
+    public function delete(int $fd, $roomNames = [])
     {
+        $roomNames = is_array($roomNames) ? $roomNames : [$roomNames];
         $roomNames = count($roomNames) ? $roomNames : $this->getRooms($fd);
+
         $this->removeValue($fd, $roomNames, 'fds');
 
         foreach ($roomNames as $room) {

src/Websocket/Rooms/RoomContract.php

@@ -10,36 +10,20 @@ interface RoomContract
     public function prepare();
 
     /**
-     * Add a socket to a room.
+     * Add multiple socket fds to a room.
      *
      * @int fd
-     * @string room
+     * @string|array rooms
      */
-    public function add(int $fd, string $room);
+    public function add(int $fd, $rooms);
 
     /**
-     * Add a socket to multiple rooms.
+     * Delete multiple socket fds from a room.
      *
      * @int fd
-     * @array room
-     */
-    public function addAll(int $fd, array $rooms);
-
-    /**
-     * Delete a socket from a room.
-     *
-     * @int fd
-     * @string room
-     */
-    public function delete(int $fd, string $room);
-
-    /**
-     * Delete a socket from all rooms.
-     *
-     * @int fd
-     * @string room
+     * @string|array rooms
      */
-    public function deleteAll(int $fd);
+    public function delete(int $fd, $rooms);
 
     /**
      * Get all sockets by a room key.

src/Websocket/Rooms/TableRoom.php

@@ -24,14 +24,10 @@ public function prepare()
         $this->initFdsTable();
     }
 
-    public function add(int $fd, string $room)
-    {
-        $this->addAll($fd, [$room]);
-    }
-
-    public function addAll(int $fd, array $roomNames)
+    public function add(int $fd, $roomNames)
     {
         $rooms = $this->getRooms($fd);
+        $roomNames = is_array($roomNames) ? $roomNames : [$roomNames];
 
         foreach ($roomNames as $room) {
             $fds = $this->getClients($room);
@@ -49,14 +45,10 @@ public function addAll(int $fd, array $roomNames)
         $this->setRooms($fd, $rooms);
     }
 
-    public function delete(int $fd, string $room)
-    {
-        $this->deleteAll($fd, [$room]);
-    }
-
-    public function deleteAll(int $fd, array $roomNames = [])
+    public function delete(int $fd, $roomNames = [])
     {
         $allRooms = $this->getRooms($fd);
+        $roomNames = is_array($roomNames) ? $roomNames : [$roomNames];
         $rooms = count($roomNames) ? $roomNames : $allRooms;
 
         $removeRooms = [];

src/Websocket/Websocket.php

@@ -4,15 +4,18 @@
 
 use InvalidArgumentException;
 use Illuminate\Support\Facades\App;
+use SwooleTW\Http\Websocket\Authenticatable;
 use Illuminate\Contracts\Container\Container;
 use SwooleTW\Http\Websocket\Rooms\RoomContract;
 use Illuminate\Contracts\Pipeline\Pipeline as PipelineContract;
 
 class Websocket
 {
-    const PUSH_ACTION = 'push';
+    use Authenticatable;
 
+    const PUSH_ACTION = 'push';
     const EVENT_CONNECT = 'connect';
+    const USER_PREFIX = 'uid_';
 
     /**
      * Determine if to broadcast.
@@ -86,25 +89,15 @@ public function broadcast()
         return $this;
     }
 
-    /**
-     * Set a recepient's fd or a room name.
-     *
-     * @param integer, string
-     */
-    public function to($value)
-    {
-        $this->toAll([$value]);
-
-        return $this;
-    }
-
     /**
      * Set multiple recepients' fd or room names.
      *
-     * @param array (fds or rooms)
+     * @param integer, string, array
      */
-    public function toAll(array $values)
+    public function to($values)
     {
+        $values = is_string($values) || is_integer($values) ? func_get_args() : $values;
+
         foreach ($values as $value) {
             if (! in_array($value, $this->to)) {
                 $this->to[] = $value;
@@ -114,49 +107,29 @@ public function toAll(array $values)
         return $this;
     }
 
-    /**
-     * Join sender to a room.
-     *
-     * @param string
-     */
-    public function join(string $room)
-    {
-        $this->room->add($this->sender, $room);
-
-        return $this;
-    }
-
     /**
      * Join sender to multiple rooms.
      *
-     * @param array
+     * @param string, array
      */
-    public function joinAll(array $rooms)
+    public function join($rooms)
     {
-        $this->room->addAll($this->sender, $rooms);
-
-        return $this;
-    }
+        $rooms = is_string($rooms) || is_integer($rooms) ? func_get_args() : $rooms;
 
-    /**
-     * Make sender leave a room.
-     *
-     * @param string
-     */
-    public function leave(string $room)
-    {
-        $this->room->delete($this->sender, $room);
+        $this->room->addAll($this->sender, $rooms);
 
         return $this;
     }
 
     /**
      * Make sender leave multiple rooms.
      *
-     * @param array
+     * @param string, array
      */
-    public function leaveAll(array $rooms = [])
+    public function leave($rooms)
     {
+        $rooms = is_string($rooms) || is_integer($rooms) ? func_get_args() : $rooms;
+
         $this->room->deleteAll($this->sender, $rooms);
 
         return $this;
@@ -322,7 +295,13 @@ protected function getFds()
         $rooms = array_diff($this->to, $fds);
 
         foreach ($rooms as $room) {
-            $fds = array_merge($fds, $this->room->getClients($room));
+            $clients = $this->room->getClients($room);
+            // rollback fd with wrong type back to fds array
+            if (empty($clients) && is_numeric($room)) {
+                $fds[] = $room;
+            } else {
+                $fds = array_merge($fds, $this->room->getClients($clients));
+            }
         }
 
         return array_values(array_unique($fds));

tests/Websocket/RedisRoomTest.php

@@ -51,7 +51,7 @@ public function testAddAll()
             ->times(3);
         $redisRoom = $this->getRedisRoom($redis);
 
-        $redisRoom->addAll(1, ['foo', 'bar']);
+        $redisRoom->add(1, ['foo', 'bar']);
     }
 
     public function testAdd()
@@ -71,7 +71,7 @@ public function testDeleteAll()
             ->times(3);
         $redisRoom = $this->getRedisRoom($redis);
 
-        $redisRoom->deleteAll(1, ['foo', 'bar']);
+        $redisRoom->delete(1, ['foo', 'bar']);
     }
 
     public function testDelete()

tests/Websocket/TableRoomTest.php

@@ -54,7 +54,7 @@ public function testSetValue()
 
     public function testAddAll()
     {
-        $this->tableRoom->addAll($key = 1, $values = ['foo', 'bar']);
+        $this->tableRoom->add($key = 1, $values = ['foo', 'bar']);
 
         $this->assertSame($values, $this->tableRoom->getValue($key, $table = 'fds'));
         $this->assertSame([$key], $this->tableRoom->getValue('foo', 'rooms'));
@@ -71,8 +71,8 @@ public function testAdd()
 
     public function testDeleteAll()
     {
-        $this->tableRoom->addAll($key = 1, $values = ['foo', 'bar']);
-        $this->tableRoom->deleteAll($key);
+        $this->tableRoom->add($key = 1, $values = ['foo', 'bar']);
+        $this->tableRoom->delete($key);
 
         $this->assertSame([], $this->tableRoom->getValue($key, $table = 'fds'));
         $this->assertSame([], $this->tableRoom->getValue('foo', 'rooms'));
@@ -81,7 +81,7 @@ public function testDeleteAll()
 
     public function testDelete()
     {
-        $this->tableRoom->addAll($key = 1, $values = ['foo', 'bar']);
+        $this->tableRoom->add($key = 1, $values = ['foo', 'bar']);
         $this->tableRoom->delete($key, 'foo');
 
         $this->assertSame(['bar'], $this->tableRoom->getValue($key, $table = 'fds'));
@@ -91,7 +91,7 @@ public function testDelete()
 
     public function testGetRooms()
     {
-        $this->tableRoom->addAll($key = 1, $values = ['foo', 'bar']);
+        $this->tableRoom->add($key = 1, $values = ['foo', 'bar']);
 
         $this->assertSame(
             $this->tableRoom->getValue($key, $table = 'fds'),