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