#37 Updated echo server configuration, added ability to switch colors…

… and have it be live updated. Fixed an issue where anonymous users couldn't view any routes.
RaiderIO · May 31, 2019 · 68215dd · 68215dd
1 parent 3bbc9ec
commit 68215dd
Show file tree

Hide file tree

Showing 33 changed files with 457 additions and 44 deletions.
diff --git a/.env.example b/.env.example
@@ -5,6 +5,7 @@ APP_DEBUG=true
 APP_LOG_LEVEL=debug
 APP_LOG_DISCORD_WEBHOOK=
 APP_URL=http://keystone.test
+APP_TYPE=local
 LOG_CHANNEL=daily
 
 DB_CONNECTION=mysql

diff --git a/app/Events/BrushlineChangedEvent.php b/app/Events/BrushlineChangedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\Brushline;
 use App\Models\DungeonRoute;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, Brushline $brushline)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/BrushlineDeletedEvent.php b/app/Events/BrushlineDeletedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\Brushline;
 use App\Models\DungeonRoute;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, Brushline $brushline)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/KillZoneChangedEvent.php b/app/Events/KillZoneChangedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\DungeonRoute;
 use App\Models\KillZone;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, KillZone $killZone)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/KillZoneDeletedEvent.php b/app/Events/KillZoneDeletedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\DungeonRoute;
 use App\Models\KillZone;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, KillZone $killZone)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/MapCommentChangedEvent.php b/app/Events/MapCommentChangedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\DungeonRoute;
 use App\Models\MapComment;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, MapComment $mapComment)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/MapCommentDeletedEvent.php b/app/Events/MapCommentDeletedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\DungeonRoute;
 use App\Models\MapComment;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, MapComment $mapComment)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/PathChangedEvent.php b/app/Events/PathChangedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\DungeonRoute;
 use App\Models\Path;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, Path $path)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/PathDeletedEvent.php b/app/Events/PathDeletedEvent.php
@@ -5,6 +5,7 @@
 use App\Models\DungeonRoute;
 use App\Models\Path;
 use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
 use Illuminate\Foundation\Events\Dispatchable;
@@ -40,7 +41,7 @@ public function __construct(DungeonRoute $dungeonroute, Path $path)
      */
     public function broadcastOn()
     {
-        return new PrivateChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
     }
 
     public function broadcastAs()

diff --git a/app/Events/UserColorChangedEvent.php b/app/Events/UserColorChangedEvent.php
@@ -0,0 +1,58 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\DungeonRoute;
+use App\User;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class UserColorChangedEvent implements ShouldBroadcast
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var DungeonRoute $_dungeonroute */
+    private $_dungeonroute;
+
+    /** @var User $_user */
+    private $_user;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param $dungeonroute DungeonRoute
+     * @param User $user
+     * @return void
+     */
+    public function __construct(DungeonRoute $dungeonroute, User $user)
+    {
+        $this->_dungeonroute = $dungeonroute;
+        $this->_user = $user;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return new PresenceChannel(sprintf('route-edit.%s', $this->_dungeonroute->public_key));
+    }
+
+    public function broadcastAs()
+    {
+        return 'user-color-changed';
+    }
+
+    public function broadcastWith()
+    {
+        return [
+            'name' => $this->_user->name,
+            'color' => $this->_user->echo_color
+        ];
+    }
+}
diff --git a/app/Http/Controllers/ProfileController.php b/app/Http/Controllers/ProfileController.php
@@ -2,6 +2,9 @@
 
 namespace App\Http\Controllers;
 
+use App\Events\UserColorChangedEvent;
+use App\Models\DungeonRoute;
+use App\Service\EchoServerHttpApiService;
 use App\User;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
@@ -17,9 +20,11 @@ public function edit(Request $request)
     /**
      * @param Request $request
      * @param User $user
+     * @param EchoServerHttpApiService $echoServerHttpApiService
      * @return \Illuminate\Http\RedirectResponse
+     * @throws \Exception
      */
-    public function update(Request $request, User $user)
+    public function update(Request $request, User $user, EchoServerHttpApiService $echoServerHttpApiService)
     {
         // Allow username change once!
         if ($user->isOAuth()) {
@@ -54,6 +59,33 @@ public function update(Request $request, User $user)
         if (!$emailExists && !$nameExists) {
             if ($user->save()) {
                 \Session::flash('status', __('Profile updated'));
+
+                // Propagate changes to any channel the user may be in
+                foreach ($echoServerHttpApiService->getChannels() as $channel) {
+                    $assoc = get_object_vars($channel);
+                    $channelName = array_keys($assoc)[0];
+
+                    $routeKey = str_replace('presence-route-edit.', '', $channelName);
+
+                    $userInChannel = false;
+                    // Check if the user is in this channel..
+                    foreach ($echoServerHttpApiService->getChannelUsers($channelName) as $users) {
+
+                        foreach ($users as $channelUser) {
+                            if ($channelUser->id === $user->id) {
+                                $userInChannel = true;
+                                break;
+                            }
+                        }
+                    }
+
+                    if ($userInChannel) {
+                        /** @var DungeonRoute $dungeonRoute */
+                        $dungeonRoute = DungeonRoute::where('public_key', $routeKey)->firstOrFail();
+                        // Broadcast that channel that the user's color has changed
+                        broadcast(new UserColorChangedEvent($dungeonRoute, $user));
+                    }
+                }
             } else {
                 abort(500, __('An unexpected error occurred trying to save your profile'));
             }

diff --git a/app/Policies/DungeonRoutePolicy.php b/app/Policies/DungeonRoutePolicy.php
@@ -17,7 +17,7 @@ class DungeonRoutePolicy
      * @param  \App\Models\DungeonRoute $dungeonroute
      * @return mixed
      */
-    public function view(User $user, DungeonRoute $dungeonroute)
+    public function view(?User $user, DungeonRoute $dungeonroute)
     {
         // Everyone can view dungeon routes (for now)
         return $dungeonroute->published;

diff --git a/app/Providers/EchoServerServiceProvider.php b/app/Providers/EchoServerServiceProvider.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class EchoServerServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        // Bind the interface to the actual service
+        $this->app->bind('App\Service\EchoServerConfigServiceInterface', 'App\Service\EchoServerConfigService');
+        $this->app->bind('App\Service\EchoServerHttpApiServiceInterface', 'App\Service\EchoServerHttpApiService');
+    }
+
+    /**
+     * Bootstrap services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+}
diff --git a/app/Service/EchoServerConfigService.php b/app/Service/EchoServerConfigService.php
@@ -0,0 +1,70 @@
+<?php
+
+namespace App\Service;
+
+
+/**
+ * This service provides functionality for reading the current laravel echo service and parsing its contents.
+ * @package App\Service
+ * @author Wouter
+ * @since 30/05/2019
+ */
+class EchoServerConfigService implements EchoServerConfigServiceInterface
+{
+    /**
+     * @return \stdClass
+     * @throws \Exception
+     */
+    public function getConfig()
+    {
+        $json = file_get_contents(
+            base_path(
+                sprintf('config/echo/%s/laravel-echo-server.json', env('APP_TYPE'))
+            )
+        );
+
+        if ($json === false) {
+            throw new \Exception('Unable to read echo server configuration, is APP_TYPE set?');
+        } else {
+            return json_decode($json);
+        }
+    }
+
+    /**
+     * @return \stdClass[]
+     * @throws \Exception
+     */
+    public function getClients()
+    {
+        return ($this->getConfig())->clients;
+    }
+
+    /**
+     * @param $appId string
+     * @return \stdClass
+     * @throws \Exception
+     */
+    public function getClient($appId)
+    {
+        $result = false;
+        foreach ($this->getConfig()->clients as $client) {
+            if ($client->appId === $appId) {
+                $result = $client;
+                break;
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param $index int
+     * @return \stdClass
+     * @throws \Exception
+     */
+    public function getClientAt($index)
+    {
+        return ($this->getConfig())->clients[$index];
+    }
+
+}
diff --git a/app/Service/EchoServerConfigServiceInterface.php b/app/Service/EchoServerConfigServiceInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+
+namespace App\Service;
+
+interface EchoServerConfigServiceInterface {
+    public function getConfig();
+
+    public function getClients();
+
+    public function getClient($appId);
+
+    public function getClientAt($index);
+}