created a helper for the duplicated logic between realtime and http api

2026-05-26 13:51:13 +00:00 · 2026-04-17 12:01:34 +05:30
parent 52dbf14d79
commit ee34e2b587
1 changed files with 131 additions and 0 deletions
@@ -0,0 +1,131 @@
+<?php
+
+namespace Appwrite\Databases;
+
+use Appwrite\Extend\Exception;
+use Appwrite\Utopia\Database\Documents\User;
+use Utopia\Database\Database;
+use Utopia\Database\Document;
+use Utopia\Database\Exception\Conflict as ConflictException;
+use Utopia\Database\Exception\Duplicate as DuplicateException;
+use Utopia\Database\Exception\NotFound as NotFoundException;
+use Utopia\Database\Exception\Relationship as RelationshipException;
+use Utopia\Database\Exception\Structure as StructureException;
+use Utopia\Database\Helpers\Permission;
+use Utopia\Database\Helpers\Role;
+use Utopia\Database\Query;
+use Utopia\Database\Validator\Authorization;
+
+class PresenceState
+{
+    public function setPermissions(Document $document, ?array $permissions, User $user, Authorization $authorization): Document
+    {
+        $isAPIKey = $user->isApp($authorization->getRoles());
+        $isPrivilegedUser = $user->isPrivileged($authorization->getRoles());
+
+        $allowedPermissions = [
+            Database::PERMISSION_READ,
+            Database::PERMISSION_UPDATE,
+            Database::PERMISSION_DELETE,
+            Database::PERMISSION_WRITE,
+        ];
+
+        $permissions = Permission::aggregate($permissions, $allowedPermissions);
+
+        if (\is_null($permissions)) {
+            $permissions = [];
+            if (!empty($user->getId()) && !$isPrivilegedUser) {
+                foreach ($allowedPermissions as $permission) {
+                    $permissions[] = (new Permission($permission, 'user', $user->getId()))->toString();
+                }
+            }
+        }
+
+        if (!$isAPIKey && !$isPrivilegedUser) {
+            $this->assertPermissionsAgainstAuthorization($permissions, $authorization);
+        }
+
+        sort($permissions, SORT_STRING);
+        $document->setAttribute('$permissions', $permissions);
+
+        return $document;
+    }
+
+    public function upsertForUser(Database $dbForProject, Document $presenceDocument, string $presenceId, string $userId): Document
+    {
+        if ($presenceId !== 'unique()') {
+            $presenceDocument->setAttribute('$id', $presenceId);
+        }
+
+        try {
+            return $dbForProject->upsertDocument('presenceLogs', $presenceDocument);
+        } catch (DuplicateException $e) {
+            return $this->upsertFallback($dbForProject, $presenceDocument, $presenceId, $userId, $e);
+        } catch (NotFoundException $e) {
+            throw new Exception(Exception::DOCUMENT_NOT_FOUND, params: [$presenceId], previous: $e);
+        } catch (StructureException $e) {
+            throw new Exception(Exception::DOCUMENT_INVALID_STRUCTURE, $e->getMessage(), previous: $e);
+        } catch (ConflictException $e) {
+            throw new Exception(Exception::DOCUMENT_UPDATE_CONFLICT, $e->getMessage(), previous: $e);
+        }
+    }
+
+    private function upsertFallback(
+        Database $dbForProject,
+        Document $presenceDocument,
+        string $presenceId,
+        string $userId,
+        DuplicateException $previous
+    ): Document {
+        try {
+            return $dbForProject->withTransaction(function () use ($dbForProject, $presenceDocument, $presenceId, $userId, $previous) {
+                $existingPresence = $dbForProject->findOne('presenceLogs', [Query::equal('userId', [$userId])]);
+
+                if ($existingPresence->isEmpty()) {
+                    throw new Exception(Exception::DOCUMENT_ALREADY_EXISTS, params: [$presenceId], previous: $previous);
+                }
+
+                // Lock the current state before update to avoid races on duplicate fallback.
+                $currentPresence = $dbForProject->getDocument('presenceLogs', $existingPresence->getId(), forUpdate: true);
+
+                if ($currentPresence->isEmpty()) {
+                    throw new Exception(Exception::DOCUMENT_NOT_FOUND, params: [$existingPresence->getId()]);
+                }
+
+                return $dbForProject->updateDocument('presenceLogs', $currentPresence->getId(), $presenceDocument);
+            });
+        } catch (DuplicateException $e) {
+            throw new Exception(Exception::DOCUMENT_ALREADY_EXISTS, params: [$presenceId], previous: $e);
+        } catch (NotFoundException $e) {
+            throw new Exception(Exception::DOCUMENT_NOT_FOUND, params: [$presenceId], previous: $e);
+        } catch (RelationshipException $e) {
+            throw new Exception(Exception::RELATIONSHIP_VALUE_INVALID, $e->getMessage(), previous: $e);
+        } catch (StructureException $e) {
+            throw new Exception(Exception::DOCUMENT_INVALID_STRUCTURE, $e->getMessage(), previous: $e);
+        } catch (ConflictException $e) {
+            throw new Exception(Exception::DOCUMENT_UPDATE_CONFLICT, $e->getMessage(), previous: $e);
+        }
+    }
+
+    private function assertPermissionsAgainstAuthorization(array $permissions, Authorization $authorization): void
+    {
+        foreach (Database::PERMISSIONS as $type) {
+            foreach ($permissions as $permission) {
+                $permission = Permission::parse($permission);
+                if ($permission->getPermission() != $type) {
+                    continue;
+                }
+
+                $role = (new Role(
+                    $permission->getRole(),
+                    $permission->getIdentifier(),
+                    $permission->getDimension()
+                ))->toString();
+
+                if (!$authorization->hasRole($role)) {
+                    throw new Exception(Exception::USER_UNAUTHORIZED, 'Permissions must be one of: (' . \implode(', ', $authorization->getRoles()) . ')');
+                }
+            }
+        }
+    }
+}