Fix database check in browse controller.
[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_api_writable
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         enlarge = [(xmax-xmin)/8,0.01].min
130         xmin -= enlarge; ymin -= enlarge
131         xmax += enlarge; ymax += enlarge
132
133         if POTLATCH_USE_SQL then
134           way_ids = sql_find_way_ids_in_area(xmin, ymin, xmax, ymax)
135           points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
136           relation_ids = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, way_ids)
137         else
138           # find the way ids in an area
139           nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => "current_nodes.visible = 1", :include => :ways)
140           way_ids = nodes_in_area.collect { |node| node.way_ids }.flatten.uniq
141
142           # find the node ids in an area that aren't part of ways
143           nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
144           points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags_as_hash] }
145
146           # find the relations used by those nodes and ways
147           relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => "visible = 1") +
148                   Relation.find_for_ways(way_ids, :conditions => "visible = 1")
149           relation_ids = relations.collect { |relation| relation.id }.uniq
150         end
151
152         [way_ids, points, relation_ids]
153   end
154
155   # Find deleted ways in current bounding box (similar to whichways, but ways
156   # with a deleted node only - not POIs or relations).
157
158   def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
159         xmin -= 0.01; ymin -= 0.01
160         xmax += 0.01; ymax += 0.01
161
162         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)
163         way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
164
165         [way_ids]
166   end
167
168   # Get a way including nodes and tags.
169   # Returns 0 (success), a Potlatch-style array of points, and a hash of tags.
170
171   def getway(wayid) #:doc:
172         if POTLATCH_USE_SQL then
173           points = sql_get_nodes_in_way(wayid)
174           tags = sql_get_tags_in_way(wayid)
175         else
176           # Ideally we would do ":include => :nodes" here but if we do that
177           # then rails only seems to return the first copy of a node when a
178           # way includes a node more than once
179           way = Way.find(wayid)
180           points = way.nodes.collect do |node|
181                 nodetags=node.tags_as_hash
182                 nodetags.delete('created_by')
183                 [node.lon, node.lat, node.id, nodetags]
184           end
185           tags = way.tags
186         end
187
188         [wayid, points, tags]
189   end
190
191   # Get an old version of a way, and all constituent nodes.
192   #
193   # For undelete (version=0), always uses the most recent version of each node, 
194   # even if it's moved.  For revert (version=1+), uses the node in existence 
195   # at the time, generating a new id if it's still visible and has been moved/
196   # retagged.
197
198   def getway_old(id, version) #:doc:
199         if version < 0
200           old_way = OldWay.find(:first, :conditions => ['visible = 1 AND id = ?', id], :order => 'version DESC')
201           points = old_way.get_nodes_undelete
202         else
203           old_way = OldWay.find(:first, :conditions => ['id = ? AND version = ?', id, version])
204           points = old_way.get_nodes_revert
205         end
206
207         old_way.tags['history'] = "Retrieved from v#{old_way.version}"
208
209         [0, id, points, old_way.tags, old_way.version]
210   end
211   
212   # Find history of a way. Returns 'way', id, and 
213   # an array of previous versions.
214
215   def getway_history(wayid) #:doc:
216         history = Way.find(wayid).old_ways.reverse.collect do |old_way|
217           user = old_way.user.data_public? ? old_way.user.display_name : 'anonymous'
218           uid  = old_way.user.data_public? ? old_way.user.id : 0
219           [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
220         end
221
222         ['way',wayid,history]
223   end
224
225   # Find history of a node. Returns 'node', id, and 
226   # an array of previous versions.
227
228   def getnode_history(nodeid) #:doc:
229         history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
230           user = old_node.user.data_public? ? old_node.user.display_name : 'anonymous'
231           uid  = old_node.user.data_public? ? old_node.user.id : 0
232           [old_node.timestamp.to_i, old_node.timestamp.strftime("%d %b %Y, %H:%M"), old_node.visible ? 1 : 0, user, uid]
233         end
234
235         ['node',nodeid,history]
236   end
237
238   # Get a relation with all tags and members.
239   # Returns:
240   # 0. relation id,
241   # 1. hash of tags,
242   # 2. list of members.
243   
244   def getrelation(relid) #:doc:
245         rel = Relation.find(relid)
246
247         [relid, rel.tags, rel.members]
248   end
249
250   # Find relations with specified name/id.
251   # Returns array of relations, each in same form as getrelation.
252   
253   def findrelations(searchterm)
254         rels = []
255         if searchterm.to_i>0 then
256           rel = Relation.find(searchterm.to_i)
257           if rel and rel.visible then
258             rels.push([rel.id, rel.tags, rel.members])
259           end
260         else
261           RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
262                 if t.relation.visible then
263               rels.push([t.relation.id, t.relation.tags, t.relation.members])
264             end
265           end
266         end
267         rels
268   end
269
270   # Save a relation.
271   # Returns
272   # 0. 0 (success),
273   # 1. original relation id (unchanged),
274   # 2. new relation id.
275
276   def putrelation(renumberednodes, renumberedways, usertoken, relid, tags, members, visible) #:doc:
277         uid = getuserid(usertoken)
278         if !uid then return -1,"You are not logged in, so the relation could not be saved." end
279
280         relid = relid.to_i
281         visible = visible.to_i
282
283         # create a new relation, or find the existing one
284         if relid <= 0
285           rel = Relation.new
286         else
287           rel = Relation.find(relid)
288         end
289
290         # check the members are all positive, and correctly type
291         typedmembers = []
292         members.each do |m|
293           mid = m[1].to_i
294           if mid < 0
295                 mid = renumberednodes[mid] if m[0] == 'node'
296                 mid = renumberedways[mid] if m[0] == 'way'
297           end
298       if mid
299             typedmembers << [m[0], mid, m[2]]
300           end
301         end
302
303         # assign new contents
304         rel.members = typedmembers
305         rel.tags = tags
306         rel.visible = visible
307         rel.user_id = uid
308
309         # check it then save it
310         # BUG: the following is commented out because it always fails on my
311         #  install. I think it's a Rails bug.
312
313         #if !rel.preconditions_ok?
314         #  return -2, "Relation preconditions failed"
315         #else
316           rel.save_with_history!
317         #end
318
319         [0, relid, rel.id]
320   end
321
322   # Save a way to the database, including all nodes. Any nodes in the previous
323   # version and no longer used are deleted.
324   # 
325   # Returns:
326   # 0. '0' (code for success),
327   # 1. original way id (unchanged),
328   # 2. new way id,
329   # 3. hash of renumbered nodes (old id=>new id)
330
331   def putway(renumberednodes, usertoken, originalway, points, attributes) #:doc:
332
333         # -- Initialise and carry out checks
334         
335         uid = getuserid(usertoken)
336         if !uid then return -1,"You are not logged in, so the way could not be saved." end
337
338         originalway = originalway.to_i
339
340         points.each do |a|
341           if a[2] == 0 or a[2].nil? then return -2,"Server error - node with id 0 found in way #{originalway}." end
342           if a[1] == 90 then return -2,"Server error - node with lat -90 found in way #{originalway}." end
343         end
344
345         if points.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
346
347         # -- Get unique nodes
348
349         if originalway < 0
350           way = Way.new
351           uniques = []
352         else
353           way = Way.find(originalway)
354           uniques = way.unshared_node_ids
355         end
356
357         # -- Compare nodes and save changes to any that have changed
358
359         nodes = []
360
361         points.each do |n|
362           lon = n[0].to_f
363           lat = n[1].to_f
364           id = n[2].to_i
365           savenode = false
366
367           if renumberednodes[id]
368             id = renumberednodes[id]
369           elsif id < 0
370                 # Create new node
371                 node = Node.new
372                 savenode = true
373           else
374                 node = Node.find(id)
375                 nodetags=node.tags_as_hash
376                 nodetags.delete('created_by')
377                 if !fpcomp(lat, node.lat) or !fpcomp(lon, node.lon) or
378                    n[4] != nodetags or !node.visible?
379                   savenode = true
380                 end
381           end
382
383           if savenode
384                 node.user_id = uid
385             node.lat = lat
386         node.lon = lon
387             node.tags = Tags.join(n[4])
388             node.visible = true
389             node.save_with_history!
390
391                 if id != node.id
392                   renumberednodes[id] = node.id
393                   id = node.id
394             end
395           end
396
397           uniques = uniques - [id]
398           nodes.push(id)
399         end
400
401         # -- Save revised way
402
403         way.tags = attributes
404         way.nds = nodes
405         way.user_id = uid
406         way.visible = true
407         way.save_with_history!
408
409         # -- Delete any unique nodes
410         
411         uniques.each do |n|
412           deleteitemrelations(n, 'node')
413
414           node = Node.find(n)
415           node.user_id = uid
416           node.visible = false
417           node.save_with_history!
418         end
419
420         [0, originalway, way.id, renumberednodes]
421   end
422
423   # Save POI to the database.
424   # Refuses save if the node has since become part of a way.
425   # Returns:
426   # 0. 0 (success),
427   # 1. original node id (unchanged),
428   # 2. new node id.
429
430   def putpoi(usertoken, id, lon, lat, tags, visible) #:doc:
431         uid = getuserid(usertoken)
432         if !uid then return -1,"You are not logged in, so the point could not be saved." end
433
434         id = id.to_i
435         visible = (visible.to_i == 1)
436
437         if id > 0 then
438           node = Node.find(id)
439
440           if !visible then
441             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
442             deleteitemrelations(id, 'node')
443           end
444         else
445           node = Node.new
446         end
447
448         node.user_id = uid
449         node.lat = lat
450         node.lon = lon
451         node.tags = Tags.join(tags)
452         node.visible = visible
453         node.save_with_history!
454
455         [0, id, node.id]
456   end
457
458   # Read POI from database
459   # (only called on revert: POIs are usually read by whichways).
460   #
461   # Returns array of id, long, lat, hash of tags.
462
463   def getpoi(id,timestamp) #:doc:
464         if timestamp>0 then
465           n = OldNode.find(id, :conditions=>['UNIX_TIMESTAMP(timestamp)=?',timestamp])
466         else
467           n = Node.find(id)
468         end
469
470         if n
471           return [n.id, n.lon, n.lat, n.tags_as_hash]
472         else
473           return [nil, nil, nil, '']
474         end
475   end
476
477   # Delete way and all constituent nodes. Also removes from any relations.
478   # Returns 0 (success), unchanged way id.
479
480   def deleteway(usertoken, way_id) #:doc:
481         uid = getuserid(usertoken)
482         if !uid then return -1,"You are not logged in, so the way could not be deleted." end
483
484         # FIXME: would be good not to make two history entries when removing
485         #                two nodes from the same relation
486         user = User.find(uid)
487         way = Way.find(way_id)
488         way.unshared_node_ids.each do |n|
489           deleteitemrelations(n, 'node')
490         end
491         deleteitemrelations(way_id, 'way')
492
493         way.delete_with_relations_and_nodes_and_history(user)  
494
495         [0, way_id]
496   end
497
498
499   # ====================================================================
500   # Support functions
501
502   # Remove a node or way from all relations
503
504   def deleteitemrelations(objid, type) #:doc:
505         relations = RelationMember.find(:all, 
506                                                                         :conditions => ['member_type = ? and member_id = ?', type, objid], 
507                                                                         :include => :relation).collect { |rm| rm.relation }.uniq
508
509         relations.each do |rel|
510           rel.members.delete_if { |x| x[0] == type and x[1] == objid }
511           rel.save_with_history!
512         end
513   end
514
515   # Break out node tags into a hash
516   # (should become obsolete as of API 0.6)
517
518   def tagstring_to_hash(a) #:doc:
519         tags={}
520         Tags.split(a) do |k, v|
521           tags[k]=v
522         end
523         tags
524   end
525
526   # Authenticate token
527   # (can also be of form user:pass)
528
529   def getuserid(token) #:doc:
530         if (token =~ /^(.+)\:(.+)$/) then
531           user = User.authenticate(:username => $1, :password => $2)
532         else
533           user = User.authenticate(:token => token)
534         end
535
536         return user ? user.id : nil;
537   end
538
539   # Compare two floating-point numbers to within 0.0000001
540
541   def fpcomp(a,b) #:doc:
542         return ((a/0.0000001).round==(b/0.0000001).round)
543   end
544
545   # Send AMF response
546   
547   def sendresponse(results)
548         a,b=results.length.divmod(256)
549         render :content_type => "application/x-amf", :text => proc { |response, output| 
550           output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
551           results.each do |k,v|
552                 output.write(v)
553           end
554         }
555   end
556
557
558   # ====================================================================
559   # Alternative SQL queries for getway/whichways
560
561   def sql_find_way_ids_in_area(xmin,ymin,xmax,ymax)
562         sql=<<-EOF
563   SELECT DISTINCT current_way_nodes.id AS wayid
564                 FROM current_way_nodes
565   INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
566   INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
567            WHERE current_nodes.visible=1 
568                  AND current_ways.visible=1 
569                  AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
570         EOF
571         return ActiveRecord::Base.connection.select_all(sql).collect { |a| a['wayid'].to_i }
572   end
573         
574   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
575         sql=<<-EOF
576                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.tags 
577                         FROM current_nodes 
578  LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
579                    WHERE current_nodes.visible=1
580                          AND cwn.id IS NULL
581                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
582         EOF
583         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'])] }
584   end
585         
586   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
587         # ** It would be more Potlatchy to get relations for nodes within ways
588         #    during 'getway', not here
589         sql=<<-EOF
590           SELECT DISTINCT cr.id AS relid 
591                 FROM current_relations cr
592   INNER JOIN current_relation_members crm ON crm.id=cr.id 
593   INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node' 
594            WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
595         EOF
596         unless way_ids.empty?
597           sql+=<<-EOF
598            UNION
599           SELECT DISTINCT cr.id AS relid
600                 FROM current_relations cr
601   INNER JOIN current_relation_members crm ON crm.id=cr.id
602            WHERE crm.member_type='way' 
603                  AND crm.member_id IN (#{way_ids.join(',')})
604           EOF
605         end
606         return ActiveRecord::Base.connection.select_all(sql).collect { |a| a['relid'].to_i }.uniq
607   end
608         
609   def sql_get_nodes_in_way(wayid)
610         points=[]
611         sql=<<-EOF
612                 SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,tags 
613                   FROM current_way_nodes,current_nodes 
614                  WHERE current_way_nodes.id=#{wayid.to_i} 
615                    AND current_way_nodes.node_id=current_nodes.id 
616                    AND current_nodes.visible=1
617           ORDER BY sequence_id
618           EOF
619         ActiveRecord::Base.connection.select_all(sql).each do |row|
620           nodetags=tagstring_to_hash(row['tags'])
621           nodetags.delete('created_by')
622           points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
623         end
624         points
625   end
626         
627   def sql_get_tags_in_way(wayid)
628         tags={}
629         ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
630           tags[row['k']]=row['v']
631         end
632         tags
633   end
634
635 end
636
637 # Local Variables:
638 # indent-tabs-mode: t
639 # tab-width: 4
640 # End: