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