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