X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/95d899786a1bbabacc0cd12ef1c4814118d9d0de..34e3e51456774127d43408b7ab65c24f41373f62:/app/controllers/amf_controller.rb diff --git a/app/controllers/amf_controller.rb b/app/controllers/amf_controller.rb index 86e57a2d1..19b7d5de8 100644 --- a/app/controllers/amf_controller.rb +++ b/app/controllers/amf_controller.rb @@ -1,6 +1,6 @@ -# amf_controller is a semi-standalone API for Flash clients, particularly -# Potlatch. All interaction between Potlatch (as a .SWF application) and the -# OSM database takes place using this controller. Messages are +# amf_controller is a semi-standalone API for Flash clients, particularly +# Potlatch. All interaction between Potlatch (as a .SWF application) and the +# OSM database takes place using this controller. Messages are # encoded in the Actionscript Message Format (AMF). # # Helper functions are in /lib/potlatch.rb @@ -11,25 +11,25 @@ # == General structure # # Apart from the amf_read and amf_write methods (which distribute the requests -# from the AMF message), each method generally takes arguments in the order -# they were sent by the Potlatch SWF. Do not assume typing has been preserved. +# from the AMF message), each method generally takes arguments in the order +# they were sent by the Potlatch SWF. Do not assume typing has been preserved. # Methods all return an array to the SWF. # # == API 0.6 # # Note that this requires a patched version of composite_primary_keys 1.1.0 -# (see http://groups.google.com/group/compositekeys/t/a00e7562b677e193) +# (see http://groups.google.com/group/compositekeys/t/a00e7562b677e193) # if you are to run with POTLATCH_USE_SQL=false . -# +# # == 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(-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 logger.info("message"). # Remaining issues: @@ -43,68 +43,60 @@ class AmfController < ApplicationController # Main AMF handlers: process the raw AMF string (using AMF library) and # calls each action (private method) accordingly. - - def amf_read - if request.post? - self.status = :ok - self.content_type = Mime::AMF - self.response_body = Dispatcher.new(request.raw_post) do |message,*args| - logger.info("Executing AMF #{message}(#{args.join(',')})") - case message - when 'getpresets'; result = getpresets(*args) - when 'whichways'; result = whichways(*args) - when 'whichways_deleted'; result = whichways_deleted(*args) - when 'getway'; result = getway(args[0].to_i) - when 'getrelation'; result = getrelation(args[0].to_i) - when 'getway_old'; result = getway_old(args[0].to_i,args[1]) - when 'getway_history'; result = getway_history(args[0].to_i) - when 'getnode_history'; result = getnode_history(args[0].to_i) - when 'findgpx'; result = findgpx(*args) - when 'findrelations'; result = findrelations(*args) - when 'getpoi'; result = getpoi(*args) - end - - result + def amf_read + self.status = :ok + self.content_type = Mime::AMF + self.response_body = Dispatcher.new(request.raw_post) do |message,*args| + logger.info("Executing AMF #{message}(#{args.join(',')})") + + case message + when 'getpresets'; result = getpresets(*args) + when 'whichways'; result = whichways(*args) + when 'whichways_deleted'; result = whichways_deleted(*args) + when 'getway'; result = getway(args[0].to_i) + when 'getrelation'; result = getrelation(args[0].to_i) + when 'getway_old'; result = getway_old(args[0].to_i,args[1]) + when 'getway_history'; result = getway_history(args[0].to_i) + when 'getnode_history'; result = getnode_history(args[0].to_i) + when 'findgpx'; result = findgpx(*args) + when 'findrelations'; result = findrelations(*args) + when 'getpoi'; result = getpoi(*args) end - else - render :nothing => true, :status => :method_not_allowed + + result end end def amf_write - if request.post? - renumberednodes = {} # Shared across repeated putways - renumberedways = {} # Shared across repeated putways - err = false # Abort batch on error - - self.status = :ok - self.content_type = Mime::AMF - self.response_body = Dispatcher.new(request.raw_post) do |message,*args| - logger.info("Executing AMF #{message}") - - if err - result = [-5, nil] - else - case message - when 'putway'; orn = renumberednodes.dup - result = putway(renumberednodes, *args) - result[4] = renumberednodes.reject { |k,v| orn.has_key?(k) } - if result[0] == 0 and result[2] != result[3] then renumberedways[result[2]] = result[3] end - when 'putrelation'; result = putrelation(renumberednodes, renumberedways, *args) - when 'deleteway'; result = deleteway(*args) - when 'putpoi'; result = putpoi(*args) - if result[0] == 0 and result[2] != result[3] then renumberednodes[result[2]] = result[3] end - when 'startchangeset'; result = startchangeset(*args) - end + renumberednodes = {} # Shared across repeated putways + renumberedways = {} # Shared across repeated putways + err = false # Abort batch on error - err = true if result[0] == -3 # If a conflict is detected, don't execute any more writes + self.status = :ok + self.content_type = Mime::AMF + self.response_body = Dispatcher.new(request.raw_post) do |message,*args| + logger.info("Executing AMF #{message}") + + if err + result = [-5, nil] + else + case message + when 'putway'; orn = renumberednodes.dup + result = putway(renumberednodes, *args) + result[4] = renumberednodes.reject { |k,v| orn.has_key?(k) } + if result[0] == 0 and result[2] != result[3] then renumberedways[result[2]] = result[3] end + when 'putrelation'; result = putrelation(renumberednodes, renumberedways, *args) + when 'deleteway'; result = deleteway(*args) + when 'putpoi'; result = putpoi(*args) + if result[0] == 0 and result[2] != result[3] then renumberednodes[result[2]] = result[3] end + when 'startchangeset'; result = startchangeset(*args) end - result + err = true if result[0] == -3 # If a conflict is detected, don't execute any more writes end - else - render :nothing => true, :status => :method_not_allowed + + result end end @@ -128,7 +120,7 @@ class AmfController < ApplicationController def amf_handle_error_with_timeout(call,rootobj,rootid) amf_handle_error(call,rootobj,rootid) do - Timeout::timeout(API_TIMEOUT, OSM::APITimeoutError) do + OSM::Timer.timeout(API_TIMEOUT, OSM::APITimeoutError) do yield end end @@ -136,12 +128,12 @@ class AmfController < ApplicationController # Start new changeset # Returns success_code,success_message,changeset id - + def startchangeset(usertoken, cstags, closeid, closecomment, opennew) amf_handle_error("'startchangeset'",nil,nil) do user = getuser(usertoken) if !user then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end - unless user.active_blocks.empty? then return -1,t('application.setup_user_auth.blocked') end + if user.blocks.active.exists? then return -1,t('application.setup_user_auth.blocked') end if REQUIRE_TERMS_AGREED and user.terms_agreed.nil? then return -1,"You must accept the contributor terms before you can edit." end if cstags @@ -164,14 +156,14 @@ class AmfController < ApplicationController cs.save_with_tags! end end - + # open a new changeset if opennew!=0 cs = Changeset.new cs.tags = cstags cs.user_id = user.id - if !closecomment.empty? - cs.tags['comment']=closecomment + if !closecomment.empty? + cs.tags['comment']=closecomment # in case closecomment has chars not allowed in xml cs.tags = strip_non_xml_chars cs.tags end @@ -193,10 +185,10 @@ class AmfController < ApplicationController user = getuser(usertoken) if user && !user.languages.empty? - request.user_preferred_languages = user.languages + http_accept_language.user_preferred_languages = user.languages end - lang = request.compatible_language_from(getlocales) + lang = http_accept_language.compatible_language_from(getlocales) (real_lang, localised) = getlocalized(lang) # Tell Potlatch what language it's using @@ -242,10 +234,10 @@ class AmfController < ApplicationController ## # 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. + # in a given bounding box. Nodes are returned in full; ways and relations + # are IDs only. # - # return is of the form: + # return is of the form: # [success_code, success_message, # [[way_id, way_version], ...], # [[node_id, lat, lon, [tags, ...], node_version], ...], @@ -273,7 +265,7 @@ class AmfController < ApplicationController else # find the way ids in an area nodes_in_area = Node.bbox(bbox).visible.includes(:ways) - ways = nodes_in_area.inject([]) { |sum, node| + 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 @@ -329,12 +321,12 @@ class AmfController < ApplicationController # 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 - way = Way.where(:id => wayid).preload(:nodes => :node_tags).first + way = Way.where(:id => wayid).first # check case where way has been deleted or doesn't exist return [-4, 'way', wayid] if way.nil? or !way.visible - points = way.nodes.collect do |node| + points = way.nodes.preload(:node_tags).collect do |node| nodetags=node.tags nodetags.delete('created_by') [node.lon, node.lat, node.id, nodetags, node.version] @@ -347,33 +339,33 @@ class AmfController < ApplicationController [0, '', wayid, points, tags, version, uid] end 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, - # even if it's moved. For revert (version >= 0), uses the node in existence + # For undelete (version<0), always uses the most recent version of each node, + # even if it's moved. For revert (version >= 0), uses the node in existence # at the time, generating a new id if it's still visible and has been moved/ # retagged. # # Returns: - # 0. success code, - # 1. id, - # 2. array of points, - # 3. hash of tags, - # 4. version, + # 0. success code, + # 1. id, + # 2. array of points, + # 3. hash of tags, + # 4. version, # 5. is this the current, visible version? (boolean) - + def getway_old(id, timestamp) #:doc: amf_handle_error_with_timeout("'getway_old' #{id}, #{timestamp}", 'way',id) do if timestamp == '' # undelete - old_way = OldWay.where(:visible => true, :way_id => id).order("version DESC").first + old_way = OldWay.where(:visible => true, :way_id => id).unredacted.order("version DESC").first points = old_way.get_nodes_undelete unless old_way.nil? else begin # revert timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S") - old_way = OldWay.where("way_id = ? AND timestamp <= ?", id, timestamp).order("timestamp DESC").first + old_way = OldWay.where("way_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first unless old_way.nil? points = old_way.get_nodes_revert(timestamp) if !old_way.visible @@ -395,15 +387,15 @@ class AmfController < ApplicationController end end end - + # 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; + # 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 + # sort and collapse list (to within 2 seconds); trim all dates before the # start date of the way. def getway_history(wayid) #:doc: @@ -411,11 +403,11 @@ class AmfController < ApplicationController # Find list of revision dates for way and all constituent nodes revdates=[] revusers={} - Way.find(wayid).old_ways.collect do |a| + Way.find(wayid).old_ways.unredacted.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| + Node.find(n).old_nodes.unredacted.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 @@ -431,7 +423,7 @@ class AmfController < ApplicationController # Remove any elements where 2 seconds doesn't elapse before next one revdates.delete_if { |d| revdates.include?(d+1) or revdates.include?(d+2) } # Collect all in one nested array - revdates.collect! {|d| [d.succ.strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] } + revdates.collect! {|d| [(d + 1).strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] } revdates.uniq! return ['way', wayid, revdates] @@ -439,13 +431,13 @@ class AmfController < ApplicationController return ['way', wayid, []] end end - + # Find history of a node. Returns 'node', id, and an array of previous versions as above. def getnode_history(nodeid) #:doc: - begin - history = Node.find(nodeid).old_nodes.reverse.collect do |old_node| - [old_node.timestamp.succ.strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node) + begin + history = Node.find(nodeid).old_nodes.unredacted.reverse.collect do |old_node| + [(old_node.timestamp + 1).strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node) end return ['node', nodeid, history] rescue ActiveRecord::RecordNotFound @@ -462,12 +454,12 @@ class AmfController < ApplicationController # Find GPS traces with specified name/id. # Returns array listing GPXs, each one comprising id, name and description. - + def findgpx(searchterm, usertoken) amf_handle_error_with_timeout("'findgpx'" ,nil,nil) do user = getuser(usertoken) if !user then return -1,"You must be logged in to search for GPX traces." end - unless user.active_blocks.empty? then return -1,t('application.setup_user_auth.blocked') end + if user.blocks.active.exists? then return -1,t('application.setup_user_auth.blocked') end query = Trace.visible_to(user) if searchterm.to_i > 0 then @@ -490,7 +482,7 @@ class AmfController < ApplicationController # 3. hash of tags, # 4. list of members, # 5. version. - + def getrelation(relid) #:doc: amf_handle_error("'getrelation' #{relid}" ,'relation',relid) do rel = Relation.where(:id => relid).first @@ -502,7 +494,7 @@ class AmfController < ApplicationController # Find relations with specified name/id. # Returns array of relations, each in same form as getrelation. - + def findrelations(searchterm) rels = [] if searchterm.to_i>0 then @@ -531,7 +523,7 @@ class AmfController < ApplicationController amf_handle_error("'putrelation' #{relid}" ,'relation',relid) do user = getuser(usertoken) if !user then return -1,"You are not logged in, so the relation could not be saved." end - unless user.active_blocks.empty? then return -1,t('application.setup_user_auth.blocked') end + if user.blocks.active.exists? then return -1,t('application.setup_user_auth.blocked') end if REQUIRE_TERMS_AGREED and user.terms_agreed.nil? then return -1,"You must accept the contributor terms before you can edit." end if !tags_ok(tags) then return -1,"One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." end @@ -559,7 +551,7 @@ class AmfController < ApplicationController mid = renumberedways[mid] if m[0] == 'Way' end if mid - typedmembers << [m[0], mid, m[2]] + typedmembers << [m[0], mid, m[2].delete("\000-\037\ufffe\uffff", "^\011\012\015")] end end @@ -583,7 +575,7 @@ class AmfController < ApplicationController relation.delete_with_history!(new_relation, user) end end # transaction - + if relid <= 0 return [0, '', relid, new_relation.id, new_relation.version] else @@ -594,7 +586,7 @@ class AmfController < ApplicationController # 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) @@ -605,7 +597,7 @@ class AmfController < ApplicationController # 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. message, @@ -618,10 +610,10 @@ class AmfController < ApplicationController def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc: amf_handle_error("'putway' #{originalway}" ,'way',originalway) do # -- Initialise - + user = getuser(usertoken) if !user then return -1,"You are not logged in, so the way could not be saved." end - unless user.active_blocks.empty? then return -1,t('application.setup_user_auth.blocked') end + if user.blocks.active.exists? then return -1,t('application.setup_user_auth.blocked') end if REQUIRE_TERMS_AGREED and user.terms_agreed.nil? then return -1,"You must accept the contributor terms before you can edit." end if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end @@ -730,7 +722,7 @@ class AmfController < ApplicationController amf_handle_error("'putpoi' #{id}", 'node',id) do user = getuser(usertoken) if !user then return -1,"You are not logged in, so the point could not be saved." end - unless user.active_blocks.empty? then return -1,t('application.setup_user_auth.blocked') end + if user.blocks.active.exists? then return -1,t('application.setup_user_auth.blocked') end if REQUIRE_TERMS_AGREED and user.terms_agreed.nil? then return -1,"You must accept the contributor terms before you can edit." end if !tags_ok(tags) then return -1,"One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." end @@ -756,7 +748,7 @@ class AmfController < ApplicationController new_node.lat = lat new_node.lon = lon new_node.tags = tags - if id <= 0 + if id <= 0 # We're creating the node new_node.create_with_history(user) elsif visible @@ -775,7 +767,7 @@ class AmfController < ApplicationController return [0, '', id, new_node.id, new_node.version] else return [0, '', id, node.id, node.version] - end + end end end @@ -790,7 +782,7 @@ class AmfController < ApplicationController n = Node.find(id) v = n.version unless timestamp == '' - n = OldNode.where("id = ? AND timestamp <= ?", id, timestamp).order("timestamp DESC").first + n = OldNode.where("node_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first end if n @@ -807,7 +799,7 @@ class AmfController < ApplicationController # * 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 + # * 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. @@ -815,9 +807,9 @@ class AmfController < ApplicationController amf_handle_error("'deleteway' #{way_id}" ,'way', way_id) do user = getuser(usertoken) unless user then return -1,"You are not logged in, so the way could not be deleted." end - unless user.active_blocks.empty? then return -1,t('application.setup_user_auth.blocked') end + if user.blocks.active.exists? then return -1,t('application.setup_user_auth.blocked') end if REQUIRE_TERMS_AGREED and user.terms_agreed.nil? then return -1,"You must accept the contributor terms before you can edit." end - + way_id = way_id.to_i nodeversions = {} old_way=nil # returned, so scope it outside the transaction @@ -861,7 +853,7 @@ 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, + # When we are writing to the api, we need the actual user model, # not just the id, hence this abstraction def getuser(token) #:doc: @@ -876,7 +868,7 @@ class AmfController < ApplicationController def getlocales Dir.glob("#{Rails.root}/config/potlatch/locales/*").collect { |f| File.basename(f, ".yml") } end - + ## # check that all key-value pairs are valid UTF-8. def tags_ok(tags) @@ -894,8 +886,8 @@ class AmfController < ApplicationController new_tags = Hash.new unless tags.nil? tags.each do |k, v| - new_k = k.delete "\000-\037", "^\011\012\015" - new_v = v.delete "\000-\037", "^\011\012\015" + new_k = k.delete "\000-\037\ufffe\uffff", "^\011\012\015" + new_v = v.delete "\000-\037\ufffe\uffff", "^\011\012\015" new_tags[new_k] = new_v end end @@ -911,19 +903,19 @@ class AmfController < ApplicationController FROM current_way_nodes INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id INNER JOIN current_ways ON current_ways.id =current_way_nodes.id - WHERE current_nodes.visible=TRUE - AND current_ways.visible=TRUE + WHERE current_nodes.visible=TRUE + AND current_ways.visible=TRUE AND #{OSM.sql_for_area(bbox, "current_nodes.")} EOF return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] } end - + def sql_find_pois_in_area(bbox) pois=[] sql=<<-EOF - SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version - FROM current_nodes - LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id + SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version + FROM current_nodes + LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id WHERE current_nodes.visible=TRUE AND cwn.id IS NULL AND #{OSM.sql_for_area(bbox, "current_nodes.")} @@ -937,15 +929,15 @@ class AmfController < ApplicationController end pois end - + def sql_find_relations_in_area_and_ways(bbox,way_ids) # ** It would be more Potlatchy to get relations for nodes within ways # during 'getway', not here sql=<<-EOF - SELECT DISTINCT cr.id AS relid,cr.version AS version + 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_relation_members crm ON crm.id=cr.id + INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='Node' WHERE #{OSM.sql_for_area(bbox, "cn.")} EOF unless way_ids.empty? @@ -954,20 +946,20 @@ 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 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,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 + 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 AND current_nodes.visible=TRUE ORDER BY sequence_id EOF @@ -981,7 +973,7 @@ class AmfController < ApplicationController end points end - + def sql_get_tags_in_way(wayid) tags={} ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row| @@ -998,4 +990,3 @@ class AmfController < ApplicationController ActiveRecord::Base.connection.select_one("SELECT user FROM current_ways,changesets WHERE current_ways.id=#{wayid.to_i} AND current_ways.changeset=changesets.id")['user'] end end -