Fix rubocop lint issues
[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' then        result = getpresets(*args)
55         when 'whichways' then         result = whichways(*args)
56         when 'whichways_deleted' then result = whichways_deleted(*args)
57         when 'getway' then            result = getway(args[0].to_i)
58         when 'getrelation' then       result = getrelation(args[0].to_i)
59         when 'getway_old' then        result = getway_old(args[0].to_i, args[1])
60         when 'getway_history' then    result = getway_history(args[0].to_i)
61         when 'getnode_history' then   result = getnode_history(args[0].to_i)
62         when 'findgpx' then           result = findgpx(*args)
63         when 'findrelations' then     result = findrelations(*args)
64         when 'getpoi' then            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' then         orn = renumberednodes.dup
86                                      result = putway(renumberednodes, *args)
87                                      result[4] = renumberednodes.reject { |k, _v| orn.key?(k) }
88                                      if result[0] == 0 && result[2] != result[3] then renumberedways[result[2]] = result[3] end
89           when 'putrelation' then    result = putrelation(renumberednodes, renumberedways, *args)
90           when 'deleteway' then      result = deleteway(*args)
91           when 'putpoi' then         result = putpoi(*args)
92                                      if result[0] == 0 && result[2] != result[3] then renumberednodes[result[2]] = result[3] end
93           when 'startchangeset' then 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}"]
115   rescue OSM::APIError => ex
116     return [-1, ex.to_s]
117   rescue StandardError => ex
118     return [-2, "An unusual error happened (in #{call}). The server said: #{ex}"]
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       unless 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 && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
138
139       if cstags
140         unless 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           fail 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         unless 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 do |id|
204       POTLATCH_PRESETS[11][id] = localised["preset_icon_#{id}"]
205       localised.delete("preset_icon_#{id}")
206     end
207
208     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
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([]) do |sum, node|
269           visible_ways = node.ways.select(&:visible?)
270           sum + visible_ways.collect { |w| [w.id, w.version] }
271         end.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(&: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(&: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
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? || !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             unless 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           old_way = nil
379         end
380       end
381
382       if old_way.nil?
383         return [-1, "Sorry, the server could not find a way at that time.", id]
384       else
385         curway = Way.find(id)
386         old_way.tags['history'] = "Retrieved from v#{old_way.version}"
387         return [0, '', id, points, old_way.tags, curway.version, (curway.version == old_way.version && curway.visible)]
388       end
389     end
390   end
391
392   # Find history of a way.
393   # Returns 'way', id, and an array of previous versions:
394   # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
395   # - now [timestamp,user,uid]
396   #
397   # Heuristic: Find all nodes that have ever been part of the way;
398   # get a list of their revision dates; add revision dates of the way;
399   # sort and collapse list (to within 2 seconds); trim all dates before the
400   # start date of the way.
401
402   def getway_history(wayid) #:doc:
403     revdates = []
404     revusers = {}
405     Way.find(wayid).old_ways.unredacted.collect do |a|
406       revdates.push(a.timestamp)
407       unless revusers.key?(a.timestamp.to_i) then revusers[a.timestamp.to_i] = change_user(a) end
408       a.nds.each do |n|
409         Node.find(n).old_nodes.unredacted.collect do |o|
410           revdates.push(o.timestamp)
411           unless revusers.key?(o.timestamp.to_i) then revusers[o.timestamp.to_i] = change_user(o) end
412         end
413       end
414     end
415     waycreated = revdates[0]
416     revdates.uniq!
417     revdates.sort!
418     revdates.reverse!
419
420     # Remove any dates (from nodes) before first revision date of way
421     revdates.delete_if { |d| d < waycreated }
422     # Remove any elements where 2 seconds doesn't elapse before next one
423     revdates.delete_if { |d| revdates.include?(d + 1) || revdates.include?(d + 2) }
424     # Collect all in one nested array
425     revdates.collect! { |d| [(d + 1).strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] }
426     revdates.uniq!
427
428     return ['way', wayid, revdates]
429   rescue ActiveRecord::RecordNotFound
430     return ['way', wayid, []]
431   end
432
433   # Find history of a node. Returns 'node', id, and an array of previous versions as above.
434
435   def getnode_history(nodeid) #:doc:
436     history = Node.find(nodeid).old_nodes.unredacted.reverse.collect do |old_node|
437       [(old_node.timestamp + 1).strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node)
438     end
439     return ['node', nodeid, history]
440   rescue ActiveRecord::RecordNotFound
441     return ['node', nodeid, []]
442   end
443
444   def change_user(obj)
445     user_object = obj.changeset.user
446     user = user_object.data_public? ? user_object.display_name : 'anonymous'
447     uid  = user_object.data_public? ? user_object.id : 0
448     [user, uid]
449   end
450
451   # Find GPS traces with specified name/id.
452   # Returns array listing GPXs, each one comprising id, name and description.
453
454   def findgpx(searchterm, usertoken)
455     amf_handle_error_with_timeout("'findgpx'", nil, nil) do
456       user = getuser(usertoken)
457       unless user then return -1, "You must be logged in to search for GPX traces." end
458       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
459
460       query = Trace.visible_to(user)
461       if searchterm.to_i > 0
462         query = query.where(:id => searchterm.to_i)
463       else
464         query = query.where("MATCH(name) AGAINST (?)", searchterm).limit(21)
465       end
466       gpxs = query.collect do |gpx|
467         [gpx.id, gpx.name, gpx.description]
468       end
469       [0, '', gpxs]
470     end
471   end
472
473   # Get a relation with all tags and members.
474   # Returns:
475   # 0. success code?
476   # 1. object type?
477   # 2. relation id,
478   # 3. hash of tags,
479   # 4. list of members,
480   # 5. version.
481
482   def getrelation(relid) #:doc:
483     amf_handle_error("'getrelation' #{relid}", 'relation', relid) do
484       rel = Relation.where(:id => relid).first
485
486       return [-4, 'relation', relid] if rel.nil? || !rel.visible
487       [0, '', relid, rel.tags, rel.members, rel.version]
488     end
489   end
490
491   # Find relations with specified name/id.
492   # Returns array of relations, each in same form as getrelation.
493
494   def findrelations(searchterm)
495     rels = []
496     if searchterm.to_i > 0
497       rel = Relation.where(:id => searchterm.to_i).first
498       if rel && rel.visible
499         rels.push([rel.id, rel.tags, rel.members, rel.version])
500       end
501     else
502       RelationTag.where("v like ?", "%#{searchterm}%").limit(11).each do |t|
503         if t.relation.visible
504           rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version])
505         end
506       end
507     end
508     rels
509   end
510
511   # Save a relation.
512   # Returns
513   # 0. 0 (success),
514   # 1. original relation id (unchanged),
515   # 2. new relation id,
516   # 3. version.
517
518   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
519     amf_handle_error("'putrelation' #{relid}", 'relation', relid)  do
520       user = getuser(usertoken)
521       unless user then return -1, "You are not logged in, so the relation could not be saved." end
522       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
523       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
524
525       unless tags_ok(tags) then return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." end
526       tags = strip_non_xml_chars tags
527
528       relid = relid.to_i
529       visible = (visible.to_i != 0)
530
531       new_relation = nil
532       relation = nil
533       Relation.transaction do
534         # create a new relation, or find the existing one
535         if relid > 0
536           relation = Relation.find(relid)
537         end
538         # We always need a new node, based on the data that has been sent to us
539         new_relation = Relation.new
540
541         # check the members are all positive, and correctly type
542         typedmembers = []
543         members.each do |m|
544           mid = m[1].to_i
545           if mid < 0
546             mid = renumberednodes[mid] if m[0] == 'Node'
547             mid = renumberedways[mid] if m[0] == 'Way'
548           end
549           if mid
550             typedmembers << [m[0], mid, m[2].delete("\000-\037\ufffe\uffff", "^\011\012\015")]
551           end
552         end
553
554         # assign new contents
555         new_relation.members = typedmembers
556         new_relation.tags = tags
557         new_relation.visible = visible
558         new_relation.changeset_id = changeset_id
559         new_relation.version = version
560
561         if relid <= 0
562           # We're creating the relation
563           new_relation.create_with_history(user)
564         elsif visible
565           # We're updating the relation
566           new_relation.id = relid
567           relation.update_from(new_relation, user)
568         else
569           # We're deleting the relation
570           new_relation.id = relid
571           relation.delete_with_history!(new_relation, user)
572         end
573       end # transaction
574
575       if relid <= 0
576         return [0, '', relid, new_relation.id, new_relation.version]
577       else
578         return [0, '', relid, relid, relation.version]
579       end
580     end
581   end
582
583   # Save a way to the database, including all nodes. Any nodes in the previous
584   # version and no longer used are deleted.
585   #
586   # Parameters:
587   # 0. hash of renumbered nodes (added by amf_controller)
588   # 1. current user token (for authentication)
589   # 2. current changeset
590   # 3. new way version
591   # 4. way ID
592   # 5. list of nodes in way
593   # 6. hash of way tags
594   # 7. array of nodes to change (each one is [lon,lat,id,version,tags]),
595   # 8. hash of nodes to delete (id->version).
596   #
597   # Returns:
598   # 0. '0' (code for success),
599   # 1. message,
600   # 2. original way id (unchanged),
601   # 3. new way id,
602   # 4. hash of renumbered nodes (old id=>new id),
603   # 5. way version,
604   # 6. hash of node versions (node=>version)
605
606   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc:
607     amf_handle_error("'putway' #{originalway}", 'way', originalway) do
608       # -- Initialise
609
610       user = getuser(usertoken)
611       unless user then return -1, "You are not logged in, so the way could not be saved." end
612       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
613       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
614
615       if pointlist.length < 2 then return -2, "Server error - way is only #{points.length} points long." end
616
617       unless tags_ok(attributes) then return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." end
618       attributes = strip_non_xml_chars attributes
619
620       originalway = originalway.to_i
621       pointlist.collect!(&:to_i)
622
623       way = nil # this is returned, so scope it outside the transaction
624       nodeversions = {}
625       Way.transaction do
626         # -- Update each changed node
627
628         nodes.each do |a|
629           lon = a[0].to_f
630           lat = a[1].to_f
631           id = a[2].to_i
632           version = a[3].to_i
633
634           if id == 0  then return -2, "Server error - node with id 0 found in way #{originalway}." end
635           if lat == 90 then return -2, "Server error - node with latitude -90 found in way #{originalway}." end
636           if renumberednodes[id] then id = renumberednodes[id] end
637
638           node = Node.new
639           node.changeset_id = changeset_id
640           node.lat = lat
641           node.lon = lon
642           node.tags = a[4]
643
644           # fixup node tags in a way as well
645           unless 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
646           node.tags = strip_non_xml_chars node.tags
647
648           node.tags.delete('created_by')
649           node.version = version
650           if id <= 0
651             # We're creating the node
652             node.create_with_history(user)
653             renumberednodes[id] = node.id
654             nodeversions[node.id] = node.version
655           else
656             # We're updating an existing node
657             previous = Node.find(id)
658             node.id = id
659             previous.update_from(node, user)
660             nodeversions[previous.id] = previous.version
661           end
662         end
663
664         # -- Save revised way
665
666         pointlist.collect! do|a|
667           renumberednodes[a] ? renumberednodes[a] : a
668         end # renumber nodes
669         new_way = Way.new
670         new_way.tags = attributes
671         new_way.nds = pointlist
672         new_way.changeset_id = changeset_id
673         new_way.version = wayversion
674         if originalway <= 0
675           new_way.create_with_history(user)
676           way = new_way # so we can get way.id and way.version
677         else
678           way = Way.find(originalway)
679           if way.tags != attributes || way.nds != pointlist || !way.visible?
680             new_way.id = originalway
681             way.update_from(new_way, user)
682           end
683         end
684
685         # -- Delete unwanted nodes
686
687         deletednodes.each do |id, v|
688           node = Node.find(id.to_i)
689           new_node = Node.new
690           new_node.changeset_id = changeset_id
691           new_node.version = v.to_i
692           new_node.id = id.to_i
693           begin
694             node.delete_with_history!(new_node, user)
695           rescue OSM::APIPreconditionFailedError
696             # We don't do anything here as the node is being used elsewhere
697             # and we don't want to delete it
698           end
699         end
700       end # transaction
701
702       [0, '', originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes]
703     end
704   end
705
706   # Save POI to the database.
707   # Refuses save if the node has since become part of a way.
708   # Returns array with:
709   # 0. 0 (success),
710   # 1. success message,
711   # 2. original node id (unchanged),
712   # 3. new node id,
713   # 4. version.
714
715   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
716     amf_handle_error("'putpoi' #{id}", 'node', id) do
717       user = getuser(usertoken)
718       unless user then return -1, "You are not logged in, so the point could not be saved." end
719       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
720       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
721
722       unless tags_ok(tags) then return -1, "One of the tags is invalid. Linux users may need to upgrade to Flash Player 10.1." end
723       tags = strip_non_xml_chars tags
724
725       id = id.to_i
726       visible = (visible.to_i == 1)
727       node = nil
728       new_node = nil
729       Node.transaction do
730         if id > 0
731           node = Node.find(id)
732
733           unless visible
734             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
735           end
736         end
737         # We always need a new node, based on the data that has been sent to us
738         new_node = Node.new
739
740         new_node.changeset_id = changeset_id
741         new_node.version = version
742         new_node.lat = lat
743         new_node.lon = lon
744         new_node.tags = tags
745         if id <= 0
746           # We're creating the node
747           new_node.create_with_history(user)
748         elsif visible
749           # We're updating the node
750           new_node.id = id
751           node.update_from(new_node, user)
752         else
753           # We're deleting the node
754           new_node.id = id
755           node.delete_with_history!(new_node, user)
756         end
757       end # transaction
758
759       if id <= 0
760         return [0, '', id, new_node.id, new_node.version]
761       else
762         return [0, '', id, node.id, node.version]
763       end
764     end
765   end
766
767   # Read POI from database
768   # (only called on revert: POIs are usually read by whichways).
769   #
770   # Returns array of id, long, lat, hash of tags, (current) version.
771
772   def getpoi(id, timestamp) #:doc:
773     amf_handle_error("'getpoi' #{id}", 'node', id) do
774       id = id.to_i
775       n = Node.find(id)
776       v = n.version
777       unless timestamp == ''
778         n = OldNode.where("node_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first
779       end
780
781       if n
782         return [0, '', n.id, n.lon, n.lat, n.tags, v]
783       else
784         return [-4, 'node', id]
785       end
786     end
787   end
788
789   # Delete way and all constituent nodes.
790   # Params:
791   # * The user token
792   # * the changeset id
793   # * the id of the way to change
794   # * the version of the way that was downloaded
795   # * a hash of the id and versions of all the nodes that are in the way, if any
796   # of the nodes have been changed by someone else then, there is a problem!
797   # Returns 0 (success), unchanged way id, new way version, new node versions.
798
799   def deleteway(usertoken, changeset_id, way_id, way_version, deletednodes) #:doc:
800     amf_handle_error("'deleteway' #{way_id}", 'way', way_id) do
801       user = getuser(usertoken)
802       unless user then return -1, "You are not logged in, so the way could not be deleted." end
803       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
804       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
805
806       way_id = way_id.to_i
807       nodeversions = {}
808       old_way = nil # returned, so scope it outside the transaction
809       # Need a transaction so that if one item fails to delete, the whole delete fails.
810       Way.transaction do
811         # -- Delete the way
812
813         old_way = Way.find(way_id)
814         delete_way = Way.new
815         delete_way.version = way_version
816         delete_way.changeset_id = changeset_id
817         delete_way.id = way_id
818         old_way.delete_with_history!(delete_way, user)
819
820         # -- Delete unwanted nodes
821
822         deletednodes.each do |id, v|
823           node = Node.find(id.to_i)
824           new_node = Node.new
825           new_node.changeset_id = changeset_id
826           new_node.version = v.to_i
827           new_node.id = id.to_i
828           begin
829             node.delete_with_history!(new_node, user)
830             nodeversions[node.id] = node.version
831           rescue OSM::APIPreconditionFailedError
832             # We don't do anything with the exception as the node is in use
833             # elsewhere and we don't want to delete it
834           end
835         end
836       end # transaction
837       [0, '', way_id, old_way.version, nodeversions]
838     end
839   end
840
841   # ====================================================================
842   # Support functions
843
844   # Authenticate token
845   # (can also be of form user:pass)
846   # When we are writing to the api, we need the actual user model,
847   # not just the id, hence this abstraction
848
849   def getuser(token) #:doc:
850     if token =~ /^(.+)\:(.+)$/
851       user = User.authenticate(:username => $1, :password => $2)
852     else
853       user = User.authenticate(:token => token)
854     end
855     user
856   end
857
858   def getlocales
859     Dir.glob("#{Rails.root}/config/potlatch/locales/*").collect { |f| File.basename(f, ".yml") }
860   end
861
862   ##
863   # check that all key-value pairs are valid UTF-8.
864   def tags_ok(tags)
865     tags.each do |k, v|
866       return false unless UTF8.valid? k
867       return false unless UTF8.valid? v
868     end
869     true
870   end
871
872   ##
873   # strip characters which are invalid in XML documents from the strings
874   # in the +tags+ hash.
875   def strip_non_xml_chars(tags)
876     new_tags = {}
877     unless tags.nil?
878       tags.each do |k, v|
879         new_k = k.delete "\000-\037\ufffe\uffff", "^\011\012\015"
880         new_v = v.delete "\000-\037\ufffe\uffff", "^\011\012\015"
881         new_tags[new_k] = new_v
882       end
883     end
884     new_tags
885   end
886
887   # ====================================================================
888   # Alternative SQL queries for getway/whichways
889
890   def sql_find_ways_in_area(bbox)
891     sql = <<-EOF
892     SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
893       FROM current_way_nodes
894     INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
895     INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
896        WHERE current_nodes.visible=TRUE
897        AND current_ways.visible=TRUE
898        AND #{OSM.sql_for_area(bbox, "current_nodes.")}
899     EOF
900     ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i, a['version'].to_i] }
901   end
902
903   def sql_find_pois_in_area(bbox)
904     pois = []
905     sql = <<-EOF
906       SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version
907       FROM current_nodes
908        LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id
909        WHERE current_nodes.visible=TRUE
910        AND cwn.id IS NULL
911        AND #{OSM.sql_for_area(bbox, "current_nodes.")}
912     EOF
913     ActiveRecord::Base.connection.select_all(sql).each do |row|
914       poitags = {}
915       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
916         poitags[n['k']] = n['v']
917       end
918       pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
919     end
920     pois
921   end
922
923   def sql_find_relations_in_area_and_ways(bbox, way_ids)
924     # ** It would be more Potlatchy to get relations for nodes within ways
925     #    during 'getway', not here
926     sql = <<-EOF
927       SELECT DISTINCT cr.id AS relid,cr.version AS version
928       FROM current_relations cr
929       INNER JOIN current_relation_members crm ON crm.id=cr.id
930       INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='Node'
931        WHERE #{OSM.sql_for_area(bbox, "cn.")}
932       EOF
933     unless way_ids.empty?
934       sql += <<-EOF
935        UNION
936         SELECT DISTINCT cr.id AS relid,cr.version AS version
937         FROM current_relations cr
938         INNER JOIN current_relation_members crm ON crm.id=cr.id
939          WHERE crm.member_type='Way'
940          AND crm.member_id IN (#{way_ids.join(',')})
941         EOF
942     end
943     ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i, a['version'].to_i] }
944   end
945
946   def sql_get_nodes_in_way(wayid)
947     points = []
948     sql = <<-EOF
949       SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id,current_nodes.version
950       FROM current_way_nodes,current_nodes
951        WHERE current_way_nodes.id=#{wayid.to_i}
952        AND current_way_nodes.node_id=current_nodes.id
953        AND current_nodes.visible=TRUE
954       ORDER BY sequence_id
955     EOF
956     ActiveRecord::Base.connection.select_all(sql).each do |row|
957       nodetags = {}
958       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
959         nodetags[n['k']] = n['v']
960       end
961       nodetags.delete('created_by')
962       points << [row['lon'].to_f, row['lat'].to_f, row['id'].to_i, nodetags, row['version'].to_i]
963     end
964     points
965   end
966
967   def sql_get_tags_in_way(wayid)
968     tags = {}
969     ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
970       tags[row['k']] = row['v']
971     end
972     tags
973   end
974
975   def sql_get_way_version(wayid)
976     ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")['version']
977   end
978
979   def sql_get_way_user(wayid)
980     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']
981   end
982 end