13f7423816d117eb4f6ceeb96278db3f59f89eb2
[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. success code?
452   # 1. object type?
453   # 2. relation id,
454   # 3. hash of tags,
455   # 4. list of members,
456   # 5. version.
457   
458   def getrelation(relid) #:doc:
459     begin
460       rel = Relation.find(relid)
461     rescue ActiveRecord::RecordNotFound
462       return [-4, 'relation', relid, {}, [], nil]
463     end
464
465     return [-4, 'relation', relid, {}, [], nil] if rel.nil? or !rel.visible
466     [0, '', relid, rel.tags, rel.members, rel.version]
467   end
468
469   # Find relations with specified name/id.
470   # Returns array of relations, each in same form as getrelation.
471   
472   def findrelations(searchterm)
473     rels = []
474     if searchterm.to_i>0 then
475       rel = Relation.find(searchterm.to_i)
476       if rel and rel.visible then
477         rels.push([rel.id, rel.tags, rel.members, rel.version])
478       end
479     else
480       RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
481       if t.relation.visible then
482               rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version])
483             end
484           end
485         end
486     rels
487   end
488
489   # Save a relation.
490   # Returns
491   # 0. 0 (success),
492   # 1. original relation id (unchanged),
493   # 2. new relation id,
494   # 3. version.
495
496   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
497     user = getuser(usertoken)
498     if !user then return -1,"You are not logged in, so the relation could not be saved." end
499
500     relid = relid.to_i
501     visible = (visible.to_i != 0)
502
503     new_relation = nil
504     relation = nil
505     Relation.transaction do
506       # create a new relation, or find the existing one
507       if relid > 0
508         relation = Relation.find(relid)
509       end
510       # We always need a new node, based on the data that has been sent to us
511       new_relation = Relation.new
512
513       # check the members are all positive, and correctly type
514       typedmembers = []
515       members.each do |m|
516         mid = m[1].to_i
517         if mid < 0
518           mid = renumberednodes[mid] if m[0] == 'Node'
519           mid = renumberedways[mid] if m[0] == 'Way'
520         end
521         if mid
522           typedmembers << [m[0], mid, m[2]]
523         end
524       end
525
526       # assign new contents
527       new_relation.members = typedmembers
528       new_relation.tags = tags
529       new_relation.visible = visible
530       new_relation.changeset_id = changeset_id
531       new_relation.version = version
532
533       if relid <= 0
534         # We're creating the relation
535         new_relation.create_with_history(user)
536       elsif visible
537         # We're updating the relation
538         new_relation.id = relid
539         relation.update_from(new_relation, user)
540       else
541         # We're deleting the relation
542         new_relation.id = relid
543         relation.delete_with_history!(new_relation, user)
544       end
545     end # transaction
546       
547     if relid <= 0
548       return [0, '', relid, new_relation.id, new_relation.version]
549     else
550       return [0, '', relid, relid, relation.version]
551     end
552   rescue OSM::APIChangesetAlreadyClosedError => ex
553     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}.", relid, relid, nil]
554   rescue OSM::APIVersionMismatchError => ex
555     a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/)
556     return [-3, ['relation', a[1]], relid, relid, nil]
557   rescue OSM::APIAlreadyDeletedError => ex
558     return [-1, "The relation has already been deleted.", relid, relid, nil]
559   rescue OSM::APIError => ex
560     # Some error that we don't specifically catch
561     return [-2, "An unusual error happened (in 'putrelation' #{relid}). The server said: #{ex}", relid, relid, nil]
562   end
563
564   # Save a way to the database, including all nodes. Any nodes in the previous
565   # version and no longer used are deleted.
566   # 
567   # Parameters:
568   # 0. hash of renumbered nodes (added by amf_controller)
569   # 1. current user token (for authentication)
570   # 2. current changeset
571   # 3. new way version
572   # 4. way ID
573   # 5. list of nodes in way
574   # 6. hash of way tags
575   # 7. array of nodes to change (each one is [lon,lat,id,version,tags]),
576   # 8. hash of nodes to delete (id->version).
577   # 
578   # Returns:
579   # 0. '0' (code for success),
580   # 1. original way id (unchanged),
581   # 2. new way id,
582   # 3. hash of renumbered nodes (old id=>new id),
583   # 4. way version,
584   # 5. hash of node versions (node=>version)
585
586   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc:
587
588     # -- Initialise
589         
590     user = getuser(usertoken)
591     if !user then return -1,"You are not logged in, so the way could not be saved." end
592     if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
593
594     originalway = originalway.to_i
595 logger.info("received #{pointlist} for #{originalway}")
596         pointlist.collect! {|a| a.to_i }
597 logger.info("converted to #{pointlist}")
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 logger.info("renumberednodes is #{renumberednodes.inspect}")
638           pointlist.collect! {|a|
639               renumberednodes[a] ? renumberednodes[a]:a
640           } # renumber nodes
641 logger.info("saving with #{pointlist}")
642       new_way = Way.new
643       new_way.tags = attributes
644       new_way.nds = pointlist
645       new_way.changeset_id = changeset_id
646       new_way.version = wayversion
647       if originalway <= 0
648         new_way.create_with_history(user)
649         way=new_way     # so we can get way.id and way.version
650       else
651               way = Way.find(originalway)
652                   if way.tags!=attributes or way.nds!=pointlist or !way.visible?
653                     new_way.id=originalway
654           way.update_from(new_way, user)
655         end
656       end
657
658       # -- Delete unwanted nodes
659
660       deletednodes.each do |id,v|
661         node = Node.find(id.to_i)
662         new_node = Node.new
663         new_node.changeset_id = changeset_id
664         new_node.version = v.to_i
665         new_node.id = id.to_i
666         begin
667           node.delete_with_history!(new_node, user)
668         rescue OSM::APIPreconditionFailedError => ex
669           # We don't do anything here as the node is being used elsewhere
670           # and we don't want to delete it
671         end
672       end
673
674     end # transaction
675
676     [0, '', originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes]
677   rescue OSM::APIChangesetAlreadyClosedError => ex
678     return [-1, "Sorry, your changeset #{ex.changeset.id} was closed (at #{ex.changeset.closed_at}).", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes]
679   rescue OSM::APIVersionMismatchError => ex
680     a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/)
681     return [-3, ['way', a[1], a[2].downcase, a[3]], originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes]
682   rescue OSM::APITooManyWayNodesError => ex
683     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]
684   rescue OSM::APIAlreadyDeletedError => ex
685     return [-1, "The point has already been deleted.", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes]
686   rescue OSM::APIError => ex
687     # Some error that we don't specifically catch
688     return [-2, "An unusual error happened (in 'putway' #{originalway}). The server said: #{ex}", originalway, originalway, renumberednodes, wayversion, nodeversions, deletednodes]
689   end
690
691   # Save POI to the database.
692   # Refuses save if the node has since become part of a way.
693   # Returns array with:
694   # 0. 0 (success),
695   # 1. success message,
696   # 2. original node id (unchanged),
697   # 3. new node id,
698   # 4. version.
699
700   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
701     user = getuser(usertoken)
702     if !user then return -1,"You are not logged in, so the point could not be saved." end
703
704     id = id.to_i
705     visible = (visible.to_i == 1)
706     node = nil
707     new_node = nil
708     Node.transaction do
709       if id > 0 then
710         node = Node.find(id)
711
712         if !visible then
713           unless node.ways.empty? then return -1,"The point has since become part of a way, so you cannot save it as a POI.",id,id,version end
714         end
715       end
716       # We always need a new node, based on the data that has been sent to us
717       new_node = Node.new
718
719       new_node.changeset_id = changeset_id
720       new_node.version = version
721       new_node.lat = lat
722       new_node.lon = lon
723       new_node.tags = tags
724       if id <= 0 
725         # We're creating the node
726         new_node.create_with_history(user)
727       elsif visible
728         # We're updating the node
729         new_node.id=id
730         node.update_from(new_node, user)
731       else
732         # We're deleting the node
733         new_node.id=id
734         node.delete_with_history!(new_node, user)
735       end
736
737     end # transaction
738
739     if id <= 0
740       return [0, '', id, new_node.id, new_node.version]
741     else
742       return [0, '', id, node.id, node.version]
743     end 
744   rescue OSM::APIChangesetAlreadyClosedError => ex
745     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}",id,id,version]
746   rescue OSM::APIVersionMismatchError => ex
747     a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/)
748     return [-3, ['node', a[1]], id,id,version]
749   rescue OSM::APIAlreadyDeletedError => ex
750     return [-1, "The point has already been deleted",id,id,version]
751   rescue OSM::APIError => ex
752     # Some error that we don't specifically catch
753     return [-2, "An unusual error happened (in 'putpoi' #{id}). The server said: #{ex}",id,id,version]
754   end
755
756   # Read POI from database
757   # (only called on revert: POIs are usually read by whichways).
758   #
759   # Returns array of id, long, lat, hash of tags, (current) version.
760
761   def getpoi(id,timestamp) #:doc:
762     n = Node.find(id)
763     v = n.version
764     unless timestamp == ''
765       n = OldNode.find(id, :conditions=>['timestamp=?',DateTime.strptime(timestamp, "%d %b %Y, %H:%M:%S")])
766     end
767
768     if n
769       return [0, '', n.id, n.lon, n.lat, n.tags, v]
770     else
771       return [-4, 'node', id, nil, nil, {}, nil]
772     end
773   end
774
775   # Delete way and all constituent nodes.
776   # Params:
777   # * The user token
778   # * the changeset id
779   # * the id of the way to change
780   # * the version of the way that was downloaded
781   # * a hash of the id and versions of all the nodes that are in the way, if any 
782   # of the nodes have been changed by someone else then, there is a problem!
783   # Returns 0 (success), unchanged way id, new way version, new node versions.
784
785   def deleteway(usertoken, changeset_id, way_id, way_version, deletednodes) #:doc:
786     user = getuser(usertoken)
787     unless user then return -1,"You are not logged in, so the way could not be deleted." end
788       
789     way_id = way_id.to_i
790     nodeversions = {}
791     old_way=nil # returned, so scope it outside the transaction
792     # Need a transaction so that if one item fails to delete, the whole delete fails.
793     Way.transaction do
794
795       # -- Delete the way
796
797       old_way = Way.find(way_id)
798       delete_way = Way.new
799       delete_way.version = way_version
800       delete_way.changeset_id = changeset_id
801       delete_way.id = way_id
802       old_way.delete_with_history!(delete_way, user)
803
804       # -- Delete unwanted nodes
805
806       deletednodes.each do |id,v|
807         node = Node.find(id.to_i)
808         new_node = Node.new
809         new_node.changeset_id = changeset_id
810         new_node.version = v.to_i
811         new_node.id = id.to_i
812         begin
813           node.delete_with_history!(new_node, user)
814           nodeversions[node.id]=node.version
815         rescue OSM::APIPreconditionFailedError => ex
816           # We don't do anything with the exception as the node is in use
817           # elsewhere and we don't want to delete it
818         end
819       end
820
821     end # transaction
822     [0, '', way_id, old_way.version, nodeversions]
823   rescue OSM::APIChangesetAlreadyClosedError => ex
824     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}",way_id,way_version,nodeversions]
825   rescue OSM::APIVersionMismatchError => ex
826     a=ex.to_s.match(/(\d+) of (\w+) (\d+)$/)
827     return [-3, ['way', a[1]],way_id,way_version,nodeversions]
828   rescue OSM::APIAlreadyDeletedError => ex
829     return [-1, "The way has already been deleted.",way_id,way_version,nodeversions]
830   rescue OSM::APIError => ex
831     # Some error that we don't specifically catch
832     return [-2, "An unusual error happened (in 'deleteway' #{way_id}). The server said: #{ex}",way_id,way_version,nodeversions]
833   end
834
835
836   # ====================================================================
837   # Support functions
838
839   # Authenticate token
840   # (can also be of form user:pass)
841   # When we are writing to the api, we need the actual user model, 
842   # not just the id, hence this abstraction
843
844   def getuser(token) #:doc:
845     if (token =~ /^(.+)\:(.+)$/) then
846       user = User.authenticate(:username => $1, :password => $2)
847     else
848       user = User.authenticate(:token => token)
849     end
850     return user
851   end
852
853   # Send AMF response
854   
855   def sendresponse(results)
856     a,b=results.length.divmod(256)
857     render :content_type => "application/x-amf", :text => proc { |response, output| 
858       # ** move amf writing loop into here - 
859       # basically we read the messages in first (into an array of some sort),
860       # then iterate through that array within here, and do all the AMF writing
861       output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
862       results.each do |k,v|
863         output.write(v)
864       end
865     }
866   end
867
868
869   # ====================================================================
870   # Alternative SQL queries for getway/whichways
871
872   def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
873     sql=<<-EOF
874     SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
875       FROM current_way_nodes
876     INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
877     INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
878        WHERE current_nodes.visible=TRUE 
879        AND current_ways.visible=TRUE 
880        AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
881     EOF
882     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
883   end
884         
885   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
886     pois=[]
887     sql=<<-EOF
888                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version 
889                         FROM current_nodes 
890        LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
891                    WHERE current_nodes.visible=TRUE
892                          AND cwn.id IS NULL
893                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
894     EOF
895     ActiveRecord::Base.connection.select_all(sql).each do |row|
896       poitags={}
897       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
898         poitags[n['k']]=n['v']
899       end
900       pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
901     end
902     pois
903   end
904         
905   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
906     # ** It would be more Potlatchy to get relations for nodes within ways
907     #    during 'getway', not here
908     sql=<<-EOF
909       SELECT DISTINCT cr.id AS relid,cr.version AS version 
910       FROM current_relations cr
911       INNER JOIN current_relation_members crm ON crm.id=cr.id 
912       INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='Node' 
913        WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
914       EOF
915     unless way_ids.empty?
916       sql+=<<-EOF
917        UNION
918         SELECT DISTINCT cr.id AS relid,cr.version AS version
919         FROM current_relations cr
920         INNER JOIN current_relation_members crm ON crm.id=cr.id
921          WHERE crm.member_type='Way' 
922          AND crm.member_id IN (#{way_ids.join(',')})
923         EOF
924     end
925     ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
926   end
927         
928   def sql_get_nodes_in_way(wayid)
929     points=[]
930     sql=<<-EOF
931       SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,current_nodes.version 
932       FROM current_way_nodes,current_nodes 
933        WHERE current_way_nodes.id=#{wayid.to_i} 
934                    AND current_way_nodes.node_id=current_nodes.id 
935                    AND current_nodes.visible=TRUE
936       ORDER BY sequence_id
937           EOF
938     ActiveRecord::Base.connection.select_all(sql).each do |row|
939       nodetags={}
940       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
941         nodetags[n['k']]=n['v']
942       end
943       nodetags.delete('created_by')
944       points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags,row['version'].to_i]
945     end
946     points
947   end
948         
949   def sql_get_tags_in_way(wayid)
950     tags={}
951     ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
952       tags[row['k']]=row['v']
953     end
954     tags
955   end
956
957   def sql_get_way_version(wayid)
958     ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")
959   end
960 end
961