FRTc @ sj d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m
Z
d d l Z d d l
m Z m Z m Z 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 d l m Z m Z d d l m Z d d
l m Z d e! f d YZ" d S( iN( t md5( t BytesIOt sixt urllibt encodebytes( t BotoClientError( t StorageDataError( t PleaseRetryException( t Provider( t KeyFile( t User( t UserAgent( t compute_md5t compute_hash( t find_matching_headers( t merge_headers_by_namet Keyc B s e Z d Z d Z d Z e j j d d d Z e d d d d d
d d d
g Z
e Z x' e
D] Z e j
e j d d qd We
e d d d d g BZ dV dV d Z d Z d Z e d Z d Z d Z e e e Z d Z d Z e e e Z d Z d Z e e e Z d Z d Z e e e Z! d Z" d! Z# e$ d" Z% d# Z& d$ Z' dV d% dV dV d& Z( dV dV d' Z) d( dV dV dV d) Z* e$ Z+ e$ d* Z, d+ Z- e- Z. d, d- Z/ dV e0 d. Z1 dV e$ e$ e$ e0 d/ Z2 d0 Z3 d1 Z4 dV d2 Z5 dV d3 Z6 d4 Z7 d5 Z8 d6 Z9 dV d7 Z: dV d8 Z; dV d9 Z< dV d: Z= dV d; Z> d< Z? dV d= Z@ dV d> ZA d? dV e0 e$ dV e$ dV dV e$ e$ d@
ZB dV dV dA dV e$ dV dB ZC dV dV dA dV e$ dV dV dC ZD e$ dD ZE dV dE ZF dV e0 dV dA dV e$ dV dV dF ZG dV e0 dV dA dV dV e$ dV e$ dV e$ dG ZH dV e0 dV dA dV dV e$ e$ dH ZI dV e0 dV dA dV dV e$ e$ dI ZJ dV dV dA e$ dV dV dV dJ ZK dV dV dA e$ dV dV dV dV dV dK ZL dV dV dA dL ZM dV dV dA e$ dV dV dV dM ZN dV dV dA e$ dV dV dV dN ZO dV dV dA e$ dV dV dV dO ZP dV dP ZQ dV dV dQ ZR dR ZS dV dS ZT dV dT ZU dV dU ZV RS(W sC
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.
s application/octet-streams
%s
t Botot key_buffer_sizei s
cache-controls content-dispositions content-encodings content-languages content-md5s content-types x-robots-tagt expirest -t _s
last-modifieds content-lengtht datet etagc C s | | _ | | _ i | _ d | _ | j | _ d | _ d | _ d | _ d | _
d | _ t | _
d | _ d | _ d | _ d | _ d | _ d | _ d | _ d | _ d | _ t | _ d | _ d | _ d | _ i | _ d S( N( t buckett namet metadatat Nonet
cache_controlt DefaultContentTypet content_typet content_encodingt content_dispositiont content_languaget filenameR t Falset is_latestt
last_modifiedt ownert _storage_classt patht respt modet sizet
version_idt source_version_idt
delete_markert encryptedt ongoing_restoret expiry_datet local_hashes( t selfR R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt __init__i s2 c C sW | j r% d | j j | j f } n
d | j } t | t sS | j d } n | S( Nu u s utf-8( R R t
isinstancet strt encode( R3 R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt __repr__ s
c C s | S( N( ( R3 ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt __iter__ s c C s1 d } | j r- | j j r- | j j j } n | S( N( R R t
connectiont provider( R3 R; ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR; s c C s | j S( N( R ( R3 ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt _get_key s c C s
| | _ d S( N( R ( R3 t value( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt _set_key s c C s4 d | j k r0 | j d r0 t j | j d Sd S( NR ( R2 t binasciit b2a_hex( R3 ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt _get_md5 s c C sH | r t j | | j d | d k rb d | _ | j d | d | n t d | d S( NRu Rs Rw Rx t ws Invalid mode: %s( R* R R R ( R3 R* Rs Rw Rx ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt openR s
c C s? | j r | r | j j n d | _ d | _ t | _ d S( s
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.
N( R) R{ R R* R_ t closed( R3 t fast( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt closea s
c C s< | j | j j | j } | s8 | j t n | S( s
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.
( R R) R{ t
BufferSizeR t
StopIteration( R3 t data( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt nextw s
i c C sQ | j | d k r( | j j } n | j j | } | sM | j n | S( Ni ( R R) R{ R ( R3 R+ R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR{ s
c C s | d k r7 | j | j j | j d t d t d | S| d k rn | j | j j | j d t d t d | St d | d S( s
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.
RM t reduced_redundancyt preserve_aclt validate_dst_buckett REDUCED_REDUNDANCYs Invalid storage class: %sN( t copyR R R# R_ R ( R3 t new_storage_classt
dst_bucketR ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt change_storage_class s c C sa | j j j | | } | r' d } n | j } | j | | j j | j | d | d | d | S( s
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 t
storage_classR t encrypt_key( R R: t lookupR t copy_keyR ( R3 R t dst_keyR R R R R R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR s / c C s* | d k r" t | | _ | j Sd Sd S( Nt Owner( R
R& R ( R3 R t attrsR: ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt startElement s c C s | d k r | | _ n | d k r0 | | _ n | d k r` | d k rT t | _ q t | _ n | d k rx | | _ nm | d k r t | | _ nO | d k r | | _ n7 | d k r n( | d k r | | _ n t
| | | d S(
NR t ETagt IsLatestR] t LastModifiedt Sizet StorageClassR t VersionId( R R R_ R$ R# R% R R+ R R, t setattr( R3 R R= R: ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt
endElement s& c C s t | j j | j d | S( st
Returns True if the key exists
:rtype: bool
:return: Whether the key exists on S3
Rs ( t boolR R R ( R3 Rs ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt exists s c C s" | j j | j d | j d | S( s)
Delete this key from S3
R, Rs ( R t
delete_keyR R, ( R3 Rs ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt delete s c C s | j j | S( N( R t get( R3 R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt get_metadata" s c C s | j d k r" | | j d s c s d k r. j k r. j n' d k rU j rU j d n i } t j j d | r} d | d | j d k r( t S| j d r> t Sn d | j k oX d k n r | j d | _ | j } t | t r | j
d } n | j d d } | d k r | j d | k r | j d
| j | j f q n t S| j d k rW| j
} | j | j | j | } | j d k rWt d
| j d | qWn t S( Ni i t locationi i+ R s utf-8s/ x-amz-server-side-encryption-customer-algorithms "%s"s2 ETag from S3 did not match computed MD5. %s vs. %si t RequestTimeouts Saw %s, retryingRk ( i i ( R ( R R: R; Rz R_ RZ R R R5 RE RG R R R{ R| R} t
error_codeR R# ( R3 Rk R R; R t) server_side_encryption_customer_algorithmR t err( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR s<
c C s. t | d | \ } } } | | _ | | f S( s
: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+ ( R R+ ( R3 R R+ t
hex_digestt
b64_digestt data_size( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR s
c
C s | j j j }
|
j s4 t d |
j n | j sM | j d k r\ t d n | d k rq i } n | r | | |
j t k
r} | j t j k rt d | j n n X| r8| d k s | d k r8| d k r8| | | n x% | D] } | | j | j | s s versionId=%ss %s=%st &Ru Rw Rx ii g ?s$ Out of space for destination file %st Rangei ( R R R: R t appendR R R, R t parset quotet joinR R+ R R R R t writeRO R R t errnot ENOSPCR R RV R2 R ( R3 R Rs R R R R, Rx R R Rw R R Rp R R R Ro RE R t e( ( R s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR s| "
% '
*
"
c C s | j | | | | d t S( s
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.
R ( R! R_ ( R3 R Rs R R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt get_torrent_file s c C sl | j d k rh | r= | j | | | | | d | d | qh | j | | | | d | d | d | n d S( s
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.
R R, R N( R R R! ( R3 R Rs R R R R, t res_download_handlerR ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt get_contents_to_file2 s 6
c C s yJ t | d 5 } | j | | | | d | d | d | d | Wd QXWn! t k
rm t j | n X| j d k r yJ t j j | j }
t
t j j |
} t j | j
| | f Wq t k
r q Xn d S( sK
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 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.
t wbR R, R- R N( R R. t ExceptionR t removeR% R t emailR t parsedate_tzR t mktime_tzt utimeR ( R3 R" Rs R R R R, R- R R t modified_tuplet modified_stamp( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt get_contents_to_filenamer s" 6
c
C s_ t } | j | | | | d | d | d | | j } | d k r[ | j | } n | S( so
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
R R, R N( R R. t getvalueR RG (
R3 Rs R R R R, R t encodingR R= ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt get_contents_as_string s 6 c C s< | j d | } | j j | | | j | d | d S( s
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!
Rs N( R t aclt add_email_grantR ( R3 t
permissiont
email_addressRs R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR= s c C sB | j d | } | j j | | d | | j | d | d S( s
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.
Rs t display_nameN( R R< t add_user_grantR ( R3 R> t user_idRs R@ R ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyRA s c C sq t | t k rB t } xO | D] } | j | j q" Wn+ i } x" | D] } | | | | j | | =q> q> W| j } i } xa | D]Y } | j d s | j d r | j d d j d d } n | } | | | | Rp RA RD R RI RL RW RR RS R RX R[ R# Ra Rr Rt R R R R R R t __next__R{ R_ R R R R R R R R R R R R R R R R R R R R R R R R R R R! R R, R. R8 R; R= RA RH RN RV RX ( ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyR 0 s
5
#9 M * 3 U @ ? 4 K ; D= (# t email.utilsR2 R) R R R R R R? R R t
boto.utilsR t boto.compatR R R R t boto.exceptionR R R t
boto.providerR t boto.s3.keyfileR t boto.s3.userR
R R R
R R t objectR ( ( ( s8 /opt/freeware/lib/python2.7/site-packages/boto/s3/key.pyt s, "