Add variable endpoints for sites

2026-05-23 17:08:45 +00:00 · 2024-10-24 10:49:43 +02:00 · 2024-10-24 10:49:43 +02:00 · 8f5fa84996
commit 8f5fa84996
parent 9793cf4ece
8 changed files with 448 additions and 1 deletions
--- a/app/init.php
+++ b/app/init.php
@ -558,7 +558,7 @@ Database::addFilter(
        return $database
            ->find('variables', [
                Query::equal('resourceInternalId', [$document->getInternalId()]),
-                Query::equal('resourceType', ['function']),
+                Query::equal('resourceType', ['function', 'site']),
                Query::limit(APP_LIMIT_SUBQUERY),
            ]);
    }
--- a/src/Appwrite/Platform/Modules/Sites/Http/Sites/DeleteSite.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Sites/DeleteSite.php
@ -0,0 +1,69 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Sites;
+
+use Appwrite\Event\Delete;
+use Appwrite\Event\Event;
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+
+class DeleteSite extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'deleteSite';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_DELETE)
+            ->setHttpPath('/v1/sites/:siteId')
+            ->desc('Delete site')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.write') // TODO: Update scope to sites.write
+            ->label('event', 'sites.[siteId].delete')
+            ->label('audits.event', 'site.delete')
+            ->label('audits.resource', 'site/{request.siteId}')
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'delete')
+            ->label('sdk.description', '/docs/references/sites/delete-site.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
+            ->label('sdk.response.model', Response::MODEL_NONE)
+            ->param('siteId', '', new UID(), 'Site ID.')
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('queueForDeletes')
+            ->inject('queueForEvents')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, Response $response, Database $dbForProject, Delete $queueForDeletes, Event $queueForEvents)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        if (!$dbForProject->deleteDocument('sites', $site->getId())) {
+            throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed to remove site from DB');
+        }
+
+        $queueForDeletes
+            ->setType(DELETE_TYPE_DOCUMENT)
+            ->setDocument($site);
+
+        $queueForEvents->setParam('siteId', $site->getId());
+
+        $response->noContent();
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Http/Variables/CreateVariable.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Variables/CreateVariable.php
@ -0,0 +1,91 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Variables;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Exception\Duplicate as DuplicateException;
+use Utopia\Database\Helpers\ID;
+use Utopia\Database\Helpers\Permission;
+use Utopia\Database\Helpers\Role;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Validator\Text;
+
+class CreateVariable extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'createVariable';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_POST)
+            ->setHttpPath('/v1/sites/:siteId/variables')
+            ->desc('Create variable')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.write') // TODO: Update scope to sites.write
+            ->label('audits.event', 'variable.create')
+            ->label('audits.resource', 'site/{request.siteId}')
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'createVariable')
+            ->label('sdk.description', '/docs/references/sites/create-variable.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_VARIABLE)
+            ->param('siteId', '', new UID(), 'Site unique ID.', false)
+            ->param('key', null, new Text(Database::LENGTH_KEY), 'Variable key. Max length: ' . Database::LENGTH_KEY  . ' chars.', false)
+            ->param('value', null, new Text(8192, 0), 'Variable value. Max length: 8192 chars.', false)
+            ->inject('response')
+            ->inject('dbForProject')
+            ->inject('dbForConsole')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, string $key, string $value, Response $response, Database $dbForProject, Database $dbForConsole)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $variableId = ID::unique();
+
+        $variable = new Document([
+            '$id' => $variableId,
+            '$permissions' => [
+                Permission::read(Role::any()),
+                Permission::update(Role::any()),
+                Permission::delete(Role::any()),
+            ],
+            'resourceInternalId' => $site->getInternalId(),
+            'resourceId' => $site->getId(),
+            'resourceType' => 'site',
+            'key' => $key,
+            'value' => $value,
+            'search' => implode(' ', [$variableId, $site->getId(), $key, 'site']),
+        ]);
+
+        try {
+            $variable = $dbForProject->createDocument('variables', $variable);
+        } catch (DuplicateException $th) {
+            throw new Exception(Exception::VARIABLE_ALREADY_EXISTS);
+        }
+
+        $dbForProject->updateDocument('sites', $site->getId(), $site->setAttribute('live', false));
+
+        $response
+            ->setStatusCode(Response::STATUS_CODE_CREATED)
+            ->dynamic($variable, Response::MODEL_VARIABLE);
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Http/Variables/DeleteVariable.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Variables/DeleteVariable.php
@ -0,0 +1,68 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Variables;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+
+class DeleteVariable extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'deleteVariable';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_DELETE)
+            ->setHttpPath('/v1/sites/:siteId/variables/:variableId')
+            ->desc('Delete variable')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.write') // TODO: Update scope to sites
+            ->label('audits.event', 'variable.delete')
+            ->label('audits.resource', 'site/{request.siteId}')
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'deleteVariable')
+            ->label('sdk.description', '/docs/references/sites/delete-variable.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
+            ->label('sdk.response.model', Response::MODEL_NONE)
+            ->param('siteId', '', new UID(), 'Site unique ID.', false)
+            ->param('variableId', '', new UID(), 'Variable unique ID.', false)
+            ->inject('response')
+            ->inject('dbForProject')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, string $variableId, Response $response, Database $dbForProject)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $variable = $dbForProject->getDocument('variables', $variableId);
+        if ($variable === false || $variable->isEmpty() || $variable->getAttribute('resourceInternalId') !== $site->getInternalId() || $variable->getAttribute('resourceType') !== 'site') {
+            throw new Exception(Exception::VARIABLE_NOT_FOUND);
+        }
+
+        if ($variable === false || $variable->isEmpty()) {
+            throw new Exception(Exception::VARIABLE_NOT_FOUND);
+        }
+
+        $dbForProject->deleteDocument('variables', $variable->getId());
+
+        $dbForProject->updateDocument('sites', $site->getId(), $site->setAttribute('live', false));
+
+        $response->noContent();
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Http/Variables/GetVariable.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Variables/GetVariable.php
@ -0,0 +1,68 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Variables;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+
+class GetVariable extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'getVariable';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_GET)
+            ->setHttpPath('/v1/sites/:siteId/variables/:variableId')
+            ->desc('Get variable')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.read') // TODO: Update scope to sites
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'getVariable')
+            ->label('sdk.description', '/docs/references/sites/get-variable.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_VARIABLE)
+            ->param('siteId', '', new UID(), 'Site unique ID.', false)
+            ->param('variableId', '', new UID(), 'Variable unique ID.', false)
+            ->inject('response')
+            ->inject('dbForProject')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, string $variableId, Response $response, Database $dbForProject)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $variable = $dbForProject->getDocument('variables', $variableId);
+        if (
+            $variable === false ||
+            $variable->isEmpty() ||
+            $variable->getAttribute('resourceInternalId') !== $site->getInternalId() ||
+            $variable->getAttribute('resourceType') !== 'site'
+        ) {
+            throw new Exception(Exception::VARIABLE_NOT_FOUND);
+        }
+
+        if ($variable === false || $variable->isEmpty()) {
+            throw new Exception(Exception::VARIABLE_NOT_FOUND);
+        }
+
+        $response->dynamic($variable, Response::MODEL_VARIABLE);
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Http/Variables/ListVariables.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Variables/ListVariables.php
@ -0,0 +1,57 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Variables;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+
+class ListVariables extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'listVariables';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_GET)
+            ->setHttpPath('/v1/sites/:siteId/variables')
+            ->desc('List variables')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.read') // TODO: Update scope to sites
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'listVariables')
+            ->label('sdk.description', '/docs/references/sites/list-variables.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_VARIABLE_LIST)
+            ->param('siteId', '', new UID(), 'Site unique ID.', false)
+            ->inject('response')
+            ->inject('dbForProject')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, Response $response, Database $dbForProject)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $response->dynamic(new Document([
+            'variables' => $site->getAttribute('vars', []),
+            'total' => \count($site->getAttribute('vars', [])),
+        ]), Response::MODEL_VARIABLE_LIST);
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Http/Variables/UpdateVariable.php
+++ b/src/Appwrite/Platform/Modules/Sites/Http/Variables/UpdateVariable.php
@ -0,0 +1,82 @@
+<?php
+
+namespace Appwrite\Platform\Modules\Sites\Http\Variables;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Platform\Modules\Compute\Base;
+use Appwrite\Utopia\Response;
+use Utopia\Database\Database;
+use Utopia\Database\Exception\Duplicate as DuplicateException;
+use Utopia\Database\Validator\UID;
+use Utopia\Platform\Action;
+use Utopia\Platform\Scope\HTTP;
+use Utopia\Validator\Text;
+
+class UpdateVariable extends Base
+{
+    use HTTP;
+
+    public static function getName()
+    {
+        return 'updateVariable';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->setHttpMethod(Action::HTTP_REQUEST_METHOD_PUT)
+            ->setHttpPath('/v1/sites/:siteId/variables/:variableId')
+            ->desc('Update variable')
+            ->groups(['api', 'sites'])
+            ->label('scope', 'functions.write') // TODO: Update scope to sites
+            ->label('audits.event', 'variable.update')
+            ->label('audits.resource', 'site/{request.siteId}')
+            ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
+            ->label('sdk.namespace', 'sites')
+            ->label('sdk.method', 'updateVariable')
+            ->label('sdk.description', '/docs/references/sites/update-variable.md')
+            ->label('sdk.response.code', Response::STATUS_CODE_OK)
+            ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
+            ->label('sdk.response.model', Response::MODEL_VARIABLE)
+            ->param('siteId', '', new UID(), 'Site unique ID.', false)
+            ->param('variableId', '', new UID(), 'Variable unique ID.', false)
+            ->param('key', null, new Text(255), 'Variable key. Max length: 255 chars.', false)
+            ->param('value', null, new Text(8192, 0), 'Variable value. Max length: 8192 chars.', true)
+            ->inject('response')
+            ->inject('dbForProject')
+            ->callback([$this, 'action']);
+    }
+
+    public function action(string $siteId, string $variableId, string $key, ?string $value, Response $response, Database $dbForProject)
+    {
+        $site = $dbForProject->getDocument('sites', $siteId);
+
+        if ($site->isEmpty()) {
+            throw new Exception(Exception::SITE_NOT_FOUND);
+        }
+
+        $variable = $dbForProject->getDocument('variables', $variableId);
+        if ($variable === false || $variable->isEmpty() || $variable->getAttribute('resourceInternalId') !== $site->getInternalId() || $variable->getAttribute('resourceType') !== 'site') {
+            throw new Exception(Exception::VARIABLE_NOT_FOUND);
+        }
+
+        if ($variable === false || $variable->isEmpty()) {
+            throw new Exception(Exception::VARIABLE_NOT_FOUND);
+        }
+
+        $variable
+            ->setAttribute('key', $key)
+            ->setAttribute('value', $value ?? $variable->getAttribute('value'))
+            ->setAttribute('search', implode(' ', [$variableId, $site->getId(), $key, 'site']));
+
+        try {
+            $dbForProject->updateDocument('variables', $variable->getId(), $variable);
+        } catch (DuplicateException $th) {
+            throw new Exception(Exception::VARIABLE_ALREADY_EXISTS);
+        }
+
+        $dbForProject->updateDocument('sites', $site->getId(), $site->setAttribute('live', false));
+
+        $response->dynamic($variable, Response::MODEL_VARIABLE);
+    }
+}
--- a/src/Appwrite/Platform/Modules/Sites/Services/Http.php
+++ b/src/Appwrite/Platform/Modules/Sites/Services/Http.php
@ -11,10 +11,16 @@ use Appwrite\Platform\Modules\Sites\Http\Deployments\ListDeployments;
 use Appwrite\Platform\Modules\Sites\Http\Deployments\RebuildDeployment;
 use Appwrite\Platform\Modules\Sites\Http\Deployments\UpdateDeployment;
 use Appwrite\Platform\Modules\Sites\Http\Sites\CreateSite;
+use Appwrite\Platform\Modules\Sites\Http\Sites\DeleteSite;
 use Appwrite\Platform\Modules\Sites\Http\Sites\GetSite;
 use Appwrite\Platform\Modules\Sites\Http\Sites\ListFrameworks;
 use Appwrite\Platform\Modules\Sites\Http\Sites\ListSites;
 use Appwrite\Platform\Modules\Sites\Http\Sites\UpdateSite;
+use Appwrite\Platform\Modules\Sites\Http\Variables\CreateVariable;
+use Appwrite\Platform\Modules\Sites\Http\Variables\DeleteVariable;
+use Appwrite\Platform\Modules\Sites\Http\Variables\GetVariable;
+use Appwrite\Platform\Modules\Sites\Http\Variables\ListVariables;
+use Appwrite\Platform\Modules\Sites\Http\Variables\UpdateVariable;
 use Utopia\Platform\Service;

 class Http extends Service
@ -26,6 +32,7 @@ class Http extends Service
        $this->addAction(GetSite::getName(), new GetSite());
        $this->addAction(ListSites::getName(), new ListSites());
        $this->addAction(UpdateSite::getName(), new UpdateSite());
+        $this->addAction(DeleteSite::getName(), new DeleteSite());
        $this->addAction(ListFrameworks::getName(), new ListFrameworks());
        $this->addAction(CreateDeployment::getName(), new CreateDeployment());
        $this->addAction(GetDeployment::getName(), new GetDeployment());
@ -35,5 +42,10 @@ class Http extends Service
        $this->addAction(DownloadDeployment::getName(), new DownloadDeployment());
        $this->addAction(RebuildDeployment::getName(), new RebuildDeployment());
        $this->addAction(CancelDeployment::getName(), new CancelDeployment());
+        $this->addAction(CreateVariable::getName(), new CreateVariable());
+        $this->addAction(GetVariable::getName(), new GetVariable());
+        $this->addAction(ListVariables::getName(), new ListVariables());
+        $this->addAction(UpdateVariable::getName(), new UpdateVariable());
+        $this->addAction(DeleteVariable::getName(), new DeleteVariable());
    }
 }