Skip to content
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

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
50 changes: 50 additions & 0 deletions lib/fog/aws/parsers/storage/delete_multiple_objects.rb
@@ -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

82 changes: 82 additions & 0 deletions lib/fog/aws/requests/storage/delete_multiple_objects.rb
@@ -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>"

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.

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

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
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Member

Choose a reason for hiding this comment

The 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

2 changes: 2 additions & 0 deletions lib/fog/aws/storage.rb
Expand Up @@ -22,6 +22,7 @@ class AWS < Fog::Service
request :delete_bucket_policy
request :delete_bucket_website
request :delete_object
request :delete_multiple_objects
request :get_bucket
request :get_bucket_acl
request :get_bucket_location
Expand Down Expand Up @@ -338,6 +339,7 @@ def signature(params)
for key in (params[:query] || {}).keys.sort
if %w{
acl
delete
location
logging
notification
Expand Down
16 changes: 16 additions & 0 deletions tests/aws/requests/storage/object_tests.rb
Expand Up @@ -4,6 +4,14 @@

tests('success') do

@multiple_delete_format = {
'DeleteResult' => [{
'Deleted' => {
'Key' => String
}
}]
}

tests("#put_object('#{@directory.identity}', 'fog_object', lorem_file)").succeeds do
Fog::Storage[:aws].put_object(@directory.identity, 'fog_object', lorem_file)
end
Expand Down Expand Up @@ -84,6 +92,10 @@
Fog::Storage[:aws].delete_object(@directory.identity, 'fog_object')
end

tests("delete_multiple_objects('#{@directory.identity}', ['fog_object', 'fog_other_object'])").formats(@multiple_delete_format) do
Fog::Storage[:aws].delete_multiple_objects(@directory.identity, ['fog_object', 'fog_other_object']).body
end

end

tests('failure') do
Expand Down Expand Up @@ -124,6 +136,10 @@
Fog::Storage[:aws].delete_object('fognonbucket', 'fog_non_object')
end

tests("#delete_multiple_objects('fognonbucket', ['fog_non_object'])").raises(Excon::Errors::NotFound) do
Fog::Storage[:aws].delete_multiple_objects('fognonbucket', ['fog_non_object'])
end

tests("#put_object_acl('#{@directory.identity}', 'fog_object', 'invalid')").raises(Excon::Errors::BadRequest) do
Fog::Storage[:aws].put_object_acl('#{@directory.identity}', 'fog_object', 'invalid')
end
Expand Down