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