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