eko54r
b5e3a778ce
All checks were successful
Build, Push and Deploy / build-and-push (push) Successful in 3m3s
Gitea Actions Demo / Explore-Gitea-Actions (push) Successful in 16s
Build, Push and Deploy / deploy-staging (push) Successful in 32s
Build, Push and Deploy / deploy-production (push) Has been skipped
Build, Push and Deploy / cleanup (push) Successful in 1s
478 lines
18 KiB
PHP
478 lines
18 KiB
PHP
<?php
|
|
/**
|
|
* Copyright 2018 Google LLC
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
namespace Google\Cloud\Storage;
|
|
|
|
use Google\Cloud\Core\Timestamp;
|
|
|
|
/**
|
|
* Object Lifecycle Management supports common use cases like setting a Time to
|
|
* Live (TTL) for objects, archiving older versions of objects, or "downgrading"
|
|
* storage classes of objects to help manage costs.
|
|
*
|
|
* This builder does not execute any network requests and is intended to be used
|
|
* in combination with either
|
|
* {@see StorageClient::createBucket()}
|
|
* or {@see Bucket::update()}.
|
|
*
|
|
* Example:
|
|
* ```
|
|
* // Access a builder preconfigured with rules already existing on a given
|
|
* // bucket.
|
|
* use Google\Cloud\Storage\StorageClient;
|
|
*
|
|
* $storage = new StorageClient();
|
|
* $bucket = $storage->bucket('my-bucket');
|
|
* $lifecycle = $bucket->currentLifecycle();
|
|
* ```
|
|
*
|
|
* ```
|
|
* // Or get a fresh builder by using the static factory method.
|
|
* use Google\Cloud\Storage\Bucket;
|
|
*
|
|
* $lifecycle = Bucket::lifecycle();
|
|
* ```
|
|
*
|
|
* @see https://cloud.google.com/storage/docs/lifecycle Object Lifecycle Management API Documentation
|
|
*/
|
|
class Lifecycle implements \ArrayAccess, \IteratorAggregate
|
|
{
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $lifecycle;
|
|
|
|
/**
|
|
* @param array $lifecycle [optional] A lifecycle configuration. Please see
|
|
* [here](https://cloud.google.com/storage/docs/json_api/v1/buckets#lifecycle)
|
|
* for the expected structure.
|
|
*/
|
|
public function __construct(array $lifecycle = [])
|
|
{
|
|
$this->lifecycle = $lifecycle;
|
|
}
|
|
|
|
/**
|
|
* Adds an Object Lifecycle Delete Rule.
|
|
*
|
|
* Example:
|
|
* ```
|
|
* $lifecycle->addDeleteRule([
|
|
* 'age' => 50,
|
|
* 'isLive' => true
|
|
* ]);
|
|
* ```
|
|
*
|
|
* @param array $condition {
|
|
* The condition(s) where the rule will apply.
|
|
*
|
|
* @type int $age Age of an object (in days). This condition is
|
|
* satisfied when an object reaches the specified age.
|
|
* @type \DateTimeInterface|string $createdBefore This condition is
|
|
* satisfied when an object is created before midnight of the
|
|
* specified date in UTC. If a string is given, it must be a date
|
|
* in RFC 3339 format with only the date part (for instance,
|
|
* "2013-01-15").
|
|
* @type \DateTimeInterface|string $customTimeBefore This condition is
|
|
* satisfied when the custom time on an object is before this date
|
|
* in UTC. If a string is given, it must be a date in RFC 3339
|
|
* format with only the date part (for instance, "2013-01-15").
|
|
* @type int $daysSinceCustomTime Number of days elapsed since the
|
|
* user-specified timestamp set on an object. The condition is
|
|
* satisfied if the days elapsed is at least this number. If no
|
|
* custom timestamp is specified on an object, the condition does
|
|
* not apply.
|
|
* @type int $daysSinceNoncurrentTime Number of days elapsed since the
|
|
* noncurrent timestamp of an object. The condition is satisfied
|
|
* if the days elapsed is at least this number. This condition is
|
|
* relevant only for versioned objects. The value of the field
|
|
* must be a nonnegative integer. If it's zero, the object version
|
|
* will become eligible for Lifecycle action as soon as it becomes
|
|
* noncurrent.
|
|
* @type bool $isLive Relevant only for versioned objects. If the value
|
|
* is `true`, this condition matches live objects; if the value is
|
|
* `false`, it matches archived objects.
|
|
* @type string[] $matchesStorageClass Objects having any of the storage
|
|
* classes specified by this condition will be matched. Values
|
|
* include `"MULTI_REGIONAL"`, `"REGIONAL"`, `"NEARLINE"`,
|
|
* `"ARCHIVE"`, `"COLDLINE"`, `"STANDARD"`, and
|
|
* `"DURABLE_REDUCED_AVAILABILITY"`.
|
|
* @type \DateTimeInterface|string $noncurrentTimeBefore This condition
|
|
* is satisfied when the noncurrent time on an object is before
|
|
* this timestamp. This condition is relevant only for versioned
|
|
* objects. If a string is given, it must be a date in RFC 3339
|
|
* format with only the date part (for instance, "2013-01-15").
|
|
* @type int $numNewerVersions Relevant only for versioned objects. If
|
|
* the value is N, this condition is satisfied when there are at
|
|
* least N versions (including the live version) newer than this
|
|
* version of the object.
|
|
* @type string[] $matchesPrefix Objects having names which start with
|
|
* values specified by this condition will be matched.
|
|
* @type string[] $matchesSuffix Objects having names which end with
|
|
* values specified by this condition will be matched.
|
|
* }
|
|
* @return Lifecycle
|
|
*/
|
|
public function addDeleteRule(array $condition)
|
|
{
|
|
$this->lifecycle['rule'][] = [
|
|
'action' => [
|
|
'type' => 'Delete'
|
|
],
|
|
'condition' => $this->formatCondition($condition)
|
|
];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds a AbortIncompleteMultipartUpload lifecycle rule to Object Lifecycle.
|
|
*
|
|
* Example:
|
|
* ```
|
|
* $lifecycle->addAbortIncompleteMultipartUploadRule([
|
|
* 'age' => 50,
|
|
* 'isLive' => true
|
|
* ]);
|
|
* ```
|
|
*
|
|
* @param array $condition {
|
|
* The condition(s) where the rule will apply.
|
|
*
|
|
* @type int $age Age of an object (in days). This condition is
|
|
* satisfied when an object reaches the specified age.
|
|
* @type \DateTimeInterface|string $createdBefore This condition is
|
|
* satisfied when an object is created before midnight of the
|
|
* specified date in UTC. If a string is given, it must be a date
|
|
* in RFC 3339 format with only the date part (for instance,
|
|
* "2013-01-15").
|
|
* @type \DateTimeInterface|string $customTimeBefore This condition is
|
|
* satisfied when the custom time on an object is before this date
|
|
* in UTC. If a string is given, it must be a date in RFC 3339
|
|
* format with only the date part (for instance, "2013-01-15").
|
|
* @type int $daysSinceCustomTime Number of days elapsed since the
|
|
* user-specified timestamp set on an object. The condition is
|
|
* satisfied if the days elapsed is at least this number. If no
|
|
* custom timestamp is specified on an object, the condition does
|
|
* not apply.
|
|
* @type int $daysSinceNoncurrentTime Number of days elapsed since the
|
|
* noncurrent timestamp of an object. The condition is satisfied
|
|
* if the days elapsed is at least this number. This condition is
|
|
* relevant only for versioned objects. The value of the field
|
|
* must be a nonnegative integer. If it's zero, the object version
|
|
* will become eligible for Lifecycle action as soon as it becomes
|
|
* noncurrent.
|
|
* @type bool $isLive Relevant only for versioned objects. If the value
|
|
* is `true`, this condition matches live objects; if the value is
|
|
* `false`, it matches archived objects.
|
|
* @type string[] $matchesStorageClass Objects having any of the storage
|
|
* classes specified by this condition will be matched. Values
|
|
* include `"MULTI_REGIONAL"`, `"REGIONAL"`, `"NEARLINE"`,
|
|
* `"ARCHIVE"`, `"COLDLINE"`, `"STANDARD"`, and
|
|
* `"DURABLE_REDUCED_AVAILABILITY"`.
|
|
* @type \DateTimeInterface|string $noncurrentTimeBefore This condition
|
|
* is satisfied when the noncurrent time on an object is before
|
|
* this timestamp. This condition is relevant only for versioned
|
|
* objects. If a string is given, it must be a date in RFC 3339
|
|
* format with only the date part (for instance, "2013-01-15").
|
|
* @type int $numNewerVersions Relevant only for versioned objects. If
|
|
* the value is N, this condition is satisfied when there are at
|
|
* least N versions (including the live version) newer than this
|
|
* version of the object.
|
|
* @type string[] $matchesPrefix Objects having names which start with
|
|
* values specified by this condition will be matched.
|
|
* @type string[] $matchesSuffix Objects having names which end with
|
|
* values specified by this condition will be matched.
|
|
* }
|
|
* @return Lifecycle
|
|
*/
|
|
public function addAbortIncompleteMultipartUploadRule(array $condition)
|
|
{
|
|
$this->lifecycle['rule'][] = [
|
|
'action' => [
|
|
'type' => 'AbortIncompleteMultipartUpload'
|
|
],
|
|
'condition' => $this->formatCondition($condition)
|
|
];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Adds an Object Lifecycle Set Storage Class Rule.
|
|
*
|
|
* Example:
|
|
* ```
|
|
* $lifecycle->addSetStorageClassRule('COLDLINE', [
|
|
* 'age' => 50,
|
|
* 'isLive' => true
|
|
* ]);
|
|
* ```
|
|
*
|
|
* ```
|
|
* // Using customTimeBefore rule with an object's custom time setting.
|
|
* $lifecycle->addSetStorageClassRule('NEARLINE', [
|
|
* 'customTimeBefore' => (new \DateTime())->add(
|
|
* \DateInterval::createFromDateString('+10 days')
|
|
* )
|
|
* ]);
|
|
*
|
|
* $bucket->update(['lifecycle' => $lifecycle]);
|
|
*
|
|
* $object = $bucket->object($objectName);
|
|
* $object->update([
|
|
* 'metadata' => [
|
|
* 'customTime' => '2020-08-17'
|
|
* ]
|
|
* ]);
|
|
* ```
|
|
*
|
|
* @param string $storageClass The target storage class. Values include
|
|
* `"MULTI_REGIONAL"`, `"REGIONAL"`, `"NEARLINE"`, `"COLDLINE"`,
|
|
* `"STANDARD"`, and `"DURABLE_REDUCED_AVAILABILITY"`.
|
|
* @param array $condition {
|
|
* The condition(s) where the rule will apply.
|
|
*
|
|
* @type int $age Age of an object (in days). This condition is
|
|
* satisfied when an object reaches the specified age.
|
|
* @type \DateTimeInterface|string $createdBefore This condition is
|
|
* satisfied when an object is created before midnight of the
|
|
* specified date in UTC. If a string is given, it must be a date
|
|
* in RFC 3339 format with only the date part (for instance,
|
|
* "2013-01-15").
|
|
* @type \DateTimeInterface|string $customTimeBefore This condition is
|
|
* satisfied when the custom time on an object is before this date
|
|
* in UTC. If a string is given, it must be a date in RFC 3339
|
|
* format with only the date part (for instance, "2013-01-15").
|
|
* @type int $daysSinceCustomTime Number of days elapsed since the
|
|
* user-specified timestamp set on an object. The condition is
|
|
* satisfied if the days elapsed is at least this number. If no
|
|
* custom timestamp is specified on an object, the condition does
|
|
* not apply.
|
|
* @type int $daysSinceNoncurrentTime Number of days elapsed since the
|
|
* noncurrent timestamp of an object. The condition is satisfied
|
|
* if the days elapsed is at least this number. This condition is
|
|
* relevant only for versioned objects. The value of the field
|
|
* must be a nonnegative integer. If it's zero, the object version
|
|
* will become eligible for Lifecycle action as soon as it becomes
|
|
* noncurrent.
|
|
* @type bool $isLive Relevant only for versioned objects. If the value
|
|
* is `true`, this condition matches live objects; if the value is
|
|
* `false`, it matches archived objects.
|
|
* @type string[] $matchesStorageClass Objects having any of the storage
|
|
* classes specified by this condition will be matched. Values
|
|
* include `"MULTI_REGIONAL"`, `"REGIONAL"`, `"NEARLINE"`,
|
|
* `"ARCHIVE"`, `"COLDLINE"`, `"STANDARD"`, and
|
|
* `"DURABLE_REDUCED_AVAILABILITY"`.
|
|
* @type \DateTimeInterface|string $noncurrentTimeBefore This condition
|
|
* is satisfied when the noncurrent time on an object is before
|
|
* this timestamp. This condition is relevant only for versioned
|
|
* objects. If a string is given, it must be a date in RFC 3339
|
|
* format with only the date part (for instance, "2013-01-15").
|
|
* @type int $numNewerVersions Relevant only for versioned objects. If
|
|
* the value is N, this condition is satisfied when there are at
|
|
* least N versions (including the live version) newer than this
|
|
* version of the object.
|
|
* @type string[] $matchesPrefix Objects having names which start with
|
|
* values specified by this condition will be matched.
|
|
* @type string[] $matchesSuffix Objects having names which end with
|
|
* values specified by this condition will be matched.
|
|
* }
|
|
* @return Lifecycle
|
|
*/
|
|
public function addSetStorageClassRule($storageClass, array $condition)
|
|
{
|
|
$this->lifecycle['rule'][] = [
|
|
'action' => [
|
|
'type' => 'SetStorageClass',
|
|
'storageClass' => $storageClass
|
|
],
|
|
'condition' => $this->formatCondition($condition)
|
|
];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Clear all Object Lifecycle rules or rules of a certain action type.
|
|
*
|
|
* Example:
|
|
* ```
|
|
* // Remove all rules.
|
|
* $lifecycle->clearRules();
|
|
* ```
|
|
*
|
|
* ```
|
|
* // Remove all "Delete" based rules.
|
|
* $lifecycle->clearRules('Delete');
|
|
* ```
|
|
*
|
|
* ```
|
|
* // Clear any rules which have an age equal to 50.
|
|
* $lifecycle->clearRules(function (array $rule) {
|
|
* return $rule['condition']['age'] === 50
|
|
* ? false
|
|
* : true;
|
|
* });
|
|
* ```
|
|
*
|
|
* @param string|callable $action [optional] If a string is provided, it
|
|
* must be the name of the type of rule to remove (`SetStorageClass`
|
|
* or `Delete`). All rules of this type will then be cleared. When
|
|
* providing a callable you may define a custom route for how you
|
|
* would like to remove rules. The provided callable will be run
|
|
* through
|
|
* [array_filter](http://php.net/manual/en/function.array-filter.php).
|
|
* The callable's argument will be a single lifecycle rule as an
|
|
* associative array. When returning true from the callable the rule
|
|
* will be preserved, and if false it will be removed.
|
|
* **Defaults to** `null`, clearing all assigned rules.
|
|
* @return Lifecycle
|
|
* @throws \InvalidArgumentException If a type other than a string or
|
|
* callabe is provided.
|
|
*/
|
|
public function clearRules($action = null)
|
|
{
|
|
if (!$action) {
|
|
$this->lifecycle = [];
|
|
return $this;
|
|
}
|
|
|
|
if (!is_string($action) && !is_callable($action)) {
|
|
throw new \InvalidArgumentException(
|
|
sprintf(
|
|
'Expected either a string or callable, instead got \'%s\'.',
|
|
gettype($action)
|
|
)
|
|
);
|
|
}
|
|
|
|
if (isset($this->lifecycle['rule'])) {
|
|
if (is_string($action)) {
|
|
$action = function ($rule) use ($action) {
|
|
return $rule['action']['type'] !== $action;
|
|
};
|
|
}
|
|
|
|
$this->lifecycle['rule'] = array_filter(
|
|
$this->lifecycle['rule'],
|
|
$action
|
|
);
|
|
|
|
if (!$this->lifecycle['rule']) {
|
|
$this->lifecycle = [];
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @access private
|
|
* @return \Generator
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function getIterator()
|
|
{
|
|
if (!isset($this->lifecycle['rule'])) {
|
|
return;
|
|
}
|
|
|
|
foreach ($this->lifecycle['rule'] as $rule) {
|
|
yield $rule;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @access private
|
|
* @return array
|
|
*/
|
|
public function toArray()
|
|
{
|
|
return $this->lifecycle;
|
|
}
|
|
|
|
/**
|
|
* @access private
|
|
* @param string $offset
|
|
* @param mixed $value
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function offsetSet($offset, $value)
|
|
{
|
|
$this->lifecycle['rule'][$offset] = $value;
|
|
}
|
|
|
|
/**
|
|
* @access private
|
|
* @param string $offset
|
|
* @return bool
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function offsetExists($offset)
|
|
{
|
|
return isset($this->lifecycle['rule'][$offset]);
|
|
}
|
|
|
|
/**
|
|
* @access private
|
|
* @param string $offset
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function offsetUnset($offset)
|
|
{
|
|
unset($this->lifecycle['rule'][$offset]);
|
|
}
|
|
|
|
/**
|
|
* @access private
|
|
* @param string $offset
|
|
* @return mixed
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function offsetGet($offset)
|
|
{
|
|
return isset($this->lifecycle['rule'][$offset])
|
|
? $this->lifecycle['rule'][$offset]
|
|
: null;
|
|
}
|
|
|
|
/**
|
|
* Apply condition-specific formatting rules (such as date formatting) to
|
|
* conditions.
|
|
*
|
|
* @param array $condition
|
|
* @return array
|
|
*/
|
|
private function formatCondition(array $condition)
|
|
{
|
|
$rfc339DateFields = [
|
|
'createdBefore',
|
|
'customTimeBefore',
|
|
'noncurrentTimeBefore'
|
|
];
|
|
|
|
foreach ($rfc339DateFields as $field) {
|
|
if (isset($condition[$field]) && $condition[$field] instanceof \DateTimeInterface) {
|
|
$condition[$field] = $condition[$field]->format('Y-m-d');
|
|
}
|
|
}
|
|
|
|
return $condition;
|
|
}
|
|
}
|