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