X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/1c6ac719e62145e16ee3fc09d728662f9a04524d..88f469eec179d587f9539dd4b99032b847fc16f8:/app/controllers/amf_controller.rb diff --git a/app/controllers/amf_controller.rb b/app/controllers/amf_controller.rb index 4a5d3346c..212343607 100644 --- a/app/controllers/amf_controller.rb +++ b/app/controllers/amf_controller.rb @@ -1,33 +1,29 @@ +# 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). +# +# See Also Potlatch::Potlatch and Potlatch::AMF +# +# Public domain. +# editions Systeme D / Richard Fairhurst 2004-2008 +# +# All in/out parameters are floats unless explicitly stated. +# +# to trap errors (getway_old,putway,putpoi,deleteway only): +# return(-1,"message") <-- just puts up a dialogue +# return(-2,"message") <-- also asks the user to e-mail me +# to log: +# RAILS_DEFAULT_LOGGER.error("Args: #{args[0]}, #{args[1]}, #{args[2]}, #{args[3]}") class AmfController < ApplicationController require 'stringio' + include Potlatch + session :off before_filter :check_write_availability - # AMF controller for 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). - # - # Public domain. Set your tab width to 4 to read this document. :) - # editions Systeme D / Richard Fairhurst 2004-2008 - # - # All in/out parameters are floats unless explicitly stated. - # Note that in getway/getway_old, SWF object name and way id are - #Êidentical and one could probably be eliminated. - # - # to trap errors (getway_old,putway,putpoi,deleteway only): - # return(-1,"message") <-- just puts up a dialogue - # return(-2,"message") <-- also asks the user to e-mail me - # to log: - # RAILS_DEFAULT_LOGGER.error("Args: #{args[0]}, #{args[1]}, #{args[2]}, #{args[3]}") - - # ==================================================================== - # Main AMF handler - - # ---- talk process AMF request - + # Main AMF handler. Tha talk method takes in AMF, figures out what to do and dispatched to the appropriate private method def talk req=StringIO.new(request.raw_post+0.chr) # Get POST data as request # (cf http://www.ruby-forum.com/topic/122163) @@ -38,35 +34,35 @@ class AmfController < ApplicationController # ------------- # Parse request - headers=getint(req) # Read number of headers + headers=AMF.getint(req) # Read number of headers headers.times do # Read each header - name=getstring(req) # | + name=AMF.getstring(req) # | req.getc # | skip boolean - value=getvalue(req) # | + value=AMF.getvalue(req) # | header["name"]=value # | end - bodies=getint(req) # Read number of bodies + bodies=AMF.getint(req) # Read number of bodies bodies.times do # Read each body - message=getstring(req) # | get message name - index=getstring(req) # | get index in response sequence - bytes=getlong(req) # | get total size in bytes - args=getvalue(req) # | get response (probably an array) + 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]=putdata(index,getpresets) - when 'whichways'; results[index]=putdata(index,whichways(args)) - when 'whichways_deleted'; results[index]=putdata(index,whichways_deleted(args)) - when 'getway'; results[index]=putdata(index,getway(args)) - when 'getway_old'; results[index]=putdata(index,getway_old(args)) - when 'getway_history'; results[index]=putdata(index,getway_history(args)) + 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)) + when 'getway_old'; results[index]=AMF.putdata(index,getway_old(args)) + when 'getway_history'; results[index]=AMF.putdata(index,getway_history(args)) when 'putway'; r=putway(args,renumberednodes) renumberednodes=r[3] - results[index]=putdata(index,r) - when 'deleteway'; results[index]=putdata(index,deleteway(args)) - when 'putpoi'; results[index]=putdata(index,putpoi(args)) - when 'getpoi'; results[index]=putdata(index,getpoi(args)) + results[index]=AMF.putdata(index,r) + when 'deleteway'; results[index]=AMF.putdata(index,deleteway(args)) + when 'putpoi'; results[index]=AMF.putdata(index,putpoi(args)) + when 'getpoi'; results[index]=AMF.putdata(index,getpoi(args)) end end @@ -82,92 +78,26 @@ class AmfController < ApplicationController end } RAILS_DEFAULT_LOGGER.info(" Response: end") - end private - - # ==================================================================== - # Remote calls - - # ----- getpresets - # in: none - # does: reads tag preset menus, colours, and autocomplete config files - # out: [0] presets, [1] presetmenus, [2] presetnames, - # [3] colours, [4] casing, [5] areas, [6] autotags - # (all hashes) - - def getpresets - RAILS_DEFAULT_LOGGER.info(" Message: getpresets") - - # Read preset menus - presets={} - presetmenus={}; presetmenus['point']=[]; presetmenus['way']=[]; presetmenus['POI']=[] - presetnames={}; presetnames['point']={}; presetnames['way']={}; presetnames['POI']={} - presettype='' - presetcategory='' - # StringIO.open(txt) do |file| - File.open("#{RAILS_ROOT}/config/potlatch/presets.txt") do |file| - file.each_line {|line| - t=line.chomp - if (t=~/(\w+)\/(\w+)/) then - presettype=$1 - presetcategory=$2 - presetmenus[presettype].push(presetcategory) - presetnames[presettype][presetcategory]=["(no preset)"] - elsif (t=~/^(.+):\s?(.+)$/) then - pre=$1; kv=$2 - presetnames[presettype][presetcategory].push(pre) - presets[pre]={} - kv.split(',').each {|a| - if (a=~/^(.+)=(.*)$/) then presets[pre][$1]=$2 end - } - end - } - end - - # Read colours/styling - colours={}; casing={}; areas={} - File.open("#{RAILS_ROOT}/config/potlatch/colours.txt") do |file| - file.each_line {|line| - t=line.chomp - if (t=~/(\w+)\s+([^\s]+)\s+([^\s]+)\s+([^\s]+)/) then - tag=$1 - if ($2!='-') then colours[tag]=$2.hex end - if ($3!='-') then casing[tag]=$3.hex end - if ($4!='-') then areas[tag]=$4.hex end - end - } - end - - # Read auto-complete - autotags={}; autotags['point']={}; autotags['way']={}; autotags['POI']={}; - File.open("#{RAILS_ROOT}/config/potlatch/autocomplete.txt") do |file| - file.each_line {|line| - t=line.chomp - if (t=~/^(\w+)\/(\w+)\s+(.+)$/) then - tag=$1; type=$2; values=$3 - if values=='-' then autotags[type][tag]=[] - else autotags[type][tag]=values.split(',').sort.reverse end - end - } - end - - [presets,presetmenus,presetnames,colours,casing,areas,autotags] + # Return presets (default tags and crap) to potlatch. + # Uses POTLATCH_PRESETS global, set up in OSM::Potlatch + def getpresets #:doc: + return POTLATCH_PRESETS end + # ----- whichways # Find all the way ids and nodes (including tags and projected lat/lng) which aren't part of those ways in an are # # The argument is an array containing the following, in order: - # 0. minimun longitude + # 0. minimum longitude # 1. minimum latitude # 2. maximum longitude # 3. maximum latitude - # 4. baselong ?? - # 5. basey ?? - # 6. masterscale ?? - def whichways(args) + # 4. baselong, 5. basey, 6. masterscale as above + def whichways(args) #:doc: xmin = args[0].to_f-0.01 ymin = args[1].to_f-0.01 xmax = args[2].to_f+0.01 @@ -178,19 +108,15 @@ class AmfController < ApplicationController RAILS_DEFAULT_LOGGER.info(" Message: whichways, bbox=#{xmin},#{ymin},#{xmax},#{ymax}") - # find the way id's in an area - nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax,:conditions => "visible = 1", :include => :way_nodes) - waynodes_in_area = nodes_in_area.collect {|node| node.way_nodes }.flatten - ways = waynodes_in_area.collect {|way_node| way_node.id[0]}.uniq + # 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 # find the node ids in an area that aren't part of ways - node_ids_in_area = nodes_in_area.collect {|node| node.id}.uniq - node_ids_used_in_ways = waynodes_in_area.collect {|way_node| way_node.node_id}.uniq - node_ids_not_used_in_area = node_ids_in_area - node_ids_used_in_ways - nodes_not_used_in_area = Node.find(node_ids_not_used_in_area) - points = nodes_not_used_in_area.collect {|n| [n.id, n.lon_potlatch(baselong,masterscale), n.lat_potlatch(basey,masterscale), n.tags_as_hash] } + 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_potlatch(baselong,masterscale), n.lat_potlatch(basey,masterscale), n.tags_as_hash] } - [ways,points] + [way_ids,points] end # ----- whichways_deleted @@ -198,7 +124,7 @@ class AmfController < ApplicationController # in: as whichways # does: finds all deleted ways with a deleted node in bounding box # out: [0] array of way ids - def whichways_deleted(args) + def whichways_deleted(args) #:doc: xmin = args[0].to_f-0.01 ymin = args[1].to_f-0.01 xmax = args[2].to_f+0.01 @@ -221,51 +147,50 @@ class AmfController < ApplicationController [ways] end + # ----- getway # Get a way with all of it's nodes and tags # The input is an array with the following components, in order: - # 0. SWF object name (String?) - fuck knows - # 1. wayid (String?) - the ID of the way to get - # 2. baselong - fuck knows - # 3. basey - fuck knows - # 4. masterscale - fuck knows + # 0. wayid - the ID of the way to get + # 1. baselong - origin of SWF map (longitude) + # 2. basey - origin of SWF map (latitude) + # 3. masterscale - SWF map scale # - # The output is an array which contains all the nodes (with projected latitude and longitude) and tags for a way (and all the nodes tags). It also has the way's unprojected (WGS84) bbox. + # The output is an array which contains all the nodes (with projected + # latitude and longitude) and tags for a way (and all the nodes tags). + # It also has the way's unprojected (WGS84) bbox. # # FIXME: The server really shouldn't be figuring out a ways bounding box and doing projection for potlatch # FIXME: the argument splitting should be done in the 'talk' method, not here - # - def getway(args) - objname,wayid,baselong,basey,masterscale = args + def getway(args) #:doc: + wayid,baselong,basey,masterscale = args wayid = wayid.to_i RAILS_DEFAULT_LOGGER.info(" Message: getway, id=#{wayid}") - way = Way.find_eager(wayid) + way = Way.find(wayid, :include => :nodes) long_array = [] lat_array = [] points = [] - way.way_nodes.each do |way_node| - node = way_node.node # get the node record + way.nodes.each do |node| projected_longitude = node.lon_potlatch(baselong,masterscale) # do projection for potlatch projected_latitude = node.lat_potlatch(basey,masterscale) id = node.id tags_hash = node.tags_as_hash - - points << [projected_longitude, projected_latitude, id, nil, tags_hash] # FIXME remove the nil in potlatch. performance matters y'know! + + points << [projected_longitude, projected_latitude, id, nil, tags_hash] long_array << projected_longitude lat_array << projected_latitude end - [objname,points,way.tags,long_array.min,long_array.max,lat_array.min,lat_array.max] + [wayid,points,way.tags,long_array.min,long_array.max,lat_array.min,lat_array.max] end # ----- getway_old # returns old version of way - - # in: [0] SWF object name, [1] way id, - # [2] way version to get (or -1 for "last deleted version") - # [3] baselong, [4] basey, [5] masterscale + # in: [0] way id, + # [1] way version to get (or -1 for "last deleted version") + # [2] baselong, [3] basey, [4] masterscale # does: gets old version of way and all constituent nodes # for undelete, always uses the most recent version of each node # (even if it's moved) @@ -275,12 +200,11 @@ class AmfController < ApplicationController # [2] array of points (as getway _except_ [3] is node.visible?, 0 or 1), # [4] xmin, [5] xmax, [6] ymin, [7] ymax (unprojected bbox), # [8] way version - - def getway_old(args) + def getway_old(args) #:doc: RAILS_DEFAULT_LOGGER.info(" Message: getway_old (server is #{SERVER_URL})") # if SERVER_URL=="www.openstreetmap.org" then return -1,"Revert is not currently enabled on the OpenStreetMap server." end - objname,wayid,version,baselong,basey,masterscale=args + wayid,version,baselong,basey,masterscale=args wayid = wayid.to_i version = version.to_i xmin = ymin = 999999 @@ -306,20 +230,18 @@ class AmfController < ApplicationController attrlist.each {|a| attributes[a['k'].gsub(':','|')]=a['v'] } attributes['history']="Retrieved from v"+version.to_s - [0,objname,points,attributes,xmin,xmax,ymin,ymax,version] + [0,wayid,points,attributes,xmin,xmax,ymin,ymax,version] end # ----- getway_history # find history of a way - # in: [0] way id # does: finds history of a way # out: [0] array of previous versions (where each is # [0] version, [1] db timestamp (string), # [2] visible 0 or 1, # [3] username or 'anonymous' (string)) - - def getway_history(args) + def getway_history(args) #:doc: wayid=args[0] history=[] sql=<<-EOF @@ -340,7 +262,6 @@ class AmfController < ApplicationController # ----- putway # saves a way to the database - # in: [0] user token (string), # [1] original way id (may be negative), # [2] array of points (as getway/getway_old), @@ -353,8 +274,7 @@ class AmfController < ApplicationController # out: [0] 0 (code for success), [1] original way id (unchanged), # [2] new way id, [3] hash of renumbered nodes (old id=>new id), # [4] xmin, [5] xmax, [6] ymin, [7] ymax (unprojected bbox) - - def putway(args,renumberednodes) + def putway(args,renumberednodes) #:doc: RAILS_DEFAULT_LOGGER.info(" putway started") usertoken,originalway,points,attributes,oldversion,baselong,basey,masterscale=args uid=getuserid(usertoken) @@ -444,7 +364,6 @@ class AmfController < ApplicationController end end - # -- 6a. delete any nodes not in modified way createuniquenodes(way,db_uqn,nodelist) # nodes which appear in this way but no other @@ -506,7 +425,6 @@ class AmfController < ApplicationController # ----- putpoi # save POI to the database - # in: [0] user token (string), # [1] original node id (may be negative), # [2] projected longitude, [3] projected latitude, @@ -516,8 +434,7 @@ class AmfController < ApplicationController # refuses save if the node has since become part of a way # out: [0] 0 (success), [1] original node id (unchanged), # [2] new node id - - def putpoi(args) + def putpoi(args) #:doc: usertoken,id,x,y,tags,visible,baselong,basey,masterscale=args uid=getuserid(usertoken) if !uid then return -1,"You are not logged in, so the point could not be saved." end @@ -553,34 +470,31 @@ class AmfController < ApplicationController end # ----- getpoi - # read POI from database + # read POI from database # (only called on revert: POIs are usually read by whichways) - # in: [0] node id, [1] baselong, [2] basey, [3] masterscale # does: reads POI # out: [0] id (unchanged), [1] projected long, [2] projected lat, # [3] hash of tags - - def getpoi(args) - id,baselong,basey,masterscale=args; id=id.to_i - poi=ActiveRecord::Base.connection.select_one("SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lng,tags "+ - "FROM current_nodes WHERE visible=1 AND id=#{id}") - if poi.nil? then return [nil,nil,nil,''] end - [id, - long2coord(poi['lng'].to_f,baselong,masterscale), - lat2coord(poi['lat'].to_f,basey,masterscale), - tag2array(poi['tags'])] + def getpoi(args) #:doc: + id,baselong,basey,masterscale = args + + n = Node.find(id.to_i) + if n + return [n.id, n.long_potlatch(baselong,masterscale), n.lat_potlatch(basey,masterscale), n.tags_as_hash] + else + return [nil,nil,nil,''] + end end # ----- deleteway # delete way and constituent nodes from database - # in: [0] user token (string), [1] way id # does: deletes way from db and any constituent nodes not used elsewhere # also removes ways/nodes from any relations they're in # out: [0] 0 (success), [1] way id (unchanged) + def deleteway(args) #:doc: - def deleteway(args) usertoken,way=args RAILS_DEFAULT_LOGGER.info(" Message: deleteway, id=#{way}") @@ -628,12 +542,7 @@ class AmfController < ApplicationController [0,way] end - - - # ==================================================================== - # Support functions for remote calls - - def readwayquery(id,insistonvisible) + def readwayquery(id,insistonvisible) #:doc: sql=<<-EOF SELECT latitude*0.0000001 AS latitude,longitude*0.0000001 AS longitude,current_nodes.id,tags,visible FROM current_way_nodes,current_nodes @@ -645,12 +554,13 @@ class AmfController < ApplicationController ActiveRecord::Base.connection.select_all(sql) end - def getlastversion(id,version) - row=ActiveRecord::Base.connection.select_one("SELECT version FROM ways WHERE id=#{id} AND visible=1 ORDER BY version DESC LIMIT 1") - row['version'] + # Get the latest version id of a way + def getlastversion(id,version) #:doc: + old_way = OldWay.find(:first, :conditions => ['id = ?' , id], :order => 'version DESC') + old_way.version end - def readwayquery_old(id,version,historic) + def readwayquery_old(id,version,historic) #:doc: # Node handling on undelete (historic=false): # - always use the node specified, even if it's moved @@ -705,7 +615,7 @@ class AmfController < ApplicationController rows end - def createuniquenodes(way,uqn_name,nodelist) + def createuniquenodes(way,uqn_name,nodelist) #:doc: # Find nodes which appear in this way but no others sql=<<-EOF CREATE TEMPORARY TABLE #{uqn_name} @@ -730,7 +640,7 @@ class AmfController < ApplicationController # deleteuniquenoderelations(uqn_name,uid,db_now) # deleteitemrelations(way|node,'way'|'node',uid,db_now) - def deleteuniquenoderelations(uqn_name,uid,db_now) + def deleteuniquenoderelations(uqn_name,uid,db_now) #:doc: sql=<<-EOF SELECT node_id,cr.id FROM #{uqn_name},current_relation_members crm,current_relations cr WHERE crm.member_id=node_id @@ -745,7 +655,7 @@ class AmfController < ApplicationController end end - def deleteitemrelations(objid,type,uid,db_now) + def deleteitemrelations(objid,type,uid,db_now) #:doc: sql=<<-EOF SELECT cr.id FROM current_relation_members crm,current_relations cr WHERE crm.member_id=#{objid} @@ -760,7 +670,7 @@ class AmfController < ApplicationController end end - def removefromrelation(objid,type,relation,uid,db_now) + def removefromrelation(objid,type,relation,uid,db_now) #:doc: rver=ActiveRecord::Base.connection.insert("INSERT INTO relations (id,user_id,timestamp,visible) VALUES (#{relation},#{uid},#{db_now},1)") tagsql=<<-EOF @@ -782,11 +692,11 @@ class AmfController < ApplicationController ActiveRecord::Base.connection.execute("DELETE FROM current_relation_members WHERE id=#{relation} AND member_type='#{type}' AND member_id=#{objid}") end - def sqlescape(a) + def sqlescape(a) #:doc: a.gsub(/[\000-\037]/,"").gsub("'","''").gsub(92.chr) {92.chr+92.chr} end - def tag2array(a) + def tag2array(a) #:doc: tags={} Tags.split(a) do |k, v| tags[k.gsub(':','|')]=v @@ -794,7 +704,7 @@ class AmfController < ApplicationController tags end - def array2tag(a) + def array2tag(a) #:doc: tags = [] a.each do |k,v| if v=='' then next end @@ -804,7 +714,7 @@ class AmfController < ApplicationController return Tags.join(tags) end - def getuserid(token) + def getuserid(token) #:doc: if (token =~ /^(.+)\+(.+)$/) then user = User.authenticate(:username => $1, :password => $2) else @@ -814,148 +724,27 @@ class AmfController < ApplicationController return user ? user.id : nil; end - - - # ==================================================================== - # AMF read subroutines - - # ----- getint return two-byte integer - # ----- getlong return four-byte long - # ----- getstring return string with two-byte length - # ----- getdouble return eight-byte double-precision float - # ----- getobject return object/hash - # ----- getarray return numeric array - - def getint(s) - s.getc*256+s.getc - end - - def getlong(s) - ((s.getc*256+s.getc)*256+s.getc)*256+s.getc - end - - def getstring(s) - len=s.getc*256+s.getc - s.read(len) - end - - def getdouble(s) - a=s.read(8).unpack('G') # G big-endian, E little-endian - a[0] - end - - def getarray(s) - len=getlong(s) - arr=[] - for i in (0..len-1) - arr[i]=getvalue(s) - end - arr - end - - def getobject(s) - arr={} - while (key=getstring(s)) - if (key=='') then break end - arr[key]=getvalue(s) - end - s.getc # skip the 9 'end of object' value - arr - end - - # ----- getvalue parse and get value - - def getvalue(s) - case s.getc - when 0; return getdouble(s) # number - when 1; return s.getc # boolean - when 2; return getstring(s) # string - when 3; return getobject(s) # object/hash - when 5; return nil # null - when 6; return nil # undefined - when 8; s.read(4) # mixedArray - return getobject(s) # | - when 10;return getarray(s) # array - else; return nil # error - end - end - - # ==================================================================== - # AMF write subroutines - - # ----- putdata envelope data into AMF writeable form - # ----- encodevalue pack variables as AMF - - def putdata(index,n) - d =encodestring(index+"/onResult") - d+=encodestring("null") - d+=[-1].pack("N") - d+=encodevalue(n) - end - - def encodevalue(n) - case n.class.to_s - when 'Array' - a=10.chr+encodelong(n.length) - n.each do |b| - a+=encodevalue(b) - end - a - when 'Hash' - a=3.chr - n.each do |k,v| - a+=encodestring(k)+encodevalue(v) - end - a+0.chr+0.chr+9.chr - when 'String' - 2.chr+encodestring(n) - when 'Bignum','Fixnum','Float' - 0.chr+encodedouble(n) - when 'NilClass' - 5.chr - else - RAILS_DEFAULT_LOGGER.error("Unexpected Ruby type for AMF conversion: "+n.class.to_s) - end - end - - # ----- encodestring encode string with two-byte length - # ----- encodedouble encode number as eight-byte double precision float - # ----- encodelong encode number as four-byte long - - def encodestring(n) - a,b=n.size.divmod(256) - a.chr+b.chr+n - end - - def encodedouble(n) - [n].pack('G') - end - - def encodelong(n) - [n].pack('N') - end - # ==================================================================== # Co-ordinate conversion - def lat2coord(a,basey,masterscale) - -(lat2y(a)-basey)*masterscale+250 + def lat2coord(a,basey,masterscale) #:doc: + -(lat2y(a)-basey)*masterscale end - def long2coord(a,baselong,masterscale) - (a-baselong)*masterscale+350 + def long2coord(a,baselong,masterscale) #:doc: + (a-baselong)*masterscale end - def lat2y(a) + def lat2y(a) #:doc: 180/Math::PI * Math.log(Math.tan(Math::PI/4+a*(Math::PI/180)/2)) end - def coord2lat(a,masterscale,basey) - y2lat((a-250)/-masterscale+basey) + def coord2lat(a,masterscale,basey) #:doc: + y2lat(a/-masterscale+basey) end - def coord2long(a,masterscale,baselong) - (a-350)/masterscale+baselong + def coord2long(a,masterscale,baselong) #:doc: + a/masterscale+baselong end def y2lat(a)