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