mirror of
https://we.phorge.it/source/phorge.git
synced 2025-02-18 01:38:39 +01:00
f1dc56a687
Summary: Ref T988. Not sure about this, feel free to push back or tweak it or whatever, but I want to reduce the amount of meta-text in the method documentation. Primarily this: - Shortens "From parent implementation in ClassName:" to "ClassName". - Tries to tweak the styles a bit so that it's relatively obvious what that means (hopefully?). - Fixes an issue with tasks where some methods could be ignored. Test Plan: {F57565} Reviewers: chad Reviewed By: chad CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6911
129 lines
3.1 KiB
PHP
129 lines
3.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Amazon S3 file storage engine. This engine scales well but is relatively
|
|
* high-latency since data has to be pulled off S3.
|
|
*
|
|
* @task internal Internals
|
|
*/
|
|
final class PhabricatorS3FileStorageEngine
|
|
extends PhabricatorFileStorageEngine {
|
|
|
|
|
|
/* -( Implementation )----------------------------------------------------- */
|
|
|
|
|
|
/**
|
|
* This engine identifies as `amazon-s3`.
|
|
*/
|
|
public function getEngineIdentifier() {
|
|
return 'amazon-s3';
|
|
}
|
|
|
|
|
|
/**
|
|
* Writes file data into Amazon S3.
|
|
*/
|
|
public function writeFile($data, array $params) {
|
|
$s3 = $this->newS3API();
|
|
|
|
// Generate a random name for this file. We add some directories to it
|
|
// (e.g. 'abcdef123456' becomes 'ab/cd/ef123456') to make large numbers of
|
|
// files more browsable with web/debugging tools like the S3 administration
|
|
// tool.
|
|
$seed = Filesystem::readRandomCharacters(20);
|
|
$parts = array(
|
|
substr($seed, 0, 2),
|
|
substr($seed, 2, 2),
|
|
substr($seed, 4),
|
|
);
|
|
$name = 'phabricator/'.implode('/', $parts);
|
|
|
|
AphrontWriteGuard::willWrite();
|
|
$s3->putObject(
|
|
$data,
|
|
$this->getBucketName(),
|
|
$name,
|
|
$acl = 'private');
|
|
|
|
return $name;
|
|
}
|
|
|
|
|
|
/**
|
|
* Load a stored blob from Amazon S3.
|
|
*/
|
|
public function readFile($handle) {
|
|
$result = $this->newS3API()->getObject(
|
|
$this->getBucketName(),
|
|
$handle);
|
|
|
|
// NOTE: The implementation of the API that we're using may respond with
|
|
// a successful result that has length 0 and no body property.
|
|
if (isset($result->body)) {
|
|
return $result->body;
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Delete a blob from Amazon S3.
|
|
*/
|
|
public function deleteFile($handle) {
|
|
AphrontWriteGuard::willWrite();
|
|
$this->newS3API()->deleteObject(
|
|
$this->getBucketName(),
|
|
$handle);
|
|
}
|
|
|
|
|
|
/* -( Internals )---------------------------------------------------------- */
|
|
|
|
|
|
/**
|
|
* Retrieve the S3 bucket name.
|
|
*
|
|
* @task internal
|
|
*/
|
|
private function getBucketName() {
|
|
$bucket = PhabricatorEnv::getEnvConfig('storage.s3.bucket');
|
|
if (!$bucket) {
|
|
throw new PhabricatorFileStorageConfigurationException(
|
|
"No 'storage.s3.bucket' specified!");
|
|
}
|
|
return $bucket;
|
|
}
|
|
|
|
/**
|
|
* Create a new S3 API object.
|
|
*
|
|
* @task internal
|
|
* @phutil-external-symbol class S3
|
|
*/
|
|
private function newS3API() {
|
|
$libroot = dirname(phutil_get_library_root('phabricator'));
|
|
require_once $libroot.'/externals/s3/S3.php';
|
|
|
|
$access_key = PhabricatorEnv::getEnvConfig('amazon-s3.access-key');
|
|
$secret_key = PhabricatorEnv::getEnvConfig('amazon-s3.secret-key');
|
|
$endpoint = PhabricatorEnv::getEnvConfig('amazon-s3.endpoint');
|
|
|
|
if (!$access_key || !$secret_key) {
|
|
throw new PhabricatorFileStorageConfigurationException(
|
|
"Specify 'amazon-s3.access-key' and 'amazon-s3.secret-key'!");
|
|
}
|
|
|
|
if ($endpoint !== null) {
|
|
$s3 = new S3($access_key, $secret_key, $use_ssl = true, $endpoint);
|
|
} else {
|
|
$s3 = new S3($access_key, $secret_key, $use_ssl = true);
|
|
}
|
|
|
|
$s3->setExceptions(true);
|
|
|
|
return $s3;
|
|
}
|
|
|
|
}
|