]> git.openstreetmap.org Git - rails.git/blobdiff - app/controllers/amf_controller.rb
Some fixes to the rails part of the AMF controller and associated test.
[rails.git] / app / controllers / amf_controller.rb
index 43bec41a1825b4d64501f0200804cb85778aa484..45dbea4db0b797b2f6c06d0f5abc221b25e02615 100644 (file)
@@ -3,7 +3,7 @@
 # OSM database takes place using this controller. Messages are 
 # encoded in the Actionscript Message Format (AMF).
 #
-# Helper functions are in /lib/potlatch.
+# Helper functions are in /lib/potlatch.rb
 #
 # Author::     editions Systeme D / Richard Fairhurst 2004-2008
 # Licence::    public domain.
@@ -130,8 +130,8 @@ class AmfController < ApplicationController
   # Start new changeset
   
   def startchangeset(usertoken, cstags, closeid, closecomment)
-    uid = getuserid(usertoken)
-    if !uid then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end
+    user = getuserid(usertoken)
+    if !user then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end
 
     # close previous changeset and add comment
     if closeid
@@ -163,21 +163,27 @@ class AmfController < ApplicationController
     return POTLATCH_PRESETS
   end
 
+  ##
   # Find all the ways, POI nodes (i.e. not part of ways), and relations
   # in a given bounding box. Nodes are returned in full; ways and relations 
   # are IDs only. 
-
+  #
+  # return is of the form: 
+  # [error_code, 
+  #  [[way_id, way_version], ...],
+  #  [[node_id, lat, lon, [tags, ...]], ...],
+  #  [[rel_id, rel_version], ...]]
+  # where the ways are any visible ways which refer to any visible
+  # nodes in the bbox, nodes are any visible nodes in the bbox but not
+  # used in any way, rel is any relation which refers to either a way
+  # or node that we're returning.
   def whichways(xmin, ymin, xmax, ymax) #:doc:
     xmin -= 0.01; ymin -= 0.01
     xmax += 0.01; ymax += 0.01
     
     # check boundary is sane and area within defined
     # see /config/application.yml
-    begin
-      check_boundaries(xmin, ymin, xmax, ymax)
-    rescue Exception => err
-      return [-2,"Sorry - I can't get the map for that area."]
-    end
+    check_boundaries(xmin, ymin, xmax, ymax)
 
     if POTLATCH_USE_SQL then
       ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
@@ -186,8 +192,9 @@ class AmfController < ApplicationController
     else
       # find the way ids in an area
       nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways)
-      ways = nodes_in_area.collect { |node| 
-        node.ways.collect { |w| [w.id,w.version] }.flatten
+      ways = nodes_in_area.inject([]) { |sum, node| 
+        visible_ways = node.ways.select { |w| w.visible? }
+        sum + visible_ways.collect { |w| [w.id,w.version] }
       }.uniq
       ways.delete([])
 
@@ -202,6 +209,9 @@ class AmfController < ApplicationController
     end
 
     [0,ways, points, relations]
+
+  rescue Exception => err
+    [-2,"Sorry - I can't get the map for that area."]
   end
 
   # Find deleted ways in current bounding box (similar to whichways, but ways
@@ -313,18 +323,16 @@ class AmfController < ApplicationController
   # an array of previous versions.
 
   def getnode_history(nodeid) #:doc:
-    begin
-         history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
-        user_object = old_node.changeset.user
-        user = user_object.data_public? ? user_object.display_name : 'anonymous'
-        uid  = user_object.data_public? ? user_object.id : 0
-        [old_node.version, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
-      end
-
-      return ['node',nodeid,history]
-    rescue ActiveRecord::RecordNotFound
-      return ['node', nodeid, []]
+    history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
+      user_object = old_node.changeset.user
+      user = user_object.data_public? ? user_object.display_name : 'anonymous'
+      uid  = user_object.data_public? ? user_object.id : 0
+      [old_node.version, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
     end
+    
+    return ['node',nodeid,history]
+  rescue ActiveRecord::RecordNotFound
+    return ['node', nodeid, []]
   end
 
   # Find GPS traces with specified name/id.
@@ -392,20 +400,19 @@ class AmfController < ApplicationController
   # 1. original relation id (unchanged),
   # 2. new relation id.
 
-  def putrelation(renumberednodes, renumberedways, usertoken, changeset, relid, tags, members, visible) #:doc:
-    uid = getuserid(usertoken)
-    if !uid then return -1,"You are not logged in, so the relation could not be saved." end
+  def putrelation(renumberednodes, renumberedways, usertoken, changeset, version, relid, tags, members, visible) #:doc:
+    user = getuserid(usertoken)
+    if !user then return -1,"You are not logged in, so the relation could not be saved." end
 
     relid = relid.to_i
     visible = (visible.to_i != 0)
 
     # create a new relation, or find the existing one
-    if relid <= 0
-      rel = Relation.new
-      rel.version = 0
-    else
-      rel = Relation.find(relid)
+    if relid > 0
+      relation = Relation.find(relid)
     end
+    # We always need a new node, based on the data that has been sent to us
+    new_relation = Relation.new
 
     # check the members are all positive, and correctly type
     typedmembers = []
@@ -421,22 +428,41 @@ class AmfController < ApplicationController
     end
 
     # assign new contents
-    rel.members = typedmembers
-    rel.tags = tags
-    rel.visible = visible
-    rel.changeset_id = changeset
-
-    # check it then save it
-    # BUG: the following is commented out because it always fails on my
-    #  install. I think it's a Rails bug.
-
-    #if !rel.preconditions_ok?
-    #  return -2, "Relation preconditions failed"
-    #else
-    rel.save_with_history!
-    #end
-
-    [0, relid, rel.id]
+    new_relation.members = typedmembers
+    new_relation.tags = tags
+    new_relation.visible = visible
+    new_relation.changeset_id = changeset
+    new_relation.version = version
+
+
+    if id <= 0
+      # We're creating the node
+      new_relation.create_with_history(user)
+    elsif visible
+      # We're updating the node
+      relation.update_from(new_relation, user)
+    else
+      # We're deleting the node
+      relation.delete_with_history!(new_relation, user)
+    end
+      
+    if id <= 0
+      return [0, relid, new_relation.id, new_relation.version]
+    else
+      return [0, relid, relation.id, relation.version]
+    end
+  rescue OSM::APIChangesetAlreadyClosedError => ex
+    return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
+  rescue OSM::APIVersionMismatchError => ex
+    # Really need to check to see whether this is a server load issue, and the 
+    # last version was in the same changeset, or belongs to the same user, then
+    # we can return something different
+    return [-3, "You have taken too long to edit, please reload the area"]
+  rescue OSM::APIAlreadyDeletedError => ex
+    return [-1, "The object has already been deleted"]
+  rescue OSM::APIError => ex
+    # Some error that we don't specifically catch
+    return [-2, "Something really bad happened :-()"]
   end
 
   # Save a way to the database, including all nodes. Any nodes in the previous
@@ -453,8 +479,8 @@ class AmfController < ApplicationController
 
     # -- Initialise and carry out checks
        
-    uid = getuserid(usertoken)
-    if !uid then return -1,"You are not logged in, so the way could not be saved." end
+    user = getuser(usertoken)
+    if !user then return -1,"You are not logged in, so the way could not be saved." end
 
     originalway = originalway.to_i
 
@@ -467,14 +493,13 @@ class AmfController < ApplicationController
 
     # -- Get unique nodes
 
-    if originalway < 0
-      way = Way.new
-      way.version = 0  # otherwise +=1 breaks
+    if originalway <= 0
       uniques = []
     else
       way = Way.find(originalway)
       uniques = way.unshared_node_ids
     end
+    new_way = Way.new
 
     # -- Compare nodes and save changes to any that have changed
 
@@ -484,16 +509,20 @@ class AmfController < ApplicationController
       lon = n[0].to_f
       lat = n[1].to_f
       id = n[2].to_i
+      version = n[3].to_i # FIXME which index does the version come in on????
       savenode = false
+      # We always need a new node if we are saving it
+      new_node = Node.new
+
 
       if renumberednodes[id]
         id = renumberednodes[id]
-      elsif id < 0
+      end
+      if id <= 0
         # Create new node
-        node = Node.new
-        node.version = 0       # otherwise +=1 breaks
         savenode = true
       else
+        # Don't modify this node, make any changes you want to the new_node above
         node = Node.find(id)
         nodetags=node.tags
         nodetags.delete('created_by')
@@ -504,12 +533,19 @@ class AmfController < ApplicationController
       end
 
       if savenode
-        node.changeset_id = changeset
-        node.lat = lat
-        node.lon = lon
-        node.tags = n[4]
-        node.visible = true
-        node.save_with_history!
+        new_node.changeset_id = changeset
+        new_node.lat = lat
+        new_node.lon = lon
+        new_node.tags = n[4]
+        new_node.visible = true
+        new_node.version = version
+        if id <= 0
+          # We're creating the node
+          new_node.create_with_history(user)
+        else
+          # We're updating the node (no delete here)
+          node.update_from(new_node, user)
+        end
 
         if id != node.id
           renumberednodes[id] = node.id
@@ -527,35 +563,49 @@ class AmfController < ApplicationController
       deleteitemrelations(n, 'node')
 
       node = Node.find(n)
-      node.changeset_id = changeset
-      node.visible = false
-      node.save_with_history!
+      new_node = Node.new
+      new_node.changeset_id = changeset
+      new_node.version = version
+      node.delete_with_history!(new_node, user)
     end
 
     # -- Save revised way
 
     if way.tags!=attributes or way.nds!=nodes or !way.visible?
-      way.tags = attributes
-      way.nds = nodes
-      way.changeset_id = changeset
-      way.visible = true
-      way.save_with_history!
+      new_way = Way.new
+      new_way.tags = attributes
+      new_way.nds = nodes
+      new_way.changeset_id = changeset
+      new_way.version = version
+      way.update_from(new_way, user)
     end
 
     [0, originalway, way.id, renumberednodes, way.version]
+  rescue OSM::APIChangesetAlreadyClosedError => ex
+    return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
+  rescue OSM::APIVersionMismatchError => ex
+    # Really need to check to see whether this is a server load issue, and the 
+    # last version was in the same changeset, or belongs to the same user, then
+    # we can return something different
+    return [-3, "You have taken too long to edit, please reload the area"]
+  rescue OSM::APIAlreadyDeletedError => ex
+    return [-1, "The object has already been deleted"]
+  rescue OSM::APIError => ex
+    # Some error that we don't specifically catch
+    return [-2, "Something really bad happened :-()"]
   end
 
   # Save POI to the database.
   # Refuses save if the node has since become part of a way.
-  # Returns:
+  # Returns array with:
   # 0. 0 (success),
   # 1. original node id (unchanged),
   # 2. new node id,
   # 3. version.
 
-  def putpoi(usertoken, changeset, id, lon, lat, tags, visible) #:doc:
-    uid = getuserid(usertoken)
-    if !uid then return -1,"You are not logged in, so the point could not be saved." end
+  def putpoi(usertoken, changeset, version, id, lon, lat, tags, visible) #:doc:
+    user = getuser(usertoken)
+    if !user then return -1,"You are not logged in, so the point could not be saved." end
 
     id = id.to_i
     visible = (visible.to_i == 1)
@@ -567,19 +617,45 @@ class AmfController < ApplicationController
         unless node.ways.empty? then return -1,"The point has since become part of a way, so you cannot save it as a POI." end
         deleteitemrelations(id, 'node')
       end
+    end
+    # We always need a new node, based on the data that has been sent to us
+    new_node = Node.new
+
+    new_node.id = id
+    new_node.changeset_id = changeset
+    new_node.version = version
+    new_node.lat = lat
+    new_node.lon = lon
+    new_node.tags = tags
+    new_node.visible = visible
+    if id <= 0 
+      # We're creating the node
+      new_node.create_with_history(user)
+    elsif visible
+      # We're updating the node
+      node.update_from(new_node, user)
     else
-      node = Node.new
-      node.version = 0
+      # We're deleting the node
+      node.delete_with_history!(new_node, user)
     end
 
-    node.changeset_id = changeset
-    node.lat = lat
-    node.lon = lon
-    node.tags = tags
-    node.visible = visible
-    node.save_with_history!
-
-    [0, id, node.id, node.version]
+    if id <= 0
+      return [0, id, new_node.id, new_node.version]
+    else
+      return [0, id, node.id, node.version]
+    end
+  rescue OSM::APIChangesetAlreadyClosedError => ex
+    return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
+  rescue OSM::APIVersionMismatchError => ex
+        # Really need to check to see whether this is a server load issue, and the 
+    # last version was in the same changeset, or belongs to the same user, then
+    # we can return something different
+    return [-3, "You have taken too long to edit, please reload the area"]
+  rescue OSM::APIAlreadyDeletedError => ex
+    return [-1, "The object has already been deleted"]
+  rescue OSM::APIError => ex
+    # Some error that we don't specifically catch
+    return [-2, "Something really bad happened :-()"]
   end
 
   # Read POI from database
@@ -604,21 +680,23 @@ class AmfController < ApplicationController
   # Delete way and all constituent nodes. Also removes from any relations.
   # Returns 0 (success), unchanged way id.
 
-  def deleteway(usertoken, changeset_id, way_id) #:doc:
-    if !getuserid(usertoken) then return -1,"You are not logged in, so the way could not be deleted." end
-
-    way_id = way_id.to_i
+  def deleteway(usertoken, changeset_id, way_id, version_id) #:doc:
+    user = getuser(usertoken)
+    if user then return -1,"You are not logged in, so the way could not be deleted." end
+    # Need a transaction so that if one item fails to delete, the whole delete fails.
+    Way.transaction do
+      way_id = way_id.to_i
+
+      # FIXME: would be good not to make two history entries when removing
+      #                 two nodes from the same relation
+      old_way = Way.find(way_id)
+      old_way.unshared_node_ids.each do |n|
+        deleteitemrelations(n, 'node')
+      end
+      deleteitemrelations(way_id, 'way')
 
-    # FIXME: would be good not to make two history entries when removing
-    #           two nodes from the same relation
-    way = Way.find(way_id)
-    way.unshared_node_ids.each do |n|
-      deleteitemrelations(n, 'node')
+      way.delete_with_relations_and_nodes_and_history(changeset_id.to_i)
     end
-    deleteitemrelations(way_id, 'way')
-
-    way.delete_with_relations_and_nodes_and_history(changeset_id.to_i)
-
     [0, way_id]
   end
 
@@ -627,7 +705,7 @@ class AmfController < ApplicationController
   # Support functions
 
   # Remove a node or way from all relations
-
+  # FIXME needs version, changeset, and user
   def deleteitemrelations(objid, type) #:doc:
     relations = RelationMember.find(:all, 
                                                                        :conditions => ['member_type = ? and member_id = ?', type, objid], 
@@ -635,7 +713,12 @@ class AmfController < ApplicationController
 
     relations.each do |rel|
       rel.members.delete_if { |x| x[0] == type and x[1] == objid }
-      rel.save_with_history!
+      # FIXME need to create the new node/way based on the type.
+      new_rel = Relation.new
+      new_rel.version = version
+      new_rel.members = members
+      new_rel.changeset = changeset
+      rel.delete_with_history(new_rel, user)
     end
   end
 
@@ -652,14 +735,20 @@ class AmfController < ApplicationController
 
   # Authenticate token
   # (can also be of form user:pass)
+  # When we are writing to the api, we need the actual user model, 
+  # not just the id, hence this abstraction
 
-  def getuserid(token) #:doc:
+  def getuser(token) #:doc:
     if (token =~ /^(.+)\:(.+)$/) then
       user = User.authenticate(:username => $1, :password => $2)
     else
       user = User.authenticate(:token => token)
     end
-
+    return user
+  end
+  
+  def getuserid(token)
+    user = getuser(token)
     return user ? user.id : nil;
   end