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