feat: support Casbin FilteredAdapter interface

Author: basakest

src/Adapters/DatabaseAdapter.php

@@ -12,11 +12,19 @@
 use EasySwoole\Permission\Model\RulesModel;
 use Throwable;
 use Casbin\Persist\BatchAdapter;
+use Casbin\Persist\FilteredAdapter;
+use Casbin\Persist\Adapters\Filter;
+use Casbin\Exceptions\InvalidFilterTypeException;
 
-class DatabaseAdapter implements Adapter, BatchAdapter
+class DatabaseAdapter implements Adapter, BatchAdapter, FilteredAdapter
 {
     use AdapterHelper;
 
+    /**
+     * @var bool
+     */
+    private $filtered = false;
+
     /**
      * savePolicyLine function.
      *
@@ -182,7 +190,7 @@ public function addPolicies(string $sec, string $ptype, array $rules): void
     public function removePolicies(string $sec, string $ptype, array $rules): void
     {
         $ids = [];
-        
+
         foreach($rules as $rule) {
             $where = [];
             $where['ptype'] = $ptype;
@@ -195,4 +203,62 @@ public function removePolicies(string $sec, string $ptype, array $rules): void
 
         RulesModel::create()->destroy($ids);
     }
+
+    /**
+     * loads only policy rules that match the filter.
+     *
+     * @param Model $model
+     * @param mixed $filter
+     */
+    public function loadFilteredPolicy(Model $model, $filter): void
+    {
+        $instance = RulesModel::create();
+
+        if (is_string($filter)) {
+            $filter = str_replace(' ', '', $filter);
+            $filter = explode('=', $filter);
+            $instance->where($filter[0], $filter[1]);
+        } else if ($filter instanceof Filter) {
+            foreach($filter->p as $k => $v) {
+                $where[$v] = $filter->g[$k];
+                $instance->where($v, $filter->g[$k]);
+            }
+        } else if ($filter instanceof \Closure) {
+            $instance->where($filter);
+        } else {
+            throw new InvalidFilterTypeException('invalid filter type');
+        }
+        $rows = $instance->all();
+        //var_dump($rows);
+        foreach ($rows as $row) {
+            $row = $row->hidden(['create_time','update_time', 'id'])->toArray();
+            $row = array_filter($row, function($value) { return !is_null($value) && $value !== ''; });
+            //var_dump($row);
+            $line = implode(', ', array_filter($row, function ($val) {
+                return '' != $val && !is_null($val);
+            }));
+            $this->loadPolicyLine(trim($line), $model);
+        }
+        $this->setFiltered(true);
+    }
+
+    /**
+     * Returns true if the loaded policy has been filtered.
+     *
+     * @return bool
+     */
+    public function isFiltered(): bool
+    {
+        return $this->filtered;
+    }
+
+    /**
+     * Sets filtered parameter.
+     *
+     * @param bool $filtered
+     */
+    public function setFiltered(bool $filtered): void
+    {
+        $this->filtered = $filtered;
+    }
 }

tests/DatabaseAdapterTest.php

@@ -9,6 +9,8 @@
 use EasySwoole\Permission\Config;
 use EasySwoole\ORM\Db\Connection;
 use EasySwoole\EasySwoole\Config as ESConfig;
+use Casbin\Exceptions\InvalidFilterTypeException;
+use Casbin\Persist\Adapters\Filter;
 
 class DatabaseAdapterTest extends TestCase
 {
@@ -143,4 +145,48 @@ public function testRemovePolicies()
             ['bob', 'data2', 'write']
         ], $e->getPolicy());
     }
+
+    public function testLoadFilteredPolicy()
+    {
+        $e = $this->getEnforcer();
+        $e->clearPolicy();
+        $this->initConfig();
+        $adapter = $e->getAdapter();
+        $adapter->setFiltered(true);
+        $this->assertEquals([], $e->getPolicy());
+
+        // invalid filter type
+        try {
+            $filter = ['alice', 'data1', 'read'];
+            $e->loadFilteredPolicy($filter);
+            $exception = InvalidFilterTypeException::class;
+            $this->fail("Expected exception $exception not thrown");
+        } catch (InvalidFilterTypeException $exception) {
+            $this->assertEquals("invalid filter type", $exception->getMessage());
+        }
+
+        // string
+        $filter = "v0 = bob";
+        $e->loadFilteredPolicy($filter);
+        $this->assertEquals([
+            ['bob', 'data2', 'write']
+        ], $e->getPolicy());
+
+        // Filter
+        $filter = new Filter(['v2'], ['read']);
+        $e->loadFilteredPolicy($filter);
+        $this->assertEquals([
+            ['alice', 'data1', 'read'],
+            ['data2_admin', 'data2', 'read'],
+        ], $e->getPolicy());
+
+        // Closure
+        $e->loadFilteredPolicy(function ($query) {
+            $query->where('v1', 'data1');
+        });
+
+        $this->assertEquals([
+            ['alice', 'data1', 'read'],
+        ], $e->getPolicy());
+    }
 }