1 # amf_controller is a semi-standalone API for Flash clients, particularly
2 # Potlatch. All interaction between Potlatch (as a .SWF application) and the
3 # OSM database takes place using this controller. Messages are
4 # encoded in the Actionscript Message Format (AMF).
6 # Helper functions are in /lib/potlatch.
8 # Author:: editions Systeme D / Richard Fairhurst 2004-2008
9 # Licence:: public domain.
11 # == General structure
13 # Apart from the amf_read and amf_write methods (which distribute the requests
14 # from the AMF message), each method generally takes arguments in the order
15 # they were sent by the Potlatch SWF. Do not assume typing has been preserved.
16 # Methods all return an array to the SWF.
20 # Note that this requires a patched version of composite_primary_keys 1.1.0
21 # (see http://groups.google.com/group/compositekeys/t/a00e7562b677e193)
22 # if you are to run with POTLATCH_USE_SQL=false .
26 # Any method that returns a status code (0 for ok) can also send:
27 # return(-1,"message") <-- just puts up a dialogue
28 # return(-2,"message") <-- also asks the user to e-mail me
30 # To write to the Rails log, use RAILS_DEFAULT_LOGGER.info("message").
32 class AmfController < ApplicationController
37 # Help methods for checking boundary sanity and area size
41 before_filter :check_write_availability
43 # Main AMF handlers: process the raw AMF string (using AMF library) and
44 # calls each action (private method) accordingly.
45 # ** FIXME: refactor to reduce duplication of code across read/write
48 req=StringIO.new(request.raw_post+0.chr)# Get POST data as request
49 # (cf http://www.ruby-forum.com/topic/122163)
50 req.read(2) # Skip version indicator and client ID
51 results={} # Results of each body
55 headers=AMF.getint(req) # Read number of headers
57 headers.times do # Read each header
58 name=AMF.getstring(req) # |
59 req.getc # | skip boolean
60 value=AMF.getvalue(req) # |
61 header["name"]=value # |
64 bodies=AMF.getint(req) # Read number of bodies
65 bodies.times do # Read each body
66 message=AMF.getstring(req) # | get message name
67 index=AMF.getstring(req) # | get index in response sequence
68 bytes=AMF.getlong(req) # | get total size in bytes
69 args=AMF.getvalue(req) # | get response (probably an array)
70 logger.info "Executing AMF #{message}:#{index}"
73 when 'getpresets'; results[index]=AMF.putdata(index,getpresets())
74 when 'whichways'; results[index]=AMF.putdata(index,whichways(*args))
75 when 'whichways_deleted'; results[index]=AMF.putdata(index,whichways_deleted(*args))
76 when 'getway'; results[index]=AMF.putdata(index,getway(args[0].to_i))
77 when 'getrelation'; results[index]=AMF.putdata(index,getrelation(args[0].to_i))
78 when 'getway_old'; results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1].to_i))
79 when 'getway_history'; results[index]=AMF.putdata(index,getway_history(args[0].to_i))
80 when 'getnode_history'; results[index]=AMF.putdata(index,getnode_history(args[0].to_i))
81 when 'findgpx'; results[index]=AMF.putdata(index,findgpx(*args))
82 when 'findrelations'; results[index]=AMF.putdata(index,findrelations(*args))
83 when 'getpoi'; results[index]=AMF.putdata(index,getpoi(*args))
86 logger.info("encoding AMF results")
91 req=StringIO.new(request.raw_post+0.chr)
94 renumberednodes={} # Shared across repeated putways
95 renumberedways={} # Shared across repeated putways
97 headers=AMF.getint(req) # Read number of headers
98 headers.times do # Read each header
99 name=AMF.getstring(req) # |
100 req.getc # | skip boolean
101 value=AMF.getvalue(req) # |
102 header["name"]=value # |
105 bodies=AMF.getint(req) # Read number of bodies
106 bodies.times do # Read each body
107 message=AMF.getstring(req) # | get message name
108 index=AMF.getstring(req) # | get index in response sequence
109 bytes=AMF.getlong(req) # | get total size in bytes
110 args=AMF.getvalue(req) # | get response (probably an array)
113 when 'putway'; r=putway(renumberednodes,*args)
116 renumberedways[r[1]] = r[2]
118 results[index]=AMF.putdata(index,r)
119 when 'putrelation'; results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args))
120 when 'deleteway'; results[index]=AMF.putdata(index,deleteway(*args))
121 when 'putpoi'; results[index]=AMF.putdata(index,putpoi(*args))
122 when 'startchangeset'; results[index]=AMF.putdata(index,startchangeset(*args))
125 sendresponse(results)
130 # Start new changeset
132 def startchangeset(usertoken, cstags, closeid, closecomment)
133 uid = getuserid(usertoken)
134 if !uid then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end
136 # close previous changeset and add comment
140 # open a new changeset
144 cs.created_at = Time.now
149 # Return presets (default tags, localisation etc.):
150 # uses POTLATCH_PRESETS global, set up in OSM::Potlatch.
152 def getpresets() #:doc:
153 return POTLATCH_PRESETS
156 # Find all the ways, POI nodes (i.e. not part of ways), and relations
157 # in a given bounding box. Nodes are returned in full; ways and relations
160 def whichways(xmin, ymin, xmax, ymax) #:doc:
161 xmin -= 0.01; ymin -= 0.01
162 xmax += 0.01; ymax += 0.01
164 # check boundary is sane and area within defined
165 # see /config/application.yml
167 check_boundaries(xmin, ymin, xmax, ymax)
168 rescue Exception => err
169 return [-2,"Sorry - I can't get the map for that area."]
172 if POTLATCH_USE_SQL then
173 ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
174 points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
175 relations = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, ways.collect {|x| x[0]})
177 # find the way ids in an area
178 nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways)
179 ways = nodes_in_area.collect { |node|
180 node.ways.collect { |w| [w.id,w.version] }.flatten
184 # find the node ids in an area that aren't part of ways
185 nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
186 points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags] }
188 # find the relations used by those nodes and ways
189 relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) +
190 Relation.find_for_ways(ways.collect { |w| w[0] }, :conditions => {:visible => true})
191 relations = relations.collect { |relation| [relation.id,relation.version] }.uniq
194 [0,ways, points, relations]
197 # Find deleted ways in current bounding box (similar to whichways, but ways
198 # with a deleted node only - not POIs or relations).
200 def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
201 xmin -= 0.01; ymin -= 0.01
202 xmax += 0.01; ymax += 0.01
204 # check boundary is sane and area within defined
205 # see /config/application.yml
207 check_boundaries(xmin, ymin, xmax, ymax)
208 rescue Exception => err
209 # FIXME: report an error rather than just return an empty result
213 nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history)
214 way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
219 # Get a way including nodes and tags.
220 # Returns the way id, a Potlatch-style array of points, a hash of tags, and the version number.
222 def getway(wayid) #:doc:
223 if POTLATCH_USE_SQL then
224 points = sql_get_nodes_in_way(wayid)
225 tags = sql_get_tags_in_way(wayid)
226 version = sql_get_way_version(wayid)
228 # Ideally we would do ":include => :nodes" here but if we do that
229 # then rails only seems to return the first copy of a node when a
230 # way includes a node more than once
232 way = Way.find(wayid)
233 rescue ActiveRecord::RecordNotFound
237 # check case where way has been deleted or doesn't exist
238 return [wayid,[],{}] if way.nil? or !way.visible
240 points = way.nodes.collect do |node|
242 nodetags.delete('created_by')
243 [node.lon, node.lat, node.id, nodetags]
246 version = way.version
249 [wayid, points, tags, version]
252 # Get an old version of a way, and all constituent nodes.
254 # For undelete (version<0), always uses the most recent version of each node,
255 # even if it's moved. For revert (version >= 0), uses the node in existence
256 # at the time, generating a new id if it's still visible and has been moved/
262 # 2. array of points,
265 # 5. is this the current, visible version? (boolean)
267 def getway_old(id, version) #:doc:
269 old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC')
270 points = old_way.get_nodes_undelete unless old_way.nil?
272 old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version])
273 points = old_way.get_nodes_revert unless old_way.nil?
277 return [-1, id, [], {}, -1,0]
280 old_way.tags['history'] = "Retrieved from v#{old_way.version}"
281 return [0, id, points, old_way.tags, old_way.version, (curway.version==old_way.version and curway.visible)]
285 # Find history of a way. Returns 'way', id, and
286 # an array of previous versions.
288 def getway_history(wayid) #:doc:
290 history = Way.find(wayid).old_ways.reverse.collect do |old_way|
291 user_object = old_way.changeset.user
292 user = user_object.data_public? ? user_object.display_name : 'anonymous'
293 uid = user_object.data_public? ? user_object.id : 0
294 [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
297 return ['way',wayid,history]
298 rescue ActiveRecord::RecordNotFound
299 return ['way', wayid, []]
303 # Find history of a node. Returns 'node', id, and
304 # an array of previous versions.
306 def getnode_history(nodeid) #:doc:
308 history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
309 user_object = old_node.changeset.user
310 user = user_object.data_public? ? user_object.display_name : 'anonymous'
311 uid = user_object.data_public? ? user_object.id : 0
312 [old_node.version, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
315 return ['node',nodeid,history]
316 rescue ActiveRecord::RecordNotFound
317 return ['node', nodeid, []]
321 # Find GPS traces with specified name/id.
322 # Returns array listing GPXs, each one comprising id, name and description.
324 def findgpx(searchterm, usertoken)
325 uid = getuserid(usertoken)
326 if !uid then return -1,"You must be logged in to search for GPX traces." end
329 if searchterm.to_i>0 then
330 gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,uid] )
332 gpxs.push([gpx.id, gpx.name, gpx.description])
335 Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,uid,searchterm] ).each do |gpx|
336 gpxs.push([gpx.id, gpx.name, gpx.description])
342 # Get a relation with all tags and members.
346 # 2. list of members,
349 def getrelation(relid) #:doc:
351 rel = Relation.find(relid)
352 rescue ActiveRecord::RecordNotFound
353 return [relid, {}, []]
356 return [relid, {}, [], nil] if rel.nil? or !rel.visible
357 [relid, rel.tags, rel.members, rel.version]
360 # Find relations with specified name/id.
361 # Returns array of relations, each in same form as getrelation.
363 def findrelations(searchterm)
365 if searchterm.to_i>0 then
366 rel = Relation.find(searchterm.to_i)
367 if rel and rel.visible then
368 rels.push([rel.id, rel.tags, rel.members])
371 RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
372 if t.relation.visible then
373 rels.push([t.relation.id, t.relation.tags, t.relation.members])
383 # 1. original relation id (unchanged),
384 # 2. new relation id.
386 def putrelation(renumberednodes, renumberedways, usertoken, changeset, relid, tags, members, visible) #:doc:
387 uid = getuserid(usertoken)
388 if !uid then return -1,"You are not logged in, so the relation could not be saved." end
391 visible = (visible.to_i != 0)
393 # create a new relation, or find the existing one
398 rel = Relation.find(relid)
401 # check the members are all positive, and correctly type
406 mid = renumberednodes[mid] if m[0] == 'node'
407 mid = renumberedways[mid] if m[0] == 'way'
410 typedmembers << [m[0], mid, m[2]]
414 # assign new contents
415 rel.members = typedmembers
417 rel.visible = visible
418 rel.changeset_id = changeset
420 # check it then save it
421 # BUG: the following is commented out because it always fails on my
422 # install. I think it's a Rails bug.
424 #if !rel.preconditions_ok?
425 # return -2, "Relation preconditions failed"
427 rel.save_with_history!
433 # Save a way to the database, including all nodes. Any nodes in the previous
434 # version and no longer used are deleted.
437 # 0. '0' (code for success),
438 # 1. original way id (unchanged),
440 # 3. hash of renumbered nodes (old id=>new id),
443 def putway(renumberednodes, usertoken, changeset, originalway, points, attributes) #:doc:
445 # -- Initialise and carry out checks
447 uid = getuserid(usertoken)
448 if !uid then return -1,"You are not logged in, so the way could not be saved." end
450 originalway = originalway.to_i
453 if a[2] == 0 or a[2].nil? then return -2,"Server error - node with id 0 found in way #{originalway}." end
454 if a[1] == 90 then return -2,"Server error - node with lat -90 found in way #{originalway}." end
457 if points.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
459 # -- Get unique nodes
463 way.version = 0 # otherwise +=1 breaks
466 way = Way.find(originalway)
467 uniques = way.unshared_node_ids
470 # -- Compare nodes and save changes to any that have changed
480 if renumberednodes[id]
481 id = renumberednodes[id]
485 node.version = 0 # otherwise +=1 breaks
490 nodetags.delete('created_by')
491 if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or
492 n[4] != nodetags or !node.visible?
498 node.changeset_id = changeset
503 node.save_with_history!
506 renumberednodes[id] = node.id
511 uniques = uniques - [id]
515 # -- Delete any unique nodes
518 deleteitemrelations(n, 'node')
521 node.changeset_id = changeset
523 node.save_with_history!
526 # -- Save revised way
528 if way.tags!=attributes or way.nds!=nodes or !way.visible?
529 way.tags = attributes
531 way.changeset_id = changeset
533 way.save_with_history!
536 [0, originalway, way.id, renumberednodes, way.version]
539 # Save POI to the database.
540 # Refuses save if the node has since become part of a way.
543 # 1. original node id (unchanged),
547 def putpoi(usertoken, changeset, id, lon, lat, tags, visible) #:doc:
548 uid = getuserid(usertoken)
549 if !uid then return -1,"You are not logged in, so the point could not be saved." end
552 visible = (visible.to_i == 1)
558 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
559 deleteitemrelations(id, 'node')
566 node.changeset_id = changeset
570 node.visible = visible
571 node.save_with_history!
573 [0, id, node.id, node.version]
576 # Read POI from database
577 # (only called on revert: POIs are usually read by whichways).
579 # Returns array of id, long, lat, hash of tags, version.
581 def getpoi(id,version) #:doc:
583 n = OldNode.find(id, :conditions=>['version=?',version])
589 return [n.id, n.lon, n.lat, n.tags, n.version]
591 return [nil, nil, nil, {}, nil]
595 # Delete way and all constituent nodes. Also removes from any relations.
596 # Returns 0 (success), unchanged way id.
598 def deleteway(usertoken, changeset_id, way_id) #:doc:
599 if !getuserid(usertoken) then return -1,"You are not logged in, so the way could not be deleted." end
603 # FIXME: would be good not to make two history entries when removing
604 # two nodes from the same relation
605 way = Way.find(way_id)
606 way.unshared_node_ids.each do |n|
607 deleteitemrelations(n, 'node')
609 deleteitemrelations(way_id, 'way')
611 way.delete_with_relations_and_nodes_and_history(changeset_id.to_i)
617 # ====================================================================
620 # Remove a node or way from all relations
622 def deleteitemrelations(objid, type) #:doc:
623 relations = RelationMember.find(:all,
624 :conditions => ['member_type = ? and member_id = ?', type, objid],
625 :include => :relation).collect { |rm| rm.relation }.uniq
627 relations.each do |rel|
628 rel.members.delete_if { |x| x[0] == type and x[1] == objid }
629 rel.save_with_history!
633 # Break out node tags into a hash
634 # (should become obsolete as of API 0.6)
636 def tagstring_to_hash(a) #:doc:
638 Tags.split(a) do |k, v|
645 # (can also be of form user:pass)
647 def getuserid(token) #:doc:
648 if (token =~ /^(.+)\:(.+)$/) then
649 user = User.authenticate(:username => $1, :password => $2)
651 user = User.authenticate(:token => token)
654 return user ? user.id : nil;
657 # Compare two floating-point numbers to within 0.0000001
659 def fpcomp(a,b) #:doc:
660 return ((a/0.0000001).round==(b/0.0000001).round)
665 def sendresponse(results)
666 a,b=results.length.divmod(256)
667 render :content_type => "application/x-amf", :text => proc { |response, output|
668 # ** move amf writing loop into here -
669 # basically we read the messages in first (into an array of some sort),
670 # then iterate through that array within here, and do all the AMF writing
671 output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
672 results.each do |k,v|
679 # ====================================================================
680 # Alternative SQL queries for getway/whichways
682 def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
684 SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
685 FROM current_way_nodes
686 INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
687 INNER JOIN current_ways ON current_ways.id =current_way_nodes.id
688 WHERE current_nodes.visible=TRUE
689 AND current_ways.visible=TRUE
690 AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
692 return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
695 def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
698 SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version
700 LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id
701 WHERE current_nodes.visible=TRUE
703 AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
705 ActiveRecord::Base.connection.select_all(sql).each do |row|
707 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
708 poitags[n['k']]=n['v']
710 pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
715 def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
716 # ** It would be more Potlatchy to get relations for nodes within ways
717 # during 'getway', not here
719 SELECT DISTINCT cr.id AS relid,cr.version AS version
720 FROM current_relations cr
721 INNER JOIN current_relation_members crm ON crm.id=cr.id
722 INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node'
723 WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
725 unless way_ids.empty?
728 SELECT DISTINCT cr.id AS relid,cr.version AS version
729 FROM current_relations cr
730 INNER JOIN current_relation_members crm ON crm.id=cr.id
731 WHERE crm.member_type='way'
732 AND crm.member_id IN (#{way_ids.join(',')})
735 return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
738 def sql_get_nodes_in_way(wayid)
741 SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id
742 FROM current_way_nodes,current_nodes
743 WHERE current_way_nodes.id=#{wayid.to_i}
744 AND current_way_nodes.node_id=current_nodes.id
745 AND current_nodes.visible=TRUE
748 ActiveRecord::Base.connection.select_all(sql).each do |row|
750 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
751 nodetags[n['k']]=n['v']
753 nodetags.delete('created_by')
754 points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
759 def sql_get_tags_in_way(wayid)
761 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
762 tags[row['k']]=row['v']
767 def sql_get_way_version(wayid)
768 ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")
773 # indent-tabs-mode: t