Merge branch 'master' into feat-simplify-exceptions

src/Appwrite/Auth/OAuth2/Authentik.php

@@ -0,0 +1,227 @@
+<?php
+
+namespace Appwrite\Auth\OAuth2;
+
+use Appwrite\Auth\OAuth2;
+
+// Reference Material
+// https://goauthentik.io/docs/providers/oauth2/
+
+class Authentik extends OAuth2
+{
+    /**
+     * @var array
+     */
+    protected array $scopes = [
+        'openid',
+        'profile',
+        'email',
+        'offline_access'
+    ];
+
+    /**
+     * @var array
+     */
+    protected array $user = [];
+
+    /**
+     * @var array
+     */
+    protected array $tokens = [];
+
+    /**
+     * @return string
+     */
+    public function getName(): string
+    {
+        return 'authentik';
+    }
+
+    /**
+     * @return string
+     */
+    public function getLoginURL(): string
+    {
+        return 'https://' . $this->getAuthentikDomain() . '/application/o/authorize?' . \http_build_query([
+            'client_id' => $this->appID,
+            'redirect_uri' => $this->callback,
+            'state' => \json_encode($this->state),
+            'scope' => \implode(' ', $this->getScopes()),
+            'response_type' => 'code'
+        ]);
+    }
+
+    /**
+     * @param string $code
+     *
+     * @return array
+     */
+    protected function getTokens(string $code): array
+    {
+        if (empty($this->tokens)) {
+            $headers = ['Content-Type: application/x-www-form-urlencoded'];
+            $this->tokens = \json_decode($this->request(
+                'POST',
+                'https://' . $this->getAuthentikDomain() . '/application/o/token/',
+                $headers,
+                \http_build_query([
+                    'code' => $code,
+                    'client_id' => $this->appID,
+                    'client_secret' => $this->getClientSecret(),
+                    'redirect_uri' => $this->callback,
+                    'scope' => \implode(' ', $this->getScopes()),
+                    'grant_type' => 'authorization_code'
+                ])
+            ), true);
+        }
+        return $this->tokens;
+    }
+
+
+    /**
+     * @param string $refreshToken
+     *
+     * @return array
+     */
+    public function refreshTokens(string $refreshToken): array
+    {
+        $headers = ['Content-Type: application/x-www-form-urlencoded'];
+        $this->tokens = \json_decode($this->request(
+            'POST',
+            'https://' . $this->getAuthentikDomain() . '/application/o/token/',
+            $headers,
+            \http_build_query([
+                'refresh_token' => $refreshToken,
+                'client_id' => $this->appID,
+                'client_secret' => $this->getClientSecret(),
+                'grant_type' => 'refresh_token'
+            ])
+        ), true);
+
+        if (empty($this->tokens['refresh_token'])) {
+            $this->tokens['refresh_token'] = $refreshToken;
+        }
+
+        return $this->tokens;
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return string
+     */
+    public function getUserID(string $accessToken): string
+    {
+        $user = $this->getUser($accessToken);
+
+        if (isset($user['sub'])) {
+            return $user['sub'];
+        }
+
+        return '';
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return string
+     */
+    public function getUserEmail(string $accessToken): string
+    {
+        $user = $this->getUser($accessToken);
+
+        if (isset($user['email'])) {
+            return $user['email'];
+        }
+
+        return '';
+    }
+
+    /**
+     * Check if the User email is verified
+     *
+     * @param string $accessToken
+     *
+     * @return bool
+     */
+    public function isEmailVerified(string $accessToken): bool
+    {
+        $user = $this->getUser($accessToken);
+
+        if ($user['email_verified'] ?? false) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return string
+     */
+    public function getUserName(string $accessToken): string
+    {
+        $user = $this->getUser($accessToken);
+
+        if (isset($user['name'])) {
+            return $user['name'];
+        }
+
+        return '';
+    }
+
+     /**
+     * @param string $accessToken
+     *
+     * @return array
+     */
+    protected function getUser(string $accessToken): array
+    {
+        if (empty($this->user)) {
+            $headers = ['Authorization: Bearer ' . \urlencode($accessToken)];
+            $user = $this->request('GET', 'https://' . $this->getAuthentikDomain() . '/application/o/userinfo/', $headers);
+            $this->user = \json_decode($user, true);
+        }
+
+        return $this->user;
+    }
+
+    /**
+     * Extracts the Client Secret from the JSON stored in appSecret
+     *
+     * @return string
+     */
+    protected function getClientSecret(): string
+    {
+        $secret = $this->getAppSecret();
+
+        return $secret['clientSecret'] ?? '';
+    }
+
+     /**
+     * Extracts the authentik Domain from the JSON stored in appSecret
+     *
+     * @return string
+     */
+    protected function getAuthentikDomain(): string
+    {
+        $secret = $this->getAppSecret();
+        return $secret['authentikDomain'] ?? '';
+    }
+
+    /**
+     * Decode the JSON stored in appSecret
+     *
+     * @return array
+     */
+    protected function getAppSecret(): array
+    {
+        try {
+            $secret = \json_decode($this->appSecret, true, 512, JSON_THROW_ON_ERROR);
+        } catch (\Throwable $th) {
+            throw new \Exception('Invalid secret');
+        }
+        return $secret;
+    }
+}

src/Appwrite/Auth/OAuth2/Podio.php

@@ -0,0 +1,199 @@
+<?php
+
+namespace Appwrite\Auth\OAuth2;
+
+use Appwrite\Auth\OAuth2;
+
+// Reference Material
+// https://developers.podio.com/doc/oauth-authorization
+
+class Podio extends OAuth2
+{
+    /**
+     * Endpoint used for initiating OAuth flow
+     *
+     * @var string
+     */
+    private string $endpoint = 'https://podio.com/oauth';
+
+    /**
+     * Endpoint for communication with API server
+     *
+     * @var string
+     */
+    private string $apiEndpoint = 'https://api.podio.com';
+
+    /**
+     * @var array
+     */
+    protected array $user = [];
+
+    /**
+     * @var array
+     */
+    protected array $tokens = [];
+
+    /**
+     * @var array
+     */
+    protected array $scopes = []; // No scopes required
+
+    /**
+     * @return string
+     */
+    public function getName(): string
+    {
+        return 'podio';
+    }
+
+    /**
+     * @return string
+     */
+    public function getLoginURL(): string
+    {
+        $url = $this->endpoint . '/authorize?' .
+            \http_build_query([
+                'client_id' => $this->appID,
+                'state' => \json_encode($this->state),
+                'redirect_uri' => $this->callback
+            ]);
+
+        return $url;
+    }
+
+    /**
+     * @param string $code
+     *
+     * @return array
+     */
+    protected function getTokens(string $code): array
+    {
+        if (empty($this->tokens)) {
+            $this->tokens = \json_decode($this->request(
+                'POST',
+                $this->apiEndpoint . '/oauth/token',
+                ['Content-Type: application/x-www-form-urlencoded'],
+                \http_build_query([
+                    'grant_type' => 'authorization_code',
+                    'code' => $code,
+                    'redirect_uri' => $this->callback,
+                    'client_id' => $this->appID,
+                    'client_secret' => $this->appSecret
+                ])
+            ), true);
+        }
+
+        return $this->tokens;
+    }
+
+    /**
+     * @param string $refreshToken
+     *
+     * @return array
+     */
+    public function refreshTokens(string $refreshToken): array
+    {
+        $this->tokens = \json_decode($this->request(
+            'POST',
+            $this->apiEndpoint . '/oauth/token',
+            ['Content-Type: application/x-www-form-urlencoded'],
+            \http_build_query([
+                'grant_type' => 'refresh_token',
+                'refresh_token' => $refreshToken,
+                'client_id' => $this->appID,
+                'client_secret' => $this->appSecret,
+            ])
+        ), true);
+
+        if (empty($this->tokens['refresh_token'])) {
+            $this->tokens['refresh_token'] = $refreshToken;
+        }
+
+        return $this->tokens;
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return string
+     */
+    public function getUserID(string $accessToken): string
+    {
+        $user = $this->getUser($accessToken);
+
+        return \strval($user['user_id']) ?? '';
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return string
+     */
+    public function getUserEmail(string $accessToken): string
+    {
+        $user = $this->getUser($accessToken);
+
+        return $user['mail'] ?? '';
+    }
+
+    /**
+     * Check if the OAuth email is verified
+     *
+     * @param string $accessToken
+     *
+     * @return bool
+     */
+    public function isEmailVerified(string $accessToken): bool
+    {
+        $user = $this->getUser($accessToken);
+
+        $mails = $user['mails'];
+        $mainMailIndex = \array_search($user['mail'], \array_map(fn($m) => $m['mail'], $mails));
+        $mainMain = $mails[$mainMailIndex];
+
+        if ($mainMain['verified'] ?? false) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return string
+     */
+    public function getUserName(string $accessToken): string
+    {
+        $user = $this->getUser($accessToken);
+
+        return $user['name'] ?? '';
+    }
+
+    /**
+     * @param string $accessToken
+     *
+     * @return array
+     */
+    protected function getUser(string $accessToken): array
+    {
+        if (empty($this->user)) {
+            $user = \json_decode($this->request(
+                'GET',
+                $this->apiEndpoint . '/user',
+                ['Authorization: Bearer ' . \urlencode($accessToken)]
+            ), true);
+
+            $profile = \json_decode($this->request(
+                'GET',
+                $this->apiEndpoint . '/user/profile',
+                ['Authorization: Bearer ' . \urlencode($accessToken)]
+            ), true);
+
+            $this->user = $user;
+            $this->user['name'] = $profile['name'];
+        }
+
+        return $this->user;
+    }
+}

src/Appwrite/Migration/Migration.php

@@ -47,7 +47,8 @@ abstract class Migration
         '0.14.2' => 'V13',
         '0.15.0' => 'V14',
         '0.15.1' => 'V14',
-        '0.15.2' => 'V14'
+        '0.15.2' => 'V14',
+        '0.15.3' => 'V14'
     ];
 
     /**

src/Appwrite/Migration/Version/V14.php

@@ -3,10 +3,11 @@
 namespace Appwrite\Migration\Version;
 
 use Appwrite\Migration\Migration;
-use Utopia\App;
+use Exception;
 use Utopia\CLI\Console;
 use Utopia\Database\Database;
 use Utopia\Database\Document;
+use Utopia\Database\Query;
 
 class V14 extends Migration
 {
@@ -208,6 +209,14 @@ class V14 extends Migration
                         } catch (\Throwable $th) {
                             Console::warning($th->getMessage());
                         }
+                        /**
+                         * Migrate Attributes
+                         */
+                        $this->migrateAttributesAndCollections('attributes', $collection);
+                        /**
+                         * Migrate Indexes
+                         */
+                        $this->migrateAttributesAndCollections('indexes', $collection);
                     }, $document);
                 }
             }, $documents);
@@ -220,6 +229,53 @@ class V14 extends Migration
         } while (!is_null($nextCollection));
     }
 
+    protected function migrateAttributesAndCollections(string $type, Document $collection): void
+    {
+        /**
+         * Offset pagination instead of cursor, since documents are re-created!
+         */
+        $offset = 0;
+        $attributesCount = $this->projectDB->count($type, queries: [new Query('collectionId', Query::TYPE_EQUAL, [$collection->getId()])]);
+
+        do {
+            $documents = $this->projectDB->find($type, limit: $this->limit, offset: $offset, queries: [new Query('collectionId', Query::TYPE_EQUAL, [$collection->getId()])]);
+            $offset += $this->limit;
+
+            foreach ($documents as $document) {
+                go(function (Document $document, string $internalId, string $type) {
+                    try {
+                        /**
+                         * Skip already migrated Documents.
+                         */
+                        if (!is_null($document->getAttribute('databaseId'))) {
+                            return;
+                        }
+                        /**
+                         * Add Internal ID 'collectionInternalId' for Subqueries.
+                         */
+                        $document->setAttribute('collectionInternalId', $internalId);
+                        /**
+                         * Add Internal ID 'databaseInternalId' for Subqueries.
+                         */
+                        $document->setAttribute('databaseInternalId', '1');
+                        /**
+                         * Add Internal ID 'databaseId'.
+                         */
+                        $document->setAttribute('databaseId', 'default');
+
+                        /**
+                         * Re-create Attribute.
+                         */
+                        $this->projectDB->deleteDocument($document->getCollection(), $document->getId());
+                        $this->projectDB->createDocument($document->getCollection(), $document->setAttribute('$id', "1_{$internalId}_{$document->getAttribute('key')}"));
+                    } catch (\Throwable $th) {
+                        Console::error("Failed to {$type} document: " . $th->getMessage());
+                    }
+                }, $document, $collection->getInternalId(), $type);
+            }
+        } while ($offset < $attributesCount);
+    }
+
     /**
      * Migrate all Collections.
      *
@@ -580,40 +636,6 @@ class V14 extends Migration
                     $document->setAttribute('teamInternalId', $internalId);
                 }
 
-                break;
-            case 'attributes':
-            case 'indexes':
-                /**
-                 * Add Internal ID 'collectionId' for Subqueries.
-                 */
-                if (!empty($document->getAttribute('collectionId')) && is_null($document->getAttribute('collectionInternalId'))) {
-                    $internalId = $this->projectDB->getDocument('database_1', $document->getAttribute('collectionId'))->getInternalId();
-                    $document->setAttribute('collectionInternalId', $internalId);
-                }
-                /**
-                 * Add Internal ID 'databaseInternalId' for Subqueries.
-                 */
-                if (is_null($document->getAttribute('databaseInternalId'))) {
-                    $document->setAttribute('databaseInternalId', '1');
-                }
-                /**
-                 * Add Internal ID 'databaseInternalId' for Subqueries.
-                 */
-                if (is_null($document->getAttribute('databaseId'))) {
-                    $document->setAttribute('databaseId', 'default');
-                }
-
-                try {
-                    /**
-                     * Re-create Collection Document
-                     */
-                    $internalId = $this->projectDB->getDocument('database_1', $document->getAttribute('collectionId'))->getInternalId();
-                    $this->projectDB->deleteDocument($document->getCollection(), $document->getId());
-                    $this->projectDB->createDocument($document->getCollection(), $document->setAttribute('$id', "1_{$internalId}_{$document->getAttribute('key')}"));
-                } catch (\Throwable $th) {
-                    Console::warning("Create Collection Document - {$th->getMessage()}");
-                }
-                $document = null;
                 break;
             case 'platforms':
                 /**

src/Appwrite/Utopia/Response/Model/Deployment.php

@@ -66,7 +66,7 @@ class Deployment extends Model
             ])
             ->addRule('status', [
                 'type' => self::TYPE_STRING,
-                'description' => 'The deployment status.',
+                'description' => 'The deployment status. Possible values are "processing", "building", "pending", "ready", and "failed".',
                 'default' => '',
                 'example' => 'enabled',
             ])