-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[aws|storage] Delete multiple objects #686
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
module Fog | ||
module Parsers | ||
module Storage | ||
module AWS | ||
|
||
class DeleteMultipleObjects < Fog::Parsers::Base | ||
|
||
def reset | ||
@deleted = { 'Deleted' => {} } | ||
@error = { 'Error' => {} } | ||
@response = { 'DeleteResult' => [] } | ||
end | ||
|
||
def start_element(name, attrs = []) | ||
super | ||
case name | ||
when 'Deleted' | ||
@in_deleted = true | ||
end | ||
end | ||
|
||
def end_element(name) | ||
case name | ||
when 'Deleted' | ||
@response['DeleteResult'] << @deleted | ||
@deleted = { 'Deleted' => {} } | ||
@in_deleted = false | ||
when 'Error' | ||
@response['DeleteResult'] << @error | ||
@error = { 'Error' => {} } | ||
when 'Key', 'VersionId' | ||
if @in_deleted | ||
@deleted['Deleted'][name] = value | ||
else | ||
@error['Error'][name] = value | ||
end | ||
when 'DeleteMarker', 'DeletemarkerVersionId' | ||
@deleted['Deleted'][name] = value | ||
when 'Code', 'Message' | ||
@error['Error'][name] = value | ||
end | ||
end | ||
|
||
end | ||
|
||
end | ||
end | ||
end | ||
end | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
module Fog | ||
module Storage | ||
class AWS | ||
class Real | ||
|
||
require 'fog/aws/parsers/storage/delete_multiple_objects' | ||
|
||
# Delete multiple objects from S3 | ||
# | ||
# ==== Parameters | ||
# * bucket_name<~String> - Name of bucket containing object to delete | ||
# * object_names<~Array> - Array of object names to delete | ||
# | ||
# ==== Returns | ||
# * response<~Excon::Response>: | ||
# * body<~Hash>: | ||
# * 'DeleteResult'<~Array>: | ||
# * 'Deleted'<~Hash>: | ||
# * 'Key'<~String> - Name of the object that was deleted | ||
# * 'VersionId'<~String> - ID for the versioned onject in case of a versioned delete | ||
# * 'DeleteMarker'<~Boolean> - Indicates if the request accessed a delete marker | ||
# * 'DeleteMarkerVersionId'<~String> - Version ID of the delete marker accessed | ||
# * 'Error'<~Hash>: | ||
# * 'Key'<~String> - Name of the object that failed to be deleted | ||
# * 'VersionId'<~String> - ID of the versioned object that was attempted to be deleted | ||
# * 'Code'<~String> - Status code for the result of the failed delete | ||
# * 'Message'<~String> - Error description | ||
# | ||
# ==== See Also | ||
# http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html | ||
|
||
def delete_multiple_objects(bucket_name, object_names, options = {}) | ||
data = "<Delete>" | ||
data << "<Quiet>true</Quiet>" if options.delete(:quiet) | ||
object_names.each do |object_name| | ||
data << "<Object>" | ||
data << "<Key>#{object_name}</Key>" | ||
data << "</Object>" | ||
end | ||
data << "</Delete>" | ||
|
||
headers = options | ||
headers['Content-Length'] = data.length | ||
headers['Content-MD5'] = Base64.encode64(Digest::MD5.digest(data)).strip | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would this be susceptible to the recent bug that was fixed for 1.8.7, whereby Base64 could span multiple lines and strip would truncate? If so, we probably want to gsub('\n', '') again. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, I think it would be best to go with the gsub (safer and more consistent). |
||
|
||
request({ | ||
:body => data, | ||
:expects => 200, | ||
:headers => headers, | ||
:host => "#{bucket_name}.#{@host}", | ||
:method => 'POST', | ||
:parser => Fog::Parsers::Storage::AWS::DeleteMultipleObjects.new, | ||
:query => {'delete' => nil} | ||
}) | ||
end | ||
|
||
end | ||
|
||
class Mock # :nodoc:all | ||
|
||
def delete_multiple_objects(bucket_name, object_names, options = {}) | ||
response = Excon::Response.new | ||
if bucket = self.data[:buckets][bucket_name] | ||
response.status = 200 | ||
response.body = { 'DeleteResult' => [] } | ||
object_names.each do |object_name| | ||
bucket[:objects].delete(object_name) | ||
deleted_entry = { 'Deleted' => { 'Key' => object_name } } | ||
response.body['DeleteResult'] << deleted_entry | ||
end | ||
else | ||
response.status = 404 | ||
raise(Excon::Errors.status_error({:expects => 200}, response)) | ||
end | ||
response | ||
end | ||
|
||
end | ||
end | ||
end | ||
end | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concatenating strings together to form XML like this will not work if object_name contains a left angle bracket or an ampersand, and watch out for "index.html.png" or similar.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That comment got mangled. It was an XML injection to delete index.html.
</Key></Object><Object><Key>index.html</Key></Object><Object><Key>.png