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