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 # Any method that returns a status code (0 for ok) can also send:
21 # return(-1,"message") <-- just puts up a dialogue
22 # return(-2,"message") <-- also asks the user to e-mail me
24 # To write to the Rails log, use RAILS_DEFAULT_LOGGER.info("message").
26 class AmfController < ApplicationController
31 # Help methods for checking boundary sanity and area size
35 before_filter :check_write_availability
37 # Main AMF handlers: process the raw AMF string (using AMF library) and
38 # calls each action (private method) accordingly.
39 # ** FIXME: refactor to reduce duplication of code across read/write
42 req=StringIO.new(request.raw_post+0.chr)# Get POST data as request
43 # (cf http://www.ruby-forum.com/topic/122163)
44 req.read(2) # Skip version indicator and client ID
45 results={} # Results of each body
49 headers=AMF.getint(req) # Read number of headers
51 headers.times do # Read each header
52 name=AMF.getstring(req) # |
53 req.getc # | skip boolean
54 value=AMF.getvalue(req) # |
55 header["name"]=value # |
58 bodies=AMF.getint(req) # Read number of bodies
59 bodies.times do # Read each body
60 message=AMF.getstring(req) # | get message name
61 index=AMF.getstring(req) # | get index in response sequence
62 bytes=AMF.getlong(req) # | get total size in bytes
63 args=AMF.getvalue(req) # | get response (probably an array)
64 logger.info "Executing AMF #{message}:#{index}"
67 when 'getpresets'; results[index]=AMF.putdata(index,getpresets())
68 when 'whichways'; results[index]=AMF.putdata(index,whichways(*args))
69 when 'whichways_deleted'; results[index]=AMF.putdata(index,whichways_deleted(*args))
70 when 'getway'; results[index]=AMF.putdata(index,getway(args[0].to_i))
71 when 'getrelation'; results[index]=AMF.putdata(index,getrelation(args[0].to_i))
72 when 'getway_old'; results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1].to_i))
73 when 'getway_history'; results[index]=AMF.putdata(index,getway_history(args[0].to_i))
74 when 'getnode_history'; results[index]=AMF.putdata(index,getnode_history(args[0].to_i))
75 when 'findrelations'; results[index]=AMF.putdata(index,findrelations(*args))
76 when 'getpoi'; results[index]=AMF.putdata(index,getpoi(*args))
79 logger.info("encoding AMF results")
84 req=StringIO.new(request.raw_post+0.chr)
87 renumberednodes={} # Shared across repeated putways
88 renumberedways={} # Shared across repeated putways
90 headers=AMF.getint(req) # Read number of headers
91 headers.times do # Read each header
92 name=AMF.getstring(req) # |
93 req.getc # | skip boolean
94 value=AMF.getvalue(req) # |
95 header["name"]=value # |
98 bodies=AMF.getint(req) # Read number of bodies
99 bodies.times do # Read each body
100 message=AMF.getstring(req) # | get message name
101 index=AMF.getstring(req) # | get index in response sequence
102 bytes=AMF.getlong(req) # | get total size in bytes
103 args=AMF.getvalue(req) # | get response (probably an array)
106 when 'putway'; r=putway(renumberednodes,*args)
109 renumberedways[r[1]] = r[2]
111 results[index]=AMF.putdata(index,r)
112 when 'putrelation'; results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args))
113 when 'deleteway'; results[index]=AMF.putdata(index,deleteway(*args))
114 when 'putpoi'; results[index]=AMF.putdata(index,putpoi(*args))
115 when 'startchangeset'; results[index]=AMF.putdata(index,startchangeset(*args))
118 sendresponse(results)
123 # Start new changeset
125 def startchangeset(usertoken, cstags, closeid, closecomment)
126 uid = getuserid(usertoken)
127 if !uid then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end
129 # close previous changeset and add comment
133 # open a new changeset
137 cs.created_at = Time.now
142 # Return presets (default tags, localisation etc.):
143 # uses POTLATCH_PRESETS global, set up in OSM::Potlatch.
145 def getpresets() #:doc:
146 return POTLATCH_PRESETS
149 # Find all the ways, POI nodes (i.e. not part of ways), and relations
150 # in a given bounding box. Nodes are returned in full; ways and relations
153 def whichways(xmin, ymin, xmax, ymax) #:doc:
154 xmin -= 0.01; ymin -= 0.01
155 xmax += 0.01; ymax += 0.01
157 # check boundary is sane and area within defined
158 # see /config/application.yml
160 check_boundaries(xmin, ymin, xmax, ymax)
161 rescue Exception => err
162 # FIXME: report an error rather than just return an empty result
166 if POTLATCH_USE_SQL then
167 ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
168 points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
169 relation_ids = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, ways.collect {|x| x[0]})
171 # find the way ids in an area
172 nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways) # ** include causes problems
173 way_ids = nodes_in_area.collect { |node| node.way_ids }.flatten.uniq
176 # find the node ids in an area that aren't part of ways
177 nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
178 points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags] }
180 # find the relations used by those nodes and ways
181 relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) +
182 Relation.find_for_ways(way_ids, :conditions => {:visible => true})
183 relation_ids = relations.collect { |relation| relation.id }.uniq
186 [ways, points, relation_ids]
189 # Find deleted ways in current bounding box (similar to whichways, but ways
190 # with a deleted node only - not POIs or relations).
192 def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
193 xmin -= 0.01; ymin -= 0.01
194 xmax += 0.01; ymax += 0.01
196 # check boundary is sane and area within defined
197 # see /config/application.yml
199 check_boundaries(xmin, ymin, xmax, ymax)
200 rescue Exception => err
201 # FIXME: report an error rather than just return an empty result
205 nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history)
206 way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
211 # Get a way including nodes and tags.
212 # Returns the way id, a Potlatch-style array of points, a hash of tags, and the version number.
214 def getway(wayid) #:doc:
215 if POTLATCH_USE_SQL then
216 points = sql_get_nodes_in_way(wayid)
217 tags = sql_get_tags_in_way(wayid)
218 version = sql_get_way_version(wayid)
220 # Ideally we would do ":include => :nodes" here but if we do that
221 # then rails only seems to return the first copy of a node when a
222 # way includes a node more than once
224 way = Way.find(wayid)
225 rescue ActiveRecord::RecordNotFound
229 # check case where way has been deleted or doesn't exist
230 return [wayid,[],{}] if way.nil? or !way.visible
232 points = way.nodes.collect do |node|
234 nodetags.delete('created_by')
235 [node.lon, node.lat, node.id, nodetags]
238 version = way.version
241 [wayid, points, tags, version]
244 # Get an old version of a way, and all constituent nodes.
246 # For undelete (version<0), always uses the most recent version of each node,
247 # even if it's moved. For revert (version >= 0), uses the node in existence
248 # at the time, generating a new id if it's still visible and has been moved/
254 # 2. array of points,
257 # 5. is this the current, visible version? (boolean)
259 def getway_old(id, version) #:doc:
261 old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC')
262 points = old_way.get_nodes_undelete unless old_way.nil?
264 old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version])
265 points = old_way.get_nodes_revert unless old_way.nil?
269 return [-1, id, [], {}, -1,0]
272 old_way.tags['history'] = "Retrieved from v#{old_way.version}"
273 return [0, id, points, old_way.tags, old_way.version, (curway.version==old_way.version and curway.visible)]
277 # Find history of a way. Returns 'way', id, and
278 # an array of previous versions.
280 def getway_history(wayid) #:doc:
282 history = Way.find(wayid).old_ways.reverse.collect do |old_way|
283 user_object = old_way.changeset.user
284 user = user_object.data_public? ? user_object.display_name : 'anonymous'
285 uid = user_object.data_public? ? user_object.id : 0
286 [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
289 return ['way',wayid,history]
290 rescue ActiveRecord::RecordNotFound
291 return ['way', wayid, []]
295 # Find history of a node. Returns 'node', id, and
296 # an array of previous versions.
298 def getnode_history(nodeid) #:doc:
300 history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
301 user_object = old_node.changeset.user
302 user = user_object.data_public? ? user_object.display_name : 'anonymous'
303 uid = user_object.data_public? ? user_object.id : 0
304 [old_node.version, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
307 return ['node',nodeid,history]
308 rescue ActiveRecord::RecordNotFound
309 return ['node', nodeid, []]
313 # Get a relation with all tags and members.
317 # 2. list of members,
320 def getrelation(relid) #:doc:
322 rel = Relation.find(relid)
323 rescue ActiveRecord::RecordNotFound
324 return [relid, {}, []]
327 return [relid, {}, [], nil] if rel.nil? or !rel.visible
328 [relid, rel.tags, rel.members, rel.version]
331 # Find relations with specified name/id.
332 # Returns array of relations, each in same form as getrelation.
334 def findrelations(searchterm)
336 if searchterm.to_i>0 then
337 rel = Relation.find(searchterm.to_i)
338 if rel and rel.visible then
339 rels.push([rel.id, rel.tags, rel.members])
342 RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
343 if t.relation.visible then
344 rels.push([t.relation.id, t.relation.tags, t.relation.members])
354 # 1. original relation id (unchanged),
355 # 2. new relation id.
357 def putrelation(renumberednodes, renumberedways, usertoken, changeset, relid, tags, members, visible) #:doc:
358 uid = getuserid(usertoken)
359 if !uid then return -1,"You are not logged in, so the relation could not be saved." end
362 visible = (visible.to_i != 0)
364 # create a new relation, or find the existing one
369 rel = Relation.find(relid)
372 # check the members are all positive, and correctly type
377 mid = renumberednodes[mid] if m[0] == 'node'
378 mid = renumberedways[mid] if m[0] == 'way'
381 typedmembers << [m[0], mid, m[2]]
385 # assign new contents
386 rel.members = typedmembers
388 rel.visible = visible
389 rel.changeset_id = changeset
391 # check it then save it
392 # BUG: the following is commented out because it always fails on my
393 # install. I think it's a Rails bug.
395 #if !rel.preconditions_ok?
396 # return -2, "Relation preconditions failed"
398 rel.save_with_history!
404 # Save a way to the database, including all nodes. Any nodes in the previous
405 # version and no longer used are deleted.
408 # 0. '0' (code for success),
409 # 1. original way id (unchanged),
411 # 3. hash of renumbered nodes (old id=>new id),
414 def putway(renumberednodes, usertoken, changeset, originalway, points, attributes) #:doc:
416 # -- Initialise and carry out checks
418 uid = getuserid(usertoken)
419 if !uid then return -1,"You are not logged in, so the way could not be saved." end
421 originalway = originalway.to_i
424 if a[2] == 0 or a[2].nil? then return -2,"Server error - node with id 0 found in way #{originalway}." end
425 if a[1] == 90 then return -2,"Server error - node with lat -90 found in way #{originalway}." end
428 if points.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
430 # -- Get unique nodes
434 way.version = 0 # otherwise +=1 breaks
437 way = Way.find(originalway)
438 uniques = way.unshared_node_ids
441 # -- Compare nodes and save changes to any that have changed
451 if renumberednodes[id]
452 id = renumberednodes[id]
456 node.version = 0 # otherwise +=1 breaks
461 nodetags.delete('created_by')
462 if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or
463 n[4] != nodetags or !node.visible?
469 node.changeset_id = changeset
474 node.save_with_history!
477 renumberednodes[id] = node.id
482 uniques = uniques - [id]
486 # -- Delete any unique nodes
489 deleteitemrelations(n, 'node')
492 node.changeset_id = changeset
494 node.save_with_history!
497 # -- Save revised way
499 if way.tags!=attributes or way.nds!=nodes or !way.visible?
500 way.tags = attributes
502 way.changeset_id = changeset
504 way.save_with_history!
507 [0, originalway, way.id, renumberednodes, way.version]
510 # Save POI to the database.
511 # Refuses save if the node has since become part of a way.
514 # 1. original node id (unchanged),
518 def putpoi(usertoken, changeset, id, lon, lat, tags, visible) #:doc:
519 uid = getuserid(usertoken)
520 if !uid then return -1,"You are not logged in, so the point could not be saved." end
523 visible = (visible.to_i == 1)
529 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
530 deleteitemrelations(id, 'node')
537 node.changeset_id = changeset
541 node.visible = visible
542 node.save_with_history!
544 [0, id, node.id, node.version]
547 # Read POI from database
548 # (only called on revert: POIs are usually read by whichways).
550 # Returns array of id, long, lat, hash of tags, version.
552 def getpoi(id,version) #:doc:
554 n = OldNode.find(id, :conditions=>['version=?',version])
560 return [n.id, n.lon, n.lat, n.tags, n.version]
562 return [nil, nil, nil, {}, nil]
566 # Delete way and all constituent nodes. Also removes from any relations.
567 # Returns 0 (success), unchanged way id.
569 def deleteway(usertoken, changeset_id, way_id) #:doc:
570 if !getuserid(usertoken) then return -1,"You are not logged in, so the way could not be deleted." end
574 # FIXME: would be good not to make two history entries when removing
575 # two nodes from the same relation
576 way = Way.find(way_id)
577 way.unshared_node_ids.each do |n|
578 deleteitemrelations(n, 'node')
580 deleteitemrelations(way_id, 'way')
582 way.delete_with_relations_and_nodes_and_history(changeset_id.to_i)
588 # ====================================================================
591 # Remove a node or way from all relations
593 def deleteitemrelations(objid, type) #:doc:
594 relations = RelationMember.find(:all,
595 :conditions => ['member_type = ? and member_id = ?', type, objid],
596 :include => :relation).collect { |rm| rm.relation }.uniq
598 relations.each do |rel|
599 rel.members.delete_if { |x| x[0] == type and x[1] == objid }
600 rel.save_with_history!
604 # Break out node tags into a hash
605 # (should become obsolete as of API 0.6)
607 def tagstring_to_hash(a) #:doc:
609 Tags.split(a) do |k, v|
616 # (could be removed if no-one uses the username+password form)
618 def getuserid(token) #:doc:
619 if (token =~ /^(.+)\+(.+)$/) then
620 user = User.authenticate(:username => $1, :password => $2)
622 user = User.authenticate(:token => token)
625 return user ? user.id : nil;
628 # Compare two floating-point numbers to within 0.0000001
630 def fpcomp(a,b) #:doc:
631 return ((a/0.0000001).round==(b/0.0000001).round)
636 def sendresponse(results)
637 a,b=results.length.divmod(256)
638 render :content_type => "application/x-amf", :text => proc { |response, output|
639 # ** move amf writing loop into here -
640 # basically we read the messages in first (into an array of some sort),
641 # then iterate through that array within here, and do all the AMF writing
642 output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
643 results.each do |k,v|
650 # ====================================================================
651 # Alternative SQL queries for getway/whichways
653 def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
655 SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
656 FROM current_way_nodes
657 INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
658 INNER JOIN current_ways ON current_ways.id =current_way_nodes.id
659 WHERE current_nodes.visible=TRUE
660 AND current_ways.visible=TRUE
661 AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
663 return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
666 def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
669 SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version
671 LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id
672 WHERE current_nodes.visible=TRUE
674 AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
676 ActiveRecord::Base.connection.select_all(sql).each do |row|
678 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
679 poitags[n['k']]=n['v']
681 pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
686 def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
687 # ** It would be more Potlatchy to get relations for nodes within ways
688 # during 'getway', not here
690 SELECT DISTINCT cr.id AS relid,cr.version AS version
691 FROM current_relations cr
692 INNER JOIN current_relation_members crm ON crm.id=cr.id
693 INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node'
694 WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
696 unless way_ids.empty?
699 SELECT DISTINCT cr.id AS relid,cr.version AS version
700 FROM current_relations cr
701 INNER JOIN current_relation_members crm ON crm.id=cr.id
702 WHERE crm.member_type='way'
703 AND crm.member_id IN (#{way_ids.join(',')})
706 return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
709 def sql_get_nodes_in_way(wayid)
712 SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id
713 FROM current_way_nodes,current_nodes
714 WHERE current_way_nodes.id=#{wayid.to_i}
715 AND current_way_nodes.node_id=current_nodes.id
716 AND current_nodes.visible=TRUE
719 ActiveRecord::Base.connection.select_all(sql).each do |row|
721 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
722 nodetags[n['k']]=n['v']
724 nodetags.delete('created_by')
725 points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
730 def sql_get_tags_in_way(wayid)
732 ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
733 tags[row['k']]=row['v']
738 def sql_get_way_version(wayid)
739 ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")
744 # indent-tabs-mode: t