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