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.rb
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)
115 if r[1] != r[2] then renumberedways[r[1]] = r[2] end
116 results[index]=AMF.putdata(index,r)
117 when 'putrelation'; results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args))
118 when 'deleteway'; results[index]=AMF.putdata(index,deleteway(*args))
119 when 'putpoi'; r=putpoi(*args)
120 if r[1] != r[2] then renumberednodes[r[1]] = r[2] end
121 results[index]=AMF.putdata(index,r)
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 user = getuserid(usertoken)
134 if !user 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
138 cs = Changeset.find(closeid)
139 cs.set_closed_time_now
140 if closecomment.empty?
143 cs.tags['comment']=closecomment
148 # open a new changeset
152 # Don't like the next two lines. These need to be abstracted to the model more/better
153 cs.created_at = Time.now
154 cs.closed_at = Time.new + Changeset::IDLE_TIMEOUT
159 # Return presets (default tags, localisation etc.):
160 # uses POTLATCH_PRESETS global, set up in OSM::Potlatch.
162 def getpresets() #:doc:
163 return POTLATCH_PRESETS
166 # Find all the ways, POI nodes (i.e. not part of ways), and relations
167 # in a given bounding box. Nodes are returned in full; ways and relations
170 def whichways(xmin, ymin, xmax, ymax) #:doc:
171 xmin -= 0.01; ymin -= 0.01
172 xmax += 0.01; ymax += 0.01
174 # check boundary is sane and area within defined
175 # see /config/application.yml
177 check_boundaries(xmin, ymin, xmax, ymax)
178 rescue Exception => err
179 return [-2,"Sorry - I can't get the map for that area."]
182 if POTLATCH_USE_SQL then
183 ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
184 points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
185 relations = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, ways.collect {|x| x[0]})
187 # find the way ids in an area
188 nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways)
189 ways = nodes_in_area.collect { |node|
190 node.ways.collect { |w| [w.id,w.version] }.flatten
194 # find the node ids in an area that aren't part of ways
195 nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
196 points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags] }
198 # find the relations used by those nodes and ways
199 relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) +
200 Relation.find_for_ways(ways.collect { |w| w[0] }, :conditions => {:visible => true})
201 relations = relations.collect { |relation| [relation.id,relation.version] }.uniq
204 [0,ways, points, relations]
207 # Find deleted ways in current bounding box (similar to whichways, but ways
208 # with a deleted node only - not POIs or relations).
210 def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
211 xmin -= 0.01; ymin -= 0.01
212 xmax += 0.01; ymax += 0.01
214 # check boundary is sane and area within defined
215 # see /config/application.yml
217 check_boundaries(xmin, ymin, xmax, ymax)
218 rescue Exception => err
219 return [-2,"Sorry - I can't get the map for that area."]
222 nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history)
223 way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
228 # Get a way including nodes and tags.
229 # Returns the way id, a Potlatch-style array of points, a hash of tags, and the version number.
231 def getway(wayid) #:doc:
232 if POTLATCH_USE_SQL then
233 points = sql_get_nodes_in_way(wayid)
234 tags = sql_get_tags_in_way(wayid)
235 version = sql_get_way_version(wayid)
237 # Ideally we would do ":include => :nodes" here but if we do that
238 # then rails only seems to return the first copy of a node when a
239 # way includes a node more than once
241 way = Way.find(wayid)
242 rescue ActiveRecord::RecordNotFound
246 # check case where way has been deleted or doesn't exist
247 return [wayid,[],{}] if way.nil? or !way.visible
249 points = way.nodes.collect do |node|
251 nodetags.delete('created_by')
252 [node.lon, node.lat, node.id, nodetags]
255 version = way.version
258 [wayid, points, tags, version]
261 # Get an old version of a way, and all constituent nodes.
263 # For undelete (version<0), always uses the most recent version of each node,
264 # even if it's moved. For revert (version >= 0), uses the node in existence
265 # at the time, generating a new id if it's still visible and has been moved/
271 # 2. array of points,
274 # 5. is this the current, visible version? (boolean)
276 def getway_old(id, version) #:doc:
278 old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC')
279 points = old_way.get_nodes_undelete unless old_way.nil?
281 old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version])
282 points = old_way.get_nodes_revert unless old_way.nil?
286 return [-1, id, [], {}, -1,0]
289 old_way.tags['history'] = "Retrieved from v#{old_way.version}"
290 return [0, id, points, old_way.tags, old_way.version, (curway.version==old_way.version and curway.visible)]
294 # Find history of a way. Returns 'way', id, and
295 # an array of previous versions.
297 def getway_history(wayid) #:doc:
299 history = Way.find(wayid).old_ways.reverse.collect do |old_way|
300 user_object = old_way.changeset.user
301 user = user_object.data_public? ? user_object.display_name : 'anonymous'
302 uid = user_object.data_public? ? user_object.id : 0
303 [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
306 return ['way',wayid,history]
307 rescue ActiveRecord::RecordNotFound
308 return ['way', wayid, []]
312 # Find history of a node. Returns 'node', id, and
313 # an array of previous versions.
315 def getnode_history(nodeid) #:doc:
317 history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
318 user_object = old_node.changeset.user
319 user = user_object.data_public? ? user_object.display_name : 'anonymous'
320 uid = user_object.data_public? ? user_object.id : 0
321 [old_node.version, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
324 return ['node',nodeid,history]
325 rescue ActiveRecord::RecordNotFound
326 return ['node', nodeid, []]
330 # Find GPS traces with specified name/id.
331 # Returns array listing GPXs, each one comprising id, name and description.
333 def findgpx(searchterm, usertoken)
334 uid = getuserid(usertoken)
335 if !uid then return -1,"You must be logged in to search for GPX traces." end
338 if searchterm.to_i>0 then
339 gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,uid] )
341 gpxs.push([gpx.id, gpx.name, gpx.description])
344 Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,uid,searchterm] ).each do |gpx|
345 gpxs.push([gpx.id, gpx.name, gpx.description])
351 # Get a relation with all tags and members.
355 # 2. list of members,
358 def getrelation(relid) #:doc:
360 rel = Relation.find(relid)
361 rescue ActiveRecord::RecordNotFound
362 return [relid, {}, []]
365 return [relid, {}, [], nil] if rel.nil? or !rel.visible
366 [relid, rel.tags, rel.members, rel.version]
369 # Find relations with specified name/id.
370 # Returns array of relations, each in same form as getrelation.
372 def findrelations(searchterm)
374 if searchterm.to_i>0 then
375 rel = Relation.find(searchterm.to_i)
376 if rel and rel.visible then
377 rels.push([rel.id, rel.tags, rel.members])
380 RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
381 if t.relation.visible then
382 rels.push([t.relation.id, t.relation.tags, t.relation.members])
392 # 1. original relation id (unchanged),
393 # 2. new relation id.
395 def putrelation(renumberednodes, renumberedways, usertoken, changeset, version, relid, tags, members, visible) #:doc:
396 user = getuserid(usertoken)
397 if !user then return -1,"You are not logged in, so the relation could not be saved." end
400 visible = (visible.to_i != 0)
402 # create a new relation, or find the existing one
404 relation = Relation.find(relid)
406 # We always need a new node, based on the data that has been sent to us
407 new_relation = Relation.new
409 # check the members are all positive, and correctly type
414 mid = renumberednodes[mid] if m[0] == 'node'
415 mid = renumberedways[mid] if m[0] == 'way'
418 typedmembers << [m[0], mid, m[2]]
422 # assign new contents
423 new_relation.members = typedmembers
424 new_relation.tags = tags
425 new_relation.visible = visible
426 new_relation.changeset_id = changeset
427 new_relation.version = version
431 # We're creating the node
432 new_relation.create_with_history(user)
434 # We're updating the node
435 relation.update_from(new_relation, user)
437 # We're deleting the node
438 relation.delete_with_history!(new_relation, user)
442 return [0, relid, new_relation.id, new_relation.version]
444 return [0, relid, relation.id, relation.version]
446 rescue OSM::APIChangesetAlreadyClosedError => ex
447 return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
448 rescue OSM::APIVersionMismatchError => ex
449 return [-1, "You have taken too long to edit, please reload the area"]
450 rescue OSM::APIAlreadyDeletedError => ex
451 return [-1, "The object has already been deleted"]
452 rescue OSM::APIError => ex
453 # Some error that we don't specifically catch
454 return [-2, "Something really bad happened :-()"]
457 # Save a way to the database, including all nodes. Any nodes in the previous
458 # version and no longer used are deleted.
461 # 0. '0' (code for success),
462 # 1. original way id (unchanged),
464 # 3. hash of renumbered nodes (old id=>new id),
467 def putway(renumberednodes, usertoken, changeset, originalway, points, attributes) #:doc:
469 # -- Initialise and carry out checks
471 user = getuser(usertoken)
472 if !user then return -1,"You are not logged in, so the way could not be saved." end
474 originalway = originalway.to_i
477 if a[2] == 0 or a[2].nil? then return -2,"Server error - node with id 0 found in way #{originalway}." end
478 if a[1] == 90 then return -2,"Server error - node with lat -90 found in way #{originalway}." end
481 if points.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
483 # -- Get unique nodes
488 way = Way.find(originalway)
489 uniques = way.unshared_node_ids
493 # -- Compare nodes and save changes to any that have changed
501 version = n[3].to_i # FIXME which index does the version come in on????
503 # We always need a new node if we are saving it
507 if renumberednodes[id]
508 id = renumberednodes[id]
514 # Don't modify this node, make any changes you want to the new_node above
517 nodetags.delete('created_by')
518 if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or
519 n[4] != nodetags or !node.visible?
525 new_node.changeset_id = changeset
529 new_node.visible = true
530 new_node.version = version
532 # We're creating the node
533 new_node.create_with_history(user)
535 # We're updating the node (no delete here)
536 node.update_from(new_node, user)
540 renumberednodes[id] = node.id
545 uniques = uniques - [id]
549 # -- Delete any unique nodes
552 deleteitemrelations(n, 'node')
556 new_node.changeset_id = changeset
557 new_node.version = version
558 node.delete_with_history!(new_node, user)
561 # -- Save revised way
563 if way.tags!=attributes or way.nds!=nodes or !way.visible?
565 new_way.tags = attributes
567 new_way.changeset_id = changeset
568 new_way.version = version
569 way.update_from(new_way, user)
572 [0, originalway, way.id, renumberednodes, way.version]
575 # Save POI to the database.
576 # Refuses save if the node has since become part of a way.
577 # Returns array with:
579 # 1. original node id (unchanged),
583 def putpoi(usertoken, changeset, version, id, lon, lat, tags, visible) #:doc:
584 user = getuser(usertoken)
585 if !user then return -1,"You are not logged in, so the point could not be saved." end
588 visible = (visible.to_i == 1)
594 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
595 deleteitemrelations(id, 'node')
598 # We always need a new node, based on the data that has been sent to us
602 new_node.changeset_id = changeset
603 new_node.version = version
607 new_node.visible = visible
609 # We're creating the node
610 new_node.create_with_history(user)
612 # We're updating the node
613 node.update_from(new_node, user)
615 # We're deleting the node
616 node.delete_with_history!(new_node, user)
620 return [0, id, new_node.id, new_node.version]
622 return [0, id, node.id, node.version]
626 # Read POI from database
627 # (only called on revert: POIs are usually read by whichways).
629 # Returns array of id, long, lat, hash of tags, version.
631 def getpoi(id,version) #:doc:
633 n = OldNode.find(id, :conditions=>['version=?',version])
639 return [n.id, n.lon, n.lat, n.tags, n.version]
641 return [nil, nil, nil, {}, nil]
645 # Delete way and all constituent nodes. Also removes from any relations.
646 # Returns 0 (success), unchanged way id.
648 def deleteway(usertoken, changeset_id, way_id) #:doc:
649 if !getuserid(usertoken) then return -1,"You are not logged in, so the way could not be deleted." end
653 # FIXME: would be good not to make two history entries when removing
654 # two nodes from the same relation
655 way = Way.find(way_id)
656 way.unshared_node_ids.each do |n|
657 deleteitemrelations(n, 'node')
659 deleteitemrelations(way_id, 'way')
661 way.delete_with_relations_and_nodes_and_history(changeset_id.to_i)
667 # ====================================================================
670 # Remove a node or way from all relations
672 def deleteitemrelations(objid, type) #:doc:
673 relations = RelationMember.find(:all,
674 :conditions => ['member_type = ? and member_id = ?', type, objid],
675 :include => :relation).collect { |rm| rm.relation }.uniq
677 relations.each do |rel|
678 rel.members.delete_if { |x| x[0] == type and x[1] == objid }
679 rel.save_with_history!
683 # Break out node tags into a hash
684 # (should become obsolete as of API 0.6)
686 def tagstring_to_hash(a) #:doc:
688 Tags.split(a) do |k, v|
695 # (can also be of form user:pass)
696 # When we are writing to the api, we need the actual user model,
697 # not just the id, hence this abstraction
699 def getuser(token) #:doc:
700 if (token =~ /^(.+)\:(.+)$/) then
701 user = User.authenticate(:username => $1, :password => $2)
703 user = User.authenticate(:token => token)
709 user = getuser(token)
710 return user ? user.id : nil;
713 # Compare two floating-point numbers to within 0.0000001
715 def fpcomp(a,b) #:doc:
716 return ((a/0.0000001).round==(b/0.0000001).round)
721 def sendresponse(results)
722 a,b=results.length.divmod(256)
723 render :content_type => "application/x-amf", :text => proc { |response, output|
724 # ** move amf writing loop into here -
725 # basically we read the messages in first (into an array of some sort),
726 # then iterate through that array within here, and do all the AMF writing
727 output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
728 results.each do |k,v|
735 # ====================================================================
736 # Alternative SQL queries for getway/whichways
738 def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
740 SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
741 FROM current_way_nodes
742 INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
743 INNER JOIN current_ways ON current_ways.id =current_way_nodes.id
744 WHERE current_nodes.visible=TRUE
745 AND current_ways.visible=TRUE
746 AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
748 return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
751 def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
754 SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version
756 LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id
757 WHERE current_nodes.visible=TRUE
759 AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
761 ActiveRecord::Base.connection.select_all(sql).each do |row|
763 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
764 poitags[n['k']]=n['v']
766 pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
771 def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
772 # ** It would be more Potlatchy to get relations for nodes within ways
773 # during 'getway', not here
775 SELECT DISTINCT cr.id AS relid,cr.version AS version
776 FROM current_relations cr
777 INNER JOIN current_relation_members crm ON crm.id=cr.id
778 INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node'
779 WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
781 unless way_ids.empty?
784 SELECT DISTINCT cr.id AS relid,cr.version AS version
785 FROM current_relations cr
786 INNER JOIN current_relation_members crm ON crm.id=cr.id
787 WHERE crm.member_type='way'
788 AND crm.member_id IN (#{way_ids.join(',')})
791 return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
794 def sql_get_nodes_in_way(wayid)
797 SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id
798 FROM current_way_nodes,current_nodes
799 WHERE current_way_nodes.id=#{wayid.to_i}
800 AND current_way_nodes.node_id=current_nodes.id
801 AND current_nodes.visible=TRUE
804 ActiveRecord::Base.connection.select_all(sql).each do |row|
806 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
807 nodetags[n['k']]=n['v']
809 nodetags.delete('created_by')
810 points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
815 def sql_get_tags_in_way(wayid)
817 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
818 tags[row['k']]=row['v']
823 def sql_get_way_version(wayid)
824 ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")