Add support for conditional deletes in changeset uploads
authorTom Hughes <tom@compton.nu>
Mon, 13 Dec 2010 00:21:47 +0000 (00:21 +0000)
committerTom Hughes <tom@compton.nu>
Wed, 15 Dec 2010 23:59:06 +0000 (23:59 +0000)
A delete element in an osmChange upload can now have an if-unused
attribute to indicate that the delete should not be done if the
object is still in use.

lib/diff_reader.rb
test/functional/changeset_controller_test.rb

index 9b3e01b86bf8dd6d20a72fec3502193dea51728d..0f0492f444f57d781bf9ec21dcf4b90d7ac8ac59 100644 (file)
@@ -54,7 +54,18 @@ class DiffReader
         # as the call to @reader.next in the innermost loop will take
         # care of that for us.
         if @reader.node_type == 1 # element
-          yield @reader.name
+          name = @reader.name
+          attributes =  {}
+
+          if @reader.has_attributes?
+            while @reader.move_to_next_attribute == 1
+              attributes[@reader.name] = @reader.value
+            end
+
+            @reader.move_to_element
+          end
+
+          yield name, attributes
         else
           read_or_die
         end
@@ -70,7 +81,7 @@ class DiffReader
   # elements, it would be better to DRY and do this in a block. This
   # could also help with error handling...?
   def with_model
-    with_element do |model_name|
+    with_element do |model_name,model_attributes|
       model = MODELS[model_name]
       raise OSM::APIBadUserInput.new("Unexpected element type #{model_name}, " +
                                      "expected node, way or relation.") if model.nil?
@@ -110,7 +121,7 @@ class DiffReader
     result.root.name = "diffResult"
 
     # loop at the top level, within the <osmChange> element
-    with_element do |action_name|
+    with_element do |action_name,action_attributes|
       if action_name == 'create'
         # create a new element. this code is agnostic of the element type
         # because all the elements support the methods that we're using.
@@ -204,12 +215,23 @@ class DiffReader
           # can a delete have placeholders under any circumstances?
           # if a way is modified, then deleted is that a valid diff?
           new.fix_placeholders!(ids)
-          old.delete_with_history!(new, @changeset.user)
 
           xml_result = XML::Node.new model.to_s.downcase
           # oh, the irony... the "new" element actually contains the "old" ID
           # a better name would have been client/server, but anyway...
           xml_result["old_id"] = new_id.to_s
+
+          if action_attributes["if-unused"]
+            begin
+              old.delete_with_history!(new, @changeset.user)
+            rescue OSM::APIPreconditionFailedError => ex
+              xml_result["new_id"] = old.id.to_s
+              xml_result["new_version"] = old.version.to_s
+            end
+          else
+            old.delete_with_history!(new, @changeset.user)
+          end
+
           result.root << xml_result
         end
 
index 38f301524243a70d468c047c8e6c5744515a45c8..3d963b4714a57d663fe8dcce8416b14a0ee75702 100644 (file)
@@ -497,6 +497,56 @@ EOF
     assert_equal true, Relation.find(current_relations(:visible_relation).id).visible
   end
 
+  ##
+  # test that a conditional delete of an in use object works.
+  def test_upload_delete_if_unused
+    basic_authorization users(:public_user).email, "test"
+
+    diff = XML::Document.new
+    diff.root = XML::Node.new "osmChange"
+    delete = XML::Node.new "delete"
+    diff.root << delete
+    delete["if-unused"] = ""
+    delete << current_relations(:public_used_relation).to_xml_node
+    delete << current_ways(:used_way).to_xml_node
+    delete << current_nodes(:node_used_by_relationship).to_xml_node
+
+    # upload it
+    content diff
+    post :upload, :id => 2
+    assert_response :success, 
+      "can't do a conditional delete of in use objects: #{@response.body}"
+
+    # check the returned payload
+    assert_select "diffResult[version=#{API_VERSION}][generator=\"OpenStreetMap server\"]", 1
+    assert_select "diffResult>node", 1
+    assert_select "diffresult>way", 1
+    assert_select "diffResult>relation", 1
+
+    # parse the response
+    doc = XML::Parser.string(@response.body).parse
+
+    # check the old IDs are all present and what we expect
+    assert_equal current_nodes(:node_used_by_relationship).id, doc.find("//diffResult/node").first["old_id"].to_i
+    assert_equal current_ways(:used_way).id, doc.find("//diffResult/way").first["old_id"].to_i
+    assert_equal current_relations(:public_used_relation).id, doc.find("//diffResult/relation").first["old_id"].to_i
+
+    # check the new IDs are all present and unchanged
+    assert_equal current_nodes(:node_used_by_relationship).id, doc.find("//diffResult/node").first["new_id"].to_i
+    assert_equal current_ways(:used_way).id, doc.find("//diffResult/way").first["new_id"].to_i
+    assert_equal current_relations(:public_used_relation).id, doc.find("//diffResult/relation").first["new_id"].to_i
+
+    # check the new versions are all present and unchanged
+    assert_equal current_nodes(:node_used_by_relationship).version, doc.find("//diffResult/node").first["new_version"].to_i
+    assert_equal current_ways(:used_way).version, doc.find("//diffResult/way").first["new_version"].to_i
+    assert_equal current_relations(:public_used_relation).version, doc.find("//diffResult/relation").first["new_version"].to_i
+
+    # check that nothing was, in fact, deleted
+    assert_equal true, Node.find(current_nodes(:node_used_by_relationship).id).visible
+    assert_equal true, Way.find(current_ways(:used_way).id).visible
+    assert_equal true, Relation.find(current_relations(:public_used_relation).id).visible
+  end
+
   ##
   # upload an element with a really long tag value
   def test_upload_invalid_too_long_tag