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