feat: support Casbin FilteredAdapter interface

Author: basakest

src/Adapter.php

@@ -4,23 +4,31 @@
 
 use Casbin\Persist\Adapter as AdapterContract;
 use Casbin\Persist\BatchAdapter as BatchAdapterContract;
+use Casbin\Persist\FilteredAdapter as FilteredAdapterContract;
 use Casbin\Persist\AdapterHelper;
 use Laminas\Db\Adapter\AdapterInterface as LaminasDbAdapterInterface;
 use Laminas\Db\Adapter\Adapter as LaminasDbAdapter;
 use Laminas\Db\TableGateway\TableGateway;
 use Laminas\Db\TableGateway\TableGatewayInterface;
 use Laminas\Db\Sql\Select;
 use Casbin\Model\Model;
+use Casbin\Persist\Adapters\Filter;
+use Casbin\Exceptions\InvalidFilterTypeException;
 
 /**
  * Laminas DB Adapter for Casbin.
  *
  * @author [email protected]
  */
-class Adapter implements AdapterContract, BatchAdapterContract
+class Adapter implements AdapterContract, BatchAdapterContract, FilteredAdapterContract
 {
     use AdapterHelper;
 
+    /**
+     * @var bool
+     */
+    private $filtered = false;
+
     /**
      * @var TableGatewayInterface
      */
@@ -235,4 +243,57 @@ public function removeFilteredPolicy($sec, $ptype, $fieldIndex, ...$fieldValues)
 
         $this->tableGateway->delete($where);
     }
+
+    /**
+     * Loads only policy rules that match the filter.
+     *
+     * @param Model $model
+     * @param mixed $filter
+     */
+    public function loadFilteredPolicy(Model $model, $filter): void
+    {
+        if (is_string($filter)) {
+            $where = $filter;
+        } elseif ($filter instanceof Filter) {
+            foreach ($filter->p as $k => $v) {
+                $where[$v] = $filter->g[$k];
+            }
+        } elseif ($filter instanceof \Closure) {
+            $where = $filter;
+        } else {
+            throw new InvalidFilterTypeException('invalid filter type');
+        }
+        $rows = $this->tableGateway->select($where)->toArray();
+
+        foreach ($rows as $row) {
+            $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;
+    }
 }

tests/AdapterTest.php

@@ -11,6 +11,9 @@
 use Laminas\Db\Sql\Ddl\CreateTable;
 use Laminas\Db\Sql\Ddl\Column\Varchar;
 use Laminas\Db\Sql\Sql;
+use Casbin\Persist\Adapters\Filter;
+use Casbin\Exceptions\InvalidFilterTypeException;
+use Laminas\Db\Sql\Select;
 
 class AdapterTest extends TestCase
 {
@@ -217,6 +220,49 @@ public function testRemoveFilteredPolicy()
         $this->assertFalse($e->enforce('alice', 'data2', 'write'));
     }
 
+    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 (Select $select) {
+            return $select->where(['v1' => 'data1']);
+        });
+
+        $this->assertEquals([
+            ['alice', 'data1', 'read'],
+        ], $e->getPolicy());
+    }
+
     protected function env($key, $default = null)
     {
         $value = getenv($key);