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