-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
transfer.py
1154 lines (948 loc) · 42.4 KB
/
transfer.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Upload and download support for apitools."""
import email.generator as email_generator
import email.mime.multipart as mime_multipart
import email.mime.nonmultipart as mime_nonmultipart
import mimetypes
import os
import six
from six.moves import http_client
from gcloud._helpers import _to_bytes
from gcloud.streaming.buffered_stream import BufferedStream
from gcloud.streaming.exceptions import CommunicationError
from gcloud.streaming.exceptions import HttpError
from gcloud.streaming.exceptions import TransferInvalidError
from gcloud.streaming.exceptions import TransferRetryError
from gcloud.streaming.http_wrapper import get_http
from gcloud.streaming.http_wrapper import make_api_request
from gcloud.streaming.http_wrapper import Request
from gcloud.streaming.http_wrapper import RESUME_INCOMPLETE
from gcloud.streaming.stream_slice import StreamSlice
from gcloud.streaming.util import acceptable_mime_type
RESUMABLE_UPLOAD_THRESHOLD = 5 << 20
SIMPLE_UPLOAD = 'simple'
RESUMABLE_UPLOAD = 'resumable'
_DEFAULT_CHUNKSIZE = 1 << 20
class _Transfer(object):
"""Generic bits common to Uploads and Downloads.
:type stream: file-like object
:param stream: stream to/from which data is downloaded/uploaded.
:type close_stream: boolean
:param close_stream: should this instance close the stream when deleted
:type chunksize: integer
:param chunksize: the size of chunks used to download/upload a file.
:type auto_transfer: boolean
:param auto_transfer: should this instance automatically begin transfering
data when initialized
:type http: :class:`httplib2.Http` (or workalike)
:param http: Http instance used to perform requests.
:type num_retries: integer
:param num_retries: how many retries should the transfer attempt
"""
_num_retries = None
def __init__(self, stream, close_stream=False,
chunksize=_DEFAULT_CHUNKSIZE, auto_transfer=True,
http=None, num_retries=5):
self._bytes_http = None
self._close_stream = close_stream
self._http = http
self._stream = stream
self._url = None
# Let the @property do validation.
self.num_retries = num_retries
self.auto_transfer = auto_transfer
self.chunksize = chunksize
def __repr__(self):
return str(self)
@property
def close_stream(self):
"""Should this instance close the stream when deleted
:rtype: boolean
"""
return self._close_stream
@property
def http(self):
"""Http instance used to perform requests.
:rtype: :class:`httplib2.Http` (or workalike)
"""
return self._http
@property
def bytes_http(self):
"""Http instance used to perform binary requests.
Defaults to :attr:`http`.
:rtype: :class:`httplib2.Http` (or workalike)
"""
return self._bytes_http or self.http
@bytes_http.setter
def bytes_http(self, value):
"""Update Http instance used to perform binary requests.
:type value: :class:`httplib2.Http` (or workalike)
:param value: new instance
"""
self._bytes_http = value
@property
def num_retries(self):
"""How many retries should the transfer attempt
:rtype: integer
"""
return self._num_retries
@num_retries.setter
def num_retries(self, value):
"""Update how many retries should the transfer attempt
:type value: integer
"""
if not isinstance(value, six.integer_types):
raise ValueError("num_retries: pass an integer")
if value < 0:
raise ValueError(
'Cannot have negative value for num_retries')
self._num_retries = value
@property
def stream(self):
"""Stream to/from which data is downloaded/uploaded.
:rtype: file-like object
"""
return self._stream
@property
def url(self):
"""URL to / from which data is downloaded/uploaded.
:rtype: string
"""
return self._url
def _initialize(self, http, url):
"""Initialize this download by setting :attr:`http` and :attr`url`.
Allow the user to be able to pre-initialize :attr:`http` by setting
the value in the constructor; in that case, we ignore the provided
http.
:type http: :class:`httplib2.Http` (or a worklike) or None.
:param http: the Http instance to use to make requests.
:type url: string
:param url: The url for this transfer.
"""
self._ensure_uninitialized()
if self.http is None:
self._http = http or get_http()
self._url = url
@property
def initialized(self):
"""Has the instance been initialized
:rtype: boolean
"""
return self.url is not None and self.http is not None
def _ensure_initialized(self):
"""Helper: assert that the instance is initialized.
:raises: :exc:`gcloud.streaming.exceptions.TransferInvalidError`
if the instance is not initialized.
"""
if not self.initialized:
raise TransferInvalidError(
'Cannot use uninitialized %s', type(self).__name__)
def _ensure_uninitialized(self):
"""Helper: assert that the instance is not initialized.
:raises: :exc:`gcloud.streaming.exceptions.TransferInvalidError`
if the instance is already initialized.
"""
if self.initialized:
raise TransferInvalidError(
'Cannot re-initialize %s', type(self).__name__)
def __del__(self):
if self._close_stream:
self._stream.close()
class Download(_Transfer):
"""Represent a single download.
:type stream: file-like object
:param stream: stream to/from which data is downloaded/uploaded.
:type kwds: dict
:param kwds: keyword arguments: all except ``total_size`` are passed
through to :meth:`_Transfer.__init__()`.
"""
_ACCEPTABLE_STATUSES = set((
http_client.OK,
http_client.NO_CONTENT,
http_client.PARTIAL_CONTENT,
http_client.REQUESTED_RANGE_NOT_SATISFIABLE,
))
def __init__(self, stream, **kwds):
total_size = kwds.pop('total_size', None)
super(Download, self).__init__(stream, **kwds)
self._initial_response = None
self._progress = 0
self._total_size = total_size
self._encoding = None
@classmethod
def from_file(cls, filename, overwrite=False, auto_transfer=True, **kwds):
"""Create a new download object from a filename.
:type filename: string
:param filename: path/filename for the target file
:type overwrite: boolean
:param overwrite: should an existing file be overwritten
:type auto_transfer: boolean
:param auto_transfer: should the transfer be started immediately
:type kwds: dict
:param kwds: keyword arguments: passed
through to :meth:`_Transfer.__init__()`.
"""
path = os.path.expanduser(filename)
if os.path.exists(path) and not overwrite:
raise ValueError(
'File %s exists and overwrite not specified' % path)
return cls(open(path, 'wb'), close_stream=True,
auto_transfer=auto_transfer, **kwds)
@classmethod
def from_stream(cls, stream, auto_transfer=True, total_size=None, **kwds):
"""Create a new Download object from a stream.
:type stream: writable file-like object
:param stream: the target file
:type total_size: integer or None
:param total_size: total size of the file to be downloaded
:type auto_transfer: boolean
:param auto_transfer: should the transfer be started immediately
:type kwds: dict
:param kwds: keyword arguments: passed
through to :meth:`_Transfer.__init__()`.
"""
return cls(stream, auto_transfer=auto_transfer, total_size=total_size,
**kwds)
@property
def progress(self):
"""Number of bytes have been downloaded.
:rtype: integer >= 0
"""
return self._progress
@property
def total_size(self):
"""Total number of bytes to be downloaded.
:rtype: integer or None
"""
return self._total_size
@property
def encoding(self):
"""'Content-Encoding' used to transfer the file
:rtype: string or None
"""
return self._encoding
def __repr__(self):
if not self.initialized:
return 'Download (uninitialized)'
else:
return 'Download with %d/%s bytes transferred from url %s' % (
self.progress, self.total_size, self.url)
def configure_request(self, http_request, url_builder):
"""Update http_request/url_builder with download-appropriate values.
:type http_request: :class:`gcloud.streaming.http_wrapper.Request`
:param http_request: the request to be updated
:type url_builder: instance with settable 'query_params' attribute.
:param url_builder: transfer policy object to be updated
"""
url_builder.query_params['alt'] = 'media'
http_request.headers['Range'] = 'bytes=0-%d' % (self.chunksize - 1,)
def _set_total(self, info):
"""Update 'total_size' based on data from a response.
:type info: mapping
:param info: response headers
"""
if 'content-range' in info:
_, _, total = info['content-range'].rpartition('/')
if total != '*':
self._total_size = int(total)
# Note "total_size is None" means we don't know it; if no size
# info was returned on our initial range request, that means we
# have a 0-byte file. (That last statement has been verified
# empirically, but is not clearly documented anywhere.)
if self.total_size is None:
self._total_size = 0
def initialize_download(self, http_request, http):
"""Initialize this download.
If the instance has :attr:`auto_transfer` enabled, begins the
download immediately.
:type http_request: :class:`gcloud.streaming.http_wrapper.Request`
:param http_request: the request to use to initialize this download.
:type http: :class:`httplib2.Http` (or workalike)
:param http: Http instance for this request.
"""
self._ensure_uninitialized()
url = http_request.url
if self.auto_transfer:
end_byte = self._compute_end_byte(0)
self._set_range_header(http_request, 0, end_byte)
response = make_api_request(
self.bytes_http or http, http_request)
if response.status_code not in self._ACCEPTABLE_STATUSES:
raise HttpError.from_response(response)
self._initial_response = response
self._set_total(response.info)
url = response.info.get('content-location', response.request_url)
self._initialize(http, url)
# Unless the user has requested otherwise, we want to just
# go ahead and pump the bytes now.
if self.auto_transfer:
self.stream_file(use_chunks=True)
def _normalize_start_end(self, start, end=None):
"""Validate / fix up byte range.
:type start: integer
:param start: start byte of the range: if negative, used as an
offset from the end.
:type end: integer
:param end: end byte of the range.
:rtype: tuple, (start, end)
:returns: the normalized start, end pair.
:raises: :exc:`gcloud.streaming.exceptions.TransferInvalidError`
for invalid combinations of start, end.
"""
if end is not None:
if start < 0:
raise TransferInvalidError(
'Cannot have end index with negative start index')
elif start >= self.total_size:
raise TransferInvalidError(
'Cannot have start index greater than total size')
end = min(end, self.total_size - 1)
if end < start:
raise TransferInvalidError(
'Range requested with end[%s] < start[%s]' % (end, start))
return start, end
else:
if start < 0:
start = max(0, start + self.total_size)
return start, self.total_size - 1
@staticmethod
def _set_range_header(request, start, end=None):
"""Update the 'Range' header in a request to match a byte range.
:type request: :class:`gcloud.streaming.http_wrapper.Request`
:param request: the request to update
:type start: integer
:param start: start byte of the range: if negative, used as an
offset from the end.
:type end: integer
:param end: end byte of the range.
"""
if start < 0:
request.headers['range'] = 'bytes=%d' % start
elif end is None:
request.headers['range'] = 'bytes=%d-' % start
else:
request.headers['range'] = 'bytes=%d-%d' % (start, end)
def _compute_end_byte(self, start, end=None, use_chunks=True):
"""Compute the last byte to fetch for this request.
Based on the HTTP spec for Range and Content-Range.
.. note::
This is potentially confusing in several ways:
- the value for the last byte is 0-based, eg "fetch 10 bytes
from the beginning" would return 9 here.
- if we have no information about size, and don't want to
use the chunksize, we'll return None.
:type start: integer
:param start: start byte of the range.
:type end: integer or None
:param end: suggested last byte of the range.
:type use_chunks: boolean
:param use_chunks: If False, ignore :attr:`chunksize`.
:returns: Last byte to use in a 'Range' header, or None.
"""
end_byte = end
if start < 0 and not self.total_size:
return end_byte
if use_chunks:
alternate = start + self.chunksize - 1
if end_byte is not None:
end_byte = min(end_byte, alternate)
else:
end_byte = alternate
if self.total_size:
alternate = self.total_size - 1
if end_byte is not None:
end_byte = min(end_byte, alternate)
else:
end_byte = alternate
return end_byte
def _get_chunk(self, start, end):
"""Retrieve a chunk of the file.
:type start: integer
:param start: start byte of the range.
:type end: integer or None
:param end: end byte of the range.
:rtype: :class:`gcloud.streaming.http_wrapper.Response`
:returns: response from the chunk request.
"""
self._ensure_initialized()
request = Request(url=self.url)
self._set_range_header(request, start, end=end)
return make_api_request(
self.bytes_http, request, retries=self.num_retries)
def _process_response(self, response):
"""Update attribtes and writing stream, based on response.
:type response: :class:`gcloud.streaming.http_wrapper.Response`
:param response: response from a download request.
:rtype: :class:`gcloud.streaming.http_wrapper.Response`
:returns: the response
:raises: :exc:`gcloud.streaming.exceptions.HttpError` for
missing / unauthorized responses;
:exc:`gcloud.streaming.exceptions.TransferRetryError`
for other error responses.
"""
if response.status_code not in self._ACCEPTABLE_STATUSES:
# We distinguish errors that mean we made a mistake in setting
# up the transfer versus something we should attempt again.
if response.status_code in (http_client.FORBIDDEN,
http_client.NOT_FOUND):
raise HttpError.from_response(response)
else:
raise TransferRetryError(response.content)
if response.status_code in (http_client.OK,
http_client.PARTIAL_CONTENT):
self.stream.write(response.content)
self._progress += response.length
if response.info and 'content-encoding' in response.info:
self._encoding = response.info['content-encoding']
elif response.status_code == http_client.NO_CONTENT:
# It's important to write something to the stream for the case
# of a 0-byte download to a file, as otherwise python won't
# create the file.
self.stream.write('')
return response
def get_range(self, start, end=None, use_chunks=True):
"""Retrieve a given byte range from this download, inclusive.
Writes retrieved bytes into :attr:`stream`.
Range must be of one of these three forms:
* 0 <= start, end = None: Fetch from start to the end of the file.
* 0 <= start <= end: Fetch the bytes from start to end.
* start < 0, end = None: Fetch the last -start bytes of the file.
(These variations correspond to those described in the HTTP 1.1
protocol for range headers in RFC 2616, sec. 14.35.1.)
:type start: integer
:param start: Where to start fetching bytes. (See above.)
:type end: integer or ``None``
:param end: Where to stop fetching bytes. (See above.)
:type use_chunks: boolean
:param use_chunks: If False, ignore :attr:`chunksize`
and fetch this range in a single request.
If True, streams via chunks.
:raises: :exc:`gcloud.streaming.exceptions.TransferRetryError`
if a request returns an empty response.
"""
self._ensure_initialized()
progress_end_normalized = False
if self.total_size is not None:
progress, end_byte = self._normalize_start_end(start, end)
progress_end_normalized = True
else:
progress = start
end_byte = end
while (not progress_end_normalized or end_byte is None or
progress <= end_byte):
end_byte = self._compute_end_byte(progress, end=end_byte,
use_chunks=use_chunks)
response = self._get_chunk(progress, end_byte)
if not progress_end_normalized:
self._set_total(response.info)
progress, end_byte = self._normalize_start_end(start, end)
progress_end_normalized = True
response = self._process_response(response)
progress += response.length
if response.length == 0:
raise TransferRetryError(
'Zero bytes unexpectedly returned in download response')
def stream_file(self, use_chunks=True):
"""Stream the entire download.
Writes retrieved bytes into :attr:`stream`.
:type use_chunks: boolean
:param use_chunks: If False, ignore :attr:`chunksize`
and stream this download in a single request.
If True, streams via chunks.
"""
self._ensure_initialized()
while True:
if self._initial_response is not None:
response = self._initial_response
self._initial_response = None
else:
end_byte = self._compute_end_byte(self.progress,
use_chunks=use_chunks)
response = self._get_chunk(self.progress, end_byte)
if self.total_size is None:
self._set_total(response.info)
response = self._process_response(response)
if (response.status_code == http_client.OK or
self.progress >= self.total_size):
break
class Upload(_Transfer):
"""Represent a single Upload.
:type stream: file-like object
:param stream: stream to/from which data is downloaded/uploaded.
:type mime_type: string:
:param mime_type: MIME type of the upload.
:type total_size: integer or None
:param total_size: Total upload size for the stream.
:type http: :class:`httplib2.Http` (or workalike)
:param http: Http instance used to perform requests.
:type close_stream: boolean
:param close_stream: should this instance close the stream when deleted
:type auto_transfer: boolean
:param auto_transfer: should this instance automatically begin transfering
data when initialized
:type kwds: dict
:param kwds: keyword arguments: all except ``total_size`` are passed
through to :meth:`_Transfer.__init__()`.
"""
_REQUIRED_SERIALIZATION_KEYS = set((
'auto_transfer', 'mime_type', 'total_size', 'url'))
def __init__(self, stream, mime_type, total_size=None, http=None,
close_stream=False, auto_transfer=True,
**kwds):
super(Upload, self).__init__(
stream, close_stream=close_stream, auto_transfer=auto_transfer,
http=http, **kwds)
self._final_response = None
self._server_chunk_granularity = None
self._complete = False
self._mime_type = mime_type
self._progress = 0
self._strategy = None
self._total_size = total_size
@classmethod
def from_file(cls, filename, mime_type=None, auto_transfer=True, **kwds):
"""Create a new Upload object from a filename.
:type filename: string
:param filename: path/filename to the file being uploaded
:type mime_type: string
:param mime_type: MIMEtype of the file being uploaded
:type auto_transfer: boolean or None
:param auto_transfer: should the transfer be started immediately
:type kwds: dict
:param kwds: keyword arguments: passed
through to :meth:`_Transfer.__init__()`.
"""
path = os.path.expanduser(filename)
if not mime_type:
mime_type, _ = mimetypes.guess_type(path)
if mime_type is None:
raise ValueError(
'Could not guess mime type for %s' % path)
size = os.stat(path).st_size
return cls(open(path, 'rb'), mime_type, total_size=size,
close_stream=True, auto_transfer=auto_transfer, **kwds)
@classmethod
def from_stream(cls, stream, mime_type,
total_size=None, auto_transfer=True, **kwds):
"""Create a new Upload object from a stream.
:type stream: writable file-like object
:param stream: the target file
:type mime_type: string
:param mime_type: MIMEtype of the file being uploaded
:type total_size: integer or None
:param total_size: Size of the file being uploaded
:type auto_transfer: boolean or None
:param auto_transfer: should the transfer be started immediately
:type kwds: dict
:param kwds: keyword arguments: passed
through to :meth:`_Transfer.__init__()`.
"""
if mime_type is None:
raise ValueError(
'No mime_type specified for stream')
return cls(stream, mime_type, total_size=total_size,
close_stream=False, auto_transfer=auto_transfer, **kwds)
@property
def complete(self):
"""Has the entire stream been uploaded.
:rtype: boolean
"""
return self._complete
@property
def mime_type(self):
"""MIMEtype of the file being uploaded.
:rtype: string
"""
return self._mime_type
@property
def progress(self):
"""Bytes uploaded so far
:rtype: integer
"""
return self._progress
@property
def strategy(self):
"""Upload strategy to use
:rtype: string or None
"""
return self._strategy
@strategy.setter
def strategy(self, value):
"""Update upload strategy to use
:type value: string (one of :data:`SIMPLE_UPLOAD` or
:data:`RESUMABLE_UPLOAD`)
:raises: :exc:`ValueError` if value is not one of the two allowed
strings.
"""
if value not in (SIMPLE_UPLOAD, RESUMABLE_UPLOAD):
raise ValueError((
'Invalid value "%s" for upload strategy, must be one of '
'"simple" or "resumable".') % value)
self._strategy = value
@property
def total_size(self):
"""Total size of the stream to be uploaded.
:rtype: integer or None
"""
return self._total_size
@total_size.setter
def total_size(self, value):
"""Update total size of the stream to be uploaded.
:type value: integer or None
:param value: the size
"""
self._ensure_uninitialized()
self._total_size = value
def __repr__(self):
if not self.initialized:
return 'Upload (uninitialized)'
else:
return 'Upload with %d/%s bytes transferred for url %s' % (
self.progress, self.total_size or '???', self.url)
def _set_default_strategy(self, upload_config, http_request):
"""Determine and set the default upload strategy for this upload.
We generally prefer simple or multipart, unless we're forced to
use resumable. This happens when any of (1) the upload is too
large, (2) the simple endpoint doesn't support multipart requests
and we have metadata, or (3) there is no simple upload endpoint.
:type upload_config: instance w/ ``max_size`` and ``accept``
attributes
:param upload_config: Configuration for the upload endpoint.
:type http_request: :class:`gcloud.streaming.http_wrapper.Request`
:param http_request: The associated http request.
"""
if upload_config.resumable_path is None:
self.strategy = SIMPLE_UPLOAD
if self.strategy is not None:
return
strategy = SIMPLE_UPLOAD
if (self.total_size is not None and
self.total_size > RESUMABLE_UPLOAD_THRESHOLD):
strategy = RESUMABLE_UPLOAD
if http_request.body and not upload_config.simple_multipart:
strategy = RESUMABLE_UPLOAD
if not upload_config.simple_path:
strategy = RESUMABLE_UPLOAD
self.strategy = strategy
def configure_request(self, upload_config, http_request, url_builder):
"""Configure the request and url for this upload.
:type upload_config: instance w/ ``max_size`` and ``accept``
attributes
:param upload_config: transfer policy object to be queried
:type http_request: :class:`gcloud.streaming.http_wrapper.Request`
:param http_request: the request to be updated
:type url_builder: instance with settable 'relative_path' and
'query_params' attributes.
:param url_builder: transfer policy object to be updated
:raises: :exc:`ValueError` if the requested upload is too big,
or does not have an acceptable MIME type.
"""
# Validate total_size vs. max_size
if (self.total_size and upload_config.max_size and
self.total_size > upload_config.max_size):
raise ValueError(
'Upload too big: %s larger than max size %s' % (
self.total_size, upload_config.max_size))
# Validate mime type
if not acceptable_mime_type(upload_config.accept, self.mime_type):
raise ValueError(
'MIME type %s does not match any accepted MIME ranges %s' % (
self.mime_type, upload_config.accept))
self._set_default_strategy(upload_config, http_request)
if self.strategy == SIMPLE_UPLOAD:
url_builder.relative_path = upload_config.simple_path
if http_request.body:
url_builder.query_params['uploadType'] = 'multipart'
self._configure_multipart_request(http_request)
else:
url_builder.query_params['uploadType'] = 'media'
self._configure_media_request(http_request)
else:
url_builder.relative_path = upload_config.resumable_path
url_builder.query_params['uploadType'] = 'resumable'
self._configure_resumable_request(http_request)
def _configure_media_request(self, http_request):
"""Helper for 'configure_request': set up simple request."""
http_request.headers['content-type'] = self.mime_type
http_request.body = self.stream.read()
http_request.loggable_body = '<media body>'
def _configure_multipart_request(self, http_request):
"""Helper for 'configure_request': set up multipart request."""
# This is a multipart/related upload.
msg_root = mime_multipart.MIMEMultipart('related')
# msg_root should not write out its own headers
setattr(msg_root, '_write_headers', lambda self: None)
# attach the body as one part
msg = mime_nonmultipart.MIMENonMultipart(
*http_request.headers['content-type'].split('/'))
msg.set_payload(http_request.body)
msg_root.attach(msg)
# attach the media as the second part
msg = mime_nonmultipart.MIMENonMultipart(*self.mime_type.split('/'))
msg['Content-Transfer-Encoding'] = 'binary'
msg.set_payload(self.stream.read())
msg_root.attach(msg)
# NOTE: generate multipart message as bytes, not text
stream = six.BytesIO()
if six.PY3: # pragma: NO COVER Python3
generator_class = email_generator.BytesGenerator
else:
generator_class = email_generator.Generator
generator = generator_class(stream, mangle_from_=False)
generator.flatten(msg_root, unixfrom=False)
http_request.body = stream.getvalue()
multipart_boundary = msg_root.get_boundary()
http_request.headers['content-type'] = (
'multipart/related; boundary="%s"' % multipart_boundary)
boundary_bytes = _to_bytes(multipart_boundary)
body_components = http_request.body.split(boundary_bytes)
headers, _, _ = body_components[-2].partition(b'\n\n')
body_components[-2] = b'\n\n'.join([headers, b'<media body>\n\n--'])
http_request.loggable_body = boundary_bytes.join(body_components)
def _configure_resumable_request(self, http_request):
"""Helper for 'configure_request': set up resumable request."""
http_request.headers['X-Upload-Content-Type'] = self.mime_type
if self.total_size is not None:
http_request.headers[
'X-Upload-Content-Length'] = str(self.total_size)
def refresh_upload_state(self):
"""Refresh the state of a resumable upload via query to the back-end.
"""
if self.strategy != RESUMABLE_UPLOAD:
return
self._ensure_initialized()
# NOTE: Per RFC 2616[1]/7231[2], a 'PUT' request is inappropriate
# here: it is intended to be used to replace the entire
# resource, not to query for a status.
#
# If the back-end doesn't provide a way to query for this state
# via a 'GET' request, somebody should be spanked.
#
# The violation is documented[3].
#
# [1] http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.6
# [2] http://tools.ietf.org/html/rfc7231#section-4.3.4
# [3]
# https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload#resume-upload
refresh_request = Request(
url=self.url, http_method='PUT',
headers={'Content-Range': 'bytes */*'})
refresh_response = make_api_request(
self.http, refresh_request, redirections=0,
retries=self.num_retries)
range_header = self._get_range_header(refresh_response)
if refresh_response.status_code in (http_client.OK,
http_client.CREATED):
self._complete = True
self._progress = self.total_size
self.stream.seek(self.progress)
# If we're finished, the refresh response will contain the metadata
# originally requested. Cache it so it can be returned in
# StreamInChunks.
self._final_response = refresh_response
elif refresh_response.status_code == RESUME_INCOMPLETE:
if range_header is None:
self._progress = 0
else:
self._progress = self._last_byte(range_header) + 1
self.stream.seek(self.progress)
else:
raise HttpError.from_response(refresh_response)
@staticmethod
def _get_range_header(response):
"""Return a 'Range' header from a response.
:type response: :class:`gcloud.streaming.http_wrapper.Response`
:param response: response to be queried
:rtype: string
"""
# NOTE: Per RFC 2616[1]/7233[2][3], 'Range' is a request header,
# not a response header. If the back-end is actually setting
# 'Range' on responses, somebody should be spanked: it should
# be sending 'Content-Range' (including the # '/<length>'
# trailer).
#
# The violation is documented[4].
#
# [1] http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
# [2] http://tools.ietf.org/html/rfc7233#section-3.1
# [3] http://tools.ietf.org/html/rfc7233#section-4.2
# [4]
# https://cloud.google.com/storage/docs/json_api/v1/how-tos/upload#chunking
return response.info.get('Range', response.info.get('range'))
def initialize_upload(self, http_request, http):
"""Initialize this upload from the given http_request.
:type http_request: :class:`gcloud.streaming.http_wrapper.Request`
:param http_request: the request to be used
:type http: :class:`httplib2.Http` (or workalike)
:param http: Http instance for this request.
:raises: :exc:`ValueError` if the instance has not been configured
with a strategy.
"""
if self.strategy is None:
raise ValueError(
'No upload strategy set; did you call configure_request?')
if self.strategy != RESUMABLE_UPLOAD:
return
self._ensure_uninitialized()
http_response = make_api_request(http, http_request,
retries=self.num_retries)
if http_response.status_code != http_client.OK:
raise HttpError.from_response(http_response)
granularity = http_response.info.get('X-Goog-Upload-Chunk-Granularity')
if granularity is not None:
granularity = int(granularity)
self._server_chunk_granularity = granularity
url = http_response.info['location']
self._initialize(http, url)
# Unless the user has requested otherwise, we want to just
# go ahead and pump the bytes now.
if self.auto_transfer:
return self.stream_file(use_chunks=True)
else:
return http_response
@staticmethod
def _last_byte(range_header):
"""Parse the last byte from a 'Range' header.
:type range_header: string
:param range_header: 'Range' header value per RFC 2616/7233
"""
_, _, end = range_header.partition('-')
return int(end)
def _validate_chunksize(self, chunksize=None):
"""Validate chunksize against server-specified granularity.
Helper for :meth:`stream_file`.
:type chunksize: integer or None