5a8ac49c36234128f0a70553805a883e68f9fd04
[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.rb
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 # == API 0.6
19 #
20 # Note that this requires a patched version of composite_primary_keys 1.1.0
21 # (see http://groups.google.com/group/compositekeys/t/a00e7562b677e193) 
22 # if you are to run with POTLATCH_USE_SQL=false .
23
24 # == Debugging
25
26 # Any method that returns a status code (0 for ok) can also send:
27 #       return(-1,"message")            <-- just puts up a dialogue
28 #       return(-2,"message")            <-- also asks the user to e-mail me
29 # return(-3,["type",v],id)    <-- version conflict
30 # return(-4,"type",id)        <-- object not found
31 # -5 indicates the method wasn't called (due to a previous error)
32
33 # To write to the Rails log, use logger.info("message").
34
35 # Remaining issues:
36 # * version conflict when POIs and ways are reverted
37
38 class AmfController < ApplicationController
39   require 'stringio'
40
41   include Potlatch
42
43   # Help methods for checking boundary sanity and area size
44   include MapBoundary
45
46   before_filter :check_api_writable
47
48   # Main AMF handlers: process the raw AMF string (using AMF library) and
49   # calls each action (private method) accordingly.
50   # ** FIXME: refactor to reduce duplication of code across read/write
51   
52   def amf_read
53     if request.post?
54       req=StringIO.new(request.raw_post+0.chr)# Get POST data as request
55                                 # (cf http://www.ruby-forum.com/topic/122163)
56       req.read(2)                                                               # Skip version indicator and client ID
57       results={}                                                                # Results of each body
58
59       # Parse request
60
61       headers=AMF.getint(req)                           # Read number of headers
62
63       headers.times do                                  # Read each header
64         name=AMF.getstring(req)                         #  |
65         req.getc                                        #  | skip boolean
66         value=AMF.getvalue(req)                         #  |
67         header["name"]=value                            #  |
68       end
69
70       bodies=AMF.getint(req)                            # Read number of bodies
71       bodies.times do                                   # Read each body
72         message=AMF.getstring(req)                      #  | get message name
73         index=AMF.getstring(req)                        #  | get index in response sequence
74         bytes=AMF.getlong(req)                          #  | get total size in bytes
75         args=AMF.getvalue(req)                          #  | get response (probably an array)
76         logger.info("Executing AMF #{message}(#{args.join(',')}):#{index}")
77
78         case message
79           when 'getpresets';        results[index]=AMF.putdata(index,getpresets(*args))
80           when 'whichways';         results[index]=AMF.putdata(index,whichways(*args))
81           when 'whichways_deleted'; results[index]=AMF.putdata(index,whichways_deleted(*args))
82           when 'getway';            results[index]=AMF.putdata(index,getway(args[0].to_i))
83           when 'getrelation';       results[index]=AMF.putdata(index,getrelation(args[0].to_i))
84           when 'getway_old';        results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1]))
85           when 'getway_history';    results[index]=AMF.putdata(index,getway_history(args[0].to_i))
86           when 'getnode_history';   results[index]=AMF.putdata(index,getnode_history(args[0].to_i))
87           when 'findgpx';           results[index]=AMF.putdata(index,findgpx(*args))
88           when 'findrelations';     results[index]=AMF.putdata(index,findrelations(*args))
89           when 'getpoi';            results[index]=AMF.putdata(index,getpoi(*args))
90         end
91       end
92       logger.info("Encoding AMF results")
93       sendresponse(results)
94     else
95       render :nothing => true, :status => :method_not_allowed
96     end
97   end
98
99   def amf_write
100     if request.post?
101       req=StringIO.new(request.raw_post+0.chr)
102       req.read(2)
103       results={}
104       renumberednodes={}                                # Shared across repeated putways
105       renumberedways={}                                 # Shared across repeated putways
106
107       headers=AMF.getint(req)           # Read number of headers
108       headers.times do                                  # Read each header
109         name=AMF.getstring(req)     #  |
110         req.getc                                              #  | skip boolean
111         value=AMF.getvalue(req)         #  |
112         header["name"]=value            #  |
113       end
114
115       bodies=AMF.getint(req)            # Read number of bodies
116       bodies.times do                                         # Read each body
117         message=AMF.getstring(req)      #  | get message name
118         index=AMF.getstring(req)                #  | get index in response sequence
119         bytes=AMF.getlong(req)                  #  | get total size in bytes
120         args=AMF.getvalue(req)                  #  | get response (probably an array)
121         err=false                   # Abort batch on error
122
123         logger.info("Executing AMF #{message}:#{index}")
124         if err
125           results[index]=[-5,nil]
126         else
127           case message
128             when 'putway';         orn=renumberednodes.dup
129                                    r=putway(renumberednodes,*args)
130                                    r[4]=renumberednodes.reject { |k,v| orn.has_key?(k) }
131                                    if r[2] != r[3] then renumberedways[r[2]] = r[3] end
132                                    results[index]=AMF.putdata(index,r)
133             when 'putrelation';    results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args))
134             when 'deleteway';      results[index]=AMF.putdata(index,deleteway(*args))
135             when 'putpoi';         r=putpoi(*args)
136                                    if r[2] != r[3] then renumberednodes[r[2]] = r[3] end
137                                    results[index]=AMF.putdata(index,r)
138             when 'startchangeset'; results[index]=AMF.putdata(index,startchangeset(*args))
139            end
140           if results[index][0]==-3 then err=true end  # If a conflict is detected, don't execute any more writes
141         end
142       end
143       logger.info("Encoding AMF results")
144       sendresponse(results)
145     else
146       render :nothing => true, :status => :method_not_allowed
147     end
148   end
149
150   private
151
152   def amf_handle_error(call)
153     yield
154   rescue OSM::APIVersionMismatchError => ex
155     return [-3, [ex.type.downcase, ex.latest, ex.id]]
156   rescue OSM::APIUserChangesetMismatchError => ex
157     return [-2, ex.to_s]
158   rescue OSM::APIBadBoundingBox => ex
159     return [-2, "Sorry - I can't get the map for that area. The server said: #{ex.to_s}"]
160   rescue OSM::APIError => ex
161     return [-1, ex.to_s]
162   rescue Exception => ex
163     return [-2, "An unusual error happened (in #{call}). The server said: #{ex.to_s}"]
164   end
165
166   def amf_handle_error_with_timeout(call)
167     amf_handle_error(call) do
168       Timeout::timeout(APP_CONFIG['api_timeout'], OSM::APITimeoutError) do
169         yield
170       end
171     end
172   end
173
174   # Start new changeset
175   # Returns success_code,success_message,changeset id
176   
177   def startchangeset(usertoken, cstags, closeid, closecomment, opennew)
178     amf_handle_error("'startchangeset'") do
179       user = getuser(usertoken)
180       if !user then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end
181
182       # close previous changeset and add comment
183       if closeid
184         cs = Changeset.find(closeid)
185         cs.set_closed_time_now
186         if cs.user_id!=user.id
187           raise OSM::APIUserChangesetMismatchError.new
188         elsif closecomment.empty?
189           cs.save!
190         else
191           cs.tags['comment']=closecomment
192           cs.save_with_tags!
193         end
194       end
195         
196       # open a new changeset
197       if opennew!=0
198         cs = Changeset.new
199         cs.tags = cstags
200         cs.user_id = user.id
201         if !closecomment.empty? then cs.tags['comment']=closecomment end
202         # smsm1 doesn't like the next two lines and thinks they need to be abstracted to the model more/better
203         cs.created_at = Time.now.getutc
204         cs.closed_at = cs.created_at + Changeset::IDLE_TIMEOUT
205         cs.save_with_tags!
206         return [0,'',cs.id]
207       else
208         return [0,'',nil]
209       end
210     end
211   end
212
213   # Return presets (default tags, localisation etc.):
214   # uses POTLATCH_PRESETS global, set up in OSM::Potlatch.
215
216   def getpresets(usertoken,lang) #:doc:
217     begin
218       # first, try the user setting
219       localised = YAML::load(File.open("#{RAILS_ROOT}/config/potlatch/localised/#{I18n.locale}/localised.yaml"))
220     rescue
221       begin
222         # if not, try the browser language
223         localised = YAML::load(File.open("#{RAILS_ROOT}/config/potlatch/localised/#{lang}/localised.yaml"))
224       rescue
225         # fall back to hardcoded English text
226         localised = ""
227       end
228     end
229
230     begin
231       help = File.read("#{RAILS_ROOT}/config/potlatch/localised/#{I18n.locale}/help.html")
232     rescue
233       begin
234         help = File.read("#{RAILS_ROOT}/config/potlatch/localised/#{lang}/help.html")
235       rescue
236         help = File.read("#{RAILS_ROOT}/config/potlatch/localised/en/help.html")
237       end
238     end
239     return POTLATCH_PRESETS+[localised,help]
240   end
241
242   ##
243   # Find all the ways, POI nodes (i.e. not part of ways), and relations
244   # in a given bounding box. Nodes are returned in full; ways and relations 
245   # are IDs only. 
246   #
247   # return is of the form: 
248   # [success_code, success_message,
249   #  [[way_id, way_version], ...],
250   #  [[node_id, lat, lon, [tags, ...], node_version], ...],
251   #  [[rel_id, rel_version], ...]]
252   # where the ways are any visible ways which refer to any visible
253   # nodes in the bbox, nodes are any visible nodes in the bbox but not
254   # used in any way, rel is any relation which refers to either a way
255   # or node that we're returning.
256   def whichways(xmin, ymin, xmax, ymax) #:doc:
257     amf_handle_error_with_timeout("'whichways'") do
258       enlarge = [(xmax-xmin)/8,0.01].min
259       xmin -= enlarge; ymin -= enlarge
260       xmax += enlarge; ymax += enlarge
261
262       # check boundary is sane and area within defined
263       # see /config/application.yml
264       check_boundaries(xmin, ymin, xmax, ymax)
265
266       if POTLATCH_USE_SQL then
267         ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
268         points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
269         relations = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, ways.collect {|x| x[0]})
270       else
271         # find the way ids in an area
272         nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways)
273         ways = nodes_in_area.inject([]) { |sum, node| 
274           visible_ways = node.ways.select { |w| w.visible? }
275           sum + visible_ways.collect { |w| [w.id,w.version] }
276         }.uniq
277         ways.delete([])
278
279         # find the node ids in an area that aren't part of ways
280         nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
281         points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags, n.version] }.uniq
282
283         # find the relations used by those nodes and ways
284         relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) +
285                     Relation.find_for_ways(ways.collect { |w| w[0] }, :conditions => {:visible => true})
286         relations = relations.collect { |relation| [relation.id,relation.version] }.uniq
287       end
288
289       [0, '', ways, points, relations]
290     end
291   end
292
293   # Find deleted ways in current bounding box (similar to whichways, but ways
294   # with a deleted node only - not POIs or relations).
295
296   def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
297     amf_handle_error_with_timeout("'whichways_deleted'") do
298       enlarge = [(xmax-xmin)/8,0.01].min
299       xmin -= enlarge; ymin -= enlarge
300       xmax += enlarge; ymax += enlarge
301
302       # check boundary is sane and area within defined
303       # see /config/application.yml
304       check_boundaries(xmin, ymin, xmax, ymax)
305
306       nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history)
307       way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
308
309       [0,'',way_ids]
310     end
311   end
312
313   # Get a way including nodes and tags.
314   # Returns the way id, a Potlatch-style array of points, a hash of tags, the version number, and the user ID.
315
316   def getway(wayid) #:doc:
317     amf_handle_error_with_timeout("'getway' #{wayid}") do
318       if POTLATCH_USE_SQL then
319         points = sql_get_nodes_in_way(wayid)
320         tags = sql_get_tags_in_way(wayid)
321         version = sql_get_way_version(wayid)
322         uid = sql_get_way_user(wayid)
323       else
324         # Ideally we would do ":include => :nodes" here but if we do that
325         # then rails only seems to return the first copy of a node when a
326         # way includes a node more than once
327         way = Way.find(:first, :conditions => { :id => wayid }, :include => { :nodes => :node_tags })
328
329         # check case where way has been deleted or doesn't exist
330         return [-4, 'way', wayid, [], {}, nil] if way.nil? or !way.visible
331
332         points = way.nodes.collect do |node|
333           nodetags=node.tags
334           nodetags.delete('created_by')
335           [node.lon, node.lat, node.id, nodetags, node.version]
336         end
337         tags = way.tags
338         version = way.version
339         uid = way.changeset.user.id
340       end
341
342       [0, '', wayid, points, tags, version, uid]
343     end
344   end
345   
346   # Get an old version of a way, and all constituent nodes.
347   #
348   # For undelete (version<0), always uses the most recent version of each node, 
349   # even if it's moved.  For revert (version >= 0), uses the node in existence 
350   # at the time, generating a new id if it's still visible and has been moved/
351   # retagged.
352   #
353   # Returns:
354   # 0. success code, 
355   # 1. id, 
356   # 2. array of points, 
357   # 3. hash of tags, 
358   # 4. version, 
359   # 5. is this the current, visible version? (boolean)
360   
361   def getway_old(id, timestamp) #:doc:
362     amf_handle_error_with_timeout("'getway_old' #{id}, #{timestamp}") do
363       if timestamp == ''
364         # undelete
365         old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC')
366         points = old_way.get_nodes_undelete unless old_way.nil?
367       else
368         begin
369           # revert
370           timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S")
371           old_way = OldWay.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC')
372           unless old_way.nil?
373             points = old_way.get_nodes_revert(timestamp)
374             if !old_way.visible
375               return [-1, "Sorry, the way was deleted at that time - please revert to a previous version.", id, [], {}, nil, false]
376             end
377           end
378         rescue ArgumentError
379           # thrown by date parsing method. leave old_way as nil for
380           # the error handler below.
381         end
382       end
383
384       if old_way.nil?
385         return [-1, "Sorry, the server could not find a way at that time.", id, [], {}, nil, false]
386       else
387         curway=Way.find(id)
388         old_way.tags['history'] = "Retrieved from v#{old_way.version}"
389         return [0, '', id, points, old_way.tags, curway.version, (curway.version==old_way.version and curway.visible)]
390       end
391     end
392   end
393   
394   # Find history of a way.
395   # Returns 'way', id, and an array of previous versions:
396   # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
397   # - now [timestamp,user,uid]
398   #
399   # Heuristic: Find all nodes that have ever been part of the way; 
400   # get a list of their revision dates; add revision dates of the way;
401   # sort and collapse list (to within 2 seconds); trim all dates before the 
402   # start date of the way.
403
404   def getway_history(wayid) #:doc:
405     begin
406       # Find list of revision dates for way and all constituent nodes
407       revdates=[]
408       revusers={}
409       Way.find(wayid).old_ways.collect do |a|
410         revdates.push(a.timestamp)
411         unless revusers.has_key?(a.timestamp.to_i) then revusers[a.timestamp.to_i]=change_user(a) end
412         a.nds.each do |n|
413           Node.find(n).old_nodes.collect do |o|
414             revdates.push(o.timestamp)
415             unless revusers.has_key?(o.timestamp.to_i) then revusers[o.timestamp.to_i]=change_user(o) end
416           end
417         end
418       end
419       waycreated=revdates[0]
420       revdates.uniq!
421       revdates.sort!
422       revdates.reverse!
423
424       # Remove any dates (from nodes) before first revision date of way
425       revdates.delete_if { |d| d<waycreated }
426       # Remove any elements where 2 seconds doesn't elapse before next one
427       revdates.delete_if { |d| revdates.include?(d+1) or revdates.include?(d+2) }
428       # Collect all in one nested array
429       revdates.collect! {|d| [d.succ.strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] }
430       revdates.uniq!
431
432       return ['way', wayid, revdates]
433     rescue ActiveRecord::RecordNotFound
434       return ['way', wayid, []]
435     end
436   end
437   
438   # Find history of a node. Returns 'node', id, and an array of previous versions as above.
439
440   def getnode_history(nodeid) #:doc:
441     begin 
442       history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
443         [old_node.timestamp.succ.strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node)
444       end
445       return ['node', nodeid, history]
446     rescue ActiveRecord::RecordNotFound
447       return ['node', nodeid, []]
448     end
449   end
450
451   def change_user(obj)
452     user_object = obj.changeset.user
453     user = user_object.data_public? ? user_object.display_name : 'anonymous'
454     uid  = user_object.data_public? ? user_object.id : 0
455     [user,uid]
456   end
457
458   # Find GPS traces with specified name/id.
459   # Returns array listing GPXs, each one comprising id, name and description.
460   
461   def findgpx(searchterm, usertoken)
462     amf_handle_error_with_timeout("'findgpx'") do
463       user = getuser(usertoken)
464       if !uid then return -1,"You must be logged in to search for GPX traces.",[] end
465
466       gpxs = []
467       if searchterm.to_i>0 then
468         gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,user.id] )
469         if gpx then
470           gpxs.push([gpx.id, gpx.name, gpx.description])
471         end
472       else
473         Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,user.id,searchterm] ).each do |gpx|
474           gpxs.push([gpx.id, gpx.name, gpx.description])
475         end
476       end
477       [0,'',gpxs]
478     end
479   end
480
481   # Get a relation with all tags and members.
482   # Returns:
483   # 0. success code?
484   # 1. object type?
485   # 2. relation id,
486   # 3. hash of tags,
487   # 4. list of members,
488   # 5. version.
489   
490   def getrelation(relid) #:doc:
491     amf_handle_error("'getrelation' #{relid}") do
492       rel = Relation.find(:first, :conditions => { :id => relid })
493
494       return [-4, 'relation', relid, {}, [], nil] if rel.nil? or !rel.visible
495       [0, '', relid, rel.tags, rel.members, rel.version]
496     end
497   end
498
499   # Find relations with specified name/id.
500   # Returns array of relations, each in same form as getrelation.
501   
502   def findrelations(searchterm)
503     rels = []
504     if searchterm.to_i>0 then
505       rel = Relation.find(searchterm.to_i)
506       if rel and rel.visible then
507         rels.push([rel.id, rel.tags, rel.members, rel.version])
508       end
509     else
510       RelationTag.find(:all, :limit => 11, :conditions => ["v like ?", "%#{searchterm}%"] ).each do |t|
511         if t.relation.visible then
512           rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version])
513         end
514       end
515     end
516     rels
517   end
518
519   # Save a relation.
520   # Returns
521   # 0. 0 (success),
522   # 1. original relation id (unchanged),
523   # 2. new relation id,
524   # 3. version.
525
526   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
527     amf_handle_error("'putrelation' #{relid}")  do
528       user = getuser(usertoken)
529       if !user then return -1,"You are not logged in, so the relation could not be saved." end
530
531       relid = relid.to_i
532       visible = (visible.to_i != 0)
533
534       new_relation = nil
535       relation = nil
536       Relation.transaction do
537         # create a new relation, or find the existing one
538         if relid > 0
539           relation = Relation.find(relid)
540         end
541         # We always need a new node, based on the data that has been sent to us
542         new_relation = Relation.new
543
544         # check the members are all positive, and correctly type
545         typedmembers = []
546         members.each do |m|
547           mid = m[1].to_i
548           if mid < 0
549             mid = renumberednodes[mid] if m[0] == 'Node'
550             mid = renumberedways[mid] if m[0] == 'Way'
551           end
552           if mid
553             typedmembers << [m[0], mid, m[2]]
554           end
555         end
556
557         # assign new contents
558         new_relation.members = typedmembers
559         new_relation.tags = tags
560         new_relation.visible = visible
561         new_relation.changeset_id = changeset_id
562         new_relation.version = version
563
564         if relid <= 0
565           # We're creating the relation
566           new_relation.create_with_history(user)
567         elsif visible
568           # We're updating the relation
569           new_relation.id = relid
570           relation.update_from(new_relation, user)
571         else
572           # We're deleting the relation
573           new_relation.id = relid
574           relation.delete_with_history!(new_relation, user)
575         end
576       end # transaction
577       
578       if relid <= 0
579         return [0, '', relid, new_relation.id, new_relation.version]
580       else
581         return [0, '', relid, relid, relation.version]
582       end
583    end
584   end
585
586   # Save a way to the database, including all nodes. Any nodes in the previous
587   # version and no longer used are deleted.
588   # 
589   # Parameters:
590   # 0. hash of renumbered nodes (added by amf_controller)
591   # 1. current user token (for authentication)
592   # 2. current changeset
593   # 3. new way version
594   # 4. way ID
595   # 5. list of nodes in way
596   # 6. hash of way tags
597   # 7. array of nodes to change (each one is [lon,lat,id,version,tags]),
598   # 8. hash of nodes to delete (id->version).
599   # 
600   # Returns:
601   # 0. '0' (code for success),
602   # 1. message,
603   # 2. original way id (unchanged),
604   # 3. new way id,
605   # 4. hash of renumbered nodes (old id=>new id),
606   # 5. way version,
607   # 6. hash of node versions (node=>version)
608
609   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc:
610     amf_handle_error("'putway' #{originalway}") do
611       # -- Initialise
612         
613       user = getuser(usertoken)
614       if !user then return -1,"You are not logged in, so the way could not be saved." end
615       if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
616
617       originalway = originalway.to_i
618       pointlist.collect! {|a| a.to_i }
619
620       way=nil   # this is returned, so scope it outside the transaction
621       nodeversions = {}
622       Way.transaction do
623
624         # -- Update each changed node
625
626         nodes.each do |a|
627           lon = a[0].to_f
628           lat = a[1].to_f
629           id = a[2].to_i
630           version = a[3].to_i
631           if id == 0  then return -2,"Server error - node with id 0 found in way #{originalway}." end
632           if lat== 90 then return -2,"Server error - node with latitude -90 found in way #{originalway}." end
633           if renumberednodes[id] then id = renumberednodes[id] end
634
635           node = Node.new
636           node.changeset_id = changeset_id
637           node.lat = lat
638           node.lon = lon
639           node.tags = a[4]
640           node.tags.delete('created_by')
641           node.version = version
642           if id <= 0
643             # We're creating the node
644             node.create_with_history(user)
645             renumberednodes[id] = node.id
646             nodeversions[node.id] = node.version
647           else
648             # We're updating an existing node
649             previous=Node.find(id)
650             node.id=id
651             previous.update_from(node, user)
652             nodeversions[previous.id] = previous.version
653           end
654         end
655
656         # -- Save revised way
657
658         pointlist.collect! {|a|
659           renumberednodes[a] ? renumberednodes[a]:a
660         } # renumber nodes
661         new_way = Way.new
662         new_way.tags = attributes
663         new_way.nds = pointlist
664         new_way.changeset_id = changeset_id
665         new_way.version = wayversion
666         if originalway <= 0
667           new_way.create_with_history(user)
668           way=new_way   # so we can get way.id and way.version
669         else
670           way = Way.find(originalway)
671           if way.tags!=attributes or way.nds!=pointlist or !way.visible?
672             new_way.id=originalway
673           way.update_from(new_way, user)
674           end
675         end
676
677         # -- Delete unwanted nodes
678
679         deletednodes.each do |id,v|
680           node = Node.find(id.to_i)
681           new_node = Node.new
682           new_node.changeset_id = changeset_id
683           new_node.version = v.to_i
684           new_node.id = id.to_i
685           begin
686             node.delete_with_history!(new_node, user)
687           rescue OSM::APIPreconditionFailedError => ex
688             # We don't do anything here as the node is being used elsewhere
689             # and we don't want to delete it
690           end
691         end
692
693       end # transaction
694
695       [0, '', originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes]
696     end
697   end
698
699   # Save POI to the database.
700   # Refuses save if the node has since become part of a way.
701   # Returns array with:
702   # 0. 0 (success),
703   # 1. success message,
704   # 2. original node id (unchanged),
705   # 3. new node id,
706   # 4. version.
707
708   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
709     amf_handle_error("'putpoi' #{id}") do
710       user = getuser(usertoken)
711       if !user then return -1,"You are not logged in, so the point could not be saved." end
712
713       id = id.to_i
714       visible = (visible.to_i == 1)
715       node = nil
716       new_node = nil
717       Node.transaction do
718         if id > 0 then
719           node = Node.find(id)
720
721           if !visible then
722             unless node.ways.empty? then return -1,"The point has since become part of a way, so you cannot save it as a POI.",id,id,version end
723           end
724         end
725         # We always need a new node, based on the data that has been sent to us
726         new_node = Node.new
727
728         new_node.changeset_id = changeset_id
729         new_node.version = version
730         new_node.lat = lat
731         new_node.lon = lon
732         new_node.tags = tags
733         if id <= 0 
734           # We're creating the node
735           new_node.create_with_history(user)
736         elsif visible
737           # We're updating the node
738           new_node.id=id
739           node.update_from(new_node, user)
740         else
741           # We're deleting the node
742           new_node.id=id
743           node.delete_with_history!(new_node, user)
744         end
745
746       end # transaction
747
748       if id <= 0
749         return [0, '', id, new_node.id, new_node.version]
750       else
751         return [0, '', id, node.id, node.version]
752       end 
753     end
754   end
755
756   # Read POI from database
757   # (only called on revert: POIs are usually read by whichways).
758   #
759   # Returns array of id, long, lat, hash of tags, (current) version.
760
761   def getpoi(id,timestamp) #:doc:
762     amf_handle_error("'getpoi' #{id}") do
763       id = id.to_i
764       n = Node.find(id)
765       v = n.version
766       unless timestamp == ''
767         n = OldNode.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC')
768       end
769
770       if n
771         return [0, '', n.id, n.lon, n.lat, n.tags, v]
772       else
773         return [-4, 'node', id, nil, nil, {}, nil]
774       end
775     end
776   end
777
778   # Delete way and all constituent nodes.
779   # Params:
780   # * The user token
781   # * the changeset id
782   # * the id of the way to change
783   # * the version of the way that was downloaded
784   # * a hash of the id and versions of all the nodes that are in the way, if any 
785   # of the nodes have been changed by someone else then, there is a problem!
786   # Returns 0 (success), unchanged way id, new way version, new node versions.
787
788   def deleteway(usertoken, changeset_id, way_id, way_version, deletednodes) #:doc:
789     amf_handle_error("'deleteway' #{way_id}") do
790       user = getuser(usertoken)
791       unless user then return -1,"You are not logged in, so the way could not be deleted." end
792       
793       way_id = way_id.to_i
794       nodeversions = {}
795       old_way=nil # returned, so scope it outside the transaction
796       # Need a transaction so that if one item fails to delete, the whole delete fails.
797       Way.transaction do
798
799         # -- Delete the way
800
801         old_way = Way.find(way_id)
802         delete_way = Way.new
803         delete_way.version = way_version
804         delete_way.changeset_id = changeset_id
805         delete_way.id = way_id
806         old_way.delete_with_history!(delete_way, user)
807
808         # -- Delete unwanted nodes
809
810         deletednodes.each do |id,v|
811           node = Node.find(id.to_i)
812           new_node = Node.new
813           new_node.changeset_id = changeset_id
814           new_node.version = v.to_i
815           new_node.id = id.to_i
816           begin
817             node.delete_with_history!(new_node, user)
818             nodeversions[node.id]=node.version
819           rescue OSM::APIPreconditionFailedError => ex
820             # We don't do anything with the exception as the node is in use
821             # elsewhere and we don't want to delete it
822           end
823         end
824
825       end # transaction
826       [0, '', way_id, old_way.version, nodeversions]
827     end
828   end
829
830
831   # ====================================================================
832   # Support functions
833
834   # Authenticate token
835   # (can also be of form user:pass)
836   # When we are writing to the api, we need the actual user model, 
837   # not just the id, hence this abstraction
838
839   def getuser(token) #:doc:
840     if (token =~ /^(.+)\:(.+)$/) then
841       user = User.authenticate(:username => $1, :password => $2)
842     else
843       user = User.authenticate(:token => token)
844     end
845     return user
846   end
847
848   # Send AMF response
849   
850   def sendresponse(results)
851     a,b=results.length.divmod(256)
852     render :content_type => "application/x-amf", :text => proc { |response, output| 
853       # ** move amf writing loop into here - 
854       # basically we read the messages in first (into an array of some sort),
855       # then iterate through that array within here, and do all the AMF writing
856       output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
857       results.each do |k,v|
858         output.write(v)
859       end
860     }
861   end
862
863
864   # ====================================================================
865   # Alternative SQL queries for getway/whichways
866
867   def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
868     sql=<<-EOF
869     SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
870       FROM current_way_nodes
871     INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
872     INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
873        WHERE current_nodes.visible=TRUE 
874        AND current_ways.visible=TRUE 
875        AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
876     EOF
877     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
878   end
879         
880   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
881     pois=[]
882     sql=<<-EOF
883                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version 
884                         FROM current_nodes 
885        LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
886                    WHERE current_nodes.visible=TRUE
887                          AND cwn.id IS NULL
888                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
889     EOF
890     ActiveRecord::Base.connection.select_all(sql).each do |row|
891       poitags={}
892       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
893         poitags[n['k']]=n['v']
894       end
895       pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
896     end
897     pois
898   end
899         
900   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
901     # ** It would be more Potlatchy to get relations for nodes within ways
902     #    during 'getway', not here
903     sql=<<-EOF
904       SELECT DISTINCT cr.id AS relid,cr.version AS version 
905       FROM current_relations cr
906       INNER JOIN current_relation_members crm ON crm.id=cr.id 
907       INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='Node' 
908        WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
909       EOF
910     unless way_ids.empty?
911       sql+=<<-EOF
912        UNION
913         SELECT DISTINCT cr.id AS relid,cr.version AS version
914         FROM current_relations cr
915         INNER JOIN current_relation_members crm ON crm.id=cr.id
916          WHERE crm.member_type='Way' 
917          AND crm.member_id IN (#{way_ids.join(',')})
918         EOF
919     end
920     ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
921   end
922         
923   def sql_get_nodes_in_way(wayid)
924     points=[]
925     sql=<<-EOF
926       SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,current_nodes.version 
927       FROM current_way_nodes,current_nodes 
928        WHERE current_way_nodes.id=#{wayid.to_i} 
929                    AND current_way_nodes.node_id=current_nodes.id 
930                    AND current_nodes.visible=TRUE
931       ORDER BY sequence_id
932           EOF
933     ActiveRecord::Base.connection.select_all(sql).each do |row|
934       nodetags={}
935       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
936         nodetags[n['k']]=n['v']
937       end
938       nodetags.delete('created_by')
939       points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags,row['version'].to_i]
940     end
941     points
942   end
943         
944   def sql_get_tags_in_way(wayid)
945     tags={}
946     ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
947       tags[row['k']]=row['v']
948     end
949     tags
950   end
951
952   def sql_get_way_version(wayid)
953     ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")['version']
954   end
955
956   def sql_get_way_user(wayid)
957     ActiveRecord::Base.connection.select_one("SELECT user FROM current_ways,changesets WHERE current_ways.id=#{wayid.to_i} AND current_ways.changeset=changesets.id")['user']
958   end
959 end
960