Merge remote-tracking branch 'origin/1.4.x' into chore-sync-master

# Conflicts:
#	app/config/specs/open-api3-1.4.x-console.json
#	app/config/specs/open-api3-latest-console.json
#	app/config/specs/swagger2-1.4.x-console.json
#	app/config/specs/swagger2-latest-console.json

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "app/console"]
 	path = app/console
 	url = https://github.com/appwrite/console
-	branch = 3.0.1
+	branch = 3.0.2

Dockerfile

@@ -167,6 +167,7 @@ RUN chmod +x /usr/local/bin/doctor && \
     chmod +x /usr/local/bin/maintenance &&  \
     chmod +x /usr/local/bin/usage && \
     chmod +x /usr/local/bin/install && \
+    chmod +x /usr/local/bin/upgrade && \
     chmod +x /usr/local/bin/migrate && \
     chmod +x /usr/local/bin/realtime && \
     chmod +x /usr/local/bin/schedule && \

app/config/roles.php

@@ -57,6 +57,9 @@ $admins = [
     'rules.write',
     'migrations.read',
     'migrations.write',
+    'vcs.read',
+    'vcs.write',
+    'assistant.read',
 ];
 
 return [

app/config/scopes.php

@@ -87,5 +87,14 @@ return [ // List of publicly visible scopes
     ],
     'migrations.write' => [
         'description' => 'Access to create, update, and delete your project\'s migrations.',
-    ]
+    ],
+    'vcs.read' => [
+        'description' => 'Access to read your project\'s VCS repositories',
+    ],
+    'vcs.write' => [
+        'description' => 'Access to create, update, and delete your project\'s VCS repositories',
+    ],
+    'assistant.read' => [
+        'description' => 'Access to read the Assistant service',
+    ],
 ];

app/console

@@ -1 +1 @@
-Subproject commit bfd14ef923e57938639e95e5ab32e68d49e24407
+Subproject commit 88b6d59051992ed86183ee83d77bf678d1cb73bf

app/controllers/api/console.php

@@ -58,6 +58,7 @@ App::get('/v1/console/variables')
 App::post('/v1/console/assistant')
     ->desc('Ask Query')
     ->groups(['api', 'assistant'])
+    ->label('scope', 'assistant.read')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.namespace', 'assistant')
     ->label('sdk.method', 'chat')

app/controllers/api/migrations.php

@@ -580,7 +580,7 @@ App::get('/v1/migrations/firebase/report/oauth')
 App::get('/v1/migrations/firebase/connect')
     ->desc('Authorize with firebase')
     ->groups(['api', 'migrations'])
-    ->label('origin', '*')
+    ->label('scope', 'migrations.read')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.namespace', 'migrations')
     ->label('sdk.method', 'createFirebaseAuth')
@@ -622,6 +622,7 @@ App::get('/v1/migrations/firebase/connect')
 App::get('/v1/migrations/firebase/redirect')
     ->desc('Capture and receive data on Firebase authorization')
     ->groups(['api', 'migrations'])
+    ->label('scope', 'public')
     ->label('error', __DIR__ . '/../../views/general/error.phtml')
     ->param('code', '', new Text(2048), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
     ->inject('user')
@@ -733,6 +734,7 @@ App::get('/v1/migrations/firebase/redirect')
 App::get('/v1/migrations/firebase/projects')
     ->desc('List Firebase Projects')
     ->groups(['api', 'migrations'])
+    ->label('scope', 'migrations.read')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.namespace', 'migrations')
     ->label('sdk.method', 'listFirebaseProjects')
@@ -821,6 +823,7 @@ App::get('/v1/migrations/firebase/projects')
 App::get('/v1/migrations/firebase/deauthorize')
     ->desc('Revoke Appwrite\'s authorization to access Firebase Projects')
     ->groups(['api', 'migrations'])
+    ->label('scope', 'migrations.write')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.namespace', 'migrations')
     ->label('sdk.method', 'deleteFirebaseAuth')

app/controllers/api/vcs.php

@@ -226,8 +226,7 @@ $createGitDeployments = function (GitHub $github, string $providerInstallationId
 App::get('/v1/vcs/github/authorize')
     ->desc('Install GitHub App')
     ->groups(['api', 'vcs'])
-    ->label('origin', '*')
-    ->label('sdk.auth', [])
+    ->label('scope', 'vcs.read')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'createGitHubInstallation')
@@ -238,12 +237,12 @@ App::get('/v1/vcs/github/authorize')
     ->label('sdk.hide', true)
     ->param('success', '', fn ($clients) => new Host($clients), 'URL to redirect back to console after a successful installation attempt.', true, ['clients'])
     ->param('failure', '', fn ($clients) => new Host($clients), 'URL to redirect back to console after a failed installation attempt.', true, ['clients'])
-    ->param('projectId', '', new UID(), 'Project ID')
     ->inject('request')
     ->inject('response')
-    ->action(function (string $success, string $failure, string $projectId, Request $request, Response $response) {
+    ->inject('project')
+    ->action(function (string $success, string $failure, Request $request, Response $response, Document $project) {
         $state = \json_encode([
-            'projectId' => $projectId,
+            'projectId' => $project->getId(),
             'success' => $success,
             'failure' => $failure,
         ]);
@@ -263,6 +262,7 @@ App::get('/v1/vcs/github/authorize')
 App::get('/v1/vcs/github/callback')
     ->desc('Capture installation and authorization from GitHub App')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'public')
     ->label('error', __DIR__ . '/../../views/general/error.phtml')
     ->param('installation_id', '', new Text(256, 0), 'GitHub installation ID', true)
     ->param('setup_action', '', new Text(256, 0), 'GitHub setup actuon type', true)
@@ -422,6 +422,7 @@ App::get('/v1/vcs/github/callback')
 App::post('/v1/vcs/github/installations/:installationId/providerRepositories/:providerRepositoryId/detection')
     ->desc('Detect runtime settings from source code')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.write')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'createRepositoryDetection')
@@ -488,6 +489,7 @@ App::post('/v1/vcs/github/installations/:installationId/providerRepositories/:pr
 App::get('/v1/vcs/github/installations/:installationId/providerRepositories')
     ->desc('List Repositories')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.read')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'listRepositories')
@@ -580,6 +582,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories')
 App::post('/v1/vcs/github/installations/:installationId/providerRepositories')
     ->desc('Create repository')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.write')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'createRepository')
@@ -680,6 +683,7 @@ App::post('/v1/vcs/github/installations/:installationId/providerRepositories')
 App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:providerRepositoryId')
     ->desc('Get repository')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.read')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'getRepository')
@@ -725,6 +729,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro
 App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:providerRepositoryId/branches')
     ->desc('List Repository Branches')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.read')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'listRepositoryBranches')
@@ -770,6 +775,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro
 App::post('/v1/vcs/github/events')
     ->desc('Create Event')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'public')
     ->inject('gitHub')
     ->inject('request')
     ->inject('response')
@@ -905,8 +911,9 @@ App::post('/v1/vcs/github/events')
     );
 
 App::get('/v1/vcs/installations')
-    ->groups(['api', 'vcs'])
     ->desc('List installations')
+    ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.read')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'listInstallations')
@@ -956,8 +963,9 @@ App::get('/v1/vcs/installations')
     });
 
 App::get('/v1/vcs/installations/:installationId')
-    ->groups(['api', 'vcs'])
     ->desc('Get installation')
+    ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.read')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'getInstallation')
@@ -984,8 +992,9 @@ App::get('/v1/vcs/installations/:installationId')
     });
 
 App::delete('/v1/vcs/installations/:installationId')
-    ->groups(['api', 'vcs'])
     ->desc('Delete Installation')
+    ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.write')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'deleteInstallation')
@@ -1018,6 +1027,7 @@ App::delete('/v1/vcs/installations/:installationId')
 App::patch('/v1/vcs/github/installations/:installationId/repositories/:repositoryId')
     ->desc('Authorize external deployment')
     ->groups(['api', 'vcs'])
+    ->label('scope', 'vcs.write')
     ->label('sdk.namespace', 'vcs')
     ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
     ->label('sdk.method', 'updateExternalDeployments')

app/views/install/compose.phtml

@@ -650,7 +650,7 @@ services:
       - MYSQL_DATABASE=${_APP_DB_SCHEMA}
       - MYSQL_USER=${_APP_DB_USER}
       - MYSQL_PASSWORD=${_APP_DB_PASS}
-    command: 'mysqld --innodb-flush-method=fsync --max_connections=${_APP_CONNECTIONS_MAX}'
+    command: 'mysqld --innodb-flush-method=fsync'
 
   redis:
     image: redis:7.0.4-alpine

bin/upgrade

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+php /usr/src/code/app/cli.php upgrade $@

src/Appwrite/Platform/Services/Tasks.php

@@ -22,6 +22,7 @@ use Appwrite\Platform\Tasks\VolumeSync;
 use Appwrite\Platform\Tasks\CalcUsersStats;
 use Appwrite\Platform\Tasks\CalcTierStats;
 use Appwrite\Platform\Tasks\PatchDeleteProjectCollections;
+use Appwrite\Platform\Tasks\Upgrade;
 
 class Tasks extends Service
 {
@@ -36,6 +37,7 @@ class Tasks extends Service
             ->addAction(Hamster::getName(), new Hamster())
             ->addAction(Doctor::getName(), new Doctor())
             ->addAction(Install::getName(), new Install())
+            ->addAction(Upgrade::getName(), new Upgrade())
             ->addAction(Maintenance::getName(), new Maintenance())
             ->addAction(PatchCreateMissingSchedules::getName(), new PatchCreateMissingSchedules())
             ->addAction(ClearCardCache::getName(), new ClearCardCache())

src/Appwrite/Platform/Tasks/Install.php

@@ -16,6 +16,8 @@ use Utopia\Platform\Action;
 
 class Install extends Action
 {
+    protected string $path = '/usr/src/code/appwrite';
+
     public static function getName(): string
     {
         return 'install';
@@ -36,7 +38,6 @@ class Install extends Action
     public function action(string $httpPort, string $httpsPort, string $organization, string $image, string $interactive): void
     {
         $config = Config::getParam('variables');
-        $path = '/usr/src/code/appwrite';
         $defaultHTTPPort = '80';
         $defaultHTTPSPort = '443';
         $vars = [];
@@ -56,19 +57,28 @@ class Install extends Action
         Console::success('Starting Appwrite installation...');
 
         // Create directory with write permissions
-        if (!\file_exists(\dirname($path))) {
-            if (!@\mkdir(\dirname($path), 0755, true)) {
-                Console::error('Can\'t create directory ' . \dirname($path));
+        if (!\file_exists(\dirname($this->path))) {
+            if (!@\mkdir(\dirname($this->path), 0755, true)) {
+                Console::error('Can\'t create directory ' . \dirname($this->path));
                 Console::exit(1);
             }
         }
 
-        $data = @file_get_contents($path . '/docker-compose.yml');
+        $data = @file_get_contents($this->path . '/docker-compose.yml');
 
         if ($data !== false) {
+            if ($interactive == 'Y' && Console::isInteractive()) {
+                $answer = Console::confirm('Previous installation found, do you want to overwrite it (a backup will be created before overwriting)? (Y/n)');
+
+                if ($answer !== 'Y') {
+                    Console::info('No action taken.');
+                    return;
+                }
+            }
+
             $time = \time();
             Console::info('Compose file found, creating backup: docker-compose.yml.' . $time . '.backup');
-            file_put_contents($path . '/docker-compose.yml.' . $time . '.backup', $data);
+            file_put_contents($this->path . '/docker-compose.yml.' . $time . '.backup', $data);
             $compose = new Compose($data);
             $appwrite = $compose->getService('appwrite');
             $oldVersion = ($appwrite) ? $appwrite->getImageVersion() : null;
@@ -102,11 +112,11 @@ class Install extends Action
                     }
                 }
 
-                $data = @file_get_contents($path . '/.env');
+                $data = @file_get_contents($this->path . '/.env');
 
                 if ($data !== false) { // Fetch all env vars from previous .env file
                     Console::info('Env file found, creating backup: .env.' . $time . '.backup');
-                    file_put_contents($path . '/.env.' . $time . '.backup', $data);
+                    file_put_contents($this->path . '/.env.' . $time . '.backup', $data);
                     $env = new Env($data);
 
                     foreach ($env->list() as $key => $value) {
@@ -196,14 +206,14 @@ class Install extends Action
 
         $templateForEnv->setParam('vars', $input);
 
-        if (!file_put_contents($path . '/docker-compose.yml', $templateForCompose->render(false))) {
+        if (!file_put_contents($this->path . '/docker-compose.yml', $templateForCompose->render(false))) {
             $message = 'Failed to save Docker Compose file';
             $this->sendEvent($analytics, $message);
             Console::error($message);
             Console::exit(1);
         }
 
-        if (!file_put_contents($path . '/.env', $templateForEnv->render(false))) {
+        if (!file_put_contents($this->path . '/.env', $templateForEnv->render(false))) {
             $message = 'Failed to save environment variables file';
             $this->sendEvent($analytics, $message);
             Console::error($message);
@@ -222,7 +232,7 @@ class Install extends Action
 
         Console::log("Running \"docker compose up -d --remove-orphans --renew-anon-volumes\"");
 
-        $exit = Console::execute("${env} docker compose --project-directory ${path} up -d --remove-orphans --renew-anon-volumes", '', $stdout, $stderr);
+        $exit = Console::execute("$env docker compose --project-directory $this->path up -d --remove-orphans --renew-anon-volumes", '', $stdout, $stderr);
 
         if ($exit !== 0) {
             $message = 'Failed to install Appwrite dockers';

src/Appwrite/Platform/Tasks/Upgrade.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Appwrite\Platform\Tasks;
+
+use Utopia\CLI\Console;
+use Utopia\Validator\Text;
+
+class Upgrade extends Install
+{
+    public static function getName(): string
+    {
+        return 'upgrade';
+    }
+
+    public function __construct()
+    {
+        $this
+            ->desc('Upgrade Appwrite')
+            ->param('httpPort', '', new Text(4), 'Server HTTP port', true)
+            ->param('httpsPort', '', new Text(4), 'Server HTTPS port', true)
+            ->param('organization', 'appwrite', new Text(0), 'Docker Registry organization', true)
+            ->param('image', 'appwrite', new Text(0), 'Main appwrite docker image', true)
+            ->param('interactive', 'Y', new Text(1), 'Run an interactive session', true)
+            ->callback(fn ($httpPort, $httpsPort, $organization, $image, $interactive) => $this->action($httpPort, $httpsPort, $organization, $image, $interactive));
+    }
+
+    public function action(string $httpPort, string $httpsPort, string $organization, string $image, string $interactive): void
+    {
+        // Check for previous installation
+        $data = @file_get_contents($this->path . '/docker-compose.yml');
+        if (empty($data)) {
+            Console::error('Appwrite installation not found.');
+            Console::log('The command was not run in the parent folder of your appwrite installation.');
+            Console::log('Please navigate to the parent directory of the Appwrite installation and try again.');
+            Console::log('  parent_directory <= you run the command in this directory');
+            Console::log('  └── appwrite');
+            Console::log('      └── docker-compose.yml');
+            Console::exit(1);
+        }
+        parent::action($httpPort, $httpsPort, $organization, $image, $interactive);
+    }
+}