nextcloud /
server
@@ -39,158 +39,158 @@ |
||
| 39 | 39 | use OCP\ILogger; |
| 40 | 40 | |
| 41 | 41 | trait S3ConnectionTrait { |
| 42 | - /** @var array */ |
|
| 43 | - protected $params; |
|
| 44 | - |
|
| 45 | - /** @var S3Client */ |
|
| 46 | - protected $connection; |
|
| 47 | - |
|
| 48 | - /** @var string */ |
|
| 49 | - protected $id; |
|
| 50 | - |
|
| 51 | - /** @var string */ |
|
| 52 | - protected $bucket; |
|
| 53 | - |
|
| 54 | - /** @var int */ |
|
| 55 | - protected $timeout; |
|
| 56 | - |
|
| 57 | - /** @var int */ |
|
| 58 | - protected $uploadPartSize; |
|
| 59 | - |
|
| 60 | - protected $test; |
|
| 61 | - |
|
| 62 | - protected function parseParams($params) { |
|
| 63 | - if (empty($params['bucket'])) { |
|
| 64 | - throw new \Exception("Bucket has to be configured."); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - $this->id = 'amazon::' . $params['bucket']; |
|
| 68 | - |
|
| 69 | - $this->test = isset($params['test']); |
|
| 70 | - $this->bucket = $params['bucket']; |
|
| 71 | - $this->timeout = !isset($params['timeout']) ? 15 : $params['timeout']; |
|
| 72 | - $this->uploadPartSize = !isset($params['uploadPartSize']) ? 524288000 : $params['uploadPartSize']; |
|
| 73 | - $params['region'] = empty($params['region']) ? 'eu-west-1' : $params['region']; |
|
| 74 | - $params['hostname'] = empty($params['hostname']) ? 's3.' . $params['region'] . '.amazonaws.com' : $params['hostname']; |
|
| 75 | - if (!isset($params['port']) || $params['port'] === '') { |
|
| 76 | - $params['port'] = (isset($params['use_ssl']) && $params['use_ssl'] === false) ? 80 : 443; |
|
| 77 | - } |
|
| 78 | - $this->params = $params; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - public function getBucket() { |
|
| 82 | - return $this->bucket; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Returns the connection |
|
| 87 | - * |
|
| 88 | - * @return S3Client connected client |
|
| 89 | - * @throws \Exception if connection could not be made |
|
| 90 | - */ |
|
| 91 | - public function getConnection() { |
|
| 92 | - if (!is_null($this->connection)) { |
|
| 93 | - return $this->connection; |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - $scheme = (isset($this->params['use_ssl']) && $this->params['use_ssl'] === false) ? 'http' : 'https'; |
|
| 97 | - $base_url = $scheme . '://' . $this->params['hostname'] . ':' . $this->params['port'] . '/'; |
|
| 98 | - |
|
| 99 | - // Adding explicit credential provider to the beginning chain. |
|
| 100 | - // Including environment variables and IAM instance profiles. |
|
| 101 | - $provider = CredentialProvider::memoize( |
|
| 102 | - CredentialProvider::chain( |
|
| 103 | - $this->paramCredentialProvider(), |
|
| 104 | - CredentialProvider::env(), |
|
| 105 | - CredentialProvider::instanceProfile() |
|
| 106 | - ) |
|
| 107 | - ); |
|
| 108 | - |
|
| 109 | - $options = [ |
|
| 110 | - 'version' => isset($this->params['version']) ? $this->params['version'] : 'latest', |
|
| 111 | - 'credentials' => $provider, |
|
| 112 | - 'endpoint' => $base_url, |
|
| 113 | - 'region' => $this->params['region'], |
|
| 114 | - 'use_path_style_endpoint' => isset($this->params['use_path_style']) ? $this->params['use_path_style'] : false, |
|
| 115 | - 'signature_provider' => \Aws\or_chain([self::class, 'legacySignatureProvider'], ClientResolver::_default_signature_provider()), |
|
| 116 | - 'csm' => false, |
|
| 117 | - ]; |
|
| 118 | - if (isset($this->params['proxy'])) { |
|
| 119 | - $options['request.options'] = ['proxy' => $this->params['proxy']]; |
|
| 120 | - } |
|
| 121 | - if (isset($this->params['legacy_auth']) && $this->params['legacy_auth']) { |
|
| 122 | - $options['signature_version'] = 'v2'; |
|
| 123 | - } |
|
| 124 | - $this->connection = new S3Client($options); |
|
| 125 | - |
|
| 126 | - if (!$this->connection::isBucketDnsCompatible($this->bucket)) { |
|
| 127 | - $logger = \OC::$server->getLogger(); |
|
| 128 | - $logger->debug('Bucket "' . $this->bucket . '" This bucket name is not dns compatible, it may contain invalid characters.', |
|
| 129 | - ['app' => 'objectstore']); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - if (!$this->connection->doesBucketExist($this->bucket)) { |
|
| 133 | - $logger = \OC::$server->getLogger(); |
|
| 134 | - try { |
|
| 135 | - $logger->info('Bucket "' . $this->bucket . '" does not exist - creating it.', ['app' => 'objectstore']); |
|
| 136 | - if (!$this->connection::isBucketDnsCompatible($this->bucket)) { |
|
| 137 | - throw new \Exception("The bucket will not be created because the name is not dns compatible, please correct it: " . $this->bucket); |
|
| 138 | - } |
|
| 139 | - $this->connection->createBucket(['Bucket' => $this->bucket]); |
|
| 140 | - $this->testTimeout(); |
|
| 141 | - } catch (S3Exception $e) { |
|
| 142 | - $logger->logException($e, [ |
|
| 143 | - 'message' => 'Invalid remote storage.', |
|
| 144 | - 'level' => ILogger::DEBUG, |
|
| 145 | - 'app' => 'objectstore', |
|
| 146 | - ]); |
|
| 147 | - throw new \Exception('Creation of bucket "' . $this->bucket . '" failed. ' . $e->getMessage()); |
|
| 148 | - } |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - // google cloud's s3 compatibility doesn't like the EncodingType parameter |
|
| 152 | - if (strpos($base_url, 'storage.googleapis.com')) { |
|
| 153 | - $this->connection->getHandlerList()->remove('s3.auto_encode'); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - return $this->connection; |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * when running the tests wait to let the buckets catch up |
|
| 161 | - */ |
|
| 162 | - private function testTimeout() { |
|
| 163 | - if ($this->test) { |
|
| 164 | - sleep($this->timeout); |
|
| 165 | - } |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - public static function legacySignatureProvider($version, $service, $region) { |
|
| 169 | - switch ($version) { |
|
| 170 | - case 'v2': |
|
| 171 | - case 's3': |
|
| 172 | - return new S3Signature(); |
|
| 173 | - default: |
|
| 174 | - return null; |
|
| 175 | - } |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * This function creates a credential provider based on user parameter file |
|
| 180 | - */ |
|
| 181 | - protected function paramCredentialProvider() : callable { |
|
| 182 | - return function () { |
|
| 183 | - $key = empty($this->params['key']) ? null : $this->params['key']; |
|
| 184 | - $secret = empty($this->params['secret']) ? null : $this->params['secret']; |
|
| 185 | - |
|
| 186 | - if ($key && $secret) { |
|
| 187 | - return Promise\promise_for( |
|
| 188 | - new Credentials($key, $secret) |
|
| 189 | - ); |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - $msg = 'Could not find parameters set for credentials in config file.'; |
|
| 193 | - return new RejectedPromise(new CredentialsException($msg)); |
|
| 194 | - }; |
|
| 195 | - } |
|
| 42 | + /** @var array */ |
|
| 43 | + protected $params; |
|
| 44 | + |
|
| 45 | + /** @var S3Client */ |
|
| 46 | + protected $connection; |
|
| 47 | + |
|
| 48 | + /** @var string */ |
|
| 49 | + protected $id; |
|
| 50 | + |
|
| 51 | + /** @var string */ |
|
| 52 | + protected $bucket; |
|
| 53 | + |
|
| 54 | + /** @var int */ |
|
| 55 | + protected $timeout; |
|
| 56 | + |
|
| 57 | + /** @var int */ |
|
| 58 | + protected $uploadPartSize; |
|
| 59 | + |
|
| 60 | + protected $test; |
|
| 61 | + |
|
| 62 | + protected function parseParams($params) { |
|
| 63 | + if (empty($params['bucket'])) { |
|
| 64 | + throw new \Exception("Bucket has to be configured."); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + $this->id = 'amazon::' . $params['bucket']; |
|
| 68 | + |
|
| 69 | + $this->test = isset($params['test']); |
|
| 70 | + $this->bucket = $params['bucket']; |
|
| 71 | + $this->timeout = !isset($params['timeout']) ? 15 : $params['timeout']; |
|
| 72 | + $this->uploadPartSize = !isset($params['uploadPartSize']) ? 524288000 : $params['uploadPartSize']; |
|
| 73 | + $params['region'] = empty($params['region']) ? 'eu-west-1' : $params['region']; |
|
| 74 | + $params['hostname'] = empty($params['hostname']) ? 's3.' . $params['region'] . '.amazonaws.com' : $params['hostname']; |
|
| 75 | + if (!isset($params['port']) || $params['port'] === '') { |
|
| 76 | + $params['port'] = (isset($params['use_ssl']) && $params['use_ssl'] === false) ? 80 : 443; |
|
| 77 | + } |
|
| 78 | + $this->params = $params; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + public function getBucket() { |
|
| 82 | + return $this->bucket; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Returns the connection |
|
| 87 | + * |
|
| 88 | + * @return S3Client connected client |
|
| 89 | + * @throws \Exception if connection could not be made |
|
| 90 | + */ |
|
| 91 | + public function getConnection() { |
|
| 92 | + if (!is_null($this->connection)) { |
|
| 93 | + return $this->connection; |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + $scheme = (isset($this->params['use_ssl']) && $this->params['use_ssl'] === false) ? 'http' : 'https'; |
|
| 97 | + $base_url = $scheme . '://' . $this->params['hostname'] . ':' . $this->params['port'] . '/'; |
|
| 98 | + |
|
| 99 | + // Adding explicit credential provider to the beginning chain. |
|
| 100 | + // Including environment variables and IAM instance profiles. |
|
| 101 | + $provider = CredentialProvider::memoize( |
|
| 102 | + CredentialProvider::chain( |
|
| 103 | + $this->paramCredentialProvider(), |
|
| 104 | + CredentialProvider::env(), |
|
| 105 | + CredentialProvider::instanceProfile() |
|
| 106 | + ) |
|
| 107 | + ); |
|
| 108 | + |
|
| 109 | + $options = [ |
|
| 110 | + 'version' => isset($this->params['version']) ? $this->params['version'] : 'latest', |
|
| 111 | + 'credentials' => $provider, |
|
| 112 | + 'endpoint' => $base_url, |
|
| 113 | + 'region' => $this->params['region'], |
|
| 114 | + 'use_path_style_endpoint' => isset($this->params['use_path_style']) ? $this->params['use_path_style'] : false, |
|
| 115 | + 'signature_provider' => \Aws\or_chain([self::class, 'legacySignatureProvider'], ClientResolver::_default_signature_provider()), |
|
| 116 | + 'csm' => false, |
|
| 117 | + ]; |
|
| 118 | + if (isset($this->params['proxy'])) { |
|
| 119 | + $options['request.options'] = ['proxy' => $this->params['proxy']]; |
|
| 120 | + } |
|
| 121 | + if (isset($this->params['legacy_auth']) && $this->params['legacy_auth']) { |
|
| 122 | + $options['signature_version'] = 'v2'; |
|
| 123 | + } |
|
| 124 | + $this->connection = new S3Client($options); |
|
| 125 | + |
|
| 126 | + if (!$this->connection::isBucketDnsCompatible($this->bucket)) { |
|
| 127 | + $logger = \OC::$server->getLogger(); |
|
| 128 | + $logger->debug('Bucket "' . $this->bucket . '" This bucket name is not dns compatible, it may contain invalid characters.', |
|
| 129 | + ['app' => 'objectstore']); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + if (!$this->connection->doesBucketExist($this->bucket)) { |
|
| 133 | + $logger = \OC::$server->getLogger(); |
|
| 134 | + try { |
|
| 135 | + $logger->info('Bucket "' . $this->bucket . '" does not exist - creating it.', ['app' => 'objectstore']); |
|
| 136 | + if (!$this->connection::isBucketDnsCompatible($this->bucket)) { |
|
| 137 | + throw new \Exception("The bucket will not be created because the name is not dns compatible, please correct it: " . $this->bucket); |
|
| 138 | + } |
|
| 139 | + $this->connection->createBucket(['Bucket' => $this->bucket]); |
|
| 140 | + $this->testTimeout(); |
|
| 141 | + } catch (S3Exception $e) { |
|
| 142 | + $logger->logException($e, [ |
|
| 143 | + 'message' => 'Invalid remote storage.', |
|
| 144 | + 'level' => ILogger::DEBUG, |
|
| 145 | + 'app' => 'objectstore', |
|
| 146 | + ]); |
|
| 147 | + throw new \Exception('Creation of bucket "' . $this->bucket . '" failed. ' . $e->getMessage()); |
|
| 148 | + } |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + // google cloud's s3 compatibility doesn't like the EncodingType parameter |
|
| 152 | + if (strpos($base_url, 'storage.googleapis.com')) { |
|
| 153 | + $this->connection->getHandlerList()->remove('s3.auto_encode'); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + return $this->connection; |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * when running the tests wait to let the buckets catch up |
|
| 161 | + */ |
|
| 162 | + private function testTimeout() { |
|
| 163 | + if ($this->test) { |
|
| 164 | + sleep($this->timeout); |
|
| 165 | + } |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + public static function legacySignatureProvider($version, $service, $region) { |
|
| 169 | + switch ($version) { |
|
| 170 | + case 'v2': |
|
| 171 | + case 's3': |
|
| 172 | + return new S3Signature(); |
|
| 173 | + default: |
|
| 174 | + return null; |
|
| 175 | + } |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * This function creates a credential provider based on user parameter file |
|
| 180 | + */ |
|
| 181 | + protected function paramCredentialProvider() : callable { |
|
| 182 | + return function () { |
|
| 183 | + $key = empty($this->params['key']) ? null : $this->params['key']; |
|
| 184 | + $secret = empty($this->params['secret']) ? null : $this->params['secret']; |
|
| 185 | + |
|
| 186 | + if ($key && $secret) { |
|
| 187 | + return Promise\promise_for( |
|
| 188 | + new Credentials($key, $secret) |
|
| 189 | + ); |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + $msg = 'Could not find parameters set for credentials in config file.'; |
|
| 193 | + return new RejectedPromise(new CredentialsException($msg)); |
|
| 194 | + }; |
|
| 195 | + } |
|
| 196 | 196 | } |
