Work in progress

2024-06-26 18:20:43 +12:00 · 2021-08-19 07:05:44 +03:00 · 2021-08-19 07:05:44 +03:00 · 5811a5680a
parent 266cce237e
commit 5811a5680a
3 changed files with 83 additions and 54 deletions
--- a/app/config/collections2.php
+++ b/app/config/collections2.php
@ -43,6 +43,36 @@ $collections = [
                'array' => false,
                'filters' => [],
            ],
+            [
+                '$id' => 'documentsPermission',
+                'type' => Database::VAR_STRING,
+                'size' => 64,
+                'signed' => true,
+                'required' => false,
+                'default' => null,
+                'array' => false,
+                'filters' => [],
+            ],
+            [
+                '$id' => 'documentsRead',
+                'type' => Database::VAR_STRING,
+                'size' => 64,
+                'signed' => true,
+                'required' => false,
+                'default' => null,
+                'array' => true,
+                'filters' => [],
+            ],
+            [
+                '$id' => 'documentsWrite',
+                'type' => Database::VAR_STRING,
+                'size' => 64,
+                'signed' => true,
+                'required' => false,
+                'default' => null,
+                'array' => true,
+                'filters' => [],
+            ],
            [
                '$id' => 'attributes',
                'type' => Database::VAR_STRING,
--- a/app/controllers/api/database.php
+++ b/app/controllers/api/database.php
@ -27,14 +27,13 @@ use Appwrite\Utopia\Response;
 use Appwrite\Database\Validator\CustomId;
 use DeviceDetector\DeviceDetector;

-$attributesCallback = function ($attribute, $response, $dbForInternal, $dbForExternal, $database, $audits) {
+$attributesCallback = function ($collectionId, $attribute, $response, $dbForInternal, $dbForExternal, $database, $audits) {
    /** @var Utopia\Database\Document $document*/
    /** @var Appwrite\Utopia\Response $response */
    /** @var Utopia\Database\Database $dbForExternal*/
    /** @var Appwrite\Event\Event $database */
    /** @var Appwrite\Event\Event $audits */

-    $collectionId = $attribute->getCollection();
    $attributeId = $attribute->getId();
    $type = $attribute->getAttribute('type', '');
    $size = $attribute->getAttribute('size', 0);
@ -94,7 +93,6 @@ $attributesCallback = function ($attribute, $response, $dbForInternal, $dbForExt
    // TODO@kodumbeats should $signed and $filters be part of the response model?

    $attribute = new Document([
-        '$collection' => $collectionId,
        '$id' => $attributeId,
        'type' => $type,
        'size' => $size,
@ -110,6 +108,7 @@ $attributesCallback = function ($attribute, $response, $dbForInternal, $dbForExt

    $database
        ->setParam('type', DATABASE_TYPE_CREATE_ATTRIBUTE)
+        ->setParam('collection', $collection)
        ->setParam('document', $attribute)
    ;

@ -137,30 +136,32 @@ App::post('/v1/database/collections')
    ->label('sdk.response.model', Response::MODEL_COLLECTION)
    ->param('collectionId', '', new CustomId(), 'Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, and underscore. Can\'t start with a leading underscore. Max length is 36 chars.')
    ->param('name', '', new Text(128), 'Collection name. Max length: 128 chars.')
+    ->param('permission', null, new WhiteList(['document', 'collection']), 'Permissions type model to use for reading documents in this collection. You can use collection-level permission set once on the collection using the `read` and `write` params, or you can set document-level permission where each document read and write params will decide who has access to read and write to each document individually. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
    ->param('read', null, new Permissions(), 'An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
    ->param('write', null, new Permissions(), 'An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
    ->inject('response')
    ->inject('dbForInternal')
    ->inject('dbForExternal')
    ->inject('audits')
-    ->action(function ($collectionId, $name, $read, $write, $response, $dbForInternal, $dbForExternal, $audits) {
+    ->action(function ($collectionId, $name, $permission, $read, $write, $response, $dbForInternal, $dbForExternal, $audits) {
        /** @var Appwrite\Utopia\Response $response */
        /** @var Utopia\Database\Database $dbForExternal*/
        /** @var Appwrite\Event\Event $audits */

        $collectionId = $collectionId == 'unique()' ? $dbForExternal->getId() : $collectionId;

-        $collection = $dbForExternal->createCollection($collectionId);
-
-        // TODO@kodumbeats what should the default permissions be?
-        $read = (is_null($read)) ? ($collection->getRead() ?? []) : $read; // By default inherit read permissions
-        $write = (is_null($write)) ? ($collection->getWrite() ?? []) : $write; // By default inherit write permissions
-
        try {
+            $dbForExternal->createCollection($collectionId);
+
            $collection = $dbForInternal->createDocument('collections', new Document([
                '$id' => $collectionId,
-                '$read' => $read,
-                '$write' => $write,
+                '$read' => [], // Collection permissions themselves
+                '$write' => [], // Collection permissions themselves
+                'dateCreated' => time(),
+                'dateUpdated' => time(),
+                'documentsPermission' => $permission, // Permissions model type (document vs collection)
+                'documentsRead' => $read ?? [], // Collection permissions for collection documents (based on permission model)
+                'documentsWrite' => $write ?? [], // Collection permissions for collection documents (based on permission model)
                'name' => $name,
                'search' => implode(' ', [$collectionId, $name]),
            ]));
@ -357,12 +358,13 @@ App::put('/v1/database/collections/:collectionId')
    ->label('sdk.response.model', Response::MODEL_COLLECTION)
    ->param('collectionId', '', new UID(), 'Collection unique ID.')
    ->param('name', null, new Text(128), 'Collection name. Max length: 128 chars.')
+    ->param('permission', null, new WhiteList(['document', 'collection']), 'Permissions type model to use for reading documents in this collection. You can use collection-level permission set once on the collection using the `read` and `write` params, or you can set document-level permission where each document read and write params will decide who has access to read and write to each document individually. [learn more about permissions](/docs/permissions) and get a full list of available permissions.')
    ->param('read', null, new Permissions(), 'An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.', true)
    ->param('write', null, new Permissions(), 'An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.', true)
    ->inject('response')
    ->inject('dbForInternal')
    ->inject('audits')
-    ->action(function ($collectionId, $name, $read, $write, $response, $dbForInternal, $audits) {
+    ->action(function ($collectionId, $name, $permission, $read, $write, $response, $dbForInternal, $audits) {
        /** @var Appwrite\Utopia\Response $response */
        /** @var Utopia\Database\Database $dbForInternal */
        /** @var Appwrite\Event\Event $audits */
@ -378,14 +380,18 @@ App::put('/v1/database/collections/:collectionId')

        try {
            $collection = $dbForInternal->updateDocument('collections', $collection->getId(), $collection
-                ->setAttribute('$read', $read)
-                ->setAttribute('$write', $write)
                ->setAttribute('name', $name)
+                ->setAttribute('dateUpdated', time())
+                ->setAttribute('documentsPermission', $permission)
+                ->setAttribute('documentsRead', $read)
+                ->setAttribute('documentsWrite', $write)
                ->setAttribute('search', implode(' ', [$collectionId, $name]))
            );
-        } catch (AuthorizationException $exception) {
+        }
+        catch (AuthorizationException $exception) {
            throw new Exception('Unauthorized permissions', 401);
-        } catch (StructureException $exception) {
+        }
+        catch (StructureException $exception) {
            throw new Exception('Bad structure. '.$exception->getMessage(), 400);
        }

@ -429,7 +435,7 @@ App::delete('/v1/database/collections/:collectionId')
            throw new Exception('Collection not found', 404);
        }

-        $dbForExternal->deleteCollection($collectionId);
+        $dbForExternal->deleteCollection($collectionId); // TDOD move to DB worker

        if (!$dbForInternal->deleteDocument('collections', $collectionId)) {
            throw new Exception('Failed to remove collection from DB', 500);
@ -478,8 +484,7 @@ App::post('/v1/database/collections/:collectionId/attributes/string')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_STRING,
            'size' => $size,
@ -518,8 +523,7 @@ App::post('/v1/database/collections/:collectionId/attributes/email')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_STRING,
            'size' => 254,
@ -559,8 +563,7 @@ App::post('/v1/database/collections/:collectionId/attributes/ip')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_STRING,
            'size' => 39,
@ -601,8 +604,7 @@ App::post('/v1/database/collections/:collectionId/attributes/url')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_STRING,
            'size' => $size,
@ -644,8 +646,7 @@ App::post('/v1/database/collections/:collectionId/attributes/integer')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_INTEGER,
            'size' => 0,
@ -691,8 +692,7 @@ App::post('/v1/database/collections/:collectionId/attributes/float')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_FLOAT,
            'required' => $required,
@ -736,8 +736,7 @@ App::post('/v1/database/collections/:collectionId/attributes/boolean')
        /** @var Appwrite\Event\Event $database */
        /** @var Appwrite\Event\Event $audits */

-        return $attributesCallback(new Document([
-            '$collection' => $collectionId,
+        return $attributesCallback($collectionId, new Document([
            '$id' => $attributeId,
            'type' => Database::VAR_BOOLEAN,
            'size' => 0,
--- a/app/workers/database.php
+++ b/app/workers/database.php
@ -20,31 +20,27 @@ class DatabaseV1 extends Worker

    public function run(): void
    {
+        Authorization::disable();
+        
        $projectId = $this->args['projectId'] ?? '';
        $type = $this->args['type'] ?? '';
-
-        Authorization::disable();
+        $collection = $this->args['collection'] ?? '';
+        $collection = new Document($collection);
+        $document = $this->args['document'] ?? '';
+        $document = new Document($document);
        
        switch (strval($type)) {
            case DATABASE_TYPE_CREATE_ATTRIBUTE:
-                $attribute = $this->args['document'] ?? '';
-                $attribute = new Document($attribute);
-                $this->createAttribute($attribute, $projectId);
+                $this->createAttribute($collection, $document, $projectId);
                break;
            case DATABASE_TYPE_DELETE_ATTRIBUTE:
-                $attribute = $this->args['document'] ?? '';
-                $attribute = new Document($attribute);
-                $this->deleteAttribute($attribute, $projectId);
+                $this->deleteAttribute($collection, $document, $projectId);
                break;
            case DATABASE_TYPE_CREATE_INDEX:
-                $index = $this->args['document'] ?? '';
-                $index = new Document($index);
-                $this->createIndex($index, $projectId);
+                $this->createIndex($collection, $document, $projectId);
                break;
            case DATABASE_TYPE_DELETE_INDEX:
-                $index = $this->args['document'] ?? '';
-                $index = new Document($index);
-                $this->deleteIndex($index, $projectId);
+                $this->deleteIndex($collection, $document, $projectId);
                break;

            default:
@ -60,14 +56,15 @@ class DatabaseV1 extends Worker
    }

    /**
+     * @param Document $collection
     * @param Document $attribute
     * @param string $projectId
     */
-    protected function createAttribute($attribute, $projectId): void
+    protected function createAttribute(Document $collection, Document $attribute, string $projectId): void
    {
        $dbForExternal = $this->getExternalDB($projectId);

-        $collectionId = $attribute->getCollection();
+        $collectionId = $collection->getId();
        $id = $attribute->getAttribute('$id', '');
        $type = $attribute->getAttribute('type', '');
        $size = $attribute->getAttribute('size', 0);
@ -85,28 +82,30 @@ class DatabaseV1 extends Worker
    }

    /**
+     * @param Document $collection
     * @param Document $attribute
     * @param string $projectId
     */
-    protected function deleteAttribute($attribute, $projectId): void
+    protected function deleteAttribute(Document $collection, Document $attribute, string $projectId): void
    {
        $dbForExternal = $this->getExternalDB($projectId);

-        $collectionId = $attribute->getCollection();
+        $collectionId = $collection->getId();
        $id = $attribute->getAttribute('$id');

        $success = $dbForExternal->deleteAttribute($collectionId, $id);
    }

    /**
+     * @param Document $collection
     * @param Document $index
     * @param string $projectId
     */
-    protected function createIndex($index, $projectId): void
+    protected function createIndex(Document $collection, Document $index, string $projectId): void
    {
        $dbForExternal = $this->getExternalDB($projectId);

-        $collectionId = $index->getCollection();
+        $collectionId = $collection->getId();
        $id = $index->getAttribute('$id', '');
        $type = $index->getAttribute('type', '');
        $attributes = $index->getAttribute('attributes', []);
@ -120,14 +119,15 @@ class DatabaseV1 extends Worker
    }

    /**
+     * @param Document $collection
     * @param Document $index
     * @param string $projectId
     */
-    protected function deleteIndex($index, $projectId): void
+    protected function deleteIndex(Document $collection, Document $index, string $projectId): void
    {
        $dbForExternal = $this->getExternalDB($projectId);

-        $collectionId = $index->getCollection();
+        $collectionId = $collection->getId();
        $id = $index->getAttribute('$id');

        $success = $dbForExternal->deleteIndex($collectionId, $id);