Elgato_dark/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite synced 2026-05-24 09:28:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge pull request #11135 from appwrite/feat-new-file-params

Browse source 
Feat: Add more file params
This commit is contained in:
Matej Bačo 2026-01-14 14:17:37 +01:00 committed by GitHub
commit b73abf69d0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 137 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/Appwrite/Utopia/Response/Model/File.php
View file

@ -4,6 +4,8 @@ namespace Appwrite\Utopia\Response\Model;
use Appwrite\Utopia\Response;
use Appwrite\Utopia\Response\Model;
use Utopia\Database\Document;
use Utopia\Storage\Compression\Compression;
class File extends Model
{
@ -77,6 +79,18 @@ class File extends Model
'default' => 0,
'example' => 17890,
])
->addRule('encryption', [
'type' => self::TYPE_BOOLEAN,
'description' => 'Whether file contents are encrypted at rest.',
'default' => false,
'example' => true,
])
->addRule('compression', [
'type' => self::TYPE_STRING,
'description' => 'Compression algorithm used for the file. Will be one of ' . Compression::NONE . ', [' . Compression::GZIP . '](https://en.wikipedia.org/wiki/Gzip), or [' . Compression::ZSTD . '](https://en.wikipedia.org/wiki/Zstd).',
'default' => '',
'example' => 'gzip'
])
;
}
@ -99,4 +113,14 @@ class File extends Model
{
return Response::MODEL_FILE;
}
public function filter(Document $document): Document
{
$document->setAttribute('compression', $document->getAttribute('algorithm', ''));
$encryption = !empty($document->getAttribute('openSSLCipher', ''));
$document->setAttribute('encryption', $encryption);
return $document;
}
}

113
tests/e2e/Services/Storage/StorageCustomClientTest.php
View file

@ -1447,4 +1447,117 @@ class StorageCustomClientTest extends Scope
]);
$this->assertEquals(204, $response['headers']['status-code']);
}
public function testFileEncryptionAndCompression(): void
{
// Create bucket
$bucket = $this->client->call(Client::METHOD_POST, '/storage/buckets', [
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
], [
'bucketId' => ID::unique(),
'name' => 'Test Bucket',
'permissions' => [
Permission::read(Role::any())
],
'encryption' => true,
'compression' => 'gzip'
]);
$this->assertSame(201, $bucket['headers']['status-code']);
// Create file
$file = $this->client->call(Client::METHOD_POST, '/storage/buckets/' . $bucket['body']['$id'] . '/files', [
'content-type' => 'multipart/form-data',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
], [
'fileId' => ID::unique(),
'file' => new CURLFile(realpath(__DIR__ . '/../../../resources/logo.png'), 'image/png', 'transformations.png'),
]);
$this->assertSame(201, $file['headers']['status-code']);
$this->assertSame('gzip', $file['body']['compression']);
$this->assertSame(true, $file['body']['encryption']);
// Get file
$file = $this->client->call(Client::METHOD_GET, '/storage/buckets/' . $bucket['body']['$id'] . '/files/' . $file['body']['$id'], [
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
]);
$this->assertSame(200, $file['headers']['status-code']);
$this->assertSame('gzip', $file['body']['compression']);
$this->assertSame(true, $file['body']['encryption']);
// List files
$files = $this->client->call(Client::METHOD_GET, '/storage/buckets/' . $bucket['body']['$id'] . '/files', [
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
]);
$this->assertSame(200, $files['headers']['status-code']);
$this->assertSame(1, $files['body']['total']);
$this->assertSame('gzip', $files['body']['files'][0]['compression']);
$this->assertSame(true, $files['body']['files'][0]['encryption']);
// Update the bucket
$bucket = $this->client->call(Client::METHOD_PUT, '/storage/buckets/' . $bucket['body']['$id'], [
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
], [
'name' => 'Test Bucket',
'encryption' => false,
'compression' => 'none'
]);
// Existing file did not update
$file = $this->client->call(Client::METHOD_GET, '/storage/buckets/' . $bucket['body']['$id'] . '/files/' . $file['body']['$id'], [
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
]);
$this->assertSame(200, $file['headers']['status-code']);
$this->assertSame('gzip', $file['body']['compression']);
$this->assertSame(true, $file['body']['encryption']);
// Create 2nd file
$file = $this->client->call(Client::METHOD_POST, '/storage/buckets/' . $bucket['body']['$id'] . '/files', [
'content-type' => 'multipart/form-data',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
], [
'fileId' => ID::unique(),
'file' => new CURLFile(realpath(__DIR__ . '/../../../resources/logo.png'), 'image/png', 'transformations.png'),
]);
$this->assertSame(201, $file['headers']['status-code']);
$this->assertSame('none', $file['body']['compression']);
$this->assertSame(false, $file['body']['encryption']);
// Get file
$file = $this->client->call(Client::METHOD_GET, '/storage/buckets/' . $bucket['body']['$id'] . '/files/' . $file['body']['$id'], [
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
]);
$this->assertSame(200, $file['headers']['status-code']);
$this->assertSame('none', $file['body']['compression']);
$this->assertSame(false, $file['body']['encryption']);
// List files
$files = $this->client->call(Client::METHOD_GET, '/storage/buckets/' . $bucket['body']['$id'] . '/files', [
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
]);
$this->assertSame(200, $files['headers']['status-code']);
$this->assertSame(2, $files['body']['total']);
$this->assertSame('none', $files['body']['files'][1]['compression']);
$this->assertSame(false, $files['body']['files'][1]['encryption']);
$this->assertSame('gzip', $files['body']['files'][0]['compression']);
$this->assertSame(true, $files['body']['files'][0]['encryption']);
// Delete the bucket
$response = $this->client->call(Client::METHOD_DELETE, '/storage/buckets/' . $bucket['body']['$id'], [
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
]);
$this->assertEquals(204, $response['headers']['status-code']);
}
}