U 3 dzE@sddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddlm Z ddl Z ddl mZmZmZmZddlmZddlmZddlmZddlmZddlmZdd lmZdd l mZdd l mZmZdd l mZdd l m Z Gddde!Z"dS)N)md5)BytesIOsixurllib encodebytesBotoClientError)StorageDataError)PleaseRetryException)Provider)KeyFile)User) UserAgent) compute_md5 compute_hash)find_matching_headers)merge_headers_by_namec @seZdZdZdZdZejdddZ e ddd d d d d dgZ e Z e D]Z e e ddqFe e ddddgBZdddZddZddZeddZddZd d!ZeeeZd"d#Zd$d%ZeeeZd&d'Zd(d)ZeeeZd*d+Zd,d-Z eee Z!d.d/Z"d0d1Z#d2d3Z$dd5d6Z%d7d8Z&d9d:Z'ddd?Z)ddAdBZ*d4Z+ddCdDZ,dEdFZ-e-Z.ddHdIZ/ddKdLZ0ddMdNZ1dOdPZ2dQdRZ3ddSdTZ4ddUdVZ5dWdXZ6dYdZZ7d[d\Z8dd]d^Z9dd_d`Z:ddadbZ;ddcddZddidjZ?ddkdlZ@ddndoZAddqdrZBddsdtZCddudvZDddwdxZEddydzZFdd{d|ZGdd}d~ZHdddZIdddZJdddZKdddZLdddZMdddZNdddZOdddZPdddZQddZRdddZSdddZTdddZUdS)KeyaC Represents a key (object) in an S3 bucket. :ivar bucket: The parent :class:`boto.s3.bucket.Bucket`. :ivar name: The name of this Key object. :ivar metadata: A dictionary containing user metadata that you wish to store with the object or that has been retrieved from an existing object. :ivar cache_control: The value of the `Cache-Control` HTTP header. :ivar content_type: The value of the `Content-Type` HTTP header. :ivar content_encoding: The value of the `Content-Encoding` HTTP header. :ivar content_disposition: The value of the `Content-Disposition` HTTP header. :ivar content_language: The value of the `Content-Language` HTTP header. :ivar etag: The `etag` associated with this object. :ivar last_modified: The string timestamp representing the last time this object was modified in S3. :ivar owner: The ID of the owner of this object. :ivar storage_class: The storage class of the object. Currently, one of: STANDARD | REDUCED_REDUNDANCY | GLACIER :ivar md5: The MD5 hash of the contents of the object. :ivar size: The size, in bytes, of the object. :ivar version_id: The version ID of this object, if it is a versioned object. :ivar encrypted: Whether the object is encrypted while at rest on the server. zapplication/octet-streamz %s ZBotoZkey_buffer_sizei z cache-controlzcontent-dispositionzcontent-encodingzcontent-language content-md5 content-typez x-robots-tagexpires-_z last-modifiedcontent-lengthdateetagNcCs||_||_i|_d|_|j|_d|_d|_d|_d|_ d|_ d|_ d|_ d|_ d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_i|_dS)NF)bucketnamemetadataZ cache_controlDefaultContentType content_typecontent_encodingcontent_dispositioncontent_languagefilenamer is_latest last_modifiedowner_storage_classpathrespmodesize version_idsource_version_id delete_marker encryptedongoing_restore expiry_date local_hashes)selfrrr5//tmp/pip-unpacked-wheel-d7dsrkjd/boto/s3/key.py__init__is2z Key.__init__cCs<|jrd|jj|jf}n d|j}t|ts8|d}|S)Nz zutf-8)rr isinstancestrencoder4rr5r5r6__repr__s    z Key.__repr__cCs|SNr5r4r5r5r6__iter__sz Key.__iter__cCs d}|jr|jjr|jjj}|Sr>)r connectionprovider)r4rBr5r5r6rBs z Key.providercCs|jSr>rr?r5r5r6_get_keysz Key._get_keycCs ||_dSr>rCr4valuer5r5r6_set_keysz Key._set_keycCs(d|jkr$|jdr$t|jdSdSNr)r3binasciib2a_hexr?r5r5r6_get_md5sz Key._get_md5cCs2|rt||jd<nd|jkr.|jdddSrH)rIa2b_hexr3poprEr5r5r6_set_md5s z Key._set_md5cCsLd|jkrH|jdrH|jd}t|ts2|d}t|ddSdS)Nrr8 )r3r9bytesr;rI b2a_base64decoderstrip)r4rr5r5r6_get_base64md5s    zKey._get_base64md5cCsB|r,t|tjs|d}t||jd<nd|jkr>|jd=dS)Nr8r)r9r string_typesrRrI a2b_base64r3rEr5r5r6_set_base64md5s    zKey._set_base64md5cCsZ|jdkrT|jrTt|j|jd}t|rNt|dddrN|dj|_nd|_|jS)Nr8rr(STANDARD)r(rlistrr;lengetattr)r4Z list_itemsr5r5r6_get_storage_classszKey._get_storage_classcCs ||_dSr>)r(rEr5r5r6_set_storage_classszKey._set_storage_classcCs2t|}t|}|ddkr*|dd}||fS)z A utility function to create the 2-tuple (md5hexdigest, base64md5) from just having a precalculated md5_hexdigest. rOr)rI unhexlifyr)r4Z md5_hexdigestdigest base64md5r5r5r6get_md5_from_hexdigests    zKey.get_md5_from_hexdigestcCs,|jjj}|jr"||jd|_nd|_dSr>)rrArBserver_side_encryption_header getheaderr0r4r*rBr5r5r6handle_encryption_headerss zKey.handle_encryption_headerscCs@|jjj}|jr<||jd|_|jdkr<|dkr sz.Key.handle_restore_headers..="zongoing-requestrkTFz expiry-date) rrArBrdZrestore_headersplitreplacelowerr1r2)r4responserBheaderpartspartkeyvalr5r5r6handle_restore_headerss    zKey.handle_restore_headerscCsdS)z Used by Key subclasses to do additional, provider-specific processing of response headers. No-op for this base class. Nr5r4headersr5r5r6handle_addl_headersszKey.handle_addl_headersrvc CsB|jdkr>d|_|jjj}|jjjd|jj|j|||d|_|jjdksV|jjdkrv|j}| |jj|jj ||jj }t j |||_|D]r\}}|dkrd|krt||_q|d krtd d |} t| |_q|tjkr||j|d d <q||j||j||j||jdS)a Open this key for reading :type headers: dict :param headers: Headers to pass in the web request :type query_args: string :param query_args: Arguments to pass in the query string (ie, 'torrent') :type override_num_retries: int :param override_num_retries: If not None will override configured num_retries parameter for underlying GET. :type response_headers: dict :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. NrGET query_argsoverride_num_retries+rz Content-Rangez content-rangez.*/(.*)z\1rr)r*r+rrArB make_requestrstatusreadstorage_response_errorreasonmsgbotoutilsZget_aws_metadataritemsryintr,resubr base_fields__dict__rxrmrfrr getheaders) r4rrrresponse_headersrBbodyrrFZ end_ranger5r5r6 open_readsF           z Key.open_readcCs tddS)aK Open this key for writing. Not yet implemented :type headers: dict :param headers: Headers to pass in the write request :type override_num_retries: int :param override_num_retries: If not None will override configured num_retries parameter for underlying PUT. zNot ImplementedNr)r4rrr5r5r6 open_writePs zKey.open_writercCsN|dkr d|_|j|||dn*|dkr>d|_|j||dn td|dS)Nr)rrrw)rrzInvalid mode: %s)r+rrr)r4r+rrrr5r5r6open^szKey.opencCs*|jr|s|jd|_d|_d|_dS)a Close this key. :type fast: bool :param fast: True if you want the connection to be closed without first reading the content. This should only be used in cases where subsequent calls don't need to return the content from the open HTTP connection. Note: As explained at http://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.getresponse, callers must read the whole response before sending a new request to the server. Calling Key.close(fast=True) and making a subsequent request to the server will work because boto will get an httplib exception and close/reopen the connection. NT)r*rr+closed)r4fastr5r5r6closems   z Key.closecCs*||j|j}|s&|t|S)a By providing a next method, the key object supports use as an iterator. For example, you can now say: for bytes in key: write bytes to a file or whatever All of the HTTP connection stuff is handled for you. )rr*r BufferSizer StopIteration)r4datar5r5r6nexts zKey.nextrcCs8||dkr|j}n |j|}|s4||S)Nr)rr*rr)r4r,rr5r5r6rs  zKey.readTcCsX|p |jj}|dkr*|j||jdd|dS|dkrH|j||jdd|dStd|dS)a Change the storage class of an existing key. Depending on whether a different destination bucket is supplied or not, this will either move the item within the bucket, preserving all metadata and ACL info bucket changing the storage class or it will copy the item to the provided destination bucket, also preserving metadata and ACL info. :type new_storage_class: string :param new_storage_class: The new storage class for the Key. Possible values are: * STANDARD * REDUCED_REDUNDANCY :type dst_bucket: string :param dst_bucket: The name of a destination bucket. If not provided the current bucket of the key will be used. :type validate_dst_bucket: bool :param validate_dst_bucket: If True, will validate the dst_bucket by using an extra list request. rXFT)reduced_redundancy preserve_aclvalidate_dst_bucketREDUCED_REDUNDANCYzInvalid storage class: %sN)rrcopyr)r4Znew_storage_class dst_bucketrZ bucket_namer5r5r6change_storage_classs    zKey.change_storage_classc CsB|jj||}|rd}n|j}|j||jj|j|||||jdS)a Copy this Key to another bucket. :type dst_bucket: string :param dst_bucket: The name of the destination bucket :type dst_key: string :param dst_key: The name of the destination key :type metadata: dict :param metadata: Metadata to be associated with new key. If metadata is supplied, it will replace the metadata of the source key being copied. If no metadata is supplied, the source key's metadata will be copied to the new key. :type reduced_redundancy: bool :param reduced_redundancy: If True, this will force the storage class of the new Key to be REDUCED_REDUNDANCY regardless of the storage class of the key being copied. The Reduced Redundancy Storage (RRS) feature of S3, provides lower redundancy at lower storage cost. :type preserve_acl: bool :param preserve_acl: If True, the ACL from the source key will be copied to the destination key. If False, the destination key will have the default ACL. Note that preserving the ACL in the new key object will require two additional API calls to S3, one to retrieve the current ACL and one to set that ACL on the new object. If you don't care about the ACL, a value of False will be significantly more efficient. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. :type validate_dst_bucket: bool :param validate_dst_bucket: If True, will validate the dst_bucket by using an extra list request. :rtype: :class:`boto.s3.key.Key` or subclass :returns: An instance of the newly created key object r) storage_classr encrypt_keyZsrc_version_id)rrAlookuprcopy_keyrr-) r4rZdst_keyrrrrrrr5r5r6rs/  zKey.copycCs |dkrt||_|jSdSdS)NOwner)r r')r4rattrsrAr5r5r6 startElements zKey.startElementcCs|dkr||_n|dkr ||_nz|dkr@|dkr8d|_qd|_nZ|dkrP||_nJ|dkrdt||_n6|d krt||_n&|d kr~n|d kr||_n t|||dS) NrETagZIsLatestrkTFZ LastModifiedSizeZ StorageClassrZ VersionId) rrr%r&rr,rr-setattr)r4rrFrAr5r5r6 endElement s& zKey.endElementcCst|jj|j|dS)zt Returns True if the key exists :rtype: bool :return: Whether the key exists on S3 r)boolrrrrr5r5r6exists sz Key.existscCs|jj|j|j|dS)z) Delete this key from S3 )r-r)rZ delete_keyrr-rr5r5r6delete)sz Key.deletecCs |j|Sr>)rgetr<r5r5r6 get_metadata0szKey.get_metadatacCsb|dkr||jd<n"|dkr0||jd<n ||j|<|tjkr^||j|dd<dS)Nr Content-Typer Content-MD5rr)ryrrbase_user_settable_fieldsrrx)r4rrFr5r5r6 set_metadata3s     zKey.set_metadatacCs|j|dSr>)rupdate)r4dr5r5r6update_metadata?szKey.update_metadatacCs"|jdk r|jj||j|ddSNr)rset_aclrr4Zacl_strrr5r5r6rCs z Key.set_aclcCs |jdk r|jj|j|dSdSr)rget_aclrrr5r5r6rGs z Key.get_aclcCs |jdk r|jj|j|dSdSr)r get_xml_aclrrr5r5r6rKs zKey.get_xml_aclcCs"|jdk r|jj||j|dSdSr)r set_xml_aclrrr5r5r6rOs zKey.set_xml_aclcCs|j||j|Sr>rset_canned_aclrrr5r5r6rSszKey.set_canned_aclcCsH|jjd|jj|j}|jdkr,|dS|j|j|j| dS)zReturn the redirect location configured for this key. If no redirect is configured (via set_redirect), then None will be returned. HEADx-amz-website-redirect-locationN) rrArrrrdrBrrr)r4rzr5r5r6 get_redirectVs  zKey.get_redirectcCsb|dkri}n|}||d<|jjd|jj|j|}|jdkrFdS|j|j|j| dS)aOConfigure this key to redirect to another location. When the bucket associated with this key is accessed from the website endpoint, a 301 redirect will be issued to the specified `redirect_location`. :type redirect_location: string :param redirect_location: The location to redirect. NrPUTrT) rrrArrrrBrrr)r4redirect_locationrrzr5r5r6 set_redirectes  zKey.set_redirectcCs|jd|j|S)Nz public-readrrr5r5r6 make_public~szKey.make_publicrc Cs|jjj} |p|j}|dkr"i}n|}| r8| || j<| rTd|_| jrT|j|| j<| rbd|| j<t j ||j | }|jj |||jj|j|||||| S)a$ Generate a URL to access this key. :type expires_in: int :param expires_in: How long the url is valid for, in seconds. :type method: string :param method: The method to use for retrieving the file (default is GET). :type headers: dict :param headers: Any headers to pass along in the request. :type query_auth: bool :param query_auth: If True, signs the request in the URL. :type force_http: bool :param force_http: If True, http will be used instead of https. :type response_headers: dict :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. :type expires_in_absolute: bool :param expires_in_absolute: :type version_id: string :param version_id: The version_id of the object to GET. If specified this overrides any value in the key. :type policy: :class:`boto.s3.acl.CannedACLStrings` :param policy: A canned ACL policy that will be applied to the new key in S3. :type reduced_redundancy: bool :param reduced_redundancy: If True, this will set the storage class of the new Key to be REDUCED_REDUNDANCY. The Reduced Redundancy Storage (RRS) feature of S3, provides lower redundancy at lower storage cost. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. :rtype: string :return: The URL to access the key NrAES256)rrArBr-r acl_headerrrgrcrr merge_metar generate_urlr) r4Z expires_inmethodrZ query_authZ force_httprZexpires_in_absoluter-policyrrrBr5r5r6rs06      zKey.generate_url c Cs|j|||||||ddS)at Upload a file to a key into a bucket on S3. :type fp: file :param fp: The file pointer to upload. The file pointer must point at the offset from which you wish to upload. ie. if uploading the full file, it should point at the start of the file. Normally when a file is opened for reading, the fp will point at the first byte. See the bytes parameter below for more info. :type headers: dict :param headers: The headers to pass along with the PUT request :type num_cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. Providing a negative integer will cause your callback to be called with each buffer read. :type query_args: string :param query_args: (optional) Arguments to pass in the query string. :type chunked_transfer: boolean :param chunked_transfer: (optional) If true, we use chunked Transfer-Encoding. :type size: int :param size: (optional) The Maximum number of bytes to read from the file pointer (fp). This is useful when uploading a file in multiple parts where you are splitting the file up into different ranges to be uploaded. If not specified, the default behaviour is to read all bytes from the file pointer. Less bytes may be available. rcbnum_cbrchunked_transferr,N)_send_file_internal)r4fprrrrrr,r5r5r6 send_files ' z Key.send_filec  sNjjjz  Wntk r4d d_YnXdkrLjsLdtitfddp^iD f dd} |si}n|}t d|D] } || =qt |d<j dkrȈj |j <t d |rtd |_t d |rtd |_t d |} | r>t| d kr0|| d dkr0|| d =n td |_nDjrxtjd _jdkrlj_j|d <n j|d <jrj|d<rd|d<ntj|d<djjkrtjd} dk r| d<tf| d |d<d|d<tj |j!}jjj"djj#j#|| |d} j$| dd%| &dS)NFrc3s|]}||fVqdSr>r5rqalg hash_algsr5r6 sz*Key._send_file_internal..csPdk r kr ndkr8jr8di}tjd|rRd|d<tjd|rhd|d<|j||f||D]}||||q|| j j j }dj j _ t |ddd kr|dd}rTr܈} njrj} nd} r | dkr d j} n<dkr2tt| jd } ndkrBd } nd} d} || } | rv| jkrv| } n j} t| ts| d } dkrd_| rt| }||7}r|d||| |dn || D]}|| q| r(| |8} | dkr(qrX| d7} | | ksJ| d krX|| d} | rv| jkrv| } n j} t| ts| d } q|_D]}|j|<qr|d|dr| dks| dkr|dkr|| |||j j _ |}|}|sL|j |j!||S)Nz9Cannot retry failed request. fp does not support seeking.hostro skip_hostzaccept-encodingskip_accept_encodingr debuglevel?r^r8Tz%x; z z0 )"tellseekread_from_streamstorage_data_errorrrr putrequest putheader endheadersrrAdebugr[set_debuglevelr,rrmathceilrr9rPr;rZsendrr`r3 getresponse should_retryrrr) http_connrr)rrskipsr~ save_debugdata_lencb_sizecb_countrrZ bytes_togochunkZ chunk_lenrrzr) rr digestersrrrBr4r,sposr5r6sender s                       $   z'Key._send_file_internal..senderz User-Agent)NrXzContent-EncodingzContent-LanguagerrorrchunkedzTransfer-EncodingzContent-Lengthz hmac-v4-s3)rZhash_algorithmr,_sha256z 100-ContinueZExpectr)rrT)rl)'rrArBrIOErrorrrdictrrrr(rrgrr!r#rZr r) mimetypes guess_typerrar:r,Z_required_auth_capabilityhashlibsha256rrrrrrrrmrr)r4rrrrrrr,rrr{Zcontent_type_headerskwargsr*r5) rrrrrrrBr4r,rr6rs   x             zKey._send_file_internalc Cs|jjj}|s*|jdkrdS|dr*dSd|jkr@dkrnnv|d|_|j}t|trj| d}|dd}|d d}|dkr|dkr|jd |kr| d |j|jfdS|jd kr| }| |j|j |}|jd krtd|j|ddS)N)iiTlocationrrrr8z/x-amz-server-side-encryption-customer-algorithmzx-goog-encryption-kms-key-namez"%s"z2ETag from S3 did not match computed MD5. %s vs. %si)ZRequestTimeoutzSaw %s, retrying)rzF)rrArBrrdrrr9rPrRrrrrZ error_coder ) r4rzrrBrZ-amz_server_side_encryption_customer_algorithmZ goog_customer_managed_encryptionrerrr5r5r6rsT         zKey.should_retrycCs t||d\}}}||_||fS)a :type fp: file :param fp: File pointer to the file to MD5 hash. The file pointer will be reset to the same position before the method returns. :type size: int :param size: (optional) The Maximum number of bytes to read from the file pointer (fp). This is useful when uploading a file in multiple parts where the file is being split in place into different parts. Less bytes may be available. )r,)rr,)r4rr, hex_digestZ b64_digest data_sizer5r5r6rs zKey.compute_md5c Cs|jjj} | s"td| |jr2|jdkr:td|dkrFi}|rT||| j<|rpd|_| j rp|j|| j <|jdk r|s|j |jrdS|j |||||d| ddS)a" Store an object using the name of the Key object as the key in cloud and the contents of the data stream pointed to by 'fp' as the contents. The stream object is not seekable and total size is not known. This has the implication that we can't specify the Content-Size and Content-MD5 in the header. So for huge uploads, the delay in calculating MD5 is avoided but with a penalty of inability to verify the integrity of the uploaded data. :type fp: file :param fp: the file whose contents are to be uploaded :type headers: dict :param headers: additional HTTP headers to be sent with the PUT request. :type replace: bool :param replace: If this parameter is False, the method will first check to see if an object exists in the bucket with the same key. If it does, it won't overwrite it. The default value is True which will overwrite the object. :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to GS and the second representing the total number of bytes that need to be transmitted. :type num_cb: int :param num_cb: (optional) If a callback is specified with the cb parameter, this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type policy: :class:`boto.gs.acl.CannedACLStrings` :param policy: A canned ACL policy that will be applied to the new key in GS. :type reduced_redundancy: bool :param reduced_redundancy: If True, this will set the storage class of the new Key to be REDUCED_REDUNDANCY. The Reduced Redundancy Storage (RRS) feature of S3, provides lower redundancy at lower storage cost. :type size: int :param size: (optional) The Maximum number of bytes to read from the file pointer (fp). This is useful when uploading a file in multiple parts where you are splitting the file up into different ranges to be uploaded. If not specified, the default behaviour is to read all bytes from the file pointer. Less bytes may be available. z$%s does not support chunked transferrvzACannot determine the destination object name for the given streamNrT)rr,) rrArBsupports_chunked_transferrrhrrrrgrr) r4rrrxrrrrrr,rBr5r5r6set_contents_from_streams.=    zKey.set_contents_from_streamc  Cs|jjj} |pi}|r ||| j<| r.d|| j<| rB|dtjnbt|t s| }|dtj | |kr|dtj| |kr||t d|||rd|_ | jr|j || j<t|dr|j|_|jdk r|s| rd}d|_nd}t|t rR|}|j| } | |_td |jrR|jd }|tt|f}|sl||| }|j} nB| rz| |_n4| }|dtj | ||_|||j} |d|_|d |_|jdkr|j|_|s|j |jrdS|j!||||| || d |jSdS) a Store an object in S3 using the name of the Key object as the key in S3 and the contents of the file pointed to by 'fp' as the contents. The data is read from 'fp' from its current position until 'size' bytes have been read or EOF. :type fp: file :param fp: the file whose contents to upload :type headers: dict :param headers: Additional HTTP headers that will be sent with the PUT request. :type replace: bool :param replace: If this parameter is False, the method will first check to see if an object exists in the bucket with the same key. If it does, it won't overwrite it. The default value is True which will overwrite the object. :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type num_cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type policy: :class:`boto.s3.acl.CannedACLStrings` :param policy: A canned ACL policy that will be applied to the new key in S3. :type md5: A tuple containing the hexdigest version of the MD5 checksum of the file as the first element and the Base64-encoded version of the plain checksum as the second element. This is the same format returned by the compute_md5 method. :param md5: If you need to compute the MD5 for any reason prior to upload, it's silly to have to do it twice so this param, if present, will be used as the MD5 values of the file. Otherwise, the checksum will be computed. :type reduced_redundancy: bool :param reduced_redundancy: If True, this will set the storage class of the new Key to be REDUCED_REDUNDANCY. The Reduced Redundancy Storage (RRS) feature of S3, provides lower redundancy at lower storage cost. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. :type size: int :param size: (optional) The Maximum number of bytes to read from the file pointer (fp). This is useful when uploading a file in multiple parts where you are splitting the file up into different ranges to be uploaded. If not specified, the default behaviour is to read all bytes from the file pointer. Less bytes may be available. :type rewind: bool :param rewind: (optional) If True, the file pointer (fp) will be rewound to the start before any bytes are read from it. The default behaviour is False which reads from the current position of the file pointer (fp). :rtype: int :return: The number of bytes written to the key. rrz8fp is at EOF. Use rewind option or seek() to data start.rrNTFz^"[a-fA-F0-9]{32}"$ruror)"rrArBrrcrosSEEK_SETr9r rSEEK_ENDAttributeErrorrrghasattrrr)rr,Zgetkeyrmatchrrpbase64 b64encoderIr_rrrarr)r4rrrxrrrrrrrr,rewindrBrrr~rr5r5r6set_contents_from_fileostO                    zKey.set_contents_from_filec Cs>t|d*} |j| |||||||| d W5QRSQRXdS)a# Store an object in S3 using the name of the Key object as the key in S3 and the contents of the file named by 'filename'. See set_contents_from_file method for details about the parameters. :type filename: string :param filename: The name of the file that you want to put onto S3 :type headers: dict :param headers: Additional headers to pass along with the request to AWS. :type replace: bool :param replace: If True, replaces the contents of the file if it already exists. :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type policy: :class:`boto.s3.acl.CannedACLStrings` :param policy: A canned ACL policy that will be applied to the new key in S3. :type md5: A tuple containing the hexdigest version of the MD5 checksum of the file as the first element and the Base64-encoded version of the plain checksum as the second element. This is the same format returned by the compute_md5 method. :param md5: If you need to compute the MD5 for any reason prior to upload, it's silly to have to do it twice so this param, if present, will be used as the MD5 values of the file. Otherwise, the checksum will be computed. :type reduced_redundancy: bool :param reduced_redundancy: If True, this will set the storage class of the new Key to be REDUCED_REDUNDANCY. The Reduced Redundancy Storage (RRS) feature of S3, provides lower redundancy at lower storage cost. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. :rtype: int :return: The number of bytes written to the key. rbrN)rr ) r4r$rrxrrrrrrrr5r5r6set_contents_from_filename!s=  zKey.set_contents_from_filenamec CsDt|ts|d}t|} |j| |||||||| d } | | S)ah Store an object in S3 using the name of the Key object as the key in S3 and the string 's' as the contents. See set_contents_from_file method for details about the parameters. :type headers: dict :param headers: Additional headers to pass along with the request to AWS. :type replace: bool :param replace: If True, replaces the contents of the file if it already exists. :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type num_cb: int :param num_cb: (optional) If a callback is specified with the num_cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type policy: :class:`boto.s3.acl.CannedACLStrings` :param policy: A canned ACL policy that will be applied to the new key in S3. :type md5: A tuple containing the hexdigest version of the MD5 checksum of the file as the first element and the Base64-encoded version of the plain checksum as the second element. This is the same format returned by the compute_md5 method. :param md5: If you need to compute the MD5 for any reason prior to upload, it's silly to have to do it twice so this param, if present, will be used as the MD5 values of the file. Otherwise, the checksum will be computed. :type reduced_redundancy: bool :param reduced_redundancy: If True, this will set the storage class of the new Key to be REDUCED_REDUNDANCY. The Reduced Redundancy Storage (RRS) feature of S3, provides lower redundancy at lower storage cost. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. r8r")r9rPr;rr r) r4Z string_datarrxrrrrrrrrr5r5r6set_contents_from_stringds9  zKey.set_contents_from_stringc Cs"|j||||||||ddd dS)aN Retrieves a file from an S3 Key :type fp: file :param fp: File pointer to put the data into :type headers: string :param: headers to send when retrieving the files :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type torrent: bool :param torrent: Flag for whether to get a torrent for the file :type override_num_retries: int :param override_num_retries: If not None will override configured num_retries parameter for underlying GET. :type response_headers: dict :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. :type version_id: str :param version_id: The ID of a particular version of the object. If this parameter is not supplied but the Key object has a ``version_id`` attribute, that value will be used when retrieving the object. You can set the Key object's ``version_id`` attribute to None to always grab the latest version from a version-enabled bucket. N) rrrtorrentr-rrrr)_get_file_internal) r4rrrrr%r-rrr5r5r6get_files/ z Key.get_filec  s|dkr i}|jjj} |jjjdkr.d|jj_| p4g} |rD| ddkrX|sXdtitfddpjiD} |dkr|j}|r| d||r|D]"} | d| tj || fqd | } |j d || |d d}|rf|j dkrd}n|j }|j dkr|d krd |j }n<|dkrDtt||j |d}n|dkrTd }nd}d}|||z|D]}|||t|7}| D]}| ||q|rl|dkr||krq|d7}||ks|d krl|||d}qlWnBtk r2}z"|jtjkr td|jW5d}~XYnX|rb|dksN|dkrb|dkrb|||| D]}| ||j|<qf|j dkr|sd|kr||_ || |jj_dS)Nrorr%rc3s|]}||fVqdSr>r5rrr5r6rsz)Key._get_file_internal..z versionId=%sz%s=%s&rrr^rrz$Out of space for destination file %sZRange)rrArappendrr r-rparsequotejoinrr,rrrrwriterZrr errnoENOSPCr rr`r3r)r4rrrrr%r-rrrrrrr~rrrrrrPrer5rr6r&s                $ zKey._get_file_internalcCs|j||||ddS)a Get a torrent file (see to get_file) :type fp: file :param fp: The file pointer of where to put the torrent :type headers: dict :param headers: Headers to be passed :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. T)r%)r')r4rrrrr5r5r6get_torrent_file)szKey.get_torrent_filec CsD|jdk r@|r(|j|||||||dn|j|||||||ddS)a Retrieve an object from S3 using the name of the Key object as the key in S3. Write the contents of the object to the file pointed to by 'fp'. :type fp: File -like object :param fp: :type headers: dict :param headers: additional HTTP headers that will be sent with the GET request. :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type torrent: bool :param torrent: If True, returns the contents of a torrent file as a string. :type res_upload_handler: ResumableDownloadHandler :param res_download_handler: If provided, this handler will perform the download. :type response_headers: dict :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. :type version_id: str :param version_id: The ID of a particular version of the object. If this parameter is not supplied but the Key object has a ``version_id`` attribute, that value will be used when retrieving the object. You can set the Key object's ``version_id`` attribute to None to always grab the latest version from a version-enabled bucket. N)r%r-r%r-r)rr') r4rrrrr%r-res_download_handlerrr5r5r6get_contents_to_fileDs6 zKey.get_contents_to_filec Csz4t|d } |j| |||||||dW5QRXWn tk rTt|YnX|jdk rz4tj|j} t tj | } t | j | | fWntk rYnXdS)aO Retrieve an object from S3 using the name of the Key object as the key in S3. Store contents of the object to a file named by 'filename'. See get_contents_to_file method for details about the parameters. :type filename: string :param filename: The filename of where to put the file contents :type headers: dict :param headers: Any additional headers to send in the request :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type num_cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type torrent: bool :param torrent: If True, returns the contents of a torrent file as a string. :type res_upload_handler: ResumableDownloadHandler :param res_download_handler: If provided, this handler will perform the download. :type response_headers: dict :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. :type version_id: str :param version_id: The ID of a particular version of the object. If this parameter is not supplied but the Key object has a ``version_id`` attribute, that value will be used when retrieving the object. You can set the Key object's ``version_id`` attribute to None to always grab the latest version from a version-enabled bucket. wb)r%r-r3rN) rr4 Exceptionrremover&emailr parsedate_tzr mktime_tzutimer) r4r$rrrr%r-r3rrZmodified_tupleZmodified_stampr5r5r6get_contents_to_filenames$6    zKey.get_contents_to_filenamec Cs<t}|j|||||||d|} |dk r8| |} | S)ao Retrieve an object from S3 using the name of the Key object as the key in S3. Return the contents of the object as a string. See get_contents_to_file method for details about the parameters. :type headers: dict :param headers: Any additional headers to send in the request :type cb: function :param cb: a callback function that will be called to report progress on the upload. The callback should accept two integer parameters, the first representing the number of bytes that have been successfully transmitted to S3 and the second representing the size of the to be transmitted object. :type cb: int :param num_cb: (optional) If a callback is specified with the cb parameter this parameter determines the granularity of the callback by defining the maximum number of times the callback will be called during the file transfer. :type torrent: bool :param torrent: If True, returns the contents of a torrent file as a string. :type response_headers: dict :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. :type version_id: str :param version_id: The ID of a particular version of the object. If this parameter is not supplied but the Key object has a ``version_id`` attribute, that value will be used when retrieving the object. You can set the Key object's ``version_id`` attribute to None to always grab the latest version from a version-enabled bucket. :type encoding: str :param encoding: The text encoding to use, such as ``utf-8`` or ``iso-8859-1``. If set, then a string will be returned. Defaults to ``None`` and returns bytes. :rtype: bytes or str :returns: The contents of the file as bytes or a string r2N)rr4getvaluerR) r4rrrr%r-rencodingrrFr5r5r6get_contents_as_strings6 zKey.get_contents_as_stringcCs,|j|d}|j|||j||ddS)a Convenience method that provides a quick way to add an email grant to a key. This method retrieves the current ACL, creates a new grant based on the parameters passed in, adds that grant to the ACL and then PUT's the new ACL back to S3. :type permission: string :param permission: The permission being granted. Should be one of: (READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL). :type email_address: string :param email_address: The email address associated with the AWS account your are granting the permission to. :type recursive: boolean :param recursive: A boolean value to controls whether the command will apply the grant to all keys within the bucket or not. The default value is False. By passing a True value, the call will iterate through all keys in the bucket and apply the same grant to each key. CAUTION: If you have a lot of keys, this could take a long time! rN)racladd_email_grantr)r4 permissionZ email_addressrrr5r5r6rAs zKey.add_email_grantcCs0|j|d}|jj|||d|j||ddS)a Convenience method that provides a quick way to add a canonical user grant to a key. This method retrieves the current ACL, creates a new grant based on the parameters passed in, adds that grant to the ACL and then PUT's the new ACL back to S3. :type permission: string :param permission: The permission being granted. Should be one of: (READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL). :type user_id: string :param user_id: The canonical user id associated with the AWS account your are granting the permission to. :type display_name: string :param display_name: An option string containing the user's Display Name. Only required on Walrus. r) display_nameN)rr@add_user_grantr)r4rBZuser_idrrCrr5r5r6rD)s   zKey.add_user_grantcCsNt|tkr,t}|D]}||qni}|D]}||||<q4|Sr>)typesetaddry)r4rZ norm_metadatakr5r5r6_normalize_metadataBs zKey._normalize_metadatacCs~i}|jD]4}t||r t||}|r |dd}|||<q |jj}|jD]*}|dd}|j||d||f<qN|S)z Extracts metadata from existing URI into a dict, so we can overwrite/delete from it to form the new set of metadata to apply to a key. rrz%s%s)%_underscore_base_user_settable_fieldsrr[rxryrBZmetadata_prefixr)r4rrZunderscore_namerF field_nameprefixr5r5r6_get_remote_metadataMs      zKey._get_remote_metadatac Cs||}||}|}|||D]}||kr*||=q*|j}i}|D]>}|dsd|drz|dddd} n|} |||| <qL|}|j|j|jj|j|||ddS)Nz x-goog-meta-z x-amz-meta-rv)rrr)rIrMrr startswithrxrr) r4Z metadata_plusZmetadata_minusrrrhZ src_bucketZrewritten_metadataZ rewritten_hr5r5r6set_remote_metadatacs.    zKey.set_remote_metadatacCsT|jjjd|jj|j|j||dd}|jdkrP|jjj}||j|j| dS)a Restore an object from an archive. :type days: int :param days: The lifetime of the restored object (must be at least 1 day). If the object is already restored then this parameter can be used to readjust the lifetime of the restored object. In this case, the days param is with respect to the initial time of the request. If the object has not been restored, this param is with respect to the completion time of the request. POSTrestore)rrr)rN) rrArr RestoreBodyrrBrrr)r4daysrrzrBr5r5r6rR|s   z Key.restore)NN)F)NrvNN)NN)rNNN)F)r)NT)NFFFT)N)N)N)N)N)N)N)N)N) rNTFNFNNFF)NNrNFN)NNrNFNN)F)N)NTNrNFNN) NTNrNNFNFNF)NTNrNNFF)NTNrNNFF)NNrFNNN) NNrFNNNNN)NNr)NNrFNNN)NNrFNNN)NNrFNNN)N)NN)N)N)N)V__name__ __module__ __qualname____doc__rrTrconfiggetintrrFrrJfrGrxrr7r=r@propertyrBrDrGr~rKrNrrTrWrar\r]rrbrfrirmrrrrrrrr__next__rrrrrrrrrrrrrrrrrrrrrrrrr r#r$r'r&r1r4r<r?rArDrIrMrPrRr5r5r5r6r0st           6     % <          P + M 7  X 3 C B 6 M  @ I A    r)# email.utilsr8r.rr rrrrIrrZ boto.utilsrZ boto.compatrrrrZboto.exceptionrr r Z boto.providerr Zboto.s3.keyfiler Z boto.s3.userr rrrrrobjectrr5r5r5r6s,