Merge 16110:16487 from trunk.
[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[0]))
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(lang) #:doc:
217     lang.gsub!(/[^\w\-]/,'')
218
219     begin
220       localised = YAML::load(File.open("#{RAILS_ROOT}/config/potlatch/localised/#{lang}/localised.yaml"))
221     rescue
222       localised = "" #¬†guess we'll just have to use the hardcoded English text instead
223     end
224
225     begin
226       help = File.read("#{RAILS_ROOT}/config/potlatch/localised/#{lang}/help.html")
227     rescue
228       help = File.read("#{RAILS_ROOT}/config/potlatch/localised/en/help.html")
229     end
230     return POTLATCH_PRESETS+[localised,help]
231   end
232
233   ##
234   # Find all the ways, POI nodes (i.e. not part of ways), and relations
235   # in a given bounding box. Nodes are returned in full; ways and relations 
236   # are IDs only. 
237   #
238   # return is of the form: 
239   # [success_code, success_message,
240   #  [[way_id, way_version], ...],
241   #  [[node_id, lat, lon, [tags, ...], node_version], ...],
242   #  [[rel_id, rel_version], ...]]
243   # where the ways are any visible ways which refer to any visible
244   # nodes in the bbox, nodes are any visible nodes in the bbox but not
245   # used in any way, rel is any relation which refers to either a way
246   # or node that we're returning.
247   def whichways(xmin, ymin, xmax, ymax) #:doc:
248     amf_handle_error_with_timeout("'whichways'") do
249       enlarge = [(xmax-xmin)/8,0.01].min
250       xmin -= enlarge; ymin -= enlarge
251       xmax += enlarge; ymax += enlarge
252
253       # check boundary is sane and area within defined
254       # see /config/application.yml
255       check_boundaries(xmin, ymin, xmax, ymax)
256
257       if POTLATCH_USE_SQL then
258         ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
259         points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
260         relations = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, ways.collect {|x| x[0]})
261       else
262         # find the way ids in an area
263         nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways)
264         ways = nodes_in_area.inject([]) { |sum, node| 
265           visible_ways = node.ways.select { |w| w.visible? }
266           sum + visible_ways.collect { |w| [w.id,w.version] }
267         }.uniq
268         ways.delete([])
269
270         # find the node ids in an area that aren't part of ways
271         nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
272         points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags, n.version] }.uniq
273
274         # find the relations used by those nodes and ways
275         relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) +
276                     Relation.find_for_ways(ways.collect { |w| w[0] }, :conditions => {:visible => true})
277         relations = relations.collect { |relation| [relation.id,relation.version] }.uniq
278       end
279
280       [0, '', ways, points, relations]
281     end
282   end
283
284   # Find deleted ways in current bounding box (similar to whichways, but ways
285   # with a deleted node only - not POIs or relations).
286
287   def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
288     amf_handle_error_with_timeout("'whichways_deleted'") do
289       enlarge = [(xmax-xmin)/8,0.01].min
290       xmin -= enlarge; ymin -= enlarge
291       xmax += enlarge; ymax += enlarge
292
293       # check boundary is sane and area within defined
294       # see /config/application.yml
295       check_boundaries(xmin, ymin, xmax, ymax)
296
297       nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history)
298       way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
299
300       [0,'',way_ids]
301     end
302   end
303
304   # Get a way including nodes and tags.
305   # Returns the way id, a Potlatch-style array of points, a hash of tags, the version number, and the user ID.
306
307   def getway(wayid) #:doc:
308     amf_handle_error_with_timeout("'getway' #{wayid}") do
309       if POTLATCH_USE_SQL then
310         points = sql_get_nodes_in_way(wayid)
311         tags = sql_get_tags_in_way(wayid)
312         version = sql_get_way_version(wayid)
313         uid = sql_get_way_user(wayid)
314       else
315         # Ideally we would do ":include => :nodes" here but if we do that
316         # then rails only seems to return the first copy of a node when a
317         # way includes a node more than once
318         way = Way.find(:first, :conditions => { :id => wayid }, :include => { :nodes => :node_tags })
319
320         # check case where way has been deleted or doesn't exist
321         return [-4, 'way', wayid, [], {}, nil] if way.nil? or !way.visible
322
323         points = way.nodes.collect do |node|
324           nodetags=node.tags
325           nodetags.delete('created_by')
326           [node.lon, node.lat, node.id, nodetags, node.version]
327         end
328         tags = way.tags
329         version = way.version
330         uid = way.changeset.user.id
331       end
332
333       [0, '', wayid, points, tags, version, uid]
334     end
335   end
336   
337   # Get an old version of a way, and all constituent nodes.
338   #
339   # For undelete (version<0), always uses the most recent version of each node, 
340   # even if it's moved.  For revert (version >= 0), uses the node in existence 
341   # at the time, generating a new id if it's still visible and has been moved/
342   # retagged.
343   #
344   # Returns:
345   # 0. success code, 
346   # 1. id, 
347   # 2. array of points, 
348   # 3. hash of tags, 
349   # 4. version, 
350   # 5. is this the current, visible version? (boolean)
351   
352   def getway_old(id, timestamp) #:doc:
353     amf_handle_error_with_timeout("'getway_old' #{id}, #{timestamp}") do
354       if timestamp == ''
355         # undelete
356         old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC')
357         points = old_way.get_nodes_undelete unless old_way.nil?
358       else
359         begin
360           # revert
361           timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S")
362           old_way = OldWay.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC')
363           unless old_way.nil?
364             points = old_way.get_nodes_revert(timestamp)
365             if !old_way.visible
366               return [-1, "Sorry, the way was deleted at that time - please revert to a previous version.", id, [], {}, nil, false]
367             end
368           end
369         rescue ArgumentError
370           # thrown by date parsing method. leave old_way as nil for
371           # the error handler below.
372         end
373       end
374
375       if old_way.nil?
376         return [-1, "Sorry, the server could not find a way at that time.", id, [], {}, nil, false]
377       else
378         curway=Way.find(id)
379         old_way.tags['history'] = "Retrieved from v#{old_way.version}"
380         return [0, '', id, points, old_way.tags, curway.version, (curway.version==old_way.version and curway.visible)]
381       end
382     end
383   end
384   
385   # Find history of a way.
386   # Returns 'way', id, and an array of previous versions:
387   # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
388   # - now [timestamp,user,uid]
389   #
390   # Heuristic: Find all nodes that have ever been part of the way; 
391   # get a list of their revision dates; add revision dates of the way;
392   # sort and collapse list (to within 2 seconds); trim all dates before the 
393   # start date of the way.
394
395   def getway_history(wayid) #:doc:
396     begin
397       # Find list of revision dates for way and all constituent nodes
398       revdates=[]
399       revusers={}
400       Way.find(wayid).old_ways.collect do |a|
401         revdates.push(a.timestamp)
402         unless revusers.has_key?(a.timestamp.to_i) then revusers[a.timestamp.to_i]=change_user(a) end
403         a.nds.each do |n|
404           Node.find(n).old_nodes.collect do |o|
405             revdates.push(o.timestamp)
406             unless revusers.has_key?(o.timestamp.to_i) then revusers[o.timestamp.to_i]=change_user(o) end
407           end
408         end
409       end
410       waycreated=revdates[0]
411       revdates.uniq!
412       revdates.sort!
413       revdates.reverse!
414
415       # Remove any dates (from nodes) before first revision date of way
416       revdates.delete_if { |d| d<waycreated }
417       # Remove any elements where 2 seconds doesn't elapse before next one
418       revdates.delete_if { |d| revdates.include?(d+1) or revdates.include?(d+2) }
419       # Collect all in one nested array
420       revdates.collect! {|d| [d.succ.strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] }
421       revdates.uniq!
422
423       return ['way', wayid, revdates]
424     rescue ActiveRecord::RecordNotFound
425       return ['way', wayid, []]
426     end
427   end
428   
429   # Find history of a node. Returns 'node', id, and an array of previous versions as above.
430
431   def getnode_history(nodeid) #:doc:
432     begin 
433       history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
434         [old_node.timestamp.succ.strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node)
435       end
436       return ['node', nodeid, history]
437     rescue ActiveRecord::RecordNotFound
438       return ['node', nodeid, []]
439     end
440   end
441
442   def change_user(obj)
443     user_object = obj.changeset.user
444     user = user_object.data_public? ? user_object.display_name : 'anonymous'
445     uid  = user_object.data_public? ? user_object.id : 0
446     [user,uid]
447   end
448
449   # Find GPS traces with specified name/id.
450   # Returns array listing GPXs, each one comprising id, name and description.
451   
452   def findgpx(searchterm, usertoken)
453     amf_handle_error_with_timeout("'findgpx'") do
454       user = getuser(usertoken)
455       if !uid then return -1,"You must be logged in to search for GPX traces.",[] end
456
457       gpxs = []
458       if searchterm.to_i>0 then
459         gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,user.id] )
460         if gpx then
461           gpxs.push([gpx.id, gpx.name, gpx.description])
462         end
463       else
464         Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,user.id,searchterm] ).each do |gpx|
465           gpxs.push([gpx.id, gpx.name, gpx.description])
466         end
467       end
468       [0,'',gpxs]
469     end
470   end
471
472   # Get a relation with all tags and members.
473   # Returns:
474   # 0. success code?
475   # 1. object type?
476   # 2. relation id,
477   # 3. hash of tags,
478   # 4. list of members,
479   # 5. version.
480   
481   def getrelation(relid) #:doc:
482     amf_handle_error("'getrelation' #{relid}") do
483       rel = Relation.find(:first, :conditions => { :id => relid })
484
485       return [-4, 'relation', relid, {}, [], nil] if rel.nil? or !rel.visible
486       [0, '', relid, rel.tags, rel.members, rel.version]
487     end
488   end
489
490   # Find relations with specified name/id.
491   # Returns array of relations, each in same form as getrelation.
492   
493   def findrelations(searchterm)
494     rels = []
495     if searchterm.to_i>0 then
496       rel = Relation.find(searchterm.to_i)
497       if rel and rel.visible then
498         rels.push([rel.id, rel.tags, rel.members, rel.version])
499       end
500     else
501       RelationTag.find(:all, :limit => 11, :conditions => ["v like ?", "%#{searchterm}%"] ).each do |t|
502         if t.relation.visible then
503           rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version])
504         end
505       end
506     end
507     rels
508   end
509
510   # Save a relation.
511   # Returns
512   # 0. 0 (success),
513   # 1. original relation id (unchanged),
514   # 2. new relation id,
515   # 3. version.
516
517   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
518     amf_handle_error("'putrelation' #{relid}")  do
519       user = getuser(usertoken)
520       if !user then return -1,"You are not logged in, so the relation could not be saved." end
521
522       relid = relid.to_i
523       visible = (visible.to_i != 0)
524
525       new_relation = nil
526       relation = nil
527       Relation.transaction do
528         # create a new relation, or find the existing one
529         if relid > 0
530           relation = Relation.find(relid)
531         end
532         # We always need a new node, based on the data that has been sent to us
533         new_relation = Relation.new
534
535         # check the members are all positive, and correctly type
536         typedmembers = []
537         members.each do |m|
538           mid = m[1].to_i
539           if mid < 0
540             mid = renumberednodes[mid] if m[0] == 'Node'
541             mid = renumberedways[mid] if m[0] == 'Way'
542           end
543           if mid
544             typedmembers << [m[0], mid, m[2]]
545           end
546         end
547
548         # assign new contents
549         new_relation.members = typedmembers
550         new_relation.tags = tags
551         new_relation.visible = visible
552         new_relation.changeset_id = changeset_id
553         new_relation.version = version
554
555         if relid <= 0
556           # We're creating the relation
557           new_relation.create_with_history(user)
558         elsif visible
559           # We're updating the relation
560           new_relation.id = relid
561           relation.update_from(new_relation, user)
562         else
563           # We're deleting the relation
564           new_relation.id = relid
565           relation.delete_with_history!(new_relation, user)
566         end
567       end # transaction
568       
569       if relid <= 0
570         return [0, '', relid, new_relation.id, new_relation.version]
571       else
572         return [0, '', relid, relid, relation.version]
573       end
574    end
575   end
576
577   # Save a way to the database, including all nodes. Any nodes in the previous
578   # version and no longer used are deleted.
579   # 
580   # Parameters:
581   # 0. hash of renumbered nodes (added by amf_controller)
582   # 1. current user token (for authentication)
583   # 2. current changeset
584   # 3. new way version
585   # 4. way ID
586   # 5. list of nodes in way
587   # 6. hash of way tags
588   # 7. array of nodes to change (each one is [lon,lat,id,version,tags]),
589   # 8. hash of nodes to delete (id->version).
590   # 
591   # Returns:
592   # 0. '0' (code for success),
593   # 1. message,
594   # 2. original way id (unchanged),
595   # 3. new way id,
596   # 4. hash of renumbered nodes (old id=>new id),
597   # 5. way version,
598   # 6. hash of node versions (node=>version)
599
600   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc:
601     amf_handle_error("'putway' #{originalway}") do
602       # -- Initialise
603         
604       user = getuser(usertoken)
605       if !user then return -1,"You are not logged in, so the way could not be saved." end
606       if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
607
608       originalway = originalway.to_i
609       pointlist.collect! {|a| a.to_i }
610
611       way=nil   # this is returned, so scope it outside the transaction
612       nodeversions = {}
613       Way.transaction do
614
615         # -- Update each changed node
616
617         nodes.each do |a|
618           lon = a[0].to_f
619           lat = a[1].to_f
620           id = a[2].to_i
621           version = a[3].to_i
622           if id == 0  then return -2,"Server error - node with id 0 found in way #{originalway}." end
623           if lat== 90 then return -2,"Server error - node with latitude -90 found in way #{originalway}." end
624           if renumberednodes[id] then id = renumberednodes[id] end
625
626           node = Node.new
627           node.changeset_id = changeset_id
628           node.lat = lat
629           node.lon = lon
630           node.tags = a[4]
631           node.tags.delete('created_by')
632           node.version = version
633           if id <= 0
634             # We're creating the node
635             node.create_with_history(user)
636             renumberednodes[id] = node.id
637             nodeversions[node.id] = node.version
638           else
639             # We're updating an existing node
640             previous=Node.find(id)
641             node.id=id
642             previous.update_from(node, user)
643             nodeversions[previous.id] = previous.version
644           end
645         end
646
647         # -- Save revised way
648
649         pointlist.collect! {|a|
650           renumberednodes[a] ? renumberednodes[a]:a
651         } # renumber nodes
652         new_way = Way.new
653         new_way.tags = attributes
654         new_way.nds = pointlist
655         new_way.changeset_id = changeset_id
656         new_way.version = wayversion
657         if originalway <= 0
658           new_way.create_with_history(user)
659           way=new_way   # so we can get way.id and way.version
660         else
661           way = Way.find(originalway)
662           if way.tags!=attributes or way.nds!=pointlist or !way.visible?
663             new_way.id=originalway
664           way.update_from(new_way, user)
665           end
666         end
667
668         # -- Delete unwanted nodes
669
670         deletednodes.each do |id,v|
671           node = Node.find(id.to_i)
672           new_node = Node.new
673           new_node.changeset_id = changeset_id
674           new_node.version = v.to_i
675           new_node.id = id.to_i
676           begin
677             node.delete_with_history!(new_node, user)
678           rescue OSM::APIPreconditionFailedError => ex
679             # We don't do anything here as the node is being used elsewhere
680             # and we don't want to delete it
681           end
682         end
683
684       end # transaction
685
686       [0, '', originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes]
687     end
688   end
689
690   # Save POI to the database.
691   # Refuses save if the node has since become part of a way.
692   # Returns array with:
693   # 0. 0 (success),
694   # 1. success message,
695   # 2. original node id (unchanged),
696   # 3. new node id,
697   # 4. version.
698
699   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
700     amf_handle_error("'putpoi' #{id}") do
701       user = getuser(usertoken)
702       if !user then return -1,"You are not logged in, so the point could not be saved." end
703
704       id = id.to_i
705       visible = (visible.to_i == 1)
706       node = nil
707       new_node = nil
708       Node.transaction do
709         if id > 0 then
710           node = Node.find(id)
711
712           if !visible then
713             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
714           end
715         end
716         # We always need a new node, based on the data that has been sent to us
717         new_node = Node.new
718
719         new_node.changeset_id = changeset_id
720         new_node.version = version
721         new_node.lat = lat
722         new_node.lon = lon
723         new_node.tags = tags
724         if id <= 0 
725           # We're creating the node
726           new_node.create_with_history(user)
727         elsif visible
728           # We're updating the node
729           new_node.id=id
730           node.update_from(new_node, user)
731         else
732           # We're deleting the node
733           new_node.id=id
734           node.delete_with_history!(new_node, user)
735         end
736
737       end # transaction
738
739       if id <= 0
740         return [0, '', id, new_node.id, new_node.version]
741       else
742         return [0, '', id, node.id, node.version]
743       end 
744     end
745   end
746
747   # Read POI from database
748   # (only called on revert: POIs are usually read by whichways).
749   #
750   # Returns array of id, long, lat, hash of tags, (current) version.
751
752   def getpoi(id,timestamp) #:doc:
753     amf_handle_error("'getpoi' #{id}") do
754       id = id.to_i
755       n = Node.find(id)
756       v = n.version
757       unless timestamp == ''
758         n = OldNode.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC')
759       end
760
761       if n
762         return [0, '', n.id, n.lon, n.lat, n.tags, v]
763       else
764         return [-4, 'node', id, nil, nil, {}, nil]
765       end
766     end
767   end
768
769   # Delete way and all constituent nodes.
770   # Params:
771   # * The user token
772   # * the changeset id
773   # * the id of the way to change
774   # * the version of the way that was downloaded
775   # * a hash of the id and versions of all the nodes that are in the way, if any 
776   # of the nodes have been changed by someone else then, there is a problem!
777   # Returns 0 (success), unchanged way id, new way version, new node versions.
778
779   def deleteway(usertoken, changeset_id, way_id, way_version, deletednodes) #:doc:
780     amf_handle_error("'deleteway' #{way_id}") do
781       user = getuser(usertoken)
782       unless user then return -1,"You are not logged in, so the way could not be deleted." end
783       
784       way_id = way_id.to_i
785       nodeversions = {}
786       old_way=nil # returned, so scope it outside the transaction
787       # Need a transaction so that if one item fails to delete, the whole delete fails.
788       Way.transaction do
789
790         # -- Delete the way
791
792         old_way = Way.find(way_id)
793         delete_way = Way.new
794         delete_way.version = way_version
795         delete_way.changeset_id = changeset_id
796         delete_way.id = way_id
797         old_way.delete_with_history!(delete_way, user)
798
799         # -- Delete unwanted nodes
800
801         deletednodes.each do |id,v|
802           node = Node.find(id.to_i)
803           new_node = Node.new
804           new_node.changeset_id = changeset_id
805           new_node.version = v.to_i
806           new_node.id = id.to_i
807           begin
808             node.delete_with_history!(new_node, user)
809             nodeversions[node.id]=node.version
810           rescue OSM::APIPreconditionFailedError => ex
811             # We don't do anything with the exception as the node is in use
812             # elsewhere and we don't want to delete it
813           end
814         end
815
816       end # transaction
817       [0, '', way_id, old_way.version, nodeversions]
818     end
819   end
820
821
822   # ====================================================================
823   # Support functions
824
825   # Authenticate token
826   # (can also be of form user:pass)
827   # When we are writing to the api, we need the actual user model, 
828   # not just the id, hence this abstraction
829
830   def getuser(token) #:doc:
831     if (token =~ /^(.+)\:(.+)$/) then
832       user = User.authenticate(:username => $1, :password => $2)
833     else
834       user = User.authenticate(:token => token)
835     end
836     return user
837   end
838
839   # Send AMF response
840   
841   def sendresponse(results)
842     a,b=results.length.divmod(256)
843     render :content_type => "application/x-amf", :text => proc { |response, output| 
844       # ** move amf writing loop into here - 
845       # basically we read the messages in first (into an array of some sort),
846       # then iterate through that array within here, and do all the AMF writing
847       output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
848       results.each do |k,v|
849         output.write(v)
850       end
851     }
852   end
853
854
855   # ====================================================================
856   # Alternative SQL queries for getway/whichways
857
858   def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
859     sql=<<-EOF
860     SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
861       FROM current_way_nodes
862     INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
863     INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
864        WHERE current_nodes.visible=TRUE 
865        AND current_ways.visible=TRUE 
866        AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
867     EOF
868     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
869   end
870         
871   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
872     pois=[]
873     sql=<<-EOF
874                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version 
875                         FROM current_nodes 
876        LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
877                    WHERE current_nodes.visible=TRUE
878                          AND cwn.id IS NULL
879                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
880     EOF
881     ActiveRecord::Base.connection.select_all(sql).each do |row|
882       poitags={}
883       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
884         poitags[n['k']]=n['v']
885       end
886       pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
887     end
888     pois
889   end
890         
891   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
892     # ** It would be more Potlatchy to get relations for nodes within ways
893     #    during 'getway', not here
894     sql=<<-EOF
895       SELECT DISTINCT cr.id AS relid,cr.version AS version 
896       FROM current_relations cr
897       INNER JOIN current_relation_members crm ON crm.id=cr.id 
898       INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='Node' 
899        WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
900       EOF
901     unless way_ids.empty?
902       sql+=<<-EOF
903        UNION
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          WHERE crm.member_type='Way' 
908          AND crm.member_id IN (#{way_ids.join(',')})
909         EOF
910     end
911     ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
912   end
913         
914   def sql_get_nodes_in_way(wayid)
915     points=[]
916     sql=<<-EOF
917       SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,current_nodes.version 
918       FROM current_way_nodes,current_nodes 
919        WHERE current_way_nodes.id=#{wayid.to_i} 
920                    AND current_way_nodes.node_id=current_nodes.id 
921                    AND current_nodes.visible=TRUE
922       ORDER BY sequence_id
923           EOF
924     ActiveRecord::Base.connection.select_all(sql).each do |row|
925       nodetags={}
926       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
927         nodetags[n['k']]=n['v']
928       end
929       nodetags.delete('created_by')
930       points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags,row['version'].to_i]
931     end
932     points
933   end
934         
935   def sql_get_tags_in_way(wayid)
936     tags={}
937     ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
938       tags[row['k']]=row['v']
939     end
940     tags
941   end
942
943   def sql_get_way_version(wayid)
944     ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")['version']
945   end
946
947   def sql_get_way_user(wayid)
948     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']
949   end
950 end
951