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