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