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