Resyncing from head 10895:11795
[rails.git] / app / controllers / amf_controller.rb
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).
5 #
6 # Helper functions are in /lib/potlatch.
7 #
8 # Author::      editions Systeme D / Richard Fairhurst 2004-2008
9 # Licence::     public domain.
10 #
11 # == General structure
12 #
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.
17
18 # == Debugging
19
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
23
24 # To write to the Rails log, use RAILS_DEFAULT_LOGGER.info("message").
25
26 class AmfController < ApplicationController
27   require 'stringio'
28
29   include Potlatch
30
31   session :off
32   before_filter :check_write_availability
33
34   # Main AMF handlers: process the raw AMF string (using AMF library) and
35   # calls each action (private method) accordingly.
36   # ** FIXME: refactor to reduce duplication of code across read/write
37   
38   def amf_read
39         req=StringIO.new(request.raw_post+0.chr)# Get POST data as request
40                                                                                         # (cf http://www.ruby-forum.com/topic/122163)
41         req.read(2)                                                             # Skip version indicator and client ID
42         results={}                                                              # Results of each body
43
44         # Parse request
45
46         headers=AMF.getint(req)                                 # Read number of headers
47
48         headers.times do                                                # Read each header
49           name=AMF.getstring(req)                               #  |
50           req.getc                                                              #  | skip boolean
51           value=AMF.getvalue(req)                               #  |
52           header["name"]=value                                  #  |
53         end
54
55         bodies=AMF.getint(req)                                  # Read number of bodies
56         bodies.times do                                                 # Read each body
57           message=AMF.getstring(req)                    #  | get message name
58           index=AMF.getstring(req)                              #  | get index in response sequence
59           bytes=AMF.getlong(req)                                #  | get total size in bytes
60           args=AMF.getvalue(req)                                #  | get response (probably an array)
61
62           case message
63                 when 'getpresets';                      results[index]=AMF.putdata(index,getpresets())
64                 when 'whichways';                       results[index]=AMF.putdata(index,whichways(*args))
65                 when 'whichways_deleted';       results[index]=AMF.putdata(index,whichways_deleted(*args))
66                 when 'getway';                          results[index]=AMF.putdata(index,getway(args[0].to_i))
67                 when 'getrelation';                     results[index]=AMF.putdata(index,getrelation(args[0].to_i))
68                 when 'getway_old';                      results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1].to_i))
69                 when 'getway_history';          results[index]=AMF.putdata(index,getway_history(args[0].to_i))
70                 when 'getnode_history';         results[index]=AMF.putdata(index,getnode_history(args[0].to_i))
71                 when 'findrelations';           results[index]=AMF.putdata(index,findrelations(*args))
72                 when 'getpoi';                          results[index]=AMF.putdata(index,getpoi(*args))
73           end
74         end
75     sendresponse(results)
76   end
77
78   def amf_write
79         req=StringIO.new(request.raw_post+0.chr)
80         req.read(2)
81         results={}
82         renumberednodes={}                                              # Shared across repeated putways
83         renumberedways={}                                               # Shared across repeated putways
84
85         headers=AMF.getint(req)                                 # Read number of headers
86         headers.times do                                                # Read each header
87           name=AMF.getstring(req)                               #  |
88           req.getc                                                              #  | skip boolean
89           value=AMF.getvalue(req)                               #  |
90           header["name"]=value                                  #  |
91         end
92
93         bodies=AMF.getint(req)                                  # Read number of bodies
94         bodies.times do                                                 # Read each body
95           message=AMF.getstring(req)                    #  | get message name
96           index=AMF.getstring(req)                              #  | get index in response sequence
97           bytes=AMF.getlong(req)                                #  | get total size in bytes
98           args=AMF.getvalue(req)                                #  | get response (probably an array)
99
100           case message
101                 when 'putway';                          r=putway(renumberednodes,*args)
102                                                                         renumberednodes=r[3]
103                                                                         if r[1] != r[2]
104                                                                           renumberedways[r[1]] = r[2]
105                                                                         end
106                                                                         results[index]=AMF.putdata(index,r)
107                 when 'putrelation';                     results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args))
108                 when 'deleteway';                       results[index]=AMF.putdata(index,deleteway(args[0],args[1].to_i))
109                 when 'putpoi';                          results[index]=AMF.putdata(index,putpoi(*args))
110           end
111         end
112     sendresponse(results)
113   end
114
115   private
116
117   # Return presets (default tags, localisation etc.):
118   # uses POTLATCH_PRESETS global, set up in OSM::Potlatch.
119
120   def getpresets() #:doc:
121         return POTLATCH_PRESETS
122   end
123
124   # Find all the ways, POI nodes (i.e. not part of ways), and relations
125   # in a given bounding box. Nodes are returned in full; ways and relations 
126   # are IDs only. 
127
128   def whichways(xmin, ymin, xmax, ymax) #:doc:
129         xmin -= 0.01; ymin -= 0.01
130         xmax += 0.01; ymax += 0.01
131
132         if POTLATCH_USE_SQL then
133           way_ids = sql_find_way_ids_in_area(xmin, ymin, xmax, ymax)
134           points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
135           relation_ids = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, way_ids)
136         else
137           # find the way ids in an area
138           nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => "current_nodes.visible = 1", :include => :ways)
139           way_ids = nodes_in_area.collect { |node| node.way_ids }.flatten.uniq
140
141           # find the node ids in an area that aren't part of ways
142           nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
143           points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags_as_hash] }
144
145           # find the relations used by those nodes and ways
146           relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => "visible = 1") +
147                   Relation.find_for_ways(way_ids, :conditions => "visible = 1")
148           relation_ids = relations.collect { |relation| relation.id }.uniq
149         end
150
151         [way_ids, points, relation_ids]
152   end
153
154   # Find deleted ways in current bounding box (similar to whichways, but ways
155   # with a deleted node only - not POIs or relations).
156
157   def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
158         xmin -= 0.01; ymin -= 0.01
159         xmax += 0.01; ymax += 0.01
160
161         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)
162         way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
163
164         [way_ids]
165   end
166
167   # Get a way including nodes and tags.
168   # Returns 0 (success), a Potlatch-style array of points, and a hash of tags.
169
170   def getway(wayid) #:doc:
171         if POTLATCH_USE_SQL then
172           points = sql_get_nodes_in_way(wayid)
173           tags = sql_get_tags_in_way(wayid)
174         else
175           # Ideally we would do ":include => :nodes" here but if we do that
176           # then rails only seems to return the first copy of a node when a
177           # way includes a node more than once
178           way = Way.find(wayid)
179           points = way.nodes.collect do |node|
180                 nodetags=node.tags_as_hash
181                 nodetags.delete('created_by')
182                 [node.lon, node.lat, node.id, nodetags]
183           end
184           tags = way.tags
185         end
186
187         [wayid, points, tags]
188   end
189
190   # Get an old version of a way, and all constituent nodes.
191   #
192   # For undelete (version=0), always uses the most recent version of each node, 
193   # even if it's moved.  For revert (version=1+), uses the node in existence 
194   # at the time, generating a new id if it's still visible and has been moved/
195   # retagged.
196
197   def getway_old(id, version) #:doc:
198         if version < 0
199           old_way = OldWay.find(:first, :conditions => ['visible = 1 AND id = ?', id], :order => 'version DESC')
200           points = old_way.get_nodes_undelete
201         else
202           old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version])
203           points = old_way.get_nodes_revert
204         end
205
206         old_way.tags['history'] = "Retrieved from v#{old_way.version}"
207
208         [0, id, points, old_way.tags, old_way.version]
209   end
210   
211   # Find history of a way. Returns 'way', id, and 
212   # an array of previous versions.
213
214   def getway_history(wayid) #:doc:
215         history = Way.find(wayid).old_ways.reverse.collect do |old_way|
216           user = old_way.user.data_public? ? old_way.user.display_name : 'anonymous'
217           uid  = old_way.user.data_public? ? old_way.user.id : 0
218           [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
219         end
220
221         ['way',wayid,history]
222   end
223
224   # Find history of a node. Returns 'node', id, and 
225   # an array of previous versions.
226
227   def getnode_history(nodeid) #:doc:
228         history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
229           user = old_node.user.data_public? ? old_node.user.display_name : 'anonymous'
230           uid  = old_node.user.data_public? ? old_node.user.id : 0
231           [old_node.timestamp.to_i, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
232         end
233
234         ['node',nodeid,history]
235   end
236
237   # Get a relation with all tags and members.
238   # Returns:
239   # 0. relation id,
240   # 1. hash of tags,
241   # 2. list of members.
242   
243   def getrelation(relid) #:doc:
244         rel = Relation.find(relid)
245
246         [relid, rel.tags, rel.members]
247   end
248
249   # Find relations with specified name/id.
250   # Returns array of relations, each in same form as getrelation.
251   
252   def findrelations(searchterm)
253         rels = []
254         if searchterm.to_i>0 then
255           rel = Relation.find(searchterm.to_i)
256           if rel and rel.visible then
257             rels.push([rel.id, rel.tags, rel.members])
258           end
259         else
260           RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
261                 if t.relation.visible then
262               rels.push([t.relation.id, t.relation.tags, t.relation.members])
263             end
264           end
265         end
266         rels
267   end
268
269   # Save a relation.
270   # Returns
271   # 0. 0 (success),
272   # 1. original relation id (unchanged),
273   # 2. new relation id.
274
275   def putrelation(renumberednodes, renumberedways, usertoken, relid, tags, members, visible) #:doc:
276         uid = getuserid(usertoken)
277         if !uid then return -1,"You are not logged in, so the relation could not be saved." end
278
279         relid = relid.to_i
280         visible = visible.to_i
281
282         # create a new relation, or find the existing one
283         if relid <= 0
284           rel = Relation.new
285         else
286           rel = Relation.find(relid)
287         end
288
289         # check the members are all positive, and correctly type
290         typedmembers = []
291         members.each do |m|
292           mid = m[1].to_i
293           if mid < 0
294                 mid = renumberednodes[mid] if m[0] == 'node'
295                 mid = renumberedways[mid] if m[0] == 'way'
296           end
297       if mid
298             typedmembers << [m[0], mid, m[2]]
299           end
300         end
301
302         # assign new contents
303         rel.members = typedmembers
304         rel.tags = tags
305         rel.visible = visible
306         rel.user_id = uid
307
308         # check it then save it
309         # BUG: the following is commented out because it always fails on my
310         #  install. I think it's a Rails bug.
311
312         #if !rel.preconditions_ok?
313         #  return -2, "Relation preconditions failed"
314         #else
315           rel.save_with_history!
316         #end
317
318         [0, relid, rel.id]
319   end
320
321   # Save a way to the database, including all nodes. Any nodes in the previous
322   # version and no longer used are deleted.
323   # 
324   # Returns:
325   # 0. '0' (code for success),
326   # 1. original way id (unchanged),
327   # 2. new way id,
328   # 3. hash of renumbered nodes (old id=>new id)
329
330   def putway(renumberednodes, usertoken, originalway, points, attributes) #:doc:
331
332         # -- Initialise and carry out checks
333         
334         uid = getuserid(usertoken)
335         if !uid then return -1,"You are not logged in, so the way could not be saved." end
336
337         originalway = originalway.to_i
338
339         points.each do |a|
340           if a[2] == 0 or a[2].nil? then return -2,"Server error - node with id 0 found in way #{originalway}." end
341           if a[1] == 90 then return -2,"Server error - node with lat -90 found in way #{originalway}." end
342         end
343
344         if points.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
345
346         # -- Get unique nodes
347
348         if originalway < 0
349           way = Way.new
350           uniques = []
351         else
352           way = Way.find(originalway)
353           uniques = way.unshared_node_ids
354         end
355
356         # -- Compare nodes and save changes to any that have changed
357
358         nodes = []
359
360         points.each do |n|
361           lon = n[0].to_f
362           lat = n[1].to_f
363           id = n[2].to_i
364           savenode = false
365
366           if renumberednodes[id]
367             id = renumberednodes[id]
368           elsif id < 0
369                 # Create new node
370                 node = Node.new
371                 savenode = true
372           else
373                 node = Node.find(id)
374                 nodetags=node.tags_as_hash
375                 nodetags.delete('created_by')
376                 if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or
377                    n[4] != nodetags or !node.visible?
378                   savenode = true
379                 end
380           end
381
382           if savenode
383                 node.user_id = uid
384             node.lat = lat
385         node.lon = lon
386             node.tags = Tags.join(n[4])
387             node.visible = true
388             node.save_with_history!
389
390                 if id != node.id
391                   renumberednodes[id] = node.id
392                   id = node.id
393             end
394           end
395
396           uniques = uniques - [id]
397           nodes.push(id)
398         end
399
400         # -- Delete any unique nodes
401         
402         uniques.each do |n|
403           deleteitemrelations(n, 'node')
404
405           node = Node.find(n)
406           node.user_id = uid
407           node.visible = false
408           node.save_with_history!
409         end
410
411         # -- Save revised way
412
413         way.tags = attributes
414         way.nds = nodes
415         way.user_id = uid
416         way.visible = true
417         way.save_with_history!
418
419         [0, originalway, way.id, renumberednodes]
420   end
421
422   # Save POI to the database.
423   # Refuses save if the node has since become part of a way.
424   # Returns:
425   # 0. 0 (success),
426   # 1. original node id (unchanged),
427   # 2. new node id.
428
429   def putpoi(usertoken, id, lon, lat, tags, visible) #:doc:
430         uid = getuserid(usertoken)
431         if !uid then return -1,"You are not logged in, so the point could not be saved." end
432
433         id = id.to_i
434         visible = (visible.to_i == 1)
435
436         if id > 0 then
437           node = Node.find(id)
438
439           if !visible then
440             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
441             deleteitemrelations(id, 'node')
442           end
443         else
444           node = Node.new
445         end
446
447         node.user_id = uid
448         node.lat = lat
449         node.lon = lon
450         node.tags = Tags.join(tags)
451         node.visible = visible
452         node.save_with_history!
453
454         [0, id, node.id]
455   end
456
457   # Read POI from database
458   # (only called on revert: POIs are usually read by whichways).
459   #
460   # Returns array of id, long, lat, hash of tags.
461
462   def getpoi(id,timestamp) #:doc:
463         if timestamp>0 then
464           n = OldNode.find(id, :conditions=>['UNIX_TIMESTAMP(timestamp)=?',timestamp])
465         else
466           n = Node.find(id)
467         end
468
469         if n
470           return [n.id, n.lon, n.lat, n.tags_as_hash]
471         else
472           return [nil, nil, nil, '']
473         end
474   end
475
476   # Delete way and all constituent nodes. Also removes from any relations.
477   # Returns 0 (success), unchanged way id.
478
479   def deleteway(usertoken, way_id) #:doc:
480         uid = getuserid(usertoken)
481         if !uid then return -1,"You are not logged in, so the way could not be deleted." end
482
483         # FIXME: would be good not to make two history entries when removing
484         #                two nodes from the same relation
485         user = User.find(uid)
486         way = Way.find(way_id)
487         way.unshared_node_ids.each do |n|
488           deleteitemrelations(n, 'node')
489         end
490         deleteitemrelations(way_id, 'way')
491
492         way.delete_with_relations_and_nodes_and_history(user)  
493
494         [0, way_id]
495   end
496
497
498   # ====================================================================
499   # Support functions
500
501   # Remove a node or way from all relations
502
503   def deleteitemrelations(objid, type) #:doc:
504         relations = RelationMember.find(:all, 
505                                                                         :conditions => ['member_type = ? and member_id = ?', type, objid], 
506                                                                         :include => :relation).collect { |rm| rm.relation }.uniq
507
508         relations.each do |rel|
509           rel.members.delete_if { |x| x[0] == type and x[1] == objid }
510           rel.save_with_history!
511         end
512   end
513
514   # Break out node tags into a hash
515   # (should become obsolete as of API 0.6)
516
517   def tagstring_to_hash(a) #:doc:
518         tags={}
519         Tags.split(a) do |k, v|
520           tags[k]=v
521         end
522         tags
523   end
524
525   # Authenticate token
526   # (could be removed if no-one uses the username+password form)
527
528   def getuserid(token) #:doc:
529         if (token =~ /^(.+)\+(.+)$/) then
530           user = User.authenticate(:username => $1, :password => $2)
531         else
532           user = User.authenticate(:token => token)
533         end
534
535         return user ? user.id : nil;
536   end
537
538   # Compare two floating-point numbers to within 0.0000001
539
540   def fpcomp(a,b) #:doc:
541         return ((a/0.0000001).round==(b/0.0000001).round)
542   end
543
544   # Send AMF response
545   
546   def sendresponse(results)
547         a,b=results.length.divmod(256)
548         render :content_type => "application/x-amf", :text => proc { |response, output| 
549           output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
550           results.each do |k,v|
551                 output.write(v)
552           end
553         }
554   end
555
556
557   # ====================================================================
558   # Alternative SQL queries for getway/whichways
559
560   def sql_find_way_ids_in_area(xmin,ymin,xmax,ymax)
561         sql=<<-EOF
562   SELECT DISTINCT current_way_nodes.id AS wayid
563                 FROM current_way_nodes
564   INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
565   INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
566            WHERE current_nodes.visible=1 
567                  AND current_ways.visible=1 
568                  AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
569         EOF
570         return ActiveRecord::Base.connection.select_all(sql).collect { |a| a['wayid'].to_i }
571   end
572         
573   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
574         sql=<<-EOF
575                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.tags 
576                         FROM current_nodes 
577  LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
578                    WHERE current_nodes.visible=1
579                          AND cwn.id IS NULL
580                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
581         EOF
582         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'])] }
583   end
584         
585   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
586         # ** It would be more Potlatchy to get relations for nodes within ways
587         #    during 'getway', not here
588         sql=<<-EOF
589           SELECT DISTINCT cr.id AS relid 
590                 FROM current_relations cr
591   INNER JOIN current_relation_members crm ON crm.id=cr.id 
592   INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node' 
593            WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
594         EOF
595         unless way_ids.empty?
596           sql+=<<-EOF
597            UNION
598           SELECT DISTINCT cr.id AS relid
599                 FROM current_relations cr
600   INNER JOIN current_relation_members crm ON crm.id=cr.id
601            WHERE crm.member_type='way' 
602                  AND crm.member_id IN (#{way_ids.join(',')})
603           EOF
604         end
605         return ActiveRecord::Base.connection.select_all(sql).collect { |a| a['relid'].to_i }.uniq
606   end
607         
608   def sql_get_nodes_in_way(wayid)
609         points=[]
610         sql=<<-EOF
611                 SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,tags 
612                   FROM current_way_nodes,current_nodes 
613                  WHERE current_way_nodes.id=#{wayid.to_i} 
614                    AND current_way_nodes.node_id=current_nodes.id 
615                    AND current_nodes.visible=1
616           ORDER BY sequence_id
617           EOF
618         ActiveRecord::Base.connection.select_all(sql).each do |row|
619           nodetags=tagstring_to_hash(row['tags'])
620           nodetags.delete('created_by')
621           points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
622         end
623         points
624   end
625         
626   def sql_get_tags_in_way(wayid)
627         tags={}
628         ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
629           tags[row['k']]=row['v']
630         end
631         tags
632   end
633
634 end
635
636 # Local Variables:
637 # indent-tabs-mode: t
638 # tab-width: 4
639 # End: