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