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