X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/d6e047d7d45ea76d56dccb53cc1fe1f5b54734d5..43c09d8062fc4aef4f1e0e5d3598e526a02bb288:/app/controllers/amf_controller.rb?ds=sidebyside diff --git a/app/controllers/amf_controller.rb b/app/controllers/amf_controller.rb index ce3dc91d5..fdad432a8 100644 --- a/app/controllers/amf_controller.rb +++ b/app/controllers/amf_controller.rb @@ -1,567 +1,1000 @@ -# 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. +# Helper functions are in /lib/potlatch.rb # -# Author:: editions Systeme D / Richard Fairhurst 2004-2008 -# Licence:: public domain. +# Author:: editions Systeme D / Richard Fairhurst 2004-2008 +# Licence:: public domain. # # == General structure # -# Apart from the talk method (which distributes 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. Methods -# all return an array to the SWF. -# +# 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. +# 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) +# 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 -# -# To write to the Rails log, use RAILS_DEFAULT_LOGGER.info("message"). +# 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 do -# -# - Check authentication -# - Check the right things are being written to the database! +# To write to the Rails log, use logger.info("message"). -class AmfController < ApplicationController - require 'stringio' +# Remaining issues: +# * version conflict when POIs and ways are reverted +class AmfController < ApplicationController include Potlatch - session :off - before_filter :check_write_availability + skip_before_action :verify_authenticity_token + before_action :check_api_writable + + # AMF Controller implements its own authentication and authorization checks + # completely independently of the rest of the codebase, so best just to let + # it keep doing its own thing. + skip_authorization_check - # Main AMF handler: processes the raw AMF string (using AMF library) and + # Main AMF handlers: process the raw AMF string (using AMF library) and # calls each action (private method) accordingly. - - def talk - 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 - renumberednodes={} # Shared across repeated putways - renumberedways={} # Shared across repeated putways - - # Parse request - - 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 '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 'putway'; r=putway(renumberednodes,*args) - renumberednodes=r[3] - if r[1] != r[2] - 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[0],args[1].to_i)) - when 'putpoi'; results[index]=AMF.putdata(index,putpoi(*args)) - when 'getpoi'; results[index]=AMF.putdata(index,getpoi(args[0].to_i)) - end - end - - # Write out response - - a,b=results.length.divmod(256) - render :content_type => "application/x-amf", :text => proc { |response, output| - output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr - results.each do |k,v| - output.write(v) - end - } + + 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" then result = getpresets(*args) + when "whichways" then result = whichways(*args) + when "whichways_deleted" then result = whichways_deleted(*args) + when "getway" then result = getway(args[0].to_i) + when "getrelation" then result = getrelation(args[0].to_i) + when "getway_old" then result = getway_old(args[0].to_i, args[1]) + when "getway_history" then result = getway_history(args[0].to_i) + when "getnode_history" then result = getnode_history(args[0].to_i) + when "findgpx" then result = findgpx(*args) + when "findrelations" then result = findrelations(*args) + when "getpoi" then result = getpoi(*args) + end + + result + end + end + + def amf_write + 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" then + orn = renumberednodes.dup + result = putway(renumberednodes, *args) + result[4] = renumberednodes.reject { |k, _v| orn.key?(k) } + renumberedways[result[2]] = result[3] if result[0].zero? && result[2] != result[3] + when "putrelation" then + result = putrelation(renumberednodes, renumberedways, *args) + when "deleteway" then + result = deleteway(*args) + when "putpoi" then + result = putpoi(*args) + renumberednodes[result[2]] = result[3] if result[0].zero? && result[2] != result[3] + when "startchangeset" then + result = startchangeset(*args) + end + + err = true if result[0] == -3 # If a conflict is detected, don't execute any more writes + end + + result + end end private + def amf_handle_error(call, rootobj, rootid) + yield + rescue OSM::APIAlreadyDeletedError => ex + [-4, ex.object, ex.object_id] + rescue OSM::APIVersionMismatchError => ex + [-3, [rootobj, rootid], [ex.type.downcase, ex.id, ex.latest]] + rescue OSM::APIUserChangesetMismatchError => ex + [-2, ex.to_s] + rescue OSM::APIBadBoundingBox => ex + [-2, "Sorry - I can't get the map for that area. The server said: #{ex}"] + rescue OSM::APIError => ex + [-1, ex.to_s] + rescue StandardError => ex + [-2, "An unusual error happened (in #{call}). The server said: #{ex}"] + end + + def amf_handle_error_with_timeout(call, rootobj, rootid) + amf_handle_error(call, rootobj, rootid) do + OSM::Timer.timeout(API_TIMEOUT, OSM::APITimeoutError) do + yield + end + end + end + + # 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) + return -1, "You are not logged in, so Potlatch can't write any changes to the database." unless user + return -1, t("application.setup_user_auth.blocked") if user.blocks.active.exists? + return -1, "You must accept the contributor terms before you can edit." if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? + + if cstags + return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." unless tags_ok(cstags) + + cstags = strip_non_xml_chars cstags + end + + # close previous changeset and add comment + if closeid + cs = Changeset.find(closeid.to_i) + cs.set_closed_time_now + if cs.user_id != user.id + raise OSM::APIUserChangesetMismatchError + elsif closecomment.empty? + cs.save! + else + cs.tags["comment"] = closecomment + # in case closecomment has chars not allowed in xml + cs.tags = strip_non_xml_chars cs.tags + cs.save_with_tags! + end + end + + # open a new changeset + if opennew.nonzero? + cs = Changeset.new + cs.tags = cstags + cs.user_id = user.id + unless closecomment.empty? + cs.tags["comment"] = closecomment + # in case closecomment has chars not allowed in xml + cs.tags = strip_non_xml_chars cs.tags + end + # 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 + end + # Return presets (default tags, localisation etc.): # uses POTLATCH_PRESETS global, set up in OSM::Potlatch. - def getpresets() #:doc: - return POTLATCH_PRESETS - end + def getpresets(usertoken, _lang) + user = getuser(usertoken) - # 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. + langs = if user && !user.languages.empty? + Locale.list(user.languages) + else + Locale.list(http_accept_language.user_preferred_languages) + end - def whichways(xmin, ymin, xmax, ymax) #:doc: - xmin -= 0.01; ymin -= 0.01 - xmax += 0.01; ymax += 0.01 + lang = getlocales.preferred(langs) + (real_lang, localised) = getlocalized(lang.to_s) - if POTLATCH_USE_SQL then - way_ids = sql_find_way_ids_in_area(xmin, ymin, xmax, ymax) - points = sql_find_pois_in_area(xmin, ymin, xmax, ymax) - relation_ids = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, way_ids) - else - # find the way ids in an area - nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => "current_nodes.visible = 1", :include => :ways) - way_ids = nodes_in_area.collect { |node| node.way_ids }.flatten.uniq + # Tell Potlatch what language it's using + localised["__potlatch_locale"] = real_lang - # 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_as_hash] } + # Get help from i18n but delete it so we won't pass it around + # twice for nothing + help = localised["help_html"] + localised.delete("help_html") - # find the relations used by those nodes and ways - relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => "visible = 1") + - Relation.find_for_ways(way_ids, :conditions => "visible = 1") - relation_ids = relations.collect { |relation| relation.id }.uniq - end + # Populate icon names + POTLATCH_PRESETS[10].each do |id| + POTLATCH_PRESETS[11][id] = localised["preset_icon_#{id}"] + localised.delete("preset_icon_#{id}") + end - [way_ids, points, relation_ids] + POTLATCH_PRESETS + [localised, help] end - # Find deleted ways in current bounding box (similar to whichways, but ways - # with a deleted node only - not POIs or relations). + def getlocalized(lang) + # What we end up actually using. Reported in Potlatch's created_by=* string + loaded_lang = "en" + + # Load English defaults + en = YAML.safe_load(File.open(Rails.root.join("config", "potlatch", "locales", "en.yml")))["en"] + + if lang == "en" + return [loaded_lang, en] + else + # Use English as a fallback + begin + other = YAML.safe_load(File.open(Rails.root.join("config", "potlatch", "locales", "#{lang}.yml")))[lang] + loaded_lang = lang + rescue StandardError + other = en + end + + # We have to return a flat list and some of the keys won't be + # translated (probably) + return [loaded_lang, en.merge(other)] + end + end - def whichways_deleted(xmin, ymin, xmax, ymax) #:doc: - xmin -= 0.01; ymin -= 0.01 - xmax += 0.01; ymax += 0.01 + ## + # 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) + amf_handle_error_with_timeout("'whichways'", nil, nil) do + 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 + bbox = BoundingBox.new(xmin, ymin, xmax, ymax) + bbox.check_boundaries + bbox.check_size + + if POTLATCH_USE_SQL + ways = sql_find_ways_in_area(bbox) + points = sql_find_pois_in_area(bbox) + relations = sql_find_relations_in_area_and_ways(bbox, ways.collect { |x| x[0] }) + else + # find the way ids in an area + nodes_in_area = Node.bbox(bbox).visible.includes(:ways) + ways = nodes_in_area.inject([]) do |sum, node| + visible_ways = node.ways.select(&:visible?) + sum + visible_ways.collect { |w| [w.id, w.version] } + end.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, n.version] }.uniq + + # find the relations used by those nodes and ways + relations = Relation.nodes(nodes_in_area.collect(&:id)).visible + + Relation.ways(ways.collect { |w| w[0] }).visible + relations = relations.collect { |relation| [relation.id, relation.version] }.uniq + end + + [0, "", ways, points, relations] + end + end - nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => "current_nodes.visible = 0 AND current_ways.visible = 0", :include => :ways_via_history) - way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq + # Find deleted ways in current bounding box (similar to whichways, but ways + # with a deleted node only - not POIs or relations). - [way_ids] + def whichways_deleted(xmin, ymin, xmax, ymax) + amf_handle_error_with_timeout("'whichways_deleted'", nil, nil) do + 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 + bbox = BoundingBox.new(xmin, ymin, xmax, ymax) + bbox.check_boundaries + bbox.check_size + + nodes_in_area = Node.bbox(bbox).joins(:ways_via_history).where(:current_ways => { :visible => false }) + way_ids = nodes_in_area.collect { |node| node.ways_via_history.invisible.collect(&:id) }.flatten.uniq + + [0, "", way_ids] + end end # Get a way including nodes and tags. - # Returns 0 (success), a Potlatch-style array of points, and a hash of tags. - - def getway(wayid) #:doc: - if POTLATCH_USE_SQL then - points = sql_get_nodes_in_way(wayid) - tags = sql_get_tags_in_way(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 - way = Way.find(wayid) - points = way.nodes.collect do |node| - [node.lon, node.lat, node.id, nil, node.tags_as_hash] - end - tags = way.tags - end - - [wayid, points, tags] + # Returns the way id, a Potlatch-style array of points, a hash of tags, the version number, and the user ID. + + def getway(wayid) + amf_handle_error_with_timeout("'getway' #{wayid}", "way", wayid) do + if POTLATCH_USE_SQL + points = sql_get_nodes_in_way(wayid) + tags = sql_get_tags_in_way(wayid) + version = sql_get_way_version(wayid) + uid = sql_get_way_user(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 + way = Way.where(:id => wayid).first + + # check case where way has been deleted or doesn't exist + return [-4, "way", wayid] if way.nil? || !way.visible + + 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] + end + tags = way.tags + version = way.version + uid = way.changeset.user.id + end + + [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=1+), 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, + # 5. is this the current, visible version? (boolean) + + def getway_old(id, timestamp) + amf_handle_error_with_timeout("'getway_old' #{id}, #{timestamp}", "way", id) do + if timestamp == "" + # undelete + 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 = Time.zone.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S") + old_way = OldWay.where("way_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first + unless old_way.nil? + if old_way.visible + points = old_way.get_nodes_revert(timestamp) + else + return [-1, "Sorry, the way was deleted at that time - please revert to a previous version.", id] + end + end + rescue ArgumentError + # thrown by date parsing method. leave old_way as nil for + # the error handler below. + old_way = nil + end + end + + if old_way.nil? + return [-1, "Sorry, the server could not find a way at that time.", id] + else + curway = Way.find(id) + old_way.tags["history"] = "Retrieved from v#{old_way.version}" + return [0, "", id, points, old_way.tags, curway.version, (curway.version == old_way.version && curway.visible)] + end + end + end - def getway_old(id, version) #:doc: - if version < 0 - old_way = OldWay.find(:first, :conditions => ['visible = 1 AND id = ?', id], :order => 'version DESC') - points = old_way.get_nodes_undelete - else - old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version]) - points = old_way.get_nodes_revert - 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; + # 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) + revdates = [] + revusers = {} + Way.find(wayid).old_ways.unredacted.collect do |a| + revdates.push(a.timestamp) + revusers[a.timestamp.to_i] = change_user(a) unless revusers.key?(a.timestamp.to_i) + a.nds.each do |n| + Node.find(n).old_nodes.unredacted.collect do |o| + revdates.push(o.timestamp) + revusers[o.timestamp.to_i] = change_user(o) unless revusers.key?(o.timestamp.to_i) + end + end + end + waycreated = revdates[0] + revdates.uniq! + revdates.sort! + revdates.reverse! + + # Remove any dates (from nodes) before first revision date of way + revdates.delete_if { |d| d < waycreated } + # Remove any elements where 2 seconds doesn't elapse before next one + revdates.delete_if { |d| revdates.include?(d + 1) || revdates.include?(d + 2) } + # Collect all in one nested array + revdates.collect! { |d| [(d + 1).strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] } + revdates.uniq! + + ["way", wayid, revdates] + rescue ActiveRecord::RecordNotFound + ["way", wayid, []] + end - old_way.tags['history'] = "Retrieved from v#{old_way.version}" + # Find history of a node. Returns 'node', id, and an array of previous versions as above. - [0, id, points, old_way.tags, old_way.version] + def getnode_history(nodeid) + 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 + ["node", nodeid, history] + rescue ActiveRecord::RecordNotFound + ["node", nodeid, []] end - - # Find history of a way. Returns an array of previous versions. - def getway_history(wayid) #:doc: - history = Way.find(wayid).old_ways.collect do |old_way| - user = old_way.user.data_public? ? old_way.user.display_name : 'anonymous' - [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user] - end + def change_user(obj) + user_object = obj.changeset.user + user = user_object.data_public? ? user_object.display_name : "anonymous" + uid = user_object.data_public? ? user_object.id : 0 + [user, uid] + end - [history] + # 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) + + return -1, "You must be logged in to search for GPX traces." unless user + return -1, t("application.setup_user_auth.blocked") if user.blocks.active.exists? + + query = Trace.visible_to(user) + query = if searchterm.to_i.positive? + query.where(:id => searchterm.to_i) + else + query.where("MATCH(name) AGAINST (?)", searchterm).limit(21) + end + gpxs = query.collect do |gpx| + [gpx.id, gpx.name, gpx.description] + end + [0, "", gpxs] + end end # Get a relation with all tags and members. # Returns: - # 0. relation id, - # 1. hash of tags, - # 2. list of members. - - def getrelation(relid) #:doc: - rel = Relation.find(relid) + # 0. success code? + # 1. object type? + # 2. relation id, + # 3. hash of tags, + # 4. list of members, + # 5. version. + + def getrelation(relid) + amf_handle_error("'getrelation' #{relid}", "relation", relid) do + rel = Relation.where(:id => relid).first + + return [-4, "relation", relid] if rel.nil? || !rel.visible + + [0, "", relid, rel.tags, rel.members, rel.version] + end + end - [relid, rel.tags, rel.members] + # Find relations with specified name/id. + # Returns array of relations, each in same form as getrelation. + + def findrelations(searchterm) + rels = [] + if searchterm.to_i.positive? + rel = Relation.where(:id => searchterm.to_i).first + rels.push([rel.id, rel.tags, rel.members, rel.version]) if rel&.visible + else + RelationTag.where("v like ?", "%#{searchterm}%").limit(11).each do |t| + rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version]) if t.relation.visible + end + end + rels end # Save a relation. # Returns # 0. 0 (success), # 1. original relation id (unchanged), - # 2. new relation id. - - def putrelation(renumberednodes, renumberedways, usertoken, 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 - - relid = relid.to_i - visible = visible.to_i - - # create a new relation, or find the existing one - if relid <= 0 - rel = Relation.new - 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' - if mid < 0 - return -2, "Negative ID unresolved" - end - end - typedmembers << [m[0], mid, m[2]] - end - - # assign new contents - rel.members = typedmembers - rel.tags = tags - rel.visible = visible - rel.user_id = uid - - # 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] + # 2. new relation id, + # 3. version. + + def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) + amf_handle_error("'putrelation' #{relid}", "relation", relid) do + user = getuser(usertoken) + + return -1, "You are not logged in, so the relation could not be saved." unless user + return -1, t("application.setup_user_auth.blocked") if user.blocks.active.exists? + return -1, "You must accept the contributor terms before you can edit." if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? + + return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." unless tags_ok(tags) + + tags = strip_non_xml_chars tags + + relid = relid.to_i + visible = visible.to_i.nonzero? + + new_relation = nil + relation = nil + Relation.transaction do + # create a new relation, or find the existing one + relation = Relation.find(relid) if relid.positive? + # 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.negative? + mid = renumberednodes[mid] if m[0] == "Node" + mid = renumberedways[mid] if m[0] == "Way" + end + typedmembers << [m[0], mid, m[2].delete("\000-\037\ufffe\uffff", "^\011\012\015")] if mid + end + + # 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 + + if relid <= 0 + return [0, "", relid, new_relation.id, new_relation.version] + else + return [0, "", relid, relid, relation.version] + end + end 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) - - def putway(renumberednodes, usertoken, originalway, points, attributes) #:doc: - - # -- 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 - - originalway = originalway.to_i - - 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 - uniques = [] - else - way = Way.find(originalway) - uniques = way.unshared_node_ids - end - - # -- Compare nodes and save changes to any that have changed - - nodes = [] - - points.each do |n| - lon = n[0].to_f - lat = n[1].to_f - id = n[2].to_i - savenode = false - - if renumberednodes[id] - id = renumberednodes[id] - elsif id < 0 - # Create new node - node = Node.new - savenode = true - else - node = Node.find(id) - if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or - Tags.join(n[4]) != node.tags or !node.visible? - savenode = true - end - end - - if savenode - node.user_id = uid - node.lat = lat - node.lon = lon - node.tags = Tags.join(n[4]) - node.visible = true - node.save_with_history! - - if id != node.id - renumberednodes[id] = node.id - id = node.id - 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.user_id = uid - node.visible = false - node.save_with_history! - end - - # -- Save revised way - - way.tags = attributes - way.nds = nodes - way.user_id = uid - way.visible = true - way.save_with_history! - - [0, originalway, way.id, renumberednodes] + # 1. message, + # 2. original way id (unchanged), + # 3. new way id, + # 4. hash of renumbered nodes (old id=>new id), + # 5. way version, + # 6. hash of changed node versions (node=>version) + # 7. hash of deleted node versions (node=>version) + + def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) + amf_handle_error("'putway' #{originalway}", "way", originalway) do + # -- Initialise + + user = getuser(usertoken) + return -1, "You are not logged in, so the way could not be saved." unless user + return -1, t("application.setup_user_auth.blocked") if user.blocks.active.exists? + return -1, "You must accept the contributor terms before you can edit." if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? + + return -2, "Server error - way is only #{pointlist.length} points long." if pointlist.length < 2 + + return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." unless tags_ok(attributes) + + attributes = strip_non_xml_chars attributes + + originalway = originalway.to_i + pointlist.collect!(&:to_i) + + way = nil # this is returned, so scope it outside the transaction + nodeversions = {} + Way.transaction do + # -- Update each changed node + + nodes.each do |a| + lon = a[0].to_f + lat = a[1].to_f + id = a[2].to_i + version = a[3].to_i + + return -2, "Server error - node with id 0 found in way #{originalway}." if id.zero? + return -2, "Server error - node with latitude -90 found in way #{originalway}." if lat == 90 + + id = renumberednodes[id] if renumberednodes[id] + + node = Node.new + node.changeset_id = changeset_id + node.lat = lat + node.lon = lon + node.tags = a[4] + + # fixup node tags in a way as well + return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." unless tags_ok(node.tags) + + node.tags = strip_non_xml_chars node.tags + + 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 + 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 + + # -- Save revised way + + pointlist.collect! do |a| + renumberednodes[a] || a + end + 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 || way.nds != pointlist || !way.visible? + new_way.id = originalway + way.update_from(new_way, user) + end + end + + # -- 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) + rescue OSM::APIPreconditionFailedError + # We don't do anything here as the node is being used elsewhere + # and we don't want to delete it + end + end + end + + [0, "", originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes] + end 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. - - def putpoi(usertoken, 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 - - id = id.to_i - visible = (visible.to_i == 1) - - 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') - end - else - node = Node.new - end - - node.user_id = uid - node.lat = lat - node.lon = lon - node.tags = Tags.join(tags) - node.visible = visible - node.save_with_history! - - [0, id, node.id] + # 1. success message, + # 2. original node id (unchanged), + # 3. new node id, + # 4. version. + + def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) + amf_handle_error("'putpoi' #{id}", "node", id) do + user = getuser(usertoken) + return -1, "You are not logged in, so the point could not be saved." unless user + return -1, t("application.setup_user_auth.blocked") if user.blocks.active.exists? + return -1, "You must accept the contributor terms before you can edit." if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? + + return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." unless tags_ok(tags) + + tags = strip_non_xml_chars tags + + id = id.to_i + visible = (visible.to_i == 1) + node = nil + new_node = nil + Node.transaction do + if id.positive? + begin + node = Node.find(id) + rescue ActiveRecord::RecordNotFound + return [-4, "node", id] + end + + return -1, "Point #{id} has since become part of a way, so you cannot save it as a POI.", id, id, version unless visible || node.ways.empty? + 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 + end + + if id <= 0 + return [0, "", id, new_node.id, new_node.version] + else + return [0, "", id, node.id, node.version] + end + end end # Read POI from database # (only called on revert: POIs are usually read by whichways). # - # Returns array of id, long, lat, hash of tags. - - def getpoi(id) #:doc: - n = Node.find(id) - - if n - return [n.id, n.lon, n.lat, n.tags_as_hash] - else - return [nil, nil, nil, ''] - end + # Returns array of id, long, lat, hash of tags, (current) version. + + def getpoi(id, timestamp) + amf_handle_error("'getpoi' #{id}", "node", id) do + id = id.to_i + n = Node.where(:id => id).first + if n + v = n.version + n = OldNode.where("node_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first unless timestamp == "" + end + + if n + return [0, "", id, n.lon, n.lat, n.tags, v] + else + return [-4, "node", id] + end + end end - # Delete way and all constituent nodes. Also removes from any relations. - # Returns 0 (success), unchanged way id. - - def deleteway(usertoken, way_id) #:doc: - uid = getuserid(usertoken) - if !uid then return -1,"You are not logged in, so the way could not be deleted." end - - # FIXME: would be good not to make two history entries when removing - # two nodes from the same relation - user = User.find(uid) - way = Way.find(way_id) - way.unshared_node_ids.each do |n| - deleteitemrelations(n, 'node') - end - - way.delete_with_relations_and_nodes_and_history(user) - - [0, way_id] + # 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) + amf_handle_error("'deleteway' #{way_id}", "way", way_id) do + user = getuser(usertoken) + return -1, "You are not logged in, so the way could not be deleted." unless user + return -1, t("application.setup_user_auth.blocked") if user.blocks.active.exists? + return -1, "You must accept the contributor terms before you can edit." if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? + + 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 + # 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 + end + [0, "", way_id, old_way.version, nodeversions] + end 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 + # 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 getuser(token) + if token =~ /^(.+)\:(.+)$/ + User.authenticate(:username => Regexp.last_match(1), :password => Regexp.last_match(2)) + else + User.authenticate(:token => token) + 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 + def getlocales + @getlocales ||= Locale.list(Dir.glob(Rails.root.join("config", "potlatch", "locales", "*")).collect { |f| File.basename(f, ".yml") }) end - # Authenticate token - # (could be removed if no-one uses the username+password form) - - def getuserid(token) #:doc: - if (token =~ /^(.+)\+(.+)$/) then - user = User.authenticate(:username => $1, :password => $2) - else - user = User.authenticate(:token => token) - end + ## + # check that all key-value pairs are valid UTF-8. + def tags_ok(tags) + tags.each do |k, v| + return false unless UTF8.valid? k + return false unless UTF8.valid? v + end + true + end - return user ? user.id : nil; + ## + # strip characters which are invalid in XML documents from the strings + # in the +tags+ hash. + def strip_non_xml_chars(tags) + new_tags = {} + tags&.each do |k, v| + 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 + new_tags end - # Compare two floating-point numbers to within 0.0000001 + # ==================================================================== + # Alternative SQL queries for getway/whichways - def fpcomp(a,b) #:doc: - return ((a/0.0000001).round==(b/0.0000001).round) + def sql_find_ways_in_area(bbox) + sql = <<-SQL + SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version + 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 + AND #{OSM.sql_for_area(bbox, 'current_nodes.')} + SQL + 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 = <<-SQL + 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.')} + SQL + ActiveRecord::Base.connection.select_all(sql).each do |row| + poitags = {} + ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n| + poitags[n["k"]] = n["v"] + end + pois << [row["id"].to_i, row["lon"].to_f, row["lat"].to_f, poitags, row["version"].to_i] + end + pois + end - # ==================================================================== - # Alternative SQL queries for getway/whichways + 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 = <<-SQL + 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' + WHERE #{OSM.sql_for_area(bbox, 'cn.')} + SQL + unless way_ids.empty? + sql += <<-SQL + UNION + 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' + AND crm.member_id IN (#{way_ids.join(',')}) + SQL + end + ActiveRecord::Base.connection.select_all(sql).collect { |a| [a["relid"].to_i, a["version"].to_i] } + end - def sql_find_way_ids_in_area(xmin,ymin,xmax,ymax) - sql=<<-EOF - SELECT DISTINCT current_way_nodes.id AS wayid - 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=1 - AND current_ways.visible=1 - AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")} - EOF - return ActiveRecord::Base.connection.select_all(sql).collect { |a| a['wayid'].to_i } - end - - def sql_find_pois_in_area(xmin,ymin,xmax,ymax) - sql=<<-EOF - SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.tags - FROM current_nodes - LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id - WHERE current_nodes.visible=1 - AND cwn.id IS NULL - AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")} - EOF - return ActiveRecord::Base.connection.select_all(sql).collect { |n| [n['id'].to_i,n['lon'].to_f,n['lat'].to_f,tagstring_to_hash(n['tags'])] } - end - - def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,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 - 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' - WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")} - EOF - unless way_ids.empty? - sql+=<<-EOF - UNION - SELECT DISTINCT cr.id AS relid - FROM current_relations cr - INNER JOIN current_relation_members crm ON crm.id=cr.id - 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 }.uniq - 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,tags - 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=1 - ORDER BY sequence_id - EOF - ActiveRecord::Base.connection.select_all(sql).each do |row| - points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nil,tagstring_to_hash(row['tags'])] - end - points - end - + points = [] + sql = <<-SQL + 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 + SQL + ActiveRecord::Base.connection.select_all(sql).each do |row| + nodetags = {} + ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n| + nodetags[n["k"]] = n["v"] + end + nodetags.delete("created_by") + points << [row["lon"].to_f, row["lat"].to_f, row["id"].to_i, nodetags, row["version"].to_i] + 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| - tags[row['k']]=row['v'] - end - tags + tags = {} + ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row| + tags[row["k"]] = row["v"] + end + tags end -end + def sql_get_way_version(wayid) + ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")["version"] + end -# Local Variables: -# indent-tabs-mode: t -# tab-width: 4 -# End: + def sql_get_way_user(wayid) + 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