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