Merge branch 'master' of github.com:php-casbin/swoole-redis-watcher into main

Author: leeqvip

.gitignore

@@ -0,0 +1,12 @@
+/vendor/
+
+composer.lock
+
+.idea/
+*.iml
+*.cache
+
+# coverage report
+/build
+
+./phpunit.xml

README.md

@@ -0,0 +1,71 @@
+# Redis watcher for PHP-Casbin in Swoole
+
+[![Latest Stable Version](https://poser.pugx.org/casbin/swoole-redis-watcher/v/stable)](https://packagist.org/packages/casbin/swoole-redis-watcher)
+[![Total Downloads](https://poser.pugx.org/casbin/swoole-redis-watcher/downloads)](https://packagist.org/packages/casbin/swoole-redis-watcher)
+[![License](https://poser.pugx.org/casbin/swoole-redis-watcher/license)](https://packagist.org/packages/casbin/swoole-redis-watcher)
+
+Redis watcher for [PHP-Casbin](https://github.com/php-casbin/php-casbin) in [Swoole](https://www.swoole.com/) , [Casbin](https://casbin.org/) is a powerful and efficient open-source access control library.
+
+### Installation
+
+Via [Composer](https://getcomposer.org/).
+
+```
+composer require casbin/swoole-redis-watcher
+```
+
+### Usage
+
+```php
+
+require dirname(__FILE__) . '/../vendor/autoload.php';
+
+use Casbin\Enforcer;
+use CasbinWatcher\SwooleRedis\Watcher;
+
+Co::set(['hook_flags'=> SWOOLE_HOOK_ALL]); 
+
+$http = new Swoole\Http\Server('0.0.0.0', 9501);
+
+$http->on('WorkerStart', function ($server, $worker_id) {
+    global $enforcer;
+
+    // Initialize the Watcher.
+    $watcher = new Watcher([
+        'host' => '127.0.0.1',
+        'password' => '',
+        'port' => 6379,
+        'database' => 0,
+    ]);
+
+    // Initialize the Enforcer.
+    $enforcer = new Enforcer("path/to/model.conf", "path/to/policy.csv");
+
+    // Set the watcher for the enforcer.
+    $enforcer->setWatcher($watcher);
+
+    // By default, the watcher's callback is automatically set to the
+    // $enforcer->loadPolicy() in the setWatcher() call.
+    // We can change it by explicitly setting a callback.
+    $watcher->setUpdateCallback(function () use ($enforcer) {
+        // Now should reload all policies.
+        // $enforcer->loadPolicy();
+    });
+
+};
+
+$http->on('Request', function ($request, $response) {
+    // ...
+});
+
+$http->start();
+
+```
+
+### Getting Help
+
+- [php-casbin](https://github.com/php-casbin/php-casbin)
+
+### License
+
+This project is licensed under the [Apache 2.0 license](LICENSE).

composer.json

@@ -0,0 +1,34 @@
+{
+    "name": "casbin/swoole-redis-watcher",
+    "keywords": [
+        "casbin",
+        "watcher",
+        "swoole",
+        "rbac",
+        "permission",
+        "acl"
+    ],
+    "description": "Redis watcher for PHP-Casbin in swoole.",
+    "authors": [
+        {
+            "name": "TechLee",
+            "email": "[email protected]"
+        }
+    ],
+    "license": "Apache-2.0",
+    "require": {
+        "casbin/casbin": "^3.0",
+        "ext-swoole": "^4.0",
+        "ext-redis": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "CasbinWatcher\\SwooleRedis\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "CasbinWatcher\\SwooleRedis\\Tests\\": "tests/"
+        }
+    }
+}

src/Watcher.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace CasbinWatcher\SwooleRedis;
+
+use Casbin\Persist\Watcher as WatcherContract;
+use Redis;
+use Closure;
+
+class Watcher implements WatcherContract
+{
+    public ?Closure $callback = null;
+
+    private $pubClient;
+
+    private $subClient;
+
+    private $channel;
+
+    /**
+     * The config of Watcher.
+     *
+     * @param array $config
+     * [
+     *     'host' => '127.0.0.1',
+     *     'password' => '',
+     *     'port' => 6379,
+     *     'database' => 0,
+     *     'channel' => '/casbin',
+     * ]
+     */
+    public function __construct(array $config)
+    {
+        $this->pubClient = $this->createRedisClient($config);
+        $this->subClient = $this->createRedisClient($config);
+        $this->channel = $config['channel'] ?? '/casbin';
+
+        go(function () {
+            $this->subClient->subscribe([$this->channel], function ($redis, $channel, $message) {
+                if ($this->callback) {
+                    go($this->callback);
+                }
+            });
+        });
+    }
+
+    /**
+     * Sets the callback function that the watcher will call when the policy in DB has been changed by other instances.
+     * A classic callback is loadPolicy() method of Enforcer class.
+     *
+     * @param Closure $func
+     */
+    public function setUpdateCallback(Closure $func): void
+    {
+        $this->callback = $func;
+    }
+
+    /**
+     * Update calls the update callback of other instances to synchronize their policy.
+     * It is usually called after changing the policy in DB, like savePolicy() method of Enforcer class,
+     * addPolicy(), removePolicy(), etc.
+     */
+    public function update(): void
+    {
+        $this->pubClient->publish($this->channel, 'casbin rules updated');
+    }
+
+    /**
+     * Close stops and releases the watcher, the callback function will not be called any more.
+     */
+    public function close(): void
+    {
+        $this->pubClient->close();
+        $this->subClient->close();
+    }
+
+    /**
+     * Create redis client
+     *
+     * @param array $config
+     * @return Redis
+     */
+    private function createRedisClient(array $config): Redis
+    {
+        $config['host'] = $config['host'] ?? '127.0.0.1';
+        $config['port'] = $config['port'] ?? 6379;
+        $config['password'] = $config['password'] ?? '';
+        $config['database'] = $config['database'] ?? 0;
+
+        $client = new Redis();
+        $client->pconnect($config['host'], $config['port']);
+        if (!empty($config['password'])) {
+            $client->auth($config['password']);
+        }
+
+        if (isset($config['database'])) {
+            $client->select((int) $config['database']);
+        }
+
+        $client->setOption(Redis::OPT_READ_TIMEOUT, -1);
+
+        return $client;
+    }
+}

tests/test.php

@@ -0,0 +1,40 @@
+<?php
+
+require dirname(__FILE__) . '/../vendor/autoload.php';
+
+use Casbin\Enforcer;
+use CasbinWatcher\SwooleRedis\Watcher;
+
+Co::set(['hook_flags' => SWOOLE_HOOK_ALL]);
+
+$http = new Swoole\Http\Server('0.0.0.0', 9501);
+
+$http->on('WorkerStart', function ($server, $worker_id) {
+    global $enforcer;
+
+    $watcher = new Watcher([
+        'host' => getenv('REDIS_HOST') ? getenv('REDIS_HOST') : '127.0.0.1',
+        'password' => getenv('REDIS_PASSWORD') ? getenv('REDIS_PASSWORD') : '',
+        'port' => getenv('REDIS_PORT') ? getenv('REDIS_PORT') : 6379,
+        'database' => getenv('REDIS_DB') ? getenv('REDIS_DB') : 0,
+    ]);
+
+    $enforcer = new Enforcer(dirname(__FILE__) . '/../vendor/casbin/casbin/examples/basic_model.conf', dirname(__FILE__) . '/../vendor/casbin/casbin/examples/basic_policy.csv');
+
+    $enforcer->setWatcher($watcher);
+
+    $watcher->setUpdateCallback(function () {
+        echo "Now should reload all policies." . PHP_EOL;
+    });
+});
+
+$http->on('Request', function ($request, $response) {
+    global $enforcer;
+
+    $enforcer->savePolicy();
+
+    $response->header('Content-Type', 'text/html; charset=utf-8');
+    $response->end('<h1>Hello Swoole. #' . rand(1000, 9999) . '</h1>');
+});
+
+$http->start();