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