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