X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/ecefee485b8dc033d020bd6b67d9ae4559ec796a..97769170fde23c0bd113cff47cbd2977c727d180:/app/controllers/amf_controller.rb diff --git a/app/controllers/amf_controller.rb b/app/controllers/amf_controller.rb index 43bec41a1..18ecb1323 100644 --- a/app/controllers/amf_controller.rb +++ b/app/controllers/amf_controller.rb @@ -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. @@ -24,10 +24,16 @@ # == Debugging # # Any method that returns a status code (0 for ok) can also send: -# return(-1,"message") <-- just puts up a dialogue -# return(-2,"message") <-- also asks the user to e-mail me +# return(-1,"message") <-- just puts up a dialogue +# return(-2,"message") <-- also asks the user to e-mail me +# return(-3,["type",v],id) <-- version conflict +# return(-4,"type",id) <-- object not found +# -5 indicates the method wasn't called (due to a previous error) # -# To write to the Rails log, use RAILS_DEFAULT_LOGGER.info("message"). +# To write to the Rails log, use logger.info("message"). + +# Remaining issues: +# * version conflict when POIs and ways are reverted class AmfController < ApplicationController require 'stringio' @@ -38,106 +44,126 @@ class AmfController < ApplicationController include MapBoundary session :off - before_filter :check_write_availability + before_filter :check_api_writable + around_filter :api_call_timeout, :only => [:amf_read] # Main AMF handlers: process the raw AMF string (using AMF library) and # calls each action (private method) accordingly. # ** FIXME: refactor to reduce duplication of code across read/write def amf_read - req=StringIO.new(request.raw_post+0.chr)# Get POST data as request - # (cf http://www.ruby-forum.com/topic/122163) - req.read(2) # Skip version indicator and client ID - results={} # Results of each body + if request.post? + req=StringIO.new(request.raw_post+0.chr)# Get POST data as request + # (cf http://www.ruby-forum.com/topic/122163) + req.read(2) # Skip version indicator and client ID + results={} # Results of each body - # Parse request + # Parse request - headers=AMF.getint(req) # Read number of headers + headers=AMF.getint(req) # Read number of headers - headers.times do # Read each header - name=AMF.getstring(req) # | - req.getc # | skip boolean - value=AMF.getvalue(req) # | - header["name"]=value # | - end + headers.times do # Read each header + name=AMF.getstring(req) # | + req.getc # | skip boolean + value=AMF.getvalue(req) # | + header["name"]=value # | + end - bodies=AMF.getint(req) # Read number of bodies - bodies.times do # Read each body - message=AMF.getstring(req) # | get message name - index=AMF.getstring(req) # | get index in response sequence - bytes=AMF.getlong(req) # | get total size in bytes - args=AMF.getvalue(req) # | get response (probably an array) - logger.info "Executing AMF #{message}:#{index}" - - case message - when 'getpresets'; results[index]=AMF.putdata(index,getpresets()) - when 'whichways'; results[index]=AMF.putdata(index,whichways(*args)) - when 'whichways_deleted'; results[index]=AMF.putdata(index,whichways_deleted(*args)) - when 'getway'; results[index]=AMF.putdata(index,getway(args[0].to_i)) - when 'getrelation'; results[index]=AMF.putdata(index,getrelation(args[0].to_i)) - when 'getway_old'; results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1].to_i)) - when 'getway_history'; results[index]=AMF.putdata(index,getway_history(args[0].to_i)) - when 'getnode_history'; results[index]=AMF.putdata(index,getnode_history(args[0].to_i)) - when 'findgpx'; results[index]=AMF.putdata(index,findgpx(*args)) - when 'findrelations'; results[index]=AMF.putdata(index,findrelations(*args)) - when 'getpoi'; results[index]=AMF.putdata(index,getpoi(*args)) + bodies=AMF.getint(req) # Read number of bodies + bodies.times do # Read each body + message=AMF.getstring(req) # | get message name + index=AMF.getstring(req) # | get index in response sequence + bytes=AMF.getlong(req) # | get total size in bytes + args=AMF.getvalue(req) # | get response (probably an array) + logger.info("Executing AMF #{message}(#{args.join(',')}):#{index}") + + case message + when 'getpresets'; results[index]=AMF.putdata(index,getpresets(args[0])) + when 'whichways'; results[index]=AMF.putdata(index,whichways(*args)) + when 'whichways_deleted'; results[index]=AMF.putdata(index,whichways_deleted(*args)) + when 'getway'; results[index]=AMF.putdata(index,getway(args[0].to_i)) + when 'getrelation'; results[index]=AMF.putdata(index,getrelation(args[0].to_i)) + when 'getway_old'; results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1])) + when 'getway_history'; results[index]=AMF.putdata(index,getway_history(args[0].to_i)) + when 'getnode_history'; results[index]=AMF.putdata(index,getnode_history(args[0].to_i)) + when 'findgpx'; results[index]=AMF.putdata(index,findgpx(*args)) + when 'findrelations'; results[index]=AMF.putdata(index,findrelations(*args)) + when 'getpoi'; results[index]=AMF.putdata(index,getpoi(*args)) + end end + logger.info("Encoding AMF results") + sendresponse(results) + else + render :nothing => true, :status => :method_not_allowed end - logger.info("encoding AMF results") - sendresponse(results) end def amf_write - req=StringIO.new(request.raw_post+0.chr) - req.read(2) - results={} - renumberednodes={} # Shared across repeated putways - renumberedways={} # Shared across repeated putways - - headers=AMF.getint(req) # Read number of headers - headers.times do # Read each header - name=AMF.getstring(req) # | - req.getc # | skip boolean - value=AMF.getvalue(req) # | - header["name"]=value # | - end + if request.post? + req=StringIO.new(request.raw_post+0.chr) + req.read(2) + results={} + renumberednodes={} # Shared across repeated putways + renumberedways={} # Shared across repeated putways + + headers=AMF.getint(req) # Read number of headers + headers.times do # Read each header + name=AMF.getstring(req) # | + req.getc # | skip boolean + value=AMF.getvalue(req) # | + header["name"]=value # | + end - bodies=AMF.getint(req) # Read number of bodies - bodies.times do # Read each body - message=AMF.getstring(req) # | get message name - index=AMF.getstring(req) # | get index in response sequence - bytes=AMF.getlong(req) # | get total size in bytes - args=AMF.getvalue(req) # | get response (probably an array) - - case message - when 'putway'; r=putway(renumberednodes,*args) - renumberednodes=r[3] - if r[1] != r[2] then renumberedways[r[1]] = r[2] end - results[index]=AMF.putdata(index,r) - when 'putrelation'; results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args)) - when 'deleteway'; results[index]=AMF.putdata(index,deleteway(*args)) - when 'putpoi'; r=putpoi(*args) - if r[1] != r[2] then renumberednodes[r[1]] = r[2] end - results[index]=AMF.putdata(index,r) - when 'startchangeset'; results[index]=AMF.putdata(index,startchangeset(*args)) + bodies=AMF.getint(req) # Read number of bodies + bodies.times do # Read each body + message=AMF.getstring(req) # | get message name + index=AMF.getstring(req) # | get index in response sequence + bytes=AMF.getlong(req) # | get total size in bytes + args=AMF.getvalue(req) # | get response (probably an array) + err=false # Abort batch on error + + logger.info("Executing AMF #{message}:#{index}") + if err + results[index]=[-5,nil] + else + case message + when 'putway'; r=putway(renumberednodes,*args) + renumberednodes=r[4] + if r[2] != r[3] then renumberedways[r[2]] = r[3] end + results[index]=AMF.putdata(index,r) + when 'putrelation'; results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args)) + when 'deleteway'; results[index]=AMF.putdata(index,deleteway(*args)) + when 'putpoi'; r=putpoi(*args) + if r[2] != r[3] then renumberednodes[r[2]] = r[3] end + results[index]=AMF.putdata(index,r) + when 'startchangeset';results[index]=AMF.putdata(index,startchangeset(*args)) + end + if results[index][0]==-3 then err=true end # If a conflict is detected, don't execute any more writes + end end + logger.info("Encoding AMF results") + sendresponse(results) + else + render :nothing => true, :status => :method_not_allowed end - sendresponse(results) end private # Start new changeset + # Returns success_code,success_message,changeset id - 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 + def startchangeset(usertoken, cstags, closeid, closecomment, opennew) + user = getuser(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 cs = Changeset.find(closeid) cs.set_closed_time_now - if closecomment.empty? + if cs.user_id!=user.id + return -2,"You cannot close that changeset because you're not the person who opened it.",nil + elsif closecomment.empty? cs.save! else cs.tags['comment']=closecomment @@ -146,38 +172,62 @@ class AmfController < ApplicationController end # open a new changeset - cs = Changeset.new - cs.tags = cstags - cs.user_id = uid - # Don't like the next two lines. These need to be abstracted to the model more/better - cs.created_at = Time.now - cs.closed_at = Time.new + Changeset::IDLE_TIMEOUT - cs.save_with_tags! - return [0,cs.id] + if opennew!=0 + cs = Changeset.new + cs.tags = cstags + cs.user_id = user.id + # smsm1 doesn't like the next two lines and thinks they need to be abstracted to the model more/better + cs.created_at = Time.now.getutc + cs.closed_at = cs.created_at + Changeset::IDLE_TIMEOUT + cs.save_with_tags! + return [0,'',cs.id] + else + return [0,'',nil] + end end # Return presets (default tags, localisation etc.): # uses POTLATCH_PRESETS global, set up in OSM::Potlatch. - def getpresets() #:doc: - return POTLATCH_PRESETS + def getpresets(lang) #:doc: + lang.gsub!(/[^\w\-]/,'') + + begin + localised = YAML::load(File.open("#{RAILS_ROOT}/config/potlatch/localised/#{lang}/localised.yaml")) + rescue + localised = "" # guess we'll just have to use the hardcoded English text instead + end + + begin + help = File.read("#{RAILS_ROOT}/config/potlatch/localised/#{lang}/help.html") + rescue + help = File.read("#{RAILS_ROOT}/config/potlatch/localised/en/help.html") + end + return POTLATCH_PRESETS+[localised,help] 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: + # [success_code, success_message, + # [[way_id, way_version], ...], + # [[node_id, lat, lon, [tags, ...], node_version], ...], + # [[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 - + enlarge = [(xmax-xmin)/8,0.01].min + xmin -= enlarge; ymin -= enlarge + xmax += enlarge; ymax += enlarge + # 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,14 +236,15 @@ 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([]) # find the node ids in an area that aren't part of ways nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? } - points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags] } + points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags, n.version] }.uniq # find the relations used by those nodes and ways relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) + @@ -201,28 +252,34 @@ class AmfController < ApplicationController relations = relations.collect { |relation| [relation.id,relation.version] }.uniq end - [0,ways, points, relations] + [0, '', ways, points, relations] + + rescue OSM::APITimeoutError => err + [-1,"Sorry, I can't get the map for that area - try zooming in further. The server said: #{err}"] + rescue Exception => err + [-2,"Sorry - I can't get the map for that area. The server said: #{err}",[],[],[] ] end # Find deleted ways in current bounding box (similar to whichways, but ways # with a deleted node only - not POIs or relations). def whichways_deleted(xmin, ymin, xmax, ymax) #:doc: - xmin -= 0.01; ymin -= 0.01 - xmax += 0.01; ymax += 0.01 + enlarge = [(xmax-xmin)/8,0.01].min + xmin -= enlarge; ymin -= enlarge + xmax += enlarge; ymax += enlarge # 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."] + return [-2,"Sorry - I can't get the map for that area. The server said: #{err}",[]] end nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history) way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq - [0,way_ids] + [0,'',way_ids] end # Get a way including nodes and tags. @@ -230,34 +287,34 @@ class AmfController < ApplicationController def getway(wayid) #:doc: if POTLATCH_USE_SQL then - points = sql_get_nodes_in_way(wayid) - tags = sql_get_tags_in_way(wayid) - version = sql_get_way_version(wayid) + points = sql_get_nodes_in_way(wayid) + tags = sql_get_tags_in_way(wayid) + version = sql_get_way_version(wayid) else # Ideally we would do ":include => :nodes" here but if we do that # then rails only seems to return the first copy of a node when a # way includes a node more than once begin - way = Way.find(wayid) + way = Way.find(wayid, :include => { :nodes => :node_tags }) rescue ActiveRecord::RecordNotFound - return [wayid,[],{}] + return [-4, 'way', wayid, [], {}, nil] end # check case where way has been deleted or doesn't exist - return [wayid,[],{}] if way.nil? or !way.visible + return [-4, 'way', wayid, [], {}, nil] if way.nil? or !way.visible points = way.nodes.collect do |node| nodetags=node.tags nodetags.delete('created_by') - [node.lon, node.lat, node.id, nodetags] + [node.lon, node.lat, node.id, nodetags, node.version] end tags = way.tags version = way.version end - [wayid, points, tags, version] + [0, '', wayid, points, tags, version] end - + # Get an old version of a way, and all constituent nodes. # # For undelete (version<0), always uses the most recent version of each node, @@ -272,80 +329,121 @@ class AmfController < ApplicationController # 3. hash of tags, # 4. version, # 5. is this the current, visible version? (boolean) - - def getway_old(id, version) #:doc: - if version < 0 + + def getway_old(id, timestamp) #:doc: + if timestamp == '' + # undelete old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC') points = old_way.get_nodes_undelete unless old_way.nil? else - old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version]) - points = old_way.get_nodes_revert unless old_way.nil? + begin + # revert + timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S") + old_way = OldWay.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC') + unless old_way.nil? + points = old_way.get_nodes_revert(timestamp) + if !old_way.visible + return [-1, "Sorry, the way was deleted at that time - please revert to a previous version.", id, [], {}, nil, false] + end + end + rescue ArgumentError + # thrown by date parsing method. leave old_way as nil for + # the error handler below. + end end if old_way.nil? - return [-1, id, [], {}, -1,0] + return [-1, "Sorry, the server could not find a way at that time.", id, [], {}, nil, false] else curway=Way.find(id) old_way.tags['history'] = "Retrieved from v#{old_way.version}" - return [0, id, points, old_way.tags, old_way.version, (curway.version==old_way.version and curway.visible)] + return [0, '', id, points, old_way.tags, curway.version, (curway.version==old_way.version and curway.visible)] end end - # Find history of a way. Returns 'way', id, and - # an array of previous versions. + # Find history of a way. + # Returns 'way', id, and an array of previous versions: + # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid] + # - now [timestamp,user,uid] + # + # Heuristic: Find all nodes that have ever been part of the way; + # get a list of their revision dates; add revision dates of the way; + # sort and collapse list (to within 2 seconds); trim all dates before the + # start date of the way. def getway_history(wayid) #:doc: + begin - history = Way.find(wayid).old_ways.reverse.collect do |old_way| - user_object = old_way.changeset.user - user = user_object.data_public? ? user_object.display_name : 'anonymous' - uid = user_object.data_public? ? user_object.id : 0 - [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid] + # Find list of revision dates for way and all constituent nodes + revdates=[] + revusers={} + Way.find(wayid).old_ways.collect do |a| + revdates.push(a.timestamp) + unless revusers.has_key?(a.timestamp.to_i) then revusers[a.timestamp.to_i]=change_user(a) end + a.nds.each do |n| + Node.find(n).old_nodes.collect do |o| + revdates.push(o.timestamp) + unless revusers.has_key?(o.timestamp.to_i) then revusers[o.timestamp.to_i]=change_user(o) end + end + end end - - return ['way',wayid,history] + waycreated=revdates[0] + revdates.uniq! + revdates.sort! + revdates.reverse! + + # Remove any dates (from nodes) before first revision date of way + revdates.delete_if { |d| d0 then - gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,uid] ) + gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,user.id] ) if gpx then gpxs.push([gpx.id, gpx.name, gpx.description]) end else - Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,uid,searchterm] ).each do |gpx| + Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,user.id,searchterm] ).each do |gpx| gpxs.push([gpx.id, gpx.name, gpx.description]) end end - gpxs + [0,'',gpxs] end # Get a relation with all tags and members. @@ -359,11 +457,11 @@ class AmfController < ApplicationController begin rel = Relation.find(relid) rescue ActiveRecord::RecordNotFound - return [relid, {}, []] + return [-4, 'relation', relid, {}, [], nil] end - return [relid, {}, [], nil] if rel.nil? or !rel.visible - [relid, rel.tags, rel.members, rel.version] + return [-4, 'relation', relid, {}, [], nil] if rel.nil? or !rel.visible + [0, '', relid, rel.tags, rel.members, rel.version] end # Find relations with specified name/id. @@ -374,12 +472,12 @@ class AmfController < ApplicationController if searchterm.to_i>0 then rel = Relation.find(searchterm.to_i) if rel and rel.visible then - rels.push([rel.id, rel.tags, rel.members]) + rels.push([rel.id, rel.tags, rel.members, rel.version]) end else RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t| if t.relation.visible then - rels.push([t.relation.id, t.relation.tags, t.relation.members]) + rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version]) end end end @@ -390,283 +488,363 @@ class AmfController < ApplicationController # Returns # 0. 0 (success), # 1. original relation id (unchanged), - # 2. new relation id. + # 2. new relation id, + # 3. version. - 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_id, version, relid, tags, members, visible) #:doc: + user = getuser(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) - end - - # check the members are all positive, and correctly type - typedmembers = [] - members.each do |m| - mid = m[1].to_i - if mid < 0 - mid = renumberednodes[mid] if m[0] == 'node' - mid = renumberedways[mid] if m[0] == 'way' + new_relation = nil + relation = nil + Relation.transaction do + # create a new relation, or find the existing one + if relid > 0 + relation = Relation.find(relid) end - if mid - typedmembers << [m[0], mid, m[2]] + # 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 = [] + members.each do |m| + mid = m[1].to_i + if mid < 0 + mid = renumberednodes[mid] if m[0] == 'Node' + mid = renumberedways[mid] if m[0] == 'Way' + end + if mid + typedmembers << [m[0], mid, m[2]] + end end - 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] + # assign new contents + new_relation.members = typedmembers + new_relation.tags = tags + new_relation.visible = visible + new_relation.changeset_id = changeset_id + new_relation.version = version + + if relid <= 0 + # We're creating the relation + new_relation.create_with_history(user) + elsif visible + # We're updating the relation + new_relation.id = relid + relation.update_from(new_relation, user) + else + # We're deleting the relation + new_relation.id = relid + relation.delete_with_history!(new_relation, user) + end + end # transaction + + if relid <= 0 + return [0, '', relid, new_relation.id, new_relation.version] + else + return [0, '', relid, relid, relation.version] + end + rescue OSM::APIChangesetAlreadyClosedError => ex + return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}.", relid, relid, nil] + rescue OSM::APIVersionMismatchError => ex + a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/) + return [-3, ['relation', a[1]], relid, relid, nil] + rescue OSM::APIAlreadyDeletedError => ex + return [-1, "The relation has already been deleted.", relid, relid, nil] + rescue OSM::APIError => ex + # Some error that we don't specifically catch + return [-2, "An unusual error happened (in 'putrelation' #{relid}). The server said: #{ex}", relid, relid, nil] end # Save a way to the database, including all nodes. Any nodes in the previous # version and no longer used are deleted. # + # Parameters: + # 0. hash of renumbered nodes (added by amf_controller) + # 1. current user token (for authentication) + # 2. current changeset + # 3. new way version + # 4. way ID + # 5. list of nodes in way + # 6. hash of way tags + # 7. array of nodes to change (each one is [lon,lat,id,version,tags]), + # 8. hash of nodes to delete (id->version). + # # Returns: # 0. '0' (code for success), # 1. original way id (unchanged), # 2. new way id, # 3. hash of renumbered nodes (old id=>new id), - # 4. version + # 4. way version, + # 5. hash of node versions (node=>version) - def putway(renumberednodes, usertoken, changeset, originalway, points, attributes) #:doc: + def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc: - # -- Initialise and carry out checks + # -- Initialise - 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 + if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end originalway = originalway.to_i +logger.info("received #{pointlist} for #{originalway}") + pointlist.collect! {|a| a.to_i } +logger.info("converted to #{pointlist}") - points.each do |a| - if a[2] == 0 or a[2].nil? then return -2,"Server error - node with id 0 found in way #{originalway}." end - if a[1] == 90 then return -2,"Server error - node with lat -90 found in way #{originalway}." end - end - - if points.length < 2 then return -2,"Server error - way is only #{points.length} points long." end - - # -- Get unique nodes - - if originalway < 0 - way = Way.new - way.version = 0 # otherwise +=1 breaks - uniques = [] - else - way = Way.find(originalway) - uniques = way.unshared_node_ids - end - - # -- Compare nodes and save changes to any that have changed + way=nil # this is returned, so scope it outside the transaction + nodeversions = {} + Way.transaction do - nodes = [] + # -- Update each changed node - points.each do |n| - lon = n[0].to_f - lat = n[1].to_f - id = n[2].to_i - savenode = false + nodes.each do |a| + lon = a[0].to_f + lat = a[1].to_f + id = a[2].to_i + version = a[3].to_i + if id == 0 then return -2,"Server error - node with id 0 found in way #{originalway}." end + if lat== 90 then return -2,"Server error - node with latitude -90 found in way #{originalway}." end + if renumberednodes[id] then id = renumberednodes[id] end - if renumberednodes[id] - id = renumberednodes[id] - elsif id < 0 - # Create new node node = Node.new - node.version = 0 # otherwise +=1 breaks - savenode = true - else - node = Node.find(id) - nodetags=node.tags - nodetags.delete('created_by') - if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or - n[4] != nodetags or !node.visible? - savenode = true - end - end - - if savenode - node.changeset_id = changeset + node.changeset_id = changeset_id node.lat = lat node.lon = lon - node.tags = n[4] - node.visible = true - node.save_with_history! - - if id != node.id + node.tags = a[4] + node.tags.delete('created_by') + node.version = version + if id <= 0 + # We're creating the node + node.create_with_history(user) renumberednodes[id] = node.id - id = node.id + nodeversions[node.id] = node.version + else + # We're updating an existing node + previous=Node.find(id) + node.id=id + previous.update_from(node, user) + nodeversions[previous.id] = previous.version end end - uniques = uniques - [id] - nodes.push(id) - end - - # -- Delete any unique nodes - - uniques.each do |n| - deleteitemrelations(n, 'node') - - node = Node.find(n) - node.changeset_id = changeset - node.visible = false - node.save_with_history! - end + # -- Save revised way + +logger.info("renumberednodes is #{renumberednodes.inspect}") + pointlist.collect! {|a| + renumberednodes[a] ? renumberednodes[a]:a + } # renumber nodes +logger.info("saving with #{pointlist}") + new_way = Way.new + new_way.tags = attributes + new_way.nds = pointlist + new_way.changeset_id = changeset_id + new_way.version = wayversion + if originalway <= 0 + new_way.create_with_history(user) + way=new_way # so we can get way.id and way.version + else + way = Way.find(originalway) + if way.tags!=attributes or way.nds!=pointlist or !way.visible? + new_way.id=originalway + way.update_from(new_way, user) + end + end - # -- Save revised way + # -- Delete unwanted nodes - 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! - end + deletednodes.each do |id,v| + node = Node.find(id.to_i) + new_node = Node.new + new_node.changeset_id = changeset_id + new_node.version = v.to_i + new_node.id = id.to_i + begin + node.delete_with_history!(new_node, user) + rescue OSM::APIPreconditionFailedError => ex + # We don't do anything here as the node is being used elsewhere + # and we don't want to delete it + end + end - [0, originalway, way.id, renumberednodes, way.version] + end # transaction + + [0, '', originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes] + rescue OSM::APIChangesetAlreadyClosedError => ex + return [-1, "Sorry, your changeset #{ex.changeset.id} was closed (at #{ex.changeset.closed_at}).", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes] + rescue OSM::APIVersionMismatchError => ex + a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/) + return [-3, ['way', a[1], a[2].downcase, a[3]], originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes] + rescue OSM::APITooManyWayNodesError => ex + return [-1, "You have tried to upload a really long way with #{ex.provided} points: only #{ex.max} are allowed.", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes] + rescue OSM::APIAlreadyDeletedError => ex + return [-1, "The point has already been deleted.", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes] + rescue OSM::APIError => ex + # Some error that we don't specifically catch + return [-2, "An unusual error happened (in 'putway' #{originalway}). The server said: #{ex}", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes] 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_id, 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) + node = nil + new_node = nil + Node.transaction do + if id > 0 then + node = Node.find(id) - if id > 0 then - node = Node.find(id) - - if !visible then - 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') + if !visible then + unless node.ways.empty? then return -1,"The point has since become part of a way, so you cannot save it as a POI.",id,id,version end + end + end + # We always need a new node, based on the data that has been sent to us + new_node = Node.new + + new_node.changeset_id = changeset_id + new_node.version = version + new_node.lat = lat + new_node.lon = lon + new_node.tags = tags + if id <= 0 + # We're creating the node + new_node.create_with_history(user) + elsif visible + # We're updating the node + new_node.id=id + node.update_from(new_node, user) + else + # We're deleting the node + new_node.id=id + node.delete_with_history!(new_node, user) end - else - node = Node.new - node.version = 0 - end - node.changeset_id = changeset - node.lat = lat - node.lon = lon - node.tags = tags - node.visible = visible - node.save_with_history! + end # transaction - [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}",id,id,version] + rescue OSM::APIVersionMismatchError => ex + a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/) + return [-3, ['node', a[1]], id,id,version] + rescue OSM::APIAlreadyDeletedError => ex + return [-1, "The point has already been deleted",id,id,version] + rescue OSM::APIError => ex + # Some error that we don't specifically catch + return [-2, "An unusual error happened (in 'putpoi' #{id}). The server said: #{ex}",id,id,version] end # Read POI from database # (only called on revert: POIs are usually read by whichways). # - # Returns array of id, long, lat, hash of tags, version. + # Returns array of id, long, lat, hash of tags, (current) version. - def getpoi(id,version) #:doc: - if version>0 then - n = OldNode.find(id, :conditions=>['version=?',version]) - else - n = Node.find(id) + def getpoi(id,timestamp) #:doc: + n = Node.find(id) + v = n.version + unless timestamp == '' + n = OldNode.find(id, :conditions=>['timestamp=?',DateTime.strptime(timestamp, "%d %b %Y, %H:%M:%S")]) end if n - return [n.id, n.lon, n.lat, n.tags, n.version] + return [0, '', n.id, n.lon, n.lat, n.tags, v] else - return [nil, nil, nil, {}, nil] + return [-4, 'node', id, nil, nil, {}, nil] end end - # 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 - + # Delete way and all constituent nodes. + # Params: + # * The user token + # * the changeset id + # * the id of the way to change + # * the version of the way that was downloaded + # * a hash of the id and versions of all the nodes that are in the way, if any + # of the nodes have been changed by someone else then, there is a problem! + # Returns 0 (success), unchanged way id, new way version, new node versions. + + def deleteway(usertoken, changeset_id, way_id, way_version, deletednodes) #:doc: + user = getuser(usertoken) + unless user then return -1,"You are not logged in, so the way could not be deleted." end + way_id = way_id.to_i + nodeversions = {} + old_way=nil # returned, so scope it outside the transaction + # Need a transaction so that if one item fails to delete, the whole delete fails. + Way.transaction do + + # -- Delete the way + + old_way = Way.find(way_id) + delete_way = Way.new + delete_way.version = way_version + delete_way.changeset_id = changeset_id + delete_way.id = way_id + old_way.delete_with_history!(delete_way, user) + + # -- Delete unwanted nodes + + deletednodes.each do |id,v| + node = Node.find(id.to_i) + new_node = Node.new + new_node.changeset_id = changeset_id + new_node.version = v.to_i + new_node.id = id.to_i + begin + node.delete_with_history!(new_node, user) + nodeversions[node.id]=node.version + rescue OSM::APIPreconditionFailedError => ex + # We don't do anything with the exception as the node is in use + # elsewhere and we don't want to delete it + end + end - # 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') - end - deleteitemrelations(way_id, 'way') - - way.delete_with_relations_and_nodes_and_history(changeset_id.to_i) - - [0, way_id] + end # transaction + [0, '', way_id, old_way.version, nodeversions] + rescue OSM::APIChangesetAlreadyClosedError => ex + return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}",way_id,way_version,nodeversions] + rescue OSM::APIVersionMismatchError => ex + a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/) + return [-3, ['way', a[1]],way_id,way_version,nodeversions] + rescue OSM::APIAlreadyDeletedError => ex + return [-1, "The way has already been deleted.",way_id,way_version,nodeversions] + rescue OSM::APIError => ex + # Some error that we don't specifically catch + return [-2, "An unusual error happened (in 'deleteway' #{way_id}). The server said: #{ex}",way_id,way_version,nodeversions] end # ==================================================================== # Support functions - # Remove a node or way from all relations - - def deleteitemrelations(objid, type) #:doc: - relations = RelationMember.find(:all, - :conditions => ['member_type = ? and member_id = ?', type, objid], - :include => :relation).collect { |rm| rm.relation }.uniq - - relations.each do |rel| - rel.members.delete_if { |x| x[0] == type and x[1] == objid } - rel.save_with_history! - end - end - - # Break out node tags into a hash - # (should become obsolete as of API 0.6) - - def tagstring_to_hash(a) #:doc: - tags={} - Tags.split(a) do |k, v| - tags[k]=v - end - tags - end - # 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 ? user.id : nil; - end - - # Compare two floating-point numbers to within 0.0000001 - - def fpcomp(a,b) #:doc: - return ((a/0.0000001).round==(b/0.0000001).round) + return user end # Send AMF response @@ -728,7 +906,7 @@ class AmfController < ApplicationController SELECT DISTINCT cr.id AS relid,cr.version AS version FROM current_relations cr INNER JOIN current_relation_members crm ON crm.id=cr.id - INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node' + INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='Node' WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")} EOF unless way_ids.empty? @@ -737,17 +915,17 @@ class AmfController < ApplicationController SELECT DISTINCT cr.id AS relid,cr.version AS version FROM current_relations cr INNER JOIN current_relation_members crm ON crm.id=cr.id - WHERE crm.member_type='way' + WHERE crm.member_type='Way' AND crm.member_id IN (#{way_ids.join(',')}) EOF end - return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] } + ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] } end def sql_get_nodes_in_way(wayid) points=[] sql=<<-EOF - SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id + SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,current_nodes.version FROM current_way_nodes,current_nodes WHERE current_way_nodes.id=#{wayid.to_i} AND current_way_nodes.node_id=current_nodes.id @@ -760,7 +938,7 @@ class AmfController < ApplicationController nodetags[n['k']]=n['v'] end nodetags.delete('created_by') - points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags] + points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags,row['version'].to_i] end points end