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