o
    ×èFh¿_  ã                   @   sˆ  d Z ddlZddlZddlmZ ddlZddlmZ ddlmZ ddl	m
Z
 ddlmZ ddlmZ dd	lmZ dd
lmZ ddlmZ dZ	 dZ	 dZ	 dZdZejed�ZdZe ed¡Z	 dZdZdZ ejj!Z"ej#j$Z%dd„ Z&dd„ Z'dd„ Z(d>dd„Z)d d!„ Z*d"d#„ Z+d$d%„ Z,G d&d'„ d'e-ƒZ.d(d)„ Z/d?d+d,„Z0d-d.„ Z1d/d0„ Z2d1d2„ Z3d3d4„ Z4d@d5d6„Z5d@d7d8„Z6d9d:„ Z7	;		dAd<d=„Z8dS )BzVHelper functions for Cloud Storage utility classes.

These are *not* part of the API.
é    N)Úmd5)Úurlsplit)Ú
urlunsplit)Úuuid4)Úresumable_media)Úenvironment_vars)Ú_DEFAULT_TIMEOUT)ÚDEFAULT_RETRY)Ú)DEFAULT_RETRY_IF_METAGENERATION_SPECIFIEDÚSTORAGE_EMULATOR_HOSTÚAPI_ENDPOINT_OVERRIDEÚAPI_VERSION_OVERRIDEzgoogleapis.comzstorage.{universe_domain})Úuniverse_domainzhttps://Úv1))Úif_etag_matchzIf-Match)Úif_etag_not_matchzIf-None-Match))Úif_generation_matchÚifGenerationMatch)Úif_generation_not_matchÚifGenerationNotMatch)Úif_metageneration_matchÚifMetagenerationMatch)Úif_metageneration_not_matchÚifMetagenerationNotMatch)Úif_source_generation_matchÚifSourceGenerationMatch)Úif_source_generation_not_matchÚifSourceGenerationNotMatch)Úif_source_metageneration_matchÚifSourceMetagenerationMatch)Ú"if_source_metageneration_not_matchÚifSourceMetagenerationNotMatchz¤`num_retries` has been deprecated and will be removed in a future release. Use the `retry` argument with a Retry or ConditionalRetryPolicy object, or None, instead.c                   C   s   t j td ¡S ©N)ÚosÚenvironÚgetÚSTORAGE_EMULATOR_ENV_VAR© r'   r'   úV/var/www/html/loop/nvenv/lib/python3.10/site-packages/google/cloud/storage/_helpers.pyÚ_get_storage_emulator_overrideX   ó   r)   c                   C   s   t  ttt ¡S r"   )r#   ÚgetenvÚ_API_ENDPOINT_OVERRIDE_ENV_VARÚ_DEFAULT_SCHEMEÚ_TRUE_DEFAULT_STORAGE_HOSTr'   r'   r'   r(   Ú_get_default_storage_base_url\   s   ÿr/   c                   C   s   t ƒ tt kr
t ƒ S dS )zIThis is an experimental configuration variable. Use api_endpoint instead.N)r/   r-   r.   r'   r'   r'   r(   Ú_get_api_endpoint_overrideb   s   r0   Fc                 C   s8   t | ƒ}|› d|j› �}t|j||rdndddfƒ}|S )z²Returns the scheme and netloc sections of the url, with the bucket
    prepended to the netloc.

    Not intended for use with netlocs which include a username and password.
    Ú.ú/Ú )r   Únetlocr   Úscheme)ÚurlÚbucketÚtrailing_slashÚ
parsed_urlÚ
new_netlocÚbase_urlr'   r'   r(   Ú_virtual_hosted_style_base_urli   s   ÿr<   c                   C   s   t  d¡dkS )NÚ!GOOGLE_API_USE_CLIENT_CERTIFICATEÚtrue)r#   r+   r'   r'   r'   r(   Ú_use_client_certw   r*   r?   c                   C   s   t  tjt  tj¡¡S r"   )r#   r+   r   ÚPROJECTÚLEGACY_PROJECTr'   r'   r'   r(   Ú_get_environ_project{   s   
þrB   c                 C   s4   | du rdS t | d  ¡ | d  ¡ gƒstdƒ‚| S )zÁPre-flight ``Bucket`` name validation.

    :type name: str or :data:`NoneType`
    :param name: Proposed bucket name.

    :rtype: str or :data:`NoneType`
    :returns: ``name`` if valid.
    Nr   éÿÿÿÿz8Bucket names must start and end with a number or letter.)ÚallÚisalnumÚ
ValueError)Únamer'   r'   r(   Ú_validate_name‚   s
   	rH   c                   @   s¾   e Zd ZdZddd„Zedd„ ƒZedd„ ƒZed	d
„ ƒZdd„ Z	dd„ Z
edd„ ƒZddddddddeedfdd„Zdd„ Zdd„ Zdddddeedfdd„Zdddddeedfdd„ZdS )Ú_PropertyMixina1  Abstract mixin for cloud storage classes with associated properties.

    Non-abstract subclasses should implement:
      - path
      - client
      - user_project

    :type name: str
    :param name: The name of the object. Bucket names must start and end with a
                 number or letter.
    Nc                 C   s   || _ i | _tƒ | _d S r"   )rG   Ú_propertiesÚsetÚ_changes)ÚselfrG   r'   r'   r(   Ú__init__¡   s   z_PropertyMixin.__init__c                 C   ó   t ‚)z$Abstract getter for the object path.©ÚNotImplementedError©rM   r'   r'   r(   Úpath¦   ó   z_PropertyMixin.pathc                 C   rO   )z&Abstract getter for the object client.rP   rR   r'   r'   r(   Úclient«   rT   z_PropertyMixin.clientc                 C   rO   )z,Abstract getter for the object user_project.rP   rR   r'   r'   r(   Úuser_project°   rT   z_PropertyMixin.user_projectc                 C   s   |du r| j }|S )a£  Check client or verify over-ride.

        :type client: :class:`~google.cloud.storage.client.Client` or
                      ``NoneType``
        :param client: the client to use.  If not passed, falls back to the
                       ``client`` stored on the current object.

        :rtype: :class:`google.cloud.storage.client.Client`
        :returns: The client passed in or the currently bound client.
        N)rU   )rM   rU   r'   r'   r(   Ú_require_clientµ   s   z_PropertyMixin._require_clientc                 C   s   i S )a@  Return any encryption headers needed to fetch the object.

        .. note::
           Defined here because :meth:`reload` calls it, but this method is
           really only relevant for :class:`~google.cloud.storage.blob.Blob`.

        :rtype: dict
        :returns: a mapping of encryption-related headers.
        r'   rR   r'   r'   r(   Ú_encryption_headersÄ   s   
z"_PropertyMixin._encryption_headersc                 C   s   i }| j dur| j |d< |S )zDefault query parameters.NÚuserProject)rV   )rM   Úparamsr'   r'   r(   Ú_query_paramsÐ   s   

z_PropertyMixin._query_paramsÚnoAclc                 C   sv   |   |¡}| j}||d< t|||||d� |dur||d< |  ¡ }t|||d� |j| j|||	|
| d�}|  |¡ dS )aÊ  Reload properties from Cloud Storage.

        If :attr:`user_project` is set, bills the API request to that project.

        :type client: :class:`~google.cloud.storage.client.Client` or
                      ``NoneType``
        :param client: the client to use. If not passed, falls back to the
                       ``client`` stored on the current object.

        :type projection: str
        :param projection: (Optional) If used, must be 'full' or 'noAcl'.
                           Defaults to ``'noAcl'``. Specifies the set of
                           properties to return.

        :type if_etag_match: Union[str, Set[str]]
        :param if_etag_match: (Optional) See :ref:`using-if-etag-match`

        :type if_etag_not_match: Union[str, Set[str]])
        :param if_etag_not_match: (Optional) See :ref:`using-if-etag-not-match`

        :type if_generation_match: long
        :param if_generation_match:
            (Optional) See :ref:`using-if-generation-match`

        :type if_generation_not_match: long
        :param if_generation_not_match:
            (Optional) See :ref:`using-if-generation-not-match`

        :type if_metageneration_match: long
        :param if_metageneration_match:
            (Optional) See :ref:`using-if-metageneration-match`

        :type if_metageneration_not_match: long
        :param if_metageneration_not_match:
            (Optional) See :ref:`using-if-metageneration-not-match`

        :type timeout: float or tuple
        :param timeout:
            (Optional) The amount of time, in seconds, to wait
            for the server response.  See: :ref:`configuring_timeouts`

        :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
        :param retry:
            (Optional) How to retry the RPC. See: :ref:`configuring_retries`

        :type soft_deleted: bool
        :param soft_deleted:
            (Optional) If True, looks for a soft-deleted object. Will only return
            the object metadata if the object exists and is in a soft-deleted state.
            :attr:`generation` is required to be set on the blob if ``soft_deleted`` is set to True.
            See: https://cloud.google.com/storage/docs/soft-delete
        Ú
projection©r   r   r   r   NÚsoftDeleted)r   r   )Úquery_paramsÚheadersÚtimeoutÚretryÚ_target_object)rW   r[   Ú _add_generation_match_parametersrX   Ú_add_etag_match_headersÚ_get_resourcerS   Ú_set_properties)rM   rU   r]   r   r   r   r   r   r   rb   rc   Úsoft_deletedr`   ra   Úapi_responser'   r'   r(   ÚreloadØ   s2   
Bûÿúz_PropertyMixin.reloadc                 C   s   | j  |¡ || j|< dS )aµ  Update field of this object's properties.

        This method will only update the field provided and will not
        touch the other fields.

        It **will not** reload the properties from the server. The behavior is
        local only and syncing occurs via :meth:`patch`.

        :type name: str
        :param name: The field name to update.

        :type value: object
        :param value: The value being updated.
        N)rL   ÚaddrJ   )rM   rG   Úvaluer'   r'   r(   Ú_patch_property6  s   z_PropertyMixin._patch_propertyc                 C   s   || _ tƒ | _dS )z±Set the properties for the current object.

        :type value: dict or :class:`google.cloud.storage.batch._FutureDict`
        :param value: The properties to be set.
        N)rJ   rK   rL   ©rM   rm   r'   r'   r(   rh   H  s   z_PropertyMixin._set_propertiesFc	                    sp   ˆ   |¡}ˆ j}	d|	d< |r||	d< t|	||||d� ‡ fdd„ˆ jD ƒ}
|jˆ j|
|	ˆ ||d�}ˆ  |¡ dS )	aj  Sends all changed properties in a PATCH request.

        Updates the ``_properties`` with the response from the backend.

        If :attr:`user_project` is set, bills the API request to that project.

        :type client: :class:`~google.cloud.storage.client.Client` or
                      ``NoneType``
        :param client: the client to use. If not passed, falls back to the
                       ``client`` stored on the current object.

        :type if_generation_match: long
        :param if_generation_match:
            (Optional) See :ref:`using-if-generation-match`

        :type if_generation_not_match: long
        :param if_generation_not_match:
            (Optional) See :ref:`using-if-generation-not-match`

        :type if_metageneration_match: long
        :param if_metageneration_match:
            (Optional) See :ref:`using-if-metageneration-match`

        :type if_metageneration_not_match: long
        :param if_metageneration_not_match:
            (Optional) See :ref:`using-if-metageneration-not-match`

        :type timeout: float or tuple
        :param timeout:
            (Optional) The amount of time, in seconds, to wait
            for the server response.  See: :ref:`configuring_timeouts`

        :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
        :param retry:
            (Optional) How to retry the RPC. See: :ref:`configuring_retries`

        :type override_unlocked_retention: bool
        :param override_unlocked_retention:
            (Optional) override_unlocked_retention must be set to True if the operation includes
            a retention property that changes the mode from Unlocked to Locked, reduces the
            retainUntilTime, or removes the retention configuration from the object. See:
            https://cloud.google.com/storage/docs/json_api/v1/objects/patch
        Úfullr]   ÚoverrideUnlockedRetentionr^   c                    s   i | ]}|ˆ j | “qS r'   )rJ   )Ú.0ÚkeyrR   r'   r(   Ú
<dictcomp>–  ó    z(_PropertyMixin.patch.<locals>.<dictcomp>)r`   rd   rb   rc   N)rW   r[   re   rL   Ú_patch_resourcerS   rh   )rM   rU   r   r   r   r   rb   rc   Úoverride_unlocked_retentionr`   Úupdate_propertiesrj   r'   rR   r(   ÚpatchR  s,   
6ûúz_PropertyMixin.patchc	                 C   s^   |   |¡}| j}	d|	d< |r||	d< t|	||||d� |j| j| j|	||| d�}
|  |
¡ dS )a`  Sends all properties in a PUT request.

        Updates the ``_properties`` with the response from the backend.

        If :attr:`user_project` is set, bills the API request to that project.

        :type client: :class:`~google.cloud.storage.client.Client` or
                      ``NoneType``
        :param client: the client to use. If not passed, falls back to the
                       ``client`` stored on the current object.

        :type if_generation_match: long
        :param if_generation_match:
            (Optional) See :ref:`using-if-generation-match`

        :type if_generation_not_match: long
        :param if_generation_not_match:
            (Optional) See :ref:`using-if-generation-not-match`

        :type if_metageneration_match: long
        :param if_metageneration_match:
            (Optional) See :ref:`using-if-metageneration-match`

        :type if_metageneration_not_match: long
        :param if_metageneration_not_match:
            (Optional) See :ref:`using-if-metageneration-not-match`

        :type timeout: float or tuple
        :param timeout:
            (Optional) The amount of time, in seconds, to wait
            for the server response.  See: :ref:`configuring_timeouts`

        :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
        :param retry:
            (Optional) How to retry the RPC. See: :ref:`configuring_retries`

        :type override_unlocked_retention: bool
        :param override_unlocked_retention:
            (Optional) override_unlocked_retention must be set to True if the operation includes
            a retention property that changes the mode from Unlocked to Locked, reduces the
            retainUntilTime, or removes the retention configuration from the object. See:
            https://cloud.google.com/storage/docs/json_api/v1/objects/patch
        rp   r]   rq   r^   )r`   rb   rc   rd   N)rW   r[   re   Ú_put_resourcerS   rJ   rh   )rM   rU   r   r   r   r   rb   rc   rw   r`   rj   r'   r'   r(   Úupdate£  s*   
6ûúz_PropertyMixin.updater"   )Ú__name__Ú
__module__Ú__qualname__Ú__doc__rN   ÚpropertyrS   rU   rV   rW   rX   r[   r   r	   rk   rn   rh   r
   ry   r{   r'   r'   r'   r(   rI   ”   sZ    




	
ô^
÷S÷rI   c                    s"   ‡ fdd„}‡ fdd„}t ||ƒS )zHCreate a property descriptor around the :class:`_PropertyMixin` helpers.c                    s   | j  ˆ ¡S )zScalar property getter.)rJ   r%   rR   ©Ú	fieldnamer'   r(   Ú_getterõ  s   z!_scalar_property.<locals>._getterc                    s   |   ˆ |¡ dS )zScalar property setter.N)rn   ro   r�   r'   r(   Ú_setterù  s   z!_scalar_property.<locals>._setter)r€   )r‚   rƒ   r„   r'   r�   r(   Ú_scalar_propertyò  s   
r…   é    c                 C   s>   |   |¡}t|ƒdkr| |¡ |   |¡}t|ƒdksdS dS )a¯  Read blocks from a buffer and update a hash with them.

    :type buffer_object: bytes buffer
    :param buffer_object: Buffer containing bytes used to update a hash object.

    :type hash_obj: object that implements update
    :param hash_obj: A hash object (MD5 or CRC32-C).

    :type digest_block_size: int
    :param digest_block_size: The block size to write to the hash.
                              Defaults to 8192.
    r   N)ÚreadÚlenr{   )Úbuffer_objectÚhash_objÚdigest_block_sizeÚblockr'   r'   r(   Ú_write_buffer_to_hash   s
   


ýr�   c                 C   s"   t ƒ }t| |ƒ | ¡ }t |¡S )a  Get MD5 hash of bytes (as base64).

    :type buffer_object: bytes buffer
    :param buffer_object: Buffer containing bytes used to compute an MD5
                          hash (as base64).

    :rtype: str
    :returns: A base64 encoded digest of the MD5 hash.
    )r   r�   ÚdigestÚbase64Ú	b64encode)r‰   rŠ   Údigest_bytesr'   r'   r(   Ú_base64_md5hash  s   


r’   c                 K   sB   t D ]\}}| |¡}|durt|tƒr|g}d |¡| |< qdS )zßAdd generation match parameters into the given parameters list.

    :type headers: dict
    :param headers: Headers dict.

    :type match_parameters: dict
    :param match_parameters: if*etag*match parameters to add.
    Nú, )Ú_ETAG_MATCH_PARAMETERSr%   Ú
isinstanceÚstrÚjoin)ra   Úmatch_parametersÚsnakecase_nameÚheader_namerm   r'   r'   r(   rf   %  s   	

€úrf   c                 K   sZ   t D ](\}}| |¡}|dur*t| tƒr|  ||f¡ qt| tƒr&|| |< qtdƒ‚qdS )ab  Add generation match parameters into the given parameters list.

    :type parameters: list or dict
    :param parameters: Parameters list or dict.

    :type match_parameters: dict
    :param match_parameters: if*generation*match parameters to add.

    :raises: :exc:`ValueError` if ``parameters`` is not a ``list()``
             or a ``dict()``.
    Nz5`parameters` argument should be a dict() or a list().)Ú_GENERATION_MATCH_PARAMETERSr%   r•   ÚlistÚappendÚdictrF   )Ú
parametersr˜   r™   Úcamelcase_namerm   r'   r'   r(   re   7  s   



ÿøýre   c                  K   sb   t dd„ |  ¡ D ƒƒdkr/dd„ |  ¡ D ƒ}d |dd… ¡}|d }d	|› d
|› �}t|ƒ‚dS )zéRaise ``ValueError`` exception if more than one parameter was set.

    :type error: :exc:`ValueError`
    :param error: Description of which fields were set

    :raises: :class:`~ValueError` containing the fields that were set
    c                 s   s   � | ]}|d uV  qd S r"   r'   )rr   Úargr'   r'   r(   Ú	<genexpr>[  s   € z._raise_if_more_than_one_set.<locals>.<genexpr>é   c                 S   s   g | ]}d |› d �‘qS )ú'r'   )rr   rG   r'   r'   r(   Ú
<listcomp>\  ru   z/_raise_if_more_than_one_set.<locals>.<listcomp>r“   NrC   zPass at most one of z and )ÚsumÚvaluesÚkeysr—   rF   )ÚkwargsÚescaped_keysÚkeys_but_lastÚlast_keyÚmsgr'   r'   r(   Ú_raise_if_more_than_one_setS  s   ør®   c                 C   s&   t | ƒ}|jr|jr| S |› d| › �S )a!  Helper to build bucket bound hostname URL.

    :type host: str
    :param host: Host name.

    :type scheme: str
    :param scheme: (Optional) Web scheme. If passed, use it
                   as a scheme in the result URL.

    :rtype: str
    :returns: A bucket bound hostname URL.
    z://)r   r5   r4   )Úhostr5   Ú	url_partsr'   r'   r(   Ú_bucket_bound_hostname_urlf  s   r±   c                 C   sZ   | dur|durt dƒ‚| durtj| j| j| j| jd�S |dur'tj|d�S tjdd�S )a~  Convert google.api.core.Retry to google.resumable_media.RetryStrategy.

    Custom predicates are not translated.

    :type retry: google.api_core.Retry
    :param retry: (Optional) The google.api_core.Retry object to translate.

    :type num_retries: int
    :param num_retries: (Optional) The number of retries desired. This is
        supported for backwards compatibility and is mutually exclusive with
        `retry`.

    :rtype: google.resumable_media.RetryStrategy
    :returns: A RetryStrategy with all applicable attributes copied from input,
              or a RetryStrategy with max_retries set to 0 if None was input.
    Nz6num_retries and retry arguments are mutually exclusive)Ú	max_sleepÚmax_cumulative_retryÚinitial_delayÚ
multiplier)Úmax_retriesr   )rF   r   ÚRetryStrategyÚ_maximumÚ	_deadlineÚ_initialÚ_multiplier)rc   Únum_retriesr'   r'   r(   Ú(_api_core_retry_to_resumable_media_retryz  s   ür½   c                   C   s   dt tƒ ƒ S )Nzgccl-invocation-id/)r–   r   r'   r'   r'   r(   Ú_get_invocation_idœ  r*   r¾   úapplication/json; charset=UTF-8c                 C   s8   | › dt ƒ › �}|r|d|› �7 }dd| |||p|dœS )a§  Get the headers for a request.

    :type user_agent: str
    :param user_agent: The user-agent for requests.

    :type command: str
    :param command:
        (Optional) Information about which interface for the operation was
        used, to be included in the X-Goog-API-Client header. Please leave
        as None unless otherwise directed.

    :rtype: dict
    :returns: The headers to be used for the request.
    ú z gccl-gcs-cmd/zapplication/jsonzgzip, deflate)ÚAcceptzAccept-Encodingz
User-AgentzX-Goog-API-Clientzcontent-typezx-upload-content-type)r¾   )Ú
user_agentÚcontent_typeÚx_upload_content_typeÚcommandÚx_goog_api_clientr'   r'   r(   Ú_get_default_headers   s   úrÇ   )F)r†   r"   )r¿   NN)9r   r�   ÚdatetimeÚhashlibr   r#   Úurllib.parser   r   Úuuidr   Úgoogler   Úgoogle.authr   Úgoogle.cloud.storage.constantsr   Úgoogle.cloud.storage.retryr	   r
   r&   r,   Ú_API_VERSION_OVERRIDE_ENV_VARÚ_DEFAULT_UNIVERSE_DOMAINÚ_STORAGE_HOST_TEMPLATEÚformatr.   r-   r+   Ú_API_VERSIONr”   r›   Ú_NUM_RETRIES_MESSAGEÚnowÚ_NOWÚtimezoneÚutcÚ_UTCr)   r/   r0   r<   r?   rB   rH   ÚobjectrI   r…   r�   r’   rf   re   r®   r±   r½   r¾   rÇ   r'   r'   r'   r(   Ú<module>   sp   ÿÿ	
  `


"ü