1440 lines
59 KiB
PHP
1440 lines
59 KiB
PHP
<?php
|
|
|
|
use Appwrite\Auth\Auth;
|
|
use Appwrite\Auth\Validator\Password;
|
|
use Appwrite\Database\Validator\CustomId;
|
|
use Appwrite\Network\Validator\CNAME;
|
|
use Appwrite\Network\Validator\Domain as DomainValidator;
|
|
use Appwrite\Network\Validator\URL;
|
|
use Appwrite\Utopia\Response;
|
|
use Utopia\Abuse\Adapters\TimeLimit;
|
|
use Utopia\App;
|
|
use Utopia\Audit\Audit;
|
|
use Utopia\Config\Config;
|
|
use Utopia\Database\Database;
|
|
use Utopia\Database\Document;
|
|
use Utopia\Database\Query;
|
|
use Utopia\Database\Validator\Authorization;
|
|
use Utopia\Database\Validator\UID;
|
|
use Utopia\Domains\Domain;
|
|
use Utopia\Exception;
|
|
use Utopia\Validator\ArrayList;
|
|
use Utopia\Validator\Boolean;
|
|
use Utopia\Validator\Integer;
|
|
use Utopia\Validator\Range;
|
|
use Utopia\Validator\Text;
|
|
use Utopia\Validator\WhiteList;
|
|
|
|
App::init(function ($project) {
|
|
/** @var Utopia\Database\Document $project */
|
|
|
|
if ($project->getId() !== 'console') {
|
|
throw new Exception('Access to this API is forbidden.', 401);
|
|
}
|
|
}, ['project'], 'projects');
|
|
|
|
App::post('/v1/projects')
|
|
->desc('Create Project')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'create')
|
|
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', 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, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
|
|
->param('name', null, new Text(128), 'Project name. Max length: 128 chars.')
|
|
->param('teamId', '', new UID(), 'Team unique ID.')
|
|
->param('description', '', new Text(256), 'Project description. Max length: 256 chars.', true)
|
|
->param('logo', '', new Text(1024), 'Project logo.', true)
|
|
->param('url', '', new URL(), 'Project URL.', true)
|
|
->param('legalName', '', new Text(256), 'Project legal Name. Max length: 256 chars.', true)
|
|
->param('legalCountry', '', new Text(256), 'Project legal Country. Max length: 256 chars.', true)
|
|
->param('legalState', '', new Text(256), 'Project legal State. Max length: 256 chars.', true)
|
|
->param('legalCity', '', new Text(256), 'Project legal City. Max length: 256 chars.', true)
|
|
->param('legalAddress', '', new Text(256), 'Project legal Address. Max length: 256 chars.', true)
|
|
->param('legalTaxId', '', new Text(256), 'Project legal Tax ID. Max length: 256 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->inject('dbForProject')
|
|
->action(function ($projectId, $name, $teamId, $description, $logo, $url, $legalName, $legalCountry, $legalState, $legalCity, $legalAddress, $legalTaxId, $response, $dbForConsole, $dbForProject) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
/** @var Utopia\Database\Database $dbForProject */
|
|
|
|
$team = $dbForConsole->getDocument('teams', $teamId);
|
|
|
|
if ($team->isEmpty()) {
|
|
throw new Exception('Team not found', 404);
|
|
}
|
|
|
|
$auth = Config::getParam('auth', []);
|
|
$auths = ['limit' => 0];
|
|
foreach ($auth as $index => $method) {
|
|
$auths[$method['key'] ?? ''] = true;
|
|
}
|
|
|
|
$projectId = ($projectId == 'unique()') ? $dbForConsole->getId() : $projectId;
|
|
$project = $dbForConsole->createDocument('projects', new Document([
|
|
'$id' => $projectId == 'unique()' ? $dbForConsole->getId() : $projectId,
|
|
'$read' => ['team:' . $teamId],
|
|
'$write' => ['team:' . $teamId . '/owner', 'team:' . $teamId . '/developer'],
|
|
'name' => $name,
|
|
'teamId' => $team->getId(),
|
|
'description' => $description,
|
|
'logo' => $logo,
|
|
'url' => $url,
|
|
'version' => APP_VERSION_STABLE,
|
|
'legalName' => $legalName,
|
|
'legalCountry' => $legalCountry,
|
|
'legalState' => $legalState,
|
|
'legalCity' => $legalCity,
|
|
'legalAddress' => $legalAddress,
|
|
'legalTaxId' => $legalTaxId,
|
|
'services' => new stdClass(),
|
|
'platforms' => null,
|
|
'providers' => [],
|
|
'webhooks' => null,
|
|
'keys' => null,
|
|
'domains' => null,
|
|
'auths' => $auths,
|
|
'search' => implode(' ', [$projectId, $name]),
|
|
]));
|
|
|
|
$collections = Config::getParam('collections', []); /** @var array $collections */
|
|
|
|
$dbForProject->setNamespace('_project_' . $project->getId());
|
|
$dbForProject->create('appwrite');
|
|
|
|
$audit = new Audit($dbForProject);
|
|
$audit->setup();
|
|
|
|
$adapter = new TimeLimit('', 0, 1, $dbForProject);
|
|
$adapter->setup();
|
|
|
|
foreach ($collections as $key => $collection) {
|
|
$attributes = [];
|
|
$indexes = [];
|
|
|
|
foreach ($collection['attributes'] as $attribute) {
|
|
$attributes[] = new Document([
|
|
'$id' => $attribute['$id'],
|
|
'type' => $attribute['type'],
|
|
'size' => $attribute['size'],
|
|
'required' => $attribute['required'],
|
|
'signed' => $attribute['signed'],
|
|
'array' => $attribute['array'],
|
|
'filters' => $attribute['filters'],
|
|
]);
|
|
}
|
|
|
|
foreach ($collection['indexes'] as $index) {
|
|
$indexes[] = new Document([
|
|
'$id' => $index['$id'],
|
|
'type' => $index['type'],
|
|
'attributes' => $index['attributes'],
|
|
'lengths' => $index['lengths'],
|
|
'orders' => $index['orders'],
|
|
]);
|
|
}
|
|
|
|
$dbForProject->createCollection($key, $attributes, $indexes);
|
|
}
|
|
|
|
$response->setStatusCode(Response::STATUS_CODE_CREATED);
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::get('/v1/projects')
|
|
->desc('List Projects')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'list')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT_LIST)
|
|
->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
|
|
->param('limit', 25, new Range(0, 100), 'Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.', true)
|
|
->param('offset', 0, new Range(0, APP_LIMIT_COUNT), 'Results offset. The default value is 0. Use this param to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)', true)
|
|
->param('cursor', '', new UID(), 'ID of the project used as the starting point for the query, excluding the project itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)', true)
|
|
->param('cursorDirection', Database::CURSOR_AFTER, new WhiteList([Database::CURSOR_AFTER, Database::CURSOR_BEFORE]), 'Direction of the cursor.', true)
|
|
->param('orderType', 'ASC', new WhiteList(['ASC', 'DESC'], true), 'Order result by ASC or DESC order.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($search, $limit, $offset, $cursor, $cursorDirection, $orderType, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
if (!empty($cursor)) {
|
|
$cursorProject = $dbForConsole->getDocument('projects', $cursor);
|
|
|
|
if ($cursorProject->isEmpty()) {
|
|
throw new Exception("Project '{$cursor}' for the 'cursor' value not found.", 400);
|
|
}
|
|
}
|
|
|
|
$queries = [];
|
|
|
|
if (!empty($search)) {
|
|
$queries[] = new Query('search', Query::TYPE_SEARCH, [$search]);
|
|
}
|
|
|
|
$results = $dbForConsole->find('projects', $queries, $limit, $offset, [], [$orderType], $cursorProject ?? null, $cursorDirection);
|
|
$sum = $dbForConsole->count('projects', $queries, APP_LIMIT_COUNT);
|
|
|
|
$response->dynamic(new Document([
|
|
'projects' => $results,
|
|
'sum' => $sum,
|
|
]), Response::MODEL_PROJECT_LIST);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId')
|
|
->desc('Get Project')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'get')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/usage')
|
|
->desc('Get usage stats for a project')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'getUsage')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_USAGE_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('range', '30d', new WhiteList(['24h', '7d', '30d', '90d'], true), 'Date range.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->inject('dbForProject')
|
|
->inject('register')
|
|
->action(function ($projectId, $range, $response, $dbForConsole, $dbForProject, $register) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
/** @var Utopia\Database\Database $dbForProject */
|
|
/** @var Utopia\Registry\Registry $register */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$usage = [];
|
|
if (App::getEnv('_APP_USAGE_STATS', 'enabled') == 'enabled') {
|
|
$periods = [
|
|
'24h' => [
|
|
'period' => '30m',
|
|
'limit' => 48,
|
|
],
|
|
'7d' => [
|
|
'period' => '1d',
|
|
'limit' => 7,
|
|
],
|
|
'30d' => [
|
|
'period' => '1d',
|
|
'limit' => 30,
|
|
],
|
|
'90d' => [
|
|
'period' => '1d',
|
|
'limit' => 90,
|
|
],
|
|
];
|
|
|
|
$dbForProject->setNamespace('_project_' . $projectId);
|
|
|
|
$metrics = [
|
|
'requests',
|
|
'network',
|
|
'executions',
|
|
'users.count',
|
|
'database.documents.count',
|
|
'database.collections.count',
|
|
'storage.total'
|
|
];
|
|
|
|
$stats = [];
|
|
|
|
Authorization::skip(function() use ($dbForProject, $periods, $range, $metrics, &$stats) {
|
|
foreach ($metrics as $metric) {
|
|
$limit = $periods[$range]['limit'];
|
|
$period = $periods[$range]['period'];
|
|
|
|
$requestDocs = $dbForProject->find('stats', [
|
|
new Query('period', Query::TYPE_EQUAL, [$period]),
|
|
new Query('metric', Query::TYPE_EQUAL, [$metric]),
|
|
], $limit, 0, ['time'], [Database::ORDER_DESC]);
|
|
|
|
$stats[$metric] = [];
|
|
foreach ($requestDocs as $requestDoc) {
|
|
$stats[$metric][] = [
|
|
'value' => $requestDoc->getAttribute('value'),
|
|
'date' => $requestDoc->getAttribute('time'),
|
|
];
|
|
}
|
|
|
|
// backfill metrics with empty values for graphs
|
|
$backfill = $limit - \count($requestDocs);
|
|
while ($backfill > 0) {
|
|
$last = $limit - $backfill - 1; // array index of last added metric
|
|
$diff = match($period) { // convert period to seconds for unix timestamp math
|
|
'30m' => 1800,
|
|
'1d' => 86400,
|
|
};
|
|
$stats[$metric][] = [
|
|
'value' => 0,
|
|
'date' => ($stats[$metric][$last]['date'] ?? \time()) - $diff, // time of last metric minus period
|
|
];
|
|
$backfill--;
|
|
}
|
|
$stats[$metric] = array_reverse($stats[$metric]);
|
|
}
|
|
});
|
|
|
|
$usage = new Document([
|
|
'range' => $range,
|
|
'requests' => $stats['requests'],
|
|
'network' => $stats['network'],
|
|
'functions' => $stats['executions'],
|
|
'documents' => $stats['database.documents.count'],
|
|
'collections' => $stats['database.collections.count'],
|
|
'users' => $stats['users.count'],
|
|
'storage' => $stats['storage.total']
|
|
]);
|
|
}
|
|
|
|
$response->dynamic($usage, Response::MODEL_USAGE_PROJECT);
|
|
});
|
|
|
|
App::patch('/v1/projects/:projectId')
|
|
->desc('Update Project')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'update')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('name', null, new Text(128), 'Project name. Max length: 128 chars.')
|
|
->param('description', '', new Text(256), 'Project description. Max length: 256 chars.', true)
|
|
->param('logo', '', new Text(1024), 'Project logo.', true)
|
|
->param('url', '', new URL(), 'Project URL.', true)
|
|
->param('legalName', '', new Text(256), 'Project legal name. Max length: 256 chars.', true)
|
|
->param('legalCountry', '', new Text(256), 'Project legal country. Max length: 256 chars.', true)
|
|
->param('legalState', '', new Text(256), 'Project legal state. Max length: 256 chars.', true)
|
|
->param('legalCity', '', new Text(256), 'Project legal city. Max length: 256 chars.', true)
|
|
->param('legalAddress', '', new Text(256), 'Project legal address. Max length: 256 chars.', true)
|
|
->param('legalTaxId', '', new Text(256), 'Project legal tax ID. Max length: 256 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $name, $description, $logo, $url, $legalName, $legalCountry, $legalState, $legalCity, $legalAddress, $legalTaxId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$project = $dbForConsole->updateDocument('projects', $project->getId(), $project
|
|
->setAttribute('name', $name)
|
|
->setAttribute('description', $description)
|
|
->setAttribute('logo', $logo)
|
|
->setAttribute('url', $url)
|
|
->setAttribute('legalName', $legalName)
|
|
->setAttribute('legalCountry', $legalCountry)
|
|
->setAttribute('legalState', $legalState)
|
|
->setAttribute('legalCity', $legalCity)
|
|
->setAttribute('legalAddress', $legalAddress)
|
|
->setAttribute('legalTaxId', $legalTaxId)
|
|
->setAttribute('search', implode(' ', [$projectId, $name]))
|
|
);
|
|
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::patch('/v1/projects/:projectId/service')
|
|
->desc('Update service status')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateServiceStatus')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('service', '', new WhiteList(array_keys(array_filter(Config::getParam('services'), function ($element) {return $element['optional'];})), true), 'Service name.')
|
|
->param('status', null, new Boolean(), 'Service status.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $service, $status, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
/** @var Boolean $status */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$services = $project->getAttribute('services', []);
|
|
$services[$service] = $status;
|
|
|
|
$project = $dbForConsole->updateDocument('projects', $project->getId(), $project->setAttribute('services', $services));
|
|
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::patch('/v1/projects/:projectId/oauth2')
|
|
->desc('Update Project OAuth2')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateOAuth2')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('provider', '', new WhiteList(\array_keys(Config::getParam('providers')), true), 'Provider Name', false)
|
|
->param('appId', '', new Text(256), 'Provider app ID. Max length: 256 chars.', true)
|
|
->param('secret', '', new text(512), 'Provider secret key. Max length: 512 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $provider, $appId, $secret, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$providers = $project->getAttribute('providers', []);
|
|
$providers[$provider . 'Appid'] = $appId;
|
|
$providers[$provider . 'Secret'] = $secret;
|
|
|
|
$project = $dbForConsole->updateDocument('projects', $project->getId(), $project->setAttribute('providers', $providers));
|
|
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::patch('/v1/projects/:projectId/auth/limit')
|
|
->desc('Update Project users limit')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateAuthLimit')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('limit', false, new Integer(true), 'Set the max number of users allowed in this project. Use 0 for unlimited.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $limit, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$auths = $project->getAttribute('auths', []);
|
|
$auths['limit'] = $limit;
|
|
|
|
$dbForConsole->updateDocument('projects', $project->getId(), $project
|
|
->setAttribute('auths', $auths)
|
|
);
|
|
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::patch('/v1/projects/:projectId/auth/:method')
|
|
->desc('Update Project auth method status. Use this endpoint to enable or disable a given auth method for this project.')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateAuthStatus')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PROJECT)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('method', '', new WhiteList(\array_keys(Config::getParam('auth')), true), 'Auth Method. Possible values: ' . implode(',', \array_keys(Config::getParam('auth'))), false)
|
|
->param('status', false, new Boolean(true), 'Set the status of this auth method.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $method, $status, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
$auth = Config::getParam('auth')[$method] ?? [];
|
|
$authKey = $auth['key'] ?? '';
|
|
$status = ($status === '1' || $status === 'true' || $status === 1 || $status === true);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$auths = $project->getAttribute('auths', []);
|
|
$auths[$authKey] = $status;
|
|
|
|
$project = $dbForConsole->updateDocument('projects', $project->getId(), $project->setAttribute('auths', $auths));
|
|
|
|
$response->dynamic($project, Response::MODEL_PROJECT);
|
|
});
|
|
|
|
App::delete('/v1/projects/:projectId')
|
|
->desc('Delete Project')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'delete')
|
|
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
|
|
->label('sdk.response.model', Response::MODEL_NONE)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->param('password', '', new Password(), 'Your user password for confirmation. Must be at least 8 chars.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForConsole')
|
|
->inject('deletes')
|
|
->action(function ($projectId, $password, $response, $user, $dbForConsole, $deletes) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Appwrite\Database\Document $user */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
/** @var Appwrite\Event\Event $deletes */
|
|
|
|
if (!Auth::passwordVerify($password, $user->getAttribute('password'))) { // Double check user password
|
|
throw new Exception('Invalid credentials', 401);
|
|
}
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$deletes
|
|
->setParam('type', DELETE_TYPE_DOCUMENT)
|
|
->setParam('document', $project)
|
|
;
|
|
|
|
if (!$dbForConsole->deleteDocument('teams', $project->getAttribute('teamId', null))) {
|
|
throw new Exception('Failed to remove project team from DB', 500);
|
|
}
|
|
|
|
if (!$dbForConsole->deleteDocument('projects', $projectId)) {
|
|
throw new Exception('Failed to remove project from DB', 500);
|
|
}
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
// Webhooks
|
|
|
|
App::post('/v1/projects/:projectId/webhooks')
|
|
->desc('Create Webhook')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'createWebhook')
|
|
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_WEBHOOK)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('name', null, new Text(128), 'Webhook name. Max length: 128 chars.')
|
|
->param('events', null, new ArrayList(new WhiteList(array_keys(Config::getParam('events'), true), true)), 'Events list.')
|
|
->param('url', null, new URL(), 'Webhook URL.')
|
|
->param('security', false, new Boolean(true), 'Certificate verification, false for disabled or true for enabled.')
|
|
->param('httpUser', '', new Text(256), 'Webhook HTTP user. Max length: 256 chars.', true)
|
|
->param('httpPass', '', new Text(256), 'Webhook HTTP password. Max length: 256 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $name, $events, $url, $security, $httpUser, $httpPass, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$security = ($security === '1' || $security === 'true' || $security === 1 || $security === true);
|
|
|
|
$webhook = new Document([
|
|
'$id' => $dbForConsole->getId(),
|
|
'$read' => ['role:all'],
|
|
'$write' => ['role:all'],
|
|
'projectId' => $project->getId(),
|
|
'name' => $name,
|
|
'events' => $events,
|
|
'url' => $url,
|
|
'security' => $security,
|
|
'httpUser' => $httpUser,
|
|
'httpPass' => $httpPass,
|
|
]);
|
|
|
|
$webhook = $dbForConsole->createDocument('webhooks', $webhook);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->setStatusCode(Response::STATUS_CODE_CREATED);
|
|
$response->dynamic($webhook, Response::MODEL_WEBHOOK);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/webhooks')
|
|
->desc('List Webhooks')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'listWebhooks')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_WEBHOOK_LIST)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$webhooks = $dbForConsole->find('webhooks', [
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
$response->dynamic(new Document([
|
|
'webhooks' => $webhooks,
|
|
'sum' => count($webhooks),
|
|
]), Response::MODEL_WEBHOOK_LIST);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/webhooks/:webhookId')
|
|
->desc('Get Webhook')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'getWebhook')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_WEBHOOK)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('webhookId', null, new UID(), 'Webhook unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $webhookId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$webhook = $dbForConsole->findOne('webhooks', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$webhookId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($webhook === false || $webhook->isEmpty()) {
|
|
throw new Exception('Webhook not found', 404);
|
|
}
|
|
|
|
$response->dynamic($webhook, Response::MODEL_WEBHOOK);
|
|
});
|
|
|
|
App::put('/v1/projects/:projectId/webhooks/:webhookId')
|
|
->desc('Update Webhook')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateWebhook')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_WEBHOOK)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('webhookId', null, new UID(), 'Webhook unique ID.')
|
|
->param('name', null, new Text(128), 'Webhook name. Max length: 128 chars.')
|
|
->param('events', null, new ArrayList(new WhiteList(array_keys(Config::getParam('events'), true), true)), 'Events list.')
|
|
->param('url', null, new URL(), 'Webhook URL.')
|
|
->param('security', false, new Boolean(true), 'Certificate verification, false for disabled or true for enabled.')
|
|
->param('httpUser', '', new Text(256), 'Webhook HTTP user. Max length: 256 chars.', true)
|
|
->param('httpPass', '', new Text(256), 'Webhook HTTP password. Max length: 256 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $webhookId, $name, $events, $url, $security, $httpUser, $httpPass, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$security = ($security === '1' || $security === 'true' || $security === 1 || $security === true);
|
|
|
|
$webhook = $dbForConsole->findOne('webhooks', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$webhookId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($webhook === false || $webhook->isEmpty()) {
|
|
throw new Exception('Webhook not found', 404);
|
|
}
|
|
|
|
$webhook
|
|
->setAttribute('name', $name)
|
|
->setAttribute('events', $events)
|
|
->setAttribute('url', $url)
|
|
->setAttribute('security', $security)
|
|
->setAttribute('httpUser', $httpUser)
|
|
->setAttribute('httpPass', $httpPass)
|
|
;
|
|
|
|
$dbForConsole->updateDocument('webhooks', $webhook->getId(), $webhook);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->dynamic($webhook, Response::MODEL_WEBHOOK);
|
|
});
|
|
|
|
App::delete('/v1/projects/:projectId/webhooks/:webhookId')
|
|
->desc('Delete Webhook')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'deleteWebhook')
|
|
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
|
|
->label('sdk.response.model', Response::MODEL_NONE)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('webhookId', null, new UID(), 'Webhook unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $webhookId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$webhook = $dbForConsole->findOne('webhooks', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$webhookId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if($webhook === false || $webhook->isEmpty()) {
|
|
throw new Exception('Webhook not found', 404);
|
|
}
|
|
|
|
$dbForConsole->deleteDocument('webhooks', $webhook->getId());
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
// Keys
|
|
|
|
App::post('/v1/projects/:projectId/keys')
|
|
->desc('Create Key')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'createKey')
|
|
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_KEY)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
|
|
->param('scopes', null, new ArrayList(new WhiteList(array_keys(Config::getParam('scopes')), true)), 'Key scopes list.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $name, $scopes, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$key = new Document([
|
|
'$id' => $dbForConsole->getId(),
|
|
'$read' => ['role:all'],
|
|
'$write' => ['role:all'],
|
|
'projectId' => $project->getId(),
|
|
'name' => $name,
|
|
'scopes' => $scopes,
|
|
'secret' => \bin2hex(\random_bytes(128)),
|
|
]);
|
|
|
|
$key = $dbForConsole->createDocument('keys', $key);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->setStatusCode(Response::STATUS_CODE_CREATED);
|
|
$response->dynamic($key, Response::MODEL_KEY);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/keys')
|
|
->desc('List Keys')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'listKeys')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_KEY_LIST)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$keys = $dbForConsole->find('keys', [
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()]),
|
|
], 5000);
|
|
|
|
$response->dynamic(new Document([
|
|
'keys' => $keys,
|
|
'sum' => count($keys),
|
|
]), Response::MODEL_KEY_LIST);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/keys/:keyId')
|
|
->desc('Get Key')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'getKey')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_KEY)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('keyId', null, new UID(), 'Key unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $keyId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$key = $dbForConsole->findOne('keys', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$keyId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($key === false || $key->isEmpty()) {
|
|
throw new Exception('Key not found', 404);
|
|
}
|
|
|
|
$response->dynamic($key, Response::MODEL_KEY);
|
|
});
|
|
|
|
App::put('/v1/projects/:projectId/keys/:keyId')
|
|
->desc('Update Key')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateKey')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_KEY)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('keyId', null, new UID(), 'Key unique ID.')
|
|
->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
|
|
->param('scopes', null, new ArrayList(new WhiteList(array_keys(Config::getParam('scopes')), true)), 'Key scopes list')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $keyId, $name, $scopes, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$key = $dbForConsole->findOne('keys', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$keyId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($key === false || $key->isEmpty()) {
|
|
throw new Exception('Key not found', 404);
|
|
}
|
|
|
|
$key
|
|
->setAttribute('name', $name)
|
|
->setAttribute('scopes', $scopes)
|
|
;
|
|
|
|
$dbForConsole->updateDocument('keys', $key->getId(), $key);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->dynamic($key, Response::MODEL_KEY);
|
|
});
|
|
|
|
App::delete('/v1/projects/:projectId/keys/:keyId')
|
|
->desc('Delete Key')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'deleteKey')
|
|
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
|
|
->label('sdk.response.model', Response::MODEL_NONE)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('keyId', null, new UID(), 'Key unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $keyId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$key = $dbForConsole->findOne('keys', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$keyId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if($key === false || $key->isEmpty()) {
|
|
throw new Exception('Key not found', 404);
|
|
}
|
|
|
|
$dbForConsole->deleteDocument('keys', $key->getId());
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
// Platforms
|
|
|
|
App::post('/v1/projects/:projectId/platforms')
|
|
->desc('Create Platform')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'createPlatform')
|
|
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PLATFORM)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('type', null, new WhiteList(['web', 'flutter-ios', 'flutter-android', 'flutter-linux', 'flutter-macos', 'flutter-windows', 'apple-ios', 'apple-macos', 'apple-watchos', 'apple-tvos', 'android', 'unity'], true), 'Platform type.')
|
|
->param('name', null, new Text(128), 'Platform name. Max length: 128 chars.')
|
|
->param('key', '', new Text(256), 'Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.', true)
|
|
->param('store', '', new Text(256), 'App store or Google Play store ID. Max length: 256 chars.', true)
|
|
->param('hostname', '', new Text(256), 'Platform client hostname. Max length: 256 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $type, $name, $key, $store, $hostname, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$platform = new Document([
|
|
'$id' => $dbForConsole->getId(),
|
|
'$read' => ['role:all'],
|
|
'$write' => ['role:all'],
|
|
'projectId' => $project->getId(),
|
|
'type' => $type,
|
|
'name' => $name,
|
|
'key' => $key,
|
|
'store' => $store,
|
|
'hostname' => $hostname,
|
|
'dateCreated' => \time(),
|
|
'dateUpdated' => \time(),
|
|
]);
|
|
|
|
$platform = $dbForConsole->createDocument('platforms', $platform);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->setStatusCode(Response::STATUS_CODE_CREATED);
|
|
$response->dynamic($platform, Response::MODEL_PLATFORM);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/platforms')
|
|
->desc('List Platforms')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'listPlatforms')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PLATFORM_LIST)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$platforms = $dbForConsole->find('platforms', [
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
], 5000);
|
|
|
|
$response->dynamic(new Document([
|
|
'platforms' => $platforms,
|
|
'sum' => count($platforms),
|
|
]), Response::MODEL_PLATFORM_LIST);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/platforms/:platformId')
|
|
->desc('Get Platform')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'getPlatform')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PLATFORM)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('platformId', null, new UID(), 'Platform unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $platformId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$platform = $dbForConsole->findOne('platforms', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$platformId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($platform === false || $platform->isEmpty()) {
|
|
throw new Exception('Platform not found', 404);
|
|
}
|
|
|
|
$response->dynamic($platform, Response::MODEL_PLATFORM);
|
|
});
|
|
|
|
App::put('/v1/projects/:projectId/platforms/:platformId')
|
|
->desc('Update Platform')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updatePlatform')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_PLATFORM)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('platformId', null, new UID(), 'Platform unique ID.')
|
|
->param('name', null, new Text(128), 'Platform name. Max length: 128 chars.')
|
|
->param('key', '', new Text(256), 'Package name for android or bundle ID for iOS. Max length: 256 chars.', true)
|
|
->param('store', '', new Text(256), 'App store or Google Play store ID. Max length: 256 chars.', true)
|
|
->param('hostname', '', new Text(256), 'Platform client URL. Max length: 256 chars.', true)
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $platformId, $name, $key, $store, $hostname, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$platform = $dbForConsole->findOne('platforms', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$platformId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($platform === false || $platform->isEmpty()) {
|
|
throw new Exception('Platform not found', 404);
|
|
}
|
|
|
|
$platform
|
|
->setAttribute('name', $name)
|
|
->setAttribute('dateUpdated', \time())
|
|
->setAttribute('key', $key)
|
|
->setAttribute('store', $store)
|
|
->setAttribute('hostname', $hostname)
|
|
;
|
|
|
|
$dbForConsole->updateDocument('platforms', $platform->getId(), $platform);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->dynamic($platform, Response::MODEL_PLATFORM);
|
|
});
|
|
|
|
App::delete('/v1/projects/:projectId/platforms/:platformId')
|
|
->desc('Delete Platform')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'deletePlatform')
|
|
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
|
|
->label('sdk.response.model', Response::MODEL_NONE)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('platformId', null, new UID(), 'Platform unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $platformId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$platform = $dbForConsole->findOne('platforms', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$platformId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($platform === false || $platform->isEmpty()) {
|
|
throw new Exception('Platform not found', 404);
|
|
}
|
|
|
|
$dbForConsole->deleteDocument('platforms', $platformId);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
// Domains
|
|
|
|
App::post('/v1/projects/:projectId/domains')
|
|
->desc('Create Domain')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'createDomain')
|
|
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_DOMAIN)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('domain', null, new DomainValidator(), 'Domain name.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $domain, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$document = $dbForConsole->findOne('domains', [
|
|
new Query('domain', Query::TYPE_EQUAL, [$domain]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()]),
|
|
]);
|
|
|
|
if ($document && !$document->isEmpty()) {
|
|
throw new Exception('Domain already exists', 409);
|
|
}
|
|
|
|
$target = new Domain(App::getEnv('_APP_DOMAIN_TARGET', ''));
|
|
|
|
if (!$target->isKnown() || $target->isTest()) {
|
|
throw new Exception('Unreachable CNAME target (' . $target->get() . '), please use a domain with a public suffix.', 500);
|
|
}
|
|
|
|
$domain = new Domain($domain);
|
|
|
|
$domain = new Document([
|
|
'$id' => $dbForConsole->getId(),
|
|
'$read' => ['role:all'],
|
|
'$write' => ['role:all'],
|
|
'projectId' => $project->getId(),
|
|
'updated' => \time(),
|
|
'domain' => $domain->get(),
|
|
'tld' => $domain->getSuffix(),
|
|
'registerable' => $domain->getRegisterable(),
|
|
'verification' => false,
|
|
'certificateId' => null,
|
|
]);
|
|
|
|
$domain = $dbForConsole->createDocument('domains', $domain);
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$response->setStatusCode(Response::STATUS_CODE_CREATED);
|
|
$response->dynamic($domain, Response::MODEL_DOMAIN);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/domains')
|
|
->desc('List Domains')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'listDomains')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_DOMAIN_LIST)
|
|
->param('projectId', '', new UID(), 'Project unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$domains = $dbForConsole->find('domains', [
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
], 5000);
|
|
|
|
$response->dynamic(new Document([
|
|
'domains' => $domains,
|
|
'sum' => count($domains),
|
|
]), Response::MODEL_DOMAIN_LIST);
|
|
});
|
|
|
|
App::get('/v1/projects/:projectId/domains/:domainId')
|
|
->desc('Get Domain')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'getDomain')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_DOMAIN)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('domainId', null, new UID(), 'Domain unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $domainId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$domain = $dbForConsole->findOne('domains', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$domainId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($domain === false || $domain->isEmpty()) {
|
|
throw new Exception('Domain not found', 404);
|
|
}
|
|
|
|
$response->dynamic($domain, Response::MODEL_DOMAIN);
|
|
});
|
|
|
|
App::patch('/v1/projects/:projectId/domains/:domainId/verification')
|
|
->desc('Update Domain Verification Status')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'updateDomainVerification')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_DOMAIN)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('domainId', null, new UID(), 'Domain unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->action(function ($projectId, $domainId, $response, $dbForConsole) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$domain = $dbForConsole->findOne('domains', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$domainId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($domain === false || $domain->isEmpty()) {
|
|
throw new Exception('Domain not found', 404);
|
|
}
|
|
|
|
$target = new Domain(App::getEnv('_APP_DOMAIN_TARGET', ''));
|
|
|
|
if (!$target->isKnown() || $target->isTest()) {
|
|
throw new Exception('Unreachable CNAME target (' . $target->get() . '), please use a domain with a public suffix.', 500);
|
|
}
|
|
|
|
if ($domain->getAttribute('verification') === true) {
|
|
return $response->dynamic($domain, Response::MODEL_DOMAIN);
|
|
}
|
|
|
|
$validator = new CNAME($target->get()); // Verify Domain with DNS records
|
|
|
|
if (!$validator->isValid($domain->getAttribute('domain', ''))) {
|
|
throw new Exception('Failed to verify domain', 401);
|
|
}
|
|
|
|
|
|
$dbForConsole->updateDocument('domains', $domain->getId(), $domain->setAttribute('verification', true));
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
// Issue a TLS certificate when domain is verified
|
|
Resque::enqueue('v1-certificates', 'CertificatesV1', [
|
|
'document' => $domain->getArrayCopy(),
|
|
'domain' => $domain->getAttribute('domain'),
|
|
]);
|
|
|
|
$response->dynamic($domain, Response::MODEL_DOMAIN);
|
|
});
|
|
|
|
App::delete('/v1/projects/:projectId/domains/:domainId')
|
|
->desc('Delete Domain')
|
|
->groups(['api', 'projects'])
|
|
->label('scope', 'projects.write')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
|
|
->label('sdk.namespace', 'projects')
|
|
->label('sdk.method', 'deleteDomain')
|
|
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
|
|
->label('sdk.response.model', Response::MODEL_NONE)
|
|
->param('projectId', null, new UID(), 'Project unique ID.')
|
|
->param('domainId', null, new UID(), 'Domain unique ID.')
|
|
->inject('response')
|
|
->inject('dbForConsole')
|
|
->inject('deletes')
|
|
->action(function ($projectId, $domainId, $response, $dbForConsole, $deletes) {
|
|
/** @var Appwrite\Utopia\Response $response */
|
|
/** @var Utopia\Database\Database $dbForConsole */
|
|
|
|
$project = $dbForConsole->getDocument('projects', $projectId);
|
|
|
|
if ($project->isEmpty()) {
|
|
throw new Exception('Project not found', 404);
|
|
}
|
|
|
|
$domain = $dbForConsole->findOne('domains', [
|
|
new Query('_uid', Query::TYPE_EQUAL, [$domainId]),
|
|
new Query('projectId', Query::TYPE_EQUAL, [$project->getId()])
|
|
]);
|
|
|
|
if ($domain === false || $domain->isEmpty()) {
|
|
throw new Exception('Domain not found', 404);
|
|
}
|
|
|
|
$dbForConsole->deleteDocument('domains', $domain->getId());
|
|
|
|
$dbForConsole->deleteCachedDocument('projects', $project->getId());
|
|
|
|
$deletes
|
|
->setParam('type', DELETE_TYPE_CERTIFICATES)
|
|
->setParam('document', $domain)
|
|
;
|
|
|
|
$response->noContent();
|
|
});
|