OXIESEC PANEL
- Current Dir:
/
/
opt
/
gsutil
/
gslib
/
commands
/
__pycache__
Server IP: 2a02:4780:11:1594:0:ef5:22d7:a
Upload:
Create Dir:
Name
Size
Modified
Perms
📁
..
-
02/11/2025 08:19:49 AM
rwxr-xr-x
📄
__init__.cpython-39.pyc
323 bytes
02/11/2025 08:19:49 AM
rw-r--r--
📄
acl.cpython-39.pyc
18.76 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
autoclass.cpython-39.pyc
6.01 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
bucketpolicyonly.cpython-39.pyc
6.75 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
cat.cpython-39.pyc
4.17 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
compose.cpython-39.pyc
4.57 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
config.cpython-39.pyc
40.97 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
cors.cpython-39.pyc
6.56 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
cp.cpython-39.pyc
42.21 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
defacl.cpython-39.pyc
11.25 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
defstorageclass.cpython-39.pyc
5.78 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
du.cpython-39.pyc
8.47 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
hash.cpython-39.pyc
7.87 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
help.cpython-39.pyc
6.41 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
hmac.cpython-39.pyc
12.39 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
iam.cpython-39.pyc
24.6 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
kms.cpython-39.pyc
14.88 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
label.cpython-39.pyc
10.46 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
lifecycle.cpython-39.pyc
6.37 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
logging.cpython-39.pyc
9.04 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
ls.cpython-39.pyc
18.81 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
mb.cpython-39.pyc
12.23 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
mv.cpython-39.pyc
5.06 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
notification.cpython-39.pyc
25.47 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
pap.cpython-39.pyc
6.53 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
perfdiag.cpython-39.pyc
62.18 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
rb.cpython-39.pyc
3.78 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
requesterpays.cpython-39.pyc
5.53 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
retention.cpython-39.pyc
20.02 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
rewrite.cpython-39.pyc
16.12 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
rm.cpython-39.pyc
10.86 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
rpo.cpython-39.pyc
5.96 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
rsync.cpython-39.pyc
53.86 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
setmeta.cpython-39.pyc
11.25 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
signurl.cpython-39.pyc
20.99 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
stat.cpython-39.pyc
5.04 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
test.cpython-39.pyc
17.73 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
ubla.cpython-39.pyc
6.96 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
update.cpython-39.pyc
12.26 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
version.cpython-39.pyc
5.25 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
versioning.cpython-39.pyc
5.51 KB
02/11/2025 08:19:49 AM
rw-r--r--
📄
web.cpython-39.pyc
7.63 KB
02/11/2025 08:19:49 AM
rw-r--r--
Editing: retention.cpython-39.pyc
Close
a +(Wg w � @ s< d Z ddlmZ ddlZddlmZ ddlmZ ddlm Z ddlm Z ddl m Z dd l mZ dd lmZ dd lmZ dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlm Z ddl m Z ddl m!Z! ddl"m#Z# ddl$m%Z% ddl&m'Z' ddl&m(Z( ddl&m)Z) ddl&m*Z* ddl&m+Z+ ddl&m,Z, dd l&m-Z- dd l&m.Z. dd l/m0Z0 dd l1m2Z2 d Z3d!Z4d"Z5d#Z6d$Z7d%Z8d&Z9d'Z:d(Z;d)Z<d*Z=d+Z>d,Z?d-Z@e3e4 e5 e6 e7 e8 e9 ZAe:e; e< e= e> e? e@ ZBeeAeB�ZCee3e:�ZDee4e;�ZEee5e<�ZFee6e=�ZGee7e>�ZHee8e?�ZIee9e@�ZJG d.d/� d/e �ZKdS )0zEImplementation of Retention Policy configuration command for buckets.� )�absolute_importN)�encoding)�metrics)�AccessDeniedException)� Preconditions)�Command)�CommandArgument)� ApiSelector)�CommandException)�NO_URLS_MATCHED_TARGET)�CreateHelpText)�NameExpansionIterator)� SeekAheadNameExpansionIterator)�StorageUrlFromString)�storage_v1_messages)�MetadataMessage)�GetCloudApiInstance)�NO_MAX)�PutToQueueWithTimeout)�ConfirmLockRequest)�ReleaseEventHoldFuncWrapper)�ReleaseTempHoldFuncWrapper)�RetentionInSeconds)�RetentionPolicyToString)�SetEventHoldFuncWrapper)�SetTempHoldFuncWrapper)�$UpdateObjectMetadataExceptionHandler)�GcloudStorageMap)�PreconditionsFromHeaderszA gsutil retention set <retention_period> gs://<bucket_name>... z0 gsutil retention clear gs://<bucket_name>... z. gsutil retention get gs://<bucket_name>... z/ gsutil retention lock gs://<bucket_name>... zF gsutil retention event-default (set|release) gs://<bucket_name>... zL gsutil retention event (set|release) gs://<bucket_name>/<object_name>... zK gsutil retention temp (set|release) gs://<bucket_name>/<object_name>... a� <B>SET</B> You can configure a data retention policy for a Cloud Storage bucket that governs how long objects in the bucket must be retained. You can also lock the data retention policy, permanently preventing the policy from being reduced or removed. For more information, see `Retention policies and Bucket Lock <https://cloud.google.com/storage/docs/bucket-lock>`_. The ``gsutil retention set`` command allows you to set or update the retention policy on one or more buckets. To remove an unlocked retention policy from one or more buckets, use the ``gsutil retention clear`` command. The ``set`` sub-command can set a retention policy with the following formats: <B>SET FORMATS</B> Formats for the ``set`` subcommand include: <number>s Specifies retention period of <number> seconds for objects in this bucket. <number>d Specifies retention period of <number> days for objects in this bucket. <number>m Specifies retention period of <number> months for objects in this bucket. <number>y Specifies retention period of <number> years for objects in this bucket. GCS JSON API accepts retention periods as number of seconds. Durations provided in terms of days, months or years are converted to their rough equivalent values in seconds, using the following conversions: - A month is considered to be 31 days or 2,678,400 seconds. - A year is considered to be 365.25 days or 31,557,600 seconds. Retention periods must be greater than 0 and less than 100 years. Retention durations must be in only one form (seconds, days, months, or years), and not a combination of them. Note that while it is possible to specify retention durations shorter than a day (using seconds), enforcement of such retention periods is not guaranteed. Such durations may only be used for testing purposes. <B>EXAMPLES</B> Setting a retention policy with a duration of 1 year on a bucket: gsutil retention set 1y gs://my-bucket Setting a retention policy with a duration of 36 months on a bucket: gsutil retention set 36m gs://some-bucket You can also provide a precondition on a bucket's metageneration in order to avoid potential race conditions. You can use gsutil's '-h' option to specify preconditions. For example, the following specifies a precondition that checks a bucket's metageneration before setting the retention policy on the bucket: gsutil -h "x-goog-if-metageneration-match: 1" \ retention set 1y gs://my-bucket a4 <B>CLEAR</B> The ``gsutil retention clear`` command removes an unlocked retention policy from one or more buckets. You cannot remove or reduce the duration of a locked retention policy. <B>EXAMPLES</B> Clearing an unlocked retention policy from a bucket: gsutil retention clear gs://my-bucket z� <B>GET</B> The ``gsutil retention get`` command retrieves the retention policy for a given bucket and displays a human-readable representation of the configuration. a1 <B>LOCK</B> The ``gsutil retention lock`` command PERMANENTLY locks an unlocked retention policy on one or more buckets. CAUTION: A locked retention policy cannot be removed from a bucket or reduced in duration. Once locked, deleting the bucket is the only way to "remove" a retention policy. a� <B>EVENT-DEFAULT</B> The ``gsutil retention event-default`` command sets the default value for an event-based hold on one or more buckets. By setting the default event-based hold on a bucket, newly-created objects inherit that value as their event-based hold (it is not applied retroactively). <B>EXAMPLES</B> Setting the default event-based hold on a bucket: gsutil retention event-default set gs://my-bucket Releasing the default event-based hold on a bucket: gsutil retention event-default release gs://my-bucket You can also provide a precondition on a bucket's metageneration in order to avoid potential race conditions. You can use gsutil's '-h' option to specify preconditions. For example, the following specifies a precondition that checks a bucket's metageneration before setting the default event-based hold on the bucket: gsutil -h "x-goog-if-metageneration-match: 1" \ retention event-default set gs://my-bucket a[ <B>EVENT</B> The ``gsutil retention event`` command enables or disables an event-based hold on an object. <B>EXAMPLES</B> Setting the event-based hold on an object: gsutil retention event set gs://my-bucket/my-object Releasing the event-based hold on an object: gsutil retention event release gs://my-bucket/my-object You can also provide a precondition on an object's metageneration in order to avoid potential race conditions. You can use gsutil's '-h' option to specify preconditions. For example, the following specifies a precondition that checks an object's metageneration before setting the event-based hold on the object: gsutil -h "x-goog-if-metageneration-match: 1" \ retention event set gs://my-bucket/my-object If you want to set or release an event-based hold on a large number of objects, then you might want to use the top-level '-m' option to perform a parallel update. For example, the following command sets an event-based hold on objects ending with .jpg in parallel, in the root folder: gsutil -m retention event set gs://my-bucket/*.jpg aA <B>TEMP</B> The ``gsutil retention temp`` command enables or disables a temporary hold on an object. <B>EXAMPLES</B> Setting the temporary hold on an object: gsutil retention temp set gs://my-bucket/my-object Releasing the temporary hold on an object: gsutil retention temp release gs://my-bucket/my-object You can also provide a precondition on an object's metageneration in order to avoid potential race conditions. You can use gsutil's '-h' option to specify preconditions. For example, the following specifies a precondition that checks an object's metageneration before setting the temporary hold on the object: gsutil -h "x-goog-if-metageneration-match: 1" \ retention temp set gs://my-bucket/my-object If you want to set or release a temporary hold on a large number of objects, then you might want to use the top-level '-m' option to perform a parallel update. For example, the following command sets a temporary hold on objects ending with .jpg in parallel, in the root folder: gsutil -m retention temp set gs://bucket/*.jpg c s> e Zd ZdZejdg ededddej gej e � � ge � � ge � d�ge � � ge � � ge � � gd�e � � ge � � gd�e � � ge � � gd�d�d� Zejdg d d eeeeeeeed �d �Z� fd d�Zdd� Zdd� Zd,dd�Z dd� Z dd� Z dd� Z d d � Z d d � Z!d d!� Z"d"d#� Z#d$d%� Z$d&d'� Z%d(d)� Z&d*d+� Z'� Z(S )-�RetentionCommandz+Implementation of gsutil retention command.� retention� F� ��set�release)r$ �clear�get�lock� event-default�event�temp) �command_name_aliases�usage_synopsis�min_args�max_args� file_url_ok�provider_url_ok�urls_start_arg�gs_api_support�gs_default_api�argparse_arguments� command_helpz=Provides utilities to interact with Retention Policy feature.)r' r$ r& r( r) r* r+ )� help_name�help_name_aliases� help_type�help_one_line_summary� help_text�subcommand_help_textc s | j d dkr^tdtdddd�t| j d ��g| j dd � i d �ii d �}| j d d� | _ n�ttg d �i d �ttg d �i d �tg d �i d �d �i d �ttg d�i d �tg d�i d �d �i d �tg d�i d �tg d�i d �ttg d�i d �tg d�i d �d �i d �d�i d �}t� �|�S )Nr r$ �storage�buckets�updatez--retention-period={}sr" r! )�gcloud_command�flag_map)r= r> r? z--clear-retention-period)r= �objectsr? z--event-based-hold)r= rB r? z--no-event-based-holdr# )r= r> r? z--default-event-based-hold)r= r> r? z --no-default-event-based-hold)r= r> �describez --format=yaml(retentionPolicy)z--raw)r= r> r? z--lock-retention-period)r= rB r? z--temporary-hold)r= rB r? z--no-temporary-hold)r& r* r) r' r( r+ )�argsr �formatr �super�get_gcloud_storage_args)�self�gcloud_storage_map�� __class__� �'/opt/gsutil/gslib/commands/retention.pyrG I s� �� ��� � ����������������Z�]z(RetentionCommand.get_gcloud_storage_argsc C s� | j �d�tjkr"td�| j���t| j�| _ | j � d�}| j dd� |dkrV| j }nr|dkrf| j}nb|dkrv| j}nR|d kr�| j}nB|d kr�| j}n2|d kr�| j}n"|d kr�| j}ntd �|| j���tj|g| jd� |� S )z.Command entry point for the retention command.�gsz�The {} command can only be used with the GCS JSON API. If you have only supplied hmac credentials in your boto file, please instead supply a credential type that can be used with the JSON API.r T)� check_argsr$ r& r' r( r) r* r+ zHInvalid subcommand "{}" for the {} command. See "gsutil help retention".)� subcommands�sub_opts)� gsutil_api�GetApiSelectorr �JSONr rE � command_namer �headers� preconditionsrD �pop� ParseSubOpts� _SetRetention�_ClearRetention� _GetRetention�_LockRetention�_DefaultEventHold� _EventHold� _TempHoldr �LogCommandParamsrQ )rH �action_subcommand�funcrL rL rM � RunCommand� s> � ���zRetentionCommand.RunCommandc C s� t | jjd�}d}|D ]P}| j|dgd�}|D ]6} | j} d}| j�|| � | jj| j ||| j |d� q.q|s|t t t |� ��d S )N)�meta_gen_matchF�id�� bucket_fieldsT)rW �provider�fields)r rW re �GetBucketUrlIterFromArg� storage_url�logger�inforR � PatchBucket� bucket_name�schemer r �list) rH �url_args�bucket_metadata_updaterj �log_msg_templaterW � some_matched�url_str� bucket_iter�blr�urlrL rL rM �BucketUpdateFunc� s$ � � z!RetentionCommand.BucketUpdateFuncNc C s� t | |d�}|j}| j�||� t�tj|j�}t | j j | j j d�}|j du rV|j |_ |j du rh|j|_ |j|j|j||j ||jdgd� t|jtt�� d�� dS )a� Updates metadata on an object using PatchObjectMetadata. Args: patch_obj_metadata: Metadata changes that should be applied to the existing object. log_template: The log template that should be printed for each object. name_expansion_result: NameExpansionResult describing target object. thread_state: gsutil Cloud API instance to use for the operation. )� thread_state)� gen_matchre Nrf )� generationrW ri rj )� message_time)r �expanded_storage_urlrm rn r � JsonToMessage�apitools_messages�Object�expanded_resultr rW r} re r~ �metageneration�PatchObjectMetadatarp � object_namerq r � status_queuer �time) rH Zpatch_obj_metadata� log_template�name_expansion_resultr| rR � exp_src_urlZcloud_obj_metadatarW rL rL rM �ObjectUpdateMetadataFunc� s2 �� � �z)RetentionCommand.ObjectUpdateMetadataFuncc C s, t | j| j| j| j|| j| j| jddgd� S )Nr~ r� )� all_versions�continue_on_error�bucket_listing_fields)r rU �debugrm rR �recursion_requestedr� �parallel_operations�rH rs rL rL rM � _GetObjectNameExpansionIterator! s �z0RetentionCommand._GetObjectNameExpansionIteratorc C s$ t | j| j| �� || j| j| jd�S )N)r� � project_id)r rU r� �GetSeekAheadGsutilApir� r� r� r� rL rL rM �"_GetSeekAheadNameExpansionIterator- s �z3RetentionCommand._GetSeekAheadNameExpansionIteratorc C sT t | jd �}tjj|d�}d}tj|d�}| jdd� }| j||ddg|d � dS ) z6Set retention retention_period on one or more buckets.r ��retentionPeriodz!Setting Retention Policy on %s...��retentionPolicyr" Nrf r� �rj ru )r rD r� �Bucket�RetentionPolicyValuer{ )rH �seconds�retention_policyru rt rs rL rL rM rZ 6 s ���z RetentionCommand._SetRetentionc C s> t jjdd�}d}t j|d�}| j}| j||ddg|d� dS ) z8Clear retention retention_period on one or more buckets.Nr� z"Clearing Retention Policy on %s...r� rf r� r� r )r� r� r� rD r{ )rH r� ru rt rs rL rL rM r[ G s ���z RetentionCommand._ClearRetentionc C s. | j | jd dgd�\}}tt|j|�� dS )z)Get Retention Policy for a single bucket.r r� rg )�GetSingleBucketUrlFromArgrD �printr r� )rH � bucket_url�bucket_metadatarL rL rM r\ U s � z RetentionCommand._GetRetentionc C s� | j }d}|D ]�}| j|dgd�}|D ]�}|j}d}| jj|j|jg d�d�}|jr\|jjsnt d� |j���q&|jj du r�| j � d|� q&t|j|j�r�| j �d |� | jj|j|j|jd � q&| j � d � |�� q&q|s�t tt|� ��d S ) z-Lock Retention Policy on one or more buckets.Frf rg T)rf r� r� )ri rj z7Bucket "{}" does not have an Unlocked Retention Policy.z+Retention Policy on "%s" is already locked.z!Locking Retention Policy on %s...)ri z& Abort Locking Retention Policy on {}r )rD rk rl rR � GetBucketrp rq r� r� r rE �isLockedrm �errorr rn �LockRetentionPolicyr� r rr )rH rs rv rw rx ry rz r� rL rL rM r] \ sH ���� � ��z RetentionCommand._LockRetentionc C s� d}| j rJ| j d �� dkr"d}n(| j d �� dkr:d}ntd�| j���|rRdnd }d �|�}tj|d �}| j d d� }| j||d dg|d� dS )z?Sets default value for Event-Based Hold on one or more buckets.Nr r$ Tr% FzeInvalid subcommand "{}" for the "retention event-default" command. See "gsutil help retention event".ZSettingZ Releasingz${} default Event-Based Hold on %s...)�defaultEventBasedHoldr" rf r� r� )rD �lowerr rE rQ r� r� r{ )rH �hold�verbru rt rs rL rL rM r^ � s. �� ��z"RetentionCommand._DefaultEventHoldc C s> d}d}| � |�}| jdd� }|r(tnt}| �|||� dS )z7Sets or unsets Event-Based Hold on one or more objects.r* z Event-Basedr" Nr )�_ProcessHoldArgsrD r r �_SetHold�rH �sub_command_name�sub_command_full_namer� rs �obj_metadata_update_wrapperrL rL rM r_ � s ��zRetentionCommand._EventHoldc C s> d}d}| � |�}| jdd� }|r(tnt}| �|||� dS )z5Sets or unsets Temporary Hold on one or more objects.r+ Z Temporaryr" Nr )r� rD r r r� r� rL rL rM r` � s ��zRetentionCommand._TempHoldc C sP d}| j d �� dkr d}n0| j d �� dkr4d}ntd�| j d ||���|S )a Processes command args for Temporary and Event-Based Hold sub-command. Args: sub_command_name: The name of the subcommand: "temp" / "event" Returns: Returns a boolean value indicating whether to set (True) or release (False)the Hold. Nr r$ Tr% FzWInvalid subcommand "{}" for the "retention {}" command. See "gsutil help retention {}".)rD r� r rE )rH r� r� rL rL rM r� � s ��z!RetentionCommand._ProcessHoldArgsc C s� t |�dkr@| js@t|d �}|�� r.|�� s@td�|d ���| �|�}| �|�}d| _ z| j ||t d|d� W n8 t y� } z |j dkr�| �� � W Y d}~n d}~0 0 | j s�td�|���dS ) ap Common logic to set or unset Event-Based/Temporary Hold on objects. Args: obj_metadata_update_wrapper: The function for updating related fields in Object metadata. url_args: List of object URIs. sub_command_full_name: The full name for sub-command: "Temporary" / "Event-Based" r" r z URL ({}) must name an objectT)� fail_on_error�seek_ahead_iteratori� Nz*{} Hold for some objects could not be set.)�lenr� r � IsCloudUrl�IsObjectr rE r� r� �everything_set_okay�Applyr r �status�_WarnServiceAccounts)rH r� rs r� rz �name_expansion_iteratorr� �erL rL rM r� � s4 � � ��zRetentionCommand._SetHold)N))�__name__� __module__� __qualname__�__doc__r �CreateCommandSpec� _SYNOPSISr r rT r �%MakeZeroOrMoreCloudBucketURLsArgument� MakeNCloudBucketURLsArgument� MakeZeroOrMoreCloudURLsArgument� command_spec�HelpSpec�_DETAILED_HELP_TEXT�_get_help_text�_set_help_text�_clear_help_text�_lock_help_text�_event_default_help_text�_event_help_text�_temp_help_text� help_specrG rd r{ r� r� r� rZ r[ r\ r] r^ r_ r` r� r� � __classcell__rL rL rJ rM r st ����� �� p* � ( % r )Lr� � __future__r r� �apitools.base.pyr �gslibr �gslib.cloud_apir r � gslib.commandr �gslib.command_argumentr �gslib.cs_api_mapr �gslib.exceptionr r �gslib.help_providerr �gslib.name_expansionr r �gslib.storage_urlr �"gslib.third_party.storage_apitoolsr r� �gslib.thread_messager � gslib.utils.cloud_api_helperr �gslib.utils.constantsr �&gslib.utils.parallelism_framework_utilr �gslib.utils.retention_utilr r r r r r r r �gslib.utils.shim_utilr � gslib.utils.translation_helperr � _SET_SYNOPSISZ_CLEAR_SYNOPSIS� _GET_SYNOPSISZ_LOCK_SYNOPSISZ_EVENT_DEFAULT_SYNOPSISZ_EVENT_SYNOPSISZ_TEMP_SYNOPSIS�_SET_DESCRIPTIONZ_CLEAR_DESCRIPTION�_GET_DESCRIPTIONZ_LOCK_DESCRIPTIONZ_EVENT_DEFAULT_DESCRIPTIONZ_EVENT_DESCRIPTIONZ_TEMP_DESCRIPTIONr� � _DESCRIPTIONr� r� r� r� r� r� r� r� r rL rL rL rM �<module> s� @ ��� ���� �