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
|
# frozen_string_literal: true
#-------------------------------------------------------------------------
# # Copyright (c) Microsoft and contributors. All rights reserved.
#
# The MIT License(MIT)
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files(the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions :
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#--------------------------------------------------------------------------
module Azure::Storage
module Blob
# Public: Creates a new append blob. Note that calling create_append_blob to create an append
# blob only initializes the blob. To add content to an append blob, call append_blob_blocks method.
#
# ==== Attributes
#
# * +container+ - String. The container name.
# * +blob+ - String. The blob name.
# * +options+ - Hash. Optional parameters.
#
# ==== Options
#
# Accepted key/value pairs in options parameter are:
# * +:content_type+ - String. Content type for the blob. Will be saved with blob.
# * +:content_encoding+ - String. Content encoding for the blob. Will be saved with blob.
# * +:content_language+ - String. Content language for the blob. Will be saved with blob.
# * +:content_md5+ - String. Content MD5 for the blob. Will be saved with blob.
# * +:cache_control+ - String. Cache control for the blob. Will be saved with blob.
# * +:content_disposition+ - String. Conveys additional information about how to process the response payload,
# and also can be used to attach additional metadata
# * +:metadata+ - Hash. Custom metadata values to store with the blob.
# * +:timeout+ - Integer. A timeout in seconds.
# * +:request_id+ - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
# in the analytics logs when storage analytics logging is enabled.
# * +:if_modified_since+ - String. A DateTime value. Specify this conditional header to create a new blob
# only if the blob has been modified since the specified date/time. If the blob has not been modified,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_unmodified_since+ - String. A DateTime value. Specify this conditional header to create a new blob
# only if the blob has not been modified since the specified date/time. If the blob has been modified,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_match+ - String. An ETag value. Specify an ETag value for this conditional header to create a new blob
# only if the blob's ETag value matches the value specified. If the values do not match,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_none_match+ - String. An ETag value. Specify an ETag value for this conditional header to create a new blob
# only if the blob's ETag value does not match the value specified. If the values are identical,
# the Blob service returns status code 412 (Precondition Failed).
# * +:lease_id+ - String. Required if the blob has an active lease. To perform this operation on a blob with an active lease,
# specify the valid lease ID for this header.
#
# See http://msdn.microsoft.com/en-us/library/azure/dd179451.aspx
#
# Returns a Blob
def create_append_blob(container, blob, options = {})
query = {}
StorageService.with_query query, "timeout", options[:timeout] if options[:timeout]
uri = blob_uri(container, blob, query)
headers = {}
# set x-ms-blob-type to AppendBlob
StorageService.with_header headers, "x-ms-blob-type", "AppendBlob"
# ensure content-length is 0
StorageService.with_header headers, "Content-Length", 0
# set the rest of the optional headers
StorageService.with_header headers, "x-ms-blob-content-type", options[:content_type]
StorageService.with_header headers, "x-ms-blob-content-encoding", options[:content_encoding]
StorageService.with_header headers, "x-ms-blob-content-language", options[:content_language]
StorageService.with_header headers, "x-ms-blob-content-md5", options[:content_md5]
StorageService.with_header headers, "x-ms-blob-cache-control", options[:cache_control]
StorageService.with_header headers, "x-ms-blob-content-disposition", options[:content_disposition]
StorageService.add_metadata_to_headers options[:metadata], headers
add_blob_conditional_headers options, headers
headers["x-ms-lease-id"] = options[:lease_id] if options[:lease_id]
headers["x-ms-blob-content-type"] = Default::CONTENT_TYPE_VALUE unless headers["x-ms-blob-content-type"]
# call PutBlob with empty body
response = call(:put, uri, nil, headers, options)
result = Serialization.blob_from_headers(response.headers)
result.name = blob
result.metadata = options[:metadata] if options[:metadata]
result
end
# Public: Commits a new block of data to the end of an existing append blob.
# This operation is permitted only on blobs created with the create_append_blob API.
#
# ==== Attributes
#
# * +container+ - String. The container name.
# * +blob+ - String. The blob name.
# * +content+ - IO or String. The content of the blob.
# * +options+ - Hash. Optional parameters.
#
# ==== Options
#
# Accepted key/value pairs in options parameter are:
# * +:content_md5+ - String. Content MD5 for the request contents.
# * +:max_size+ - Integer. The max length in bytes permitted for the append blob
# * +:append_position+ - Integer. A number indicating the byte offset to compare. It will succeed only if the append position is equal to this number
# * +:timeout+ - Integer. A timeout in seconds.
# * +:request_id+ - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
# in the analytics logs when storage analytics logging is enabled.
# * +:if_modified_since+ - String. A DateTime value. Specify this conditional header to append a block only if
# the blob has been modified since the specified date/time. If the blob has not been modified,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_unmodified_since+ - String. A DateTime value. Specify this conditional header to append a block only if
# the blob has not been modified since the specified date/time. If the blob has been modified,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_match+ - String. An ETag value. Specify an ETag value for this conditional header to append a block only if
# the blob's ETag value matches the value specified. If the values do not match,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_none_match+ - String. An ETag value. Specify an ETag value for this conditional header to append a block only if
# the blob's ETag value does not match the value specified. If the values are identical,
# the Blob service returns status code 412 (Precondition Failed).
# * +:lease_id+ - String. Required if the blob has an active lease. To perform this operation on a blob with an
# active lease, specify the valid lease ID for this header.
#
# See http://msdn.microsoft.com/en-us/library/azure/mt427365.aspx
#
# Returns a Blob
def append_blob_block(container, blob, content, options = {})
query = { "comp" => "appendblock" }
StorageService.with_query query, "timeout", options[:timeout].to_s if options[:timeout]
uri = blob_uri(container, blob, query)
headers = {}
StorageService.with_header headers, "Content-MD5", options[:content_md5]
StorageService.with_header headers, "x-ms-lease-id", options[:lease_id]
StorageService.with_header headers, "x-ms-blob-condition-maxsize", options[:max_size]
StorageService.with_header headers, "x-ms-blob-condition-appendpos", options[:append_position]
add_blob_conditional_headers options, headers
headers["x-ms-lease-id"] = options[:lease_id] if options[:lease_id]
response = call(:put, uri, content, headers, options)
result = Serialization.blob_from_headers(response.headers)
result.name = blob
result
end
# Public: Creates a new append blob with given content
#
# ==== Attributes
#
# * +container+ - String. The container name.
# * +blob+ - String. The blob name.
# * +content+ - IO or String. Content to write.
# * +options+ - Hash. Optional parameters.
#
# ==== Options
#
# Accepted key/value pairs in options parameter are:
# * +:content_type+ - String. Content type for the blob. Will be saved with blob.
# * +:content_encoding+ - String. Content encoding for the blob. Will be saved with blob.
# * +:content_language+ - String. Content language for the blob. Will be saved with blob.
# * +:content_md5+ - String. Content MD5 for the blob. Will be saved with blob.
# * +:cache_control+ - String. Cache control for the blob. Will be saved with blob.
# * +:content_disposition+ - String. Conveys additional information about how to process the response payload,
# and also can be used to attach additional metadata
# * +:max_size+ - Integer. The max length in bytes permitted for the append blob.
# * +:metadata+ - Hash. Custom metadata values to store with the blob.
# * +:timeout+ - Integer. A timeout in seconds.
# * +:request_id+ - String. Provides a client-generated, opaque value with a 1 KB character limit that is recorded
# in the analytics logs when storage analytics logging is enabled.
# * +:if_modified_since+ - String. A DateTime value. Specify this conditional header to create a new blob
# only if the blob has been modified since the specified date/time. If the blob has not been modified,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_unmodified_since+ - String. A DateTime value. Specify this conditional header to create a new blob
# only if the blob has not been modified since the specified date/time. If the blob has been modified,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_match+ - String. An ETag value. Specify an ETag value for this conditional header to create a new blob
# only if the blob's ETag value matches the value specified. If the values do not match,
# the Blob service returns status code 412 (Precondition Failed).
# * +:if_none_match+ - String. An ETag value. Specify an ETag value for this conditional header to create a new blob
# only if the blob's ETag value does not match the value specified. If the values are identical,
# the Blob service returns status code 412 (Precondition Failed).
# * +:lease_id+ - String. Required if the blob has an active lease. To perform this operation on a blob with an active lease,
# specify the valid lease ID for this header.
#
# See http://msdn.microsoft.com/en-us/library/azure/dd179451.aspx
#
# Returns a Blob
def create_append_blob_from_content(container, blob, content, options = {})
# Fail fast if content has larger size than max_size
max_size = options.delete :max_size
if max_size
if content.respond_to?(:size) && max_size < content.size
raise Azure::Storage::Common::Core::StorageError.new("Given content has exceeded the specified maximum size for the blob.")
end
end
options[:content_type] = get_or_apply_content_type(content, options[:content_type])
create_append_blob(container, blob, options)
content = StringIO.new(content) if content.is_a? String
# initialize the append block options.
append_block_options = {}
append_block_options[:if_modified_since] = options[:if_modified_since] if options[:if_modified_since]
append_block_options[:if_unmodified_since] = options[:if_unmodified_since] if options[:if_unmodified_since]
append_block_options[:if_match] = options[:if_match] if options[:if_match]
append_block_options[:if_none_match] = options[:if_none_match] if options[:if_none_match]
append_block_options[:lease_id] = options[:lease_id] if options[:lease_id]
append_block_options[:max_size] = max_size if max_size
position = 0
while !content.eof?
payload = content.read(BlobConstants::DEFAULT_WRITE_BLOCK_SIZE_IN_BYTES)
# set the append position to make sure that each append is going to the correct offset.
append_block_options[:append_position] = position
append_blob_block(container, blob, payload, append_block_options)
# calculate the position after the append.
position += payload.size
end
get_properties_options = {}
get_properties_options[:lease_id] = options[:lease_id] if options[:lease_id]
# Get the blob properties
get_blob_properties(container, blob, get_properties_options)
end
end
end
|
