Add basic architecture for IPC socket

nekudo · nekudo · commit e620a74fcc0e · 2021-01-09T20:09:00.000+01:00
diff --git a/cli/client_demo.php b/cli/client_demo.php
@@ -1,4 +1,5 @@
 <?php
+/*
 ini_set('display_errors', 1);
 error_reporting(E_ALL);
 
@@ -24,3 +25,19 @@
     usleep(5000);
 }
 usleep(5000);
+    */
+
+
+require __DIR__ . '/../src/IPCPayloadFactory.php';
+require __DIR__ . '/../src/IPCPayload.php';
+
+$payload = \Bloatless\WebSocket\IPCPayloadFactory::makeApplicationPayload('demo', [
+    'action' => 'echo',
+    'data' => 'Hello from the IPC Socket!',
+]);
+
+$dataToSend = $payload->asJson();
+$dataLength = strlen($dataToSend);
+$socket = socket_create(AF_UNIX, SOCK_DGRAM, 0);
+socket_sendto($socket, $dataToSend, $dataLength, MSG_EOF, '/tmp/phpwss.sock', 0);
+socket_close($socket);
diff --git a/cli/server.php b/cli/server.php
@@ -1,6 +1,8 @@
 <?php
 
 require __DIR__ . '/../src/Connection.php';
+require __DIR__ . '/../src/IPCPayload.php';
+require __DIR__ . '/../src/IPCPayloadFactory.php';
 require __DIR__ . '/../src/Server.php';
 require __DIR__ . '/../src/Timer.php';
 require __DIR__ . '/../src/TimerCollection.php';
@@ -10,7 +12,7 @@
 require __DIR__ . '/../src/Application/DemoApplication.php';
 require __DIR__ . '/../src/Application/StatusApplication.php';
 
-$server = new \Bloatless\WebSocket\Server('127.0.0.1', 8000);
+$server = new \Bloatless\WebSocket\Server('127.0.0.1', 8000, '/tmp/phpwss.sock');
 
 // server settings:
 $server->setMaxClients(100);
diff --git a/composer.json b/composer.json
@@ -21,6 +21,8 @@
         }
     },
     "require": {
-        "php": "^7.2"
+        "php": "^7.4|^8.0",
+        "ext-json": "*",
+        "ext-sockets": "*"
     }
 }
diff --git a/public/index.html b/public/index.html
@@ -4,11 +4,11 @@
 	<link rel="stylesheet" href="css/client.css">
 	<script src="js/client.js"></script>
 	<meta charset=utf-8 />
-	<title>Shiny WSS Demo Application</title>
+	<title>Demo Application</title>
 </head>
 <body>
     <div id="container">
-        <h1>Shiny WSS Demo Application</h1>
+        <h1>Demo Application</h1>
 		<span id="status" class="offline">offline</span>
 		
 		<h2>Send Text Frame</h2>
@@ -20,4 +20,4 @@ <h2>Server-Response</h2>
         <div id="log"></div>
     </div>
 </body>
-</html>​
+</html>
diff --git a/public/status.html b/public/status.html
@@ -4,11 +4,11 @@
 	<link rel="stylesheet" href="css/status.css">
 	<script src="js/status.js"></script>
 	<meta charset=utf-8 />
-	<title>Shiny WSS Status</title>
+	<title>Server Status</title>
 </head>
 <body>
     <div id="container">
-        <h1>Shiny WSS Status</h1>
+        <h1>Server Status</h1>
 		<span id="status" class="offline">disconnected</span>
 		
 		<div id="main">
@@ -33,4 +33,4 @@ <h2>Server Messages:</h2>
 		</div>			
     </div>
 </body>
-</html>​
+</html>
diff --git a/src/Application/ApplicationInterface.php b/src/Application/ApplicationInterface.php
@@ -5,6 +5,7 @@
 namespace Bloatless\WebSocket\Application;
 
 use Bloatless\WebSocket\Connection;
+use Bloatless\WebSocket\IPCPayload;
 
 interface ApplicationInterface
 {
@@ -23,13 +24,20 @@ public function onConnect(Connection $connection): void;
     public function onDisconnect(Connection $connection): void;
 
     /**
-     * This method is triggered when the server recieves new data.
+     * This method is triggered when the server recieves new data from a client.
      *
      * @param string $data
      * @param Connection $client
      */
     public function onData(string $data, Connection $client): void;
 
+    /**
+     * This method is called when server recieves to for an application on the IPC socket.
+     *
+     * @param array $data
+     */
+    public function onIPCData(array $data): void;
+
     /**
      * Creates and returns a new instance of the application.
      *
diff --git a/src/Application/DemoApplication.php b/src/Application/DemoApplication.php
@@ -58,6 +58,14 @@ public function onData(string $data, Connection $client): void
         }
     }
 
+    public function onIPCData(array $data): void
+    {
+        $actionName = 'action' . ucfirst($data['action']);
+        if (method_exists($this, $actionName)) {
+            call_user_func([$this, $actionName], $data['data']);
+        }
+    }
+
     /**
      * Echoes data back to client(s).
      *
diff --git a/src/Application/StatusApplication.php b/src/Application/StatusApplication.php
@@ -73,6 +73,11 @@ public function onData(string $data, Connection $client): void
         // currently not in use...
     }
 
+    public function onIPCData(array $data): void
+    {
+        // TODO: Implement onIPCData() method.
+    }
+
     /**
      * Sets basic server data.
      *
diff --git a/src/IPCPayload.php b/src/IPCPayload.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bloatless\WebSocket;
+
+class IPCPayload
+{
+    public const TYPE_SERVER = 1;
+
+    public const TYPE_APPLICATION = 2;
+
+    public int $type;
+
+    public string $action;
+
+    public array $data;
+
+    public function __construct(int $type, string $action, array $data = [])
+    {
+        $this->type = $type;
+        $this->action = $action;
+        $this->data = $data;
+    }
+
+    public function asJson(): string
+    {
+        return json_encode([
+            'type' => $this->type,
+            'action' => $this->action,
+            'data' => $this->data,
+        ]);
+    }
+}
diff --git a/src/IPCPayloadFactory.php b/src/IPCPayloadFactory.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bloatless\WebSocket;
+
+class IPCPayloadFactory
+{
+    public static function makeServerPayload(string $command, array $data = []): IPCPayload
+    {
+        return new IPCPayload(IPCPayload::TYPE_SERVER, $command, $data);
+    }
+
+    public static function makeApplicationPayload(string $applicationName, array $data): IPCPayload
+    {
+        return new IPCPayload(IPCPayload::TYPE_APPLICATION, $applicationName, $data);
+    }
+
+    public static function fromJson(string $json): IPCPayload
+    {
+        $data = json_decode($json, true);
+        switch ($data['type']) {
+            case IPCPayload::TYPE_SERVER:
+                return new IPCPayload(IPCPayload::TYPE_SERVER, $data['action'], $data['data']);
+            case IPCPayload::TYPE_APPLICATION:
+                return new IPCPayload(IPCPayload::TYPE_APPLICATION, $data['action'], $data['data']);
+            default:
+                throw new \RuntimeException('Can not create IPCPayload from invalid data type.');
+        }
+    }
+}
diff --git a/src/Server.php b/src/Server.php
@@ -20,6 +20,16 @@ class Server
      */
     protected $master;
 
+    /**
+     * @var resource $icpSocket
+     */
+    private $icpSocket;
+
+    /**
+     * @var string $ipcSocketPath
+     */
+    private string $ipcSocketPath;
+
     /**
      * @var array Holds all connected sockets
      */
@@ -73,26 +83,20 @@ class Server
     /**
      * @param string $host
      * @param int $port
+     * @param string $ipcSocketPath
      */
-    public function __construct(string $host = 'localhost', int $port = 8000)
-    {
+    public function __construct(
+        string $host = 'localhost',
+        int $port = 8000,
+        string $ipcSocketPath = '/tmp/phpwss.sock'
+    ) {
         ob_implicit_flush(); // php7.x -> int, php8.x => bool, default 1 or true
         $this->createSocket($host, $port);
+        $this->openIPCSocket($ipcSocketPath);
         $this->timers = new TimerCollection();
         $this->log('Server created');
     }
 
-    /**
-     * Creates a connection from a socket resource
-     *
-     * @param resource $resource A socket resource
-     * @return Connection
-     */
-    protected function createConnection($resource): Connection
-    {
-        return new Connection($this, $resource);
-    }
-
     /**
      * Main server loop.
      * Listens for connections, handles connectes/disconnectes, e.g.
@@ -162,6 +166,8 @@ public function run(): void
                     $client->onData($data);
                 }
             }
+
+            $this->handleIPC();
         }
     }
 
@@ -299,6 +305,17 @@ public function checkOrigin(string $domain): bool
         return isset($this->allowedOrigins[$domain]);
     }
 
+    /**
+     * Creates a connection from a socket resource
+     *
+     * @param resource $resource A socket resource
+     * @return Connection
+     */
+    protected function createConnection($resource): Connection
+    {
+        return new Connection($this, $resource);
+    }
+
     /**
      * Adds a new ip to ip storage.
      *
@@ -536,4 +553,59 @@ public function writeBuffer($resource, string $string): int
 
         return $written;
     }
+
+    /**
+     * Opens a Unix-Domain-Socket to listen for inputs from other applications.
+     *
+     * @param string $ipcSocketPath
+     * @throws \RuntimeException
+     * @return void
+     */
+    private function openIPCSocket(string $ipcSocketPath): void
+    {
+        if (file_exists($ipcSocketPath)) {
+            unlink($ipcSocketPath);
+        }
+        $this->icpSocket = socket_create(AF_UNIX, SOCK_DGRAM, 0);
+        if ($this->icpSocket === false) {
+            throw new \RuntimeException('Could not open ipc socket.');
+        }
+        if (socket_set_nonblock($this->icpSocket) === false) {
+            throw new \RuntimeException('Could not set nonblock mode for ipc socket.');
+        }
+        if (socket_bind($this->icpSocket, $ipcSocketPath) === false) {
+            throw new \RuntimeException('Could not bind to ipc socket.');
+        }
+        $this->ipcSocketPath = $ipcSocketPath;
+    }
+
+    /**
+     * Checks IPC socket for input and processes data.
+     *
+     * @return void
+     */
+    private function handleIPC(): void
+    {
+        $buffer = '';
+        $bytesReceived = socket_recvfrom($this->icpSocket, $buffer, 65536, 0, $this->ipcSocketPath);
+        if ($bytesReceived === false) {
+            return;
+        }
+        if ($bytesReceived <= 0) {
+            return;
+        }
+
+        $payload = IPCPayloadFactory::fromJson($buffer);
+        switch ($payload->type) {
+            case IPCPayload::TYPE_SERVER:
+                // @todo handle server command
+                break;
+            case IPCPayload::TYPE_APPLICATION:
+                $app = $this->getApplication($payload->action);
+                $app->onIPCData($payload->data);
+                break;
+            default:
+                throw new \RuntimeException('Invalid IPC message received.');
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`	`}`
`22`	`22`	`},`
`23`	`23`	`"require": {`
`24`		`- "php": "^7.2"`
	`24`	`+ "php": "^7.4\|^8.0",`
	`25`	`+ "ext-json": "*",`
	`26`	`+ "ext-sockets": "*"`
`25`	`27`	`}`
`26`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,14 @@ public function onData(string $data, Connection $client): void`
`58`	`58`	`}`
`59`	`59`	`}`
`60`	`60`
	`61`	`+ public function onIPCData(array $data): void`
	`62`	`+ {`
	`63`	`+ $actionName = 'action' . ucfirst($data['action']);`
	`64`	`+ if (method_exists($this, $actionName)) {`
	`65`	`+ call_user_func([$this, $actionName], $data['data']);`
	`66`	`+ }`
	`67`	`+ }`
	`68`	`+`
`61`	`69`	`/**`
`62`	`70`	`* Echoes data back to client(s).`
`63`	`71`	`*`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,11 @@ public function onData(string $data, Connection $client): void`
`73`	`73`	`// currently not in use...`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ public function onIPCData(array $data): void`
	`77`	`+ {`
	`78`	`+ // TODO: Implement onIPCData() method.`
	`79`	`+ }`
	`80`	`+`
`76`	`81`	`/**`
`77`	`82`	`* Sets basic server data.`
`78`	`83`	`*`