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