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