Merge pull request #6 from basakest/filtered-adapter

feat: support Casbin FilteredAdapter interface

Author: leeqvip

src/Adapter.php

@@ -6,6 +6,10 @@
 use Casbin\Persist\Adapter as AdapterContract;
 use Casbin\Persist\BatchAdapter as BatchAdapterContract;
 use Casbin\Persist\UpdatableAdapter as UpdatableAdapterContract;
+use Casbin\Persist\FilteredAdapter as FilteredAdapterContract;
+use Casbin\Model\Model;
+use Casbin\Persist\Adapters\Filter;
+use Casbin\Exceptions\InvalidFilterTypeException;
 use Casbin\Persist\AdapterHelper;
 use Cake\ORM\TableRegistry;
 use CasbinAdapter\Cake\Model\Table\CasbinRuleTable;
@@ -15,12 +19,17 @@
  *
  * @author [email protected]
  */
-class Adapter implements AdapterContract, BatchAdapterContract, UpdatableAdapterContract
+class Adapter implements AdapterContract, BatchAdapterContract, UpdatableAdapterContract, FilteredAdapterContract
 {
     use AdapterHelper;
 
     protected $table;
 
+    /**
+     * @var bool
+     */
+    private $filtered = false;
+
     public function __construct()
     {
         $this->table = $this->getTable();
@@ -159,6 +168,64 @@ public function updatePolicy(string $sec, string $ptype, array $oldRule, array $
         $this->table->save($first);
     }
 
+    /**
+     * Loads only policy rules that match the filter.
+     *
+     * @param Model $model
+     * @param mixed $filter
+     */
+    public function loadFilteredPolicy(Model $model, $filter): void
+    {
+        $entity = $this->table->find();
+        
+        if (is_string($filter)) {
+            $entity = $entity->epilog('WHERE ' . $filter);
+        } elseif ($filter instanceof Filter) {
+            foreach ($filter->p as $k => $v) {
+                $where[$v] = $filter->g[$k];
+                $entity = $entity->where([$v => $filter->g[$k]]);
+            }
+        } elseif ($filter instanceof \Closure) {
+            $entity = $entity->where($filter);
+        } else {
+            throw new InvalidFilterTypeException('invalid filter type');
+        }
+        $rows = $entity->all();
+        
+        foreach ($rows as $row) {
+            unset($row->id);
+            $row = $row->toArray();
+            $row = array_filter($row, function ($value) {
+                return !is_null($value) && $value !== '';
+            });
+            $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;
+    }
+
     protected function getTable()
     {
         return  TableRegistry::getTableLocator()->get('CasbinRule', [

tests/DatabaseAdapterTest.php

@@ -9,6 +9,8 @@
 use CasbinAdapter\Cake\Casbin;
 use Cake\Filesystem\File;
 use Cake\Filesystem\Folder;
+use Casbin\Persist\Adapters\Filter;
+use Casbin\Exceptions\InvalidFilterTypeException;
 
 class DatabaseAdapterTest extends TestCase
 {
@@ -161,4 +163,47 @@ public function testUpdatePolicy()
             ['data2_admin', 'data2', 'write'],
         ], $e->getPolicy());
     }
+
+    public function testLoadFilteredPolicy()
+    {
+        $e = $this->getEnforcer();
+        $e->clearPolicy();
+        $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) {
+            return $query->and(['v1' => 'data1']);
+        });
+
+        $this->assertEquals([
+            ['alice', 'data1', 'read'],
+        ], $e->getPolicy());
+    }
 }