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