6f84313bef0815bf5e3f0fa0b1b8d4c560903150
[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
86           orn = renumberednodes.dup
87           result = putway(renumberednodes, *args)
88           result[4] = renumberednodes.reject { |k, _v| orn.key?(k) }
89           if result[0] == 0 && result[2] != result[3] then renumberedways[result[2]] = result[3] end
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           if result[0] == 0 && result[2] != result[3] then renumberednodes[result[2]] = result[3] end
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     return [-4, ex.object, ex.object_id]
114   rescue OSM::APIVersionMismatchError => ex
115     return [-3, [rootobj, rootid], [ex.type.downcase, ex.id, ex.latest]]
116   rescue OSM::APIUserChangesetMismatchError => ex
117     return [-2, ex.to_s]
118   rescue OSM::APIBadBoundingBox => ex
119     return [-2, "Sorry - I can't get the map for that area. The server said: #{ex}"]
120   rescue OSM::APIError => ex
121     return [-1, ex.to_s]
122   rescue StandardError => ex
123     return [-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       unless user then return -1, "You are not logged in, so Potlatch can't write any changes to the database." end
141       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
142       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
143
144       if cstags
145         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
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           fail OSM::APIUserChangesetMismatchError.new
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 != 0
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) #:doc:
190     user = getuser(usertoken)
191
192     if user && !user.languages.empty?
193       http_accept_language.user_preferred_languages = user.languages
194     end
195
196     lang = http_accept_language.compatible_language_from(getlocales)
197     (real_lang, localised) = getlocalized(lang)
198
199     # Tell Potlatch what language it's using
200     localised["__potlatch_locale"] = real_lang
201
202     # Get help from i18n but delete it so we won't pass it around
203     # twice for nothing
204     help = localised["help_html"]
205     localised.delete("help_html")
206
207     # Populate icon names
208     POTLATCH_PRESETS[10].each do |id|
209       POTLATCH_PRESETS[11][id] = localised["preset_icon_#{id}"]
210       localised.delete("preset_icon_#{id}")
211     end
212
213     POTLATCH_PRESETS + [localised, help]
214   end
215
216   def getlocalized(lang)
217     # What we end up actually using. Reported in Potlatch's created_by=* string
218     loaded_lang = 'en'
219
220     # Load English defaults
221     en = YAML.load(File.open("#{Rails.root}/config/potlatch/locales/en.yml"))["en"]
222
223     if lang == 'en'
224       return [loaded_lang, en]
225     else
226       # Use English as a fallback
227       begin
228         other = YAML.load(File.open("#{Rails.root}/config/potlatch/locales/#{lang}.yml"))[lang]
229         loaded_lang = lang
230       rescue
231         other = en
232       end
233
234       # We have to return a flat list and some of the keys won't be
235       # translated (probably)
236       return [loaded_lang, en.merge(other)]
237     end
238   end
239
240   ##
241   # Find all the ways, POI nodes (i.e. not part of ways), and relations
242   # in a given bounding box. Nodes are returned in full; ways and relations
243   # are IDs only.
244   #
245   # return is of the form:
246   # [success_code, success_message,
247   #  [[way_id, way_version], ...],
248   #  [[node_id, lat, lon, [tags, ...], node_version], ...],
249   #  [[rel_id, rel_version], ...]]
250   # where the ways are any visible ways which refer to any visible
251   # nodes in the bbox, nodes are any visible nodes in the bbox but not
252   # used in any way, rel is any relation which refers to either a way
253   # or node that we're returning.
254   def whichways(xmin, ymin, xmax, ymax) #:doc:
255     amf_handle_error_with_timeout("'whichways'", nil, nil) do
256       enlarge = [(xmax - xmin) / 8, 0.01].min
257       xmin -= enlarge
258       ymin -= enlarge
259       xmax += enlarge
260       ymax += enlarge
261
262       # check boundary is sane and area within defined
263       # see /config/application.yml
264       bbox = BoundingBox.new(xmin, ymin, xmax, ymax)
265       bbox.check_boundaries
266       bbox.check_size
267
268       if POTLATCH_USE_SQL
269         ways = sql_find_ways_in_area(bbox)
270         points = sql_find_pois_in_area(bbox)
271         relations = sql_find_relations_in_area_and_ways(bbox, ways.collect { |x| x[0] })
272       else
273         # find the way ids in an area
274         nodes_in_area = Node.bbox(bbox).visible.includes(:ways)
275         ways = nodes_in_area.inject([]) do |sum, node|
276           visible_ways = node.ways.select(&:visible?)
277           sum + visible_ways.collect { |w| [w.id, w.version] }
278         end.uniq
279         ways.delete([])
280
281         # find the node ids in an area that aren't part of ways
282         nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
283         points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags, n.version] }.uniq
284
285         # find the relations used by those nodes and ways
286         relations = Relation.nodes(nodes_in_area.collect(&:id)).visible +
287                     Relation.ways(ways.collect { |w| w[0] }).visible
288         relations = relations.collect { |relation| [relation.id, relation.version] }.uniq
289       end
290
291       [0, '', ways, points, relations]
292     end
293   end
294
295   # Find deleted ways in current bounding box (similar to whichways, but ways
296   # with a deleted node only - not POIs or relations).
297
298   def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
299     amf_handle_error_with_timeout("'whichways_deleted'", nil, nil) do
300       enlarge = [(xmax - xmin) / 8, 0.01].min
301       xmin -= enlarge
302       ymin -= enlarge
303       xmax += enlarge
304       ymax += enlarge
305
306       # check boundary is sane and area within defined
307       # see /config/application.yml
308       bbox = BoundingBox.new(xmin, ymin, xmax, ymax)
309       bbox.check_boundaries
310       bbox.check_size
311
312       nodes_in_area = Node.bbox(bbox).joins(:ways_via_history).where(:current_ways => { :visible => false })
313       way_ids = nodes_in_area.collect { |node| node.ways_via_history.invisible.collect(&:id) }.flatten.uniq
314
315       [0, '', way_ids]
316     end
317   end
318
319   # Get a way including nodes and tags.
320   # Returns the way id, a Potlatch-style array of points, a hash of tags, the version number, and the user ID.
321
322   def getway(wayid) #:doc:
323     amf_handle_error_with_timeout("'getway' #{wayid}", 'way', wayid) do
324       if POTLATCH_USE_SQL
325         points = sql_get_nodes_in_way(wayid)
326         tags = sql_get_tags_in_way(wayid)
327         version = sql_get_way_version(wayid)
328         uid = sql_get_way_user(wayid)
329       else
330         # Ideally we would do ":include => :nodes" here but if we do that
331         # then rails only seems to return the first copy of a node when a
332         # way includes a node more than once
333         way = Way.where(:id => wayid).first
334
335         # check case where way has been deleted or doesn't exist
336         return [-4, 'way', wayid] if way.nil? || !way.visible
337
338         points = way.nodes.preload(:node_tags).collect do |node|
339           nodetags = node.tags
340           nodetags.delete('created_by')
341           [node.lon, node.lat, node.id, nodetags, node.version]
342         end
343         tags = way.tags
344         version = way.version
345         uid = way.changeset.user.id
346       end
347
348       [0, '', wayid, points, tags, version, uid]
349     end
350   end
351
352   # Get an old version of a way, and all constituent nodes.
353   #
354   # For undelete (version<0), always uses the most recent version of each node,
355   # even if it's moved.  For revert (version >= 0), uses the node in existence
356   # at the time, generating a new id if it's still visible and has been moved/
357   # retagged.
358   #
359   # Returns:
360   # 0. success code,
361   # 1. id,
362   # 2. array of points,
363   # 3. hash of tags,
364   # 4. version,
365   # 5. is this the current, visible version? (boolean)
366
367   def getway_old(id, timestamp) #:doc:
368     amf_handle_error_with_timeout("'getway_old' #{id}, #{timestamp}", 'way', id) do
369       if timestamp == ''
370         # undelete
371         old_way = OldWay.where(:visible => true, :way_id => id).unredacted.order("version DESC").first
372         points = old_way.get_nodes_undelete unless old_way.nil?
373       else
374         begin
375           # revert
376           timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S")
377           old_way = OldWay.where("way_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first
378           unless old_way.nil?
379             points = old_way.get_nodes_revert(timestamp)
380             unless old_way.visible
381               return [-1, "Sorry, the way was deleted at that time - please revert to a previous version.", id]
382             end
383           end
384         rescue ArgumentError
385           # thrown by date parsing method. leave old_way as nil for
386           # the error handler below.
387           old_way = nil
388         end
389       end
390
391       if old_way.nil?
392         return [-1, "Sorry, the server could not find a way at that time.", id]
393       else
394         curway = Way.find(id)
395         old_way.tags['history'] = "Retrieved from v#{old_way.version}"
396         return [0, '', id, points, old_way.tags, curway.version, (curway.version == old_way.version && curway.visible)]
397       end
398     end
399   end
400
401   # Find history of a way.
402   # Returns 'way', id, and an array of previous versions:
403   # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
404   # - now [timestamp,user,uid]
405   #
406   # Heuristic: Find all nodes that have ever been part of the way;
407   # get a list of their revision dates; add revision dates of the way;
408   # sort and collapse list (to within 2 seconds); trim all dates before the
409   # start date of the way.
410
411   def getway_history(wayid) #:doc:
412     revdates = []
413     revusers = {}
414     Way.find(wayid).old_ways.unredacted.collect do |a|
415       revdates.push(a.timestamp)
416       unless revusers.key?(a.timestamp.to_i) then revusers[a.timestamp.to_i] = change_user(a) end
417       a.nds.each do |n|
418         Node.find(n).old_nodes.unredacted.collect do |o|
419           revdates.push(o.timestamp)
420           unless revusers.key?(o.timestamp.to_i) then revusers[o.timestamp.to_i] = change_user(o) end
421         end
422       end
423     end
424     waycreated = revdates[0]
425     revdates.uniq!
426     revdates.sort!
427     revdates.reverse!
428
429     # Remove any dates (from nodes) before first revision date of way
430     revdates.delete_if { |d| d < waycreated }
431     # Remove any elements where 2 seconds doesn't elapse before next one
432     revdates.delete_if { |d| revdates.include?(d + 1) || revdates.include?(d + 2) }
433     # Collect all in one nested array
434     revdates.collect! { |d| [(d + 1).strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] }
435     revdates.uniq!
436
437     return ['way', wayid, revdates]
438   rescue ActiveRecord::RecordNotFound
439     return ['way', wayid, []]
440   end
441
442   # Find history of a node. Returns 'node', id, and an array of previous versions as above.
443
444   def getnode_history(nodeid) #:doc:
445     history = Node.find(nodeid).old_nodes.unredacted.reverse.collect do |old_node|
446       [(old_node.timestamp + 1).strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node)
447     end
448     return ['node', nodeid, history]
449   rescue ActiveRecord::RecordNotFound
450     return ['node', nodeid, []]
451   end
452
453   def change_user(obj)
454     user_object = obj.changeset.user
455     user = user_object.data_public? ? user_object.display_name : 'anonymous'
456     uid  = user_object.data_public? ? user_object.id : 0
457     [user, uid]
458   end
459
460   # Find GPS traces with specified name/id.
461   # Returns array listing GPXs, each one comprising id, name and description.
462
463   def findgpx(searchterm, usertoken)
464     amf_handle_error_with_timeout("'findgpx'", nil, nil) do
465       user = getuser(usertoken)
466
467       return -1, "You must be logged in to search for GPX traces." unless user
468       return -1, t('application.setup_user_auth.blocked') if user.blocks.active.exists?
469
470       query = Trace.visible_to(user)
471       if searchterm.to_i > 0
472         query = query.where(:id => searchterm.to_i)
473       else
474         query = query.where("MATCH(name) AGAINST (?)", searchterm).limit(21)
475       end
476       gpxs = query.collect do |gpx|
477         [gpx.id, gpx.name, gpx.description]
478       end
479       [0, '', gpxs]
480     end
481   end
482
483   # Get a relation with all tags and members.
484   # Returns:
485   # 0. success code?
486   # 1. object type?
487   # 2. relation id,
488   # 3. hash of tags,
489   # 4. list of members,
490   # 5. version.
491
492   def getrelation(relid) #:doc:
493     amf_handle_error("'getrelation' #{relid}", 'relation', relid) do
494       rel = Relation.where(:id => relid).first
495
496       return [-4, 'relation', relid] if rel.nil? || !rel.visible
497       [0, '', relid, rel.tags, rel.members, rel.version]
498     end
499   end
500
501   # Find relations with specified name/id.
502   # Returns array of relations, each in same form as getrelation.
503
504   def findrelations(searchterm)
505     rels = []
506     if searchterm.to_i > 0
507       rel = Relation.where(:id => searchterm.to_i).first
508       if rel && rel.visible
509         rels.push([rel.id, rel.tags, rel.members, rel.version])
510       end
511     else
512       RelationTag.where("v like ?", "%#{searchterm}%").limit(11).each do |t|
513         if t.relation.visible
514           rels.push([t.relation.id, t.relation.tags, t.relation.members, t.relation.version])
515         end
516       end
517     end
518     rels
519   end
520
521   # Save a relation.
522   # Returns
523   # 0. 0 (success),
524   # 1. original relation id (unchanged),
525   # 2. new relation id,
526   # 3. version.
527
528   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
529     amf_handle_error("'putrelation' #{relid}", 'relation', relid)  do
530       user = getuser(usertoken)
531       unless user then return -1, "You are not logged in, so the relation could not be saved." end
532       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
533       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
534
535       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
536       tags = strip_non_xml_chars tags
537
538       relid = relid.to_i
539       visible = (visible.to_i != 0)
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           if mid
558             typedmembers << [m[0], mid, m[2].delete("\000-\037\ufffe\uffff", "^\011\012\015")]
559           end
560         end
561
562         # assign new contents
563         new_relation.members = typedmembers
564         new_relation.tags = tags
565         new_relation.visible = visible
566         new_relation.changeset_id = changeset_id
567         new_relation.version = version
568
569         if relid <= 0
570           # We're creating the relation
571           new_relation.create_with_history(user)
572         elsif visible
573           # We're updating the relation
574           new_relation.id = relid
575           relation.update_from(new_relation, user)
576         else
577           # We're deleting the relation
578           new_relation.id = relid
579           relation.delete_with_history!(new_relation, user)
580         end
581       end # transaction
582
583       if relid <= 0
584         return [0, '', relid, new_relation.id, new_relation.version]
585       else
586         return [0, '', relid, relid, relation.version]
587       end
588     end
589   end
590
591   # Save a way to the database, including all nodes. Any nodes in the previous
592   # version and no longer used are deleted.
593   #
594   # Parameters:
595   # 0. hash of renumbered nodes (added by amf_controller)
596   # 1. current user token (for authentication)
597   # 2. current changeset
598   # 3. new way version
599   # 4. way ID
600   # 5. list of nodes in way
601   # 6. hash of way tags
602   # 7. array of nodes to change (each one is [lon,lat,id,version,tags]),
603   # 8. hash of nodes to delete (id->version).
604   #
605   # Returns:
606   # 0. '0' (code for success),
607   # 1. message,
608   # 2. original way id (unchanged),
609   # 3. new way id,
610   # 4. hash of renumbered nodes (old id=>new id),
611   # 5. way version,
612   # 6. hash of node versions (node=>version)
613
614   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes, deletednodes) #:doc:
615     amf_handle_error("'putway' #{originalway}", 'way', originalway) do
616       # -- Initialise
617
618       user = getuser(usertoken)
619       unless user then return -1, "You are not logged in, so the way could not be saved." end
620       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
621       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
622
623       if pointlist.length < 2 then return -2, "Server error - way is only #{points.length} points long." end
624
625       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
626       attributes = strip_non_xml_chars attributes
627
628       originalway = originalway.to_i
629       pointlist.collect!(&:to_i)
630
631       way = nil # this is returned, so scope it outside the transaction
632       nodeversions = {}
633       Way.transaction do
634         # -- Update each changed node
635
636         nodes.each do |a|
637           lon = a[0].to_f
638           lat = a[1].to_f
639           id = a[2].to_i
640           version = a[3].to_i
641
642           if id == 0  then return -2, "Server error - node with id 0 found in way #{originalway}." end
643           if lat == 90 then return -2, "Server error - node with latitude -90 found in way #{originalway}." end
644
645           id = renumberednodes[id]  if renumberednodes[id]
646
647           node = Node.new
648           node.changeset_id = changeset_id
649           node.lat = lat
650           node.lon = lon
651           node.tags = a[4]
652
653           # fixup node tags in a way as well
654           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
655           node.tags = strip_non_xml_chars node.tags
656
657           node.tags.delete('created_by')
658           node.version = version
659           if id <= 0
660             # We're creating the node
661             node.create_with_history(user)
662             renumberednodes[id] = node.id
663             nodeversions[node.id] = node.version
664           else
665             # We're updating an existing node
666             previous = Node.find(id)
667             node.id = id
668             previous.update_from(node, user)
669             nodeversions[previous.id] = previous.version
670           end
671         end
672
673         # -- Save revised way
674
675         pointlist.collect! do|a|
676           renumberednodes[a] ? renumberednodes[a] : a
677         end # renumber nodes
678         new_way = Way.new
679         new_way.tags = attributes
680         new_way.nds = pointlist
681         new_way.changeset_id = changeset_id
682         new_way.version = wayversion
683         if originalway <= 0
684           new_way.create_with_history(user)
685           way = new_way # so we can get way.id and way.version
686         else
687           way = Way.find(originalway)
688           if way.tags != attributes || way.nds != pointlist || !way.visible?
689             new_way.id = originalway
690             way.update_from(new_way, user)
691           end
692         end
693
694         # -- Delete unwanted nodes
695
696         deletednodes.each do |id, v|
697           node = Node.find(id.to_i)
698           new_node = Node.new
699           new_node.changeset_id = changeset_id
700           new_node.version = v.to_i
701           new_node.id = id.to_i
702           begin
703             node.delete_with_history!(new_node, user)
704           rescue OSM::APIPreconditionFailedError
705             # We don't do anything here as the node is being used elsewhere
706             # and we don't want to delete it
707           end
708         end
709       end # transaction
710
711       [0, '', originalway, way.id, renumberednodes, way.version, nodeversions, deletednodes]
712     end
713   end
714
715   # Save POI to the database.
716   # Refuses save if the node has since become part of a way.
717   # Returns array with:
718   # 0. 0 (success),
719   # 1. success message,
720   # 2. original node id (unchanged),
721   # 3. new node id,
722   # 4. version.
723
724   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
725     amf_handle_error("'putpoi' #{id}", 'node', id) do
726       user = getuser(usertoken)
727       unless user then return -1, "You are not logged in, so the point could not be saved." end
728       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
729       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
730
731       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
732       tags = strip_non_xml_chars tags
733
734       id = id.to_i
735       visible = (visible.to_i == 1)
736       node = nil
737       new_node = nil
738       Node.transaction do
739         if id > 0
740           node = Node.find(id)
741
742           unless visible
743             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
744           end
745         end
746         # We always need a new node, based on the data that has been sent to us
747         new_node = Node.new
748
749         new_node.changeset_id = changeset_id
750         new_node.version = version
751         new_node.lat = lat
752         new_node.lon = lon
753         new_node.tags = tags
754         if id <= 0
755           # We're creating the node
756           new_node.create_with_history(user)
757         elsif visible
758           # We're updating the node
759           new_node.id = id
760           node.update_from(new_node, user)
761         else
762           # We're deleting the node
763           new_node.id = id
764           node.delete_with_history!(new_node, user)
765         end
766       end # transaction
767
768       if id <= 0
769         return [0, '', id, new_node.id, new_node.version]
770       else
771         return [0, '', id, node.id, node.version]
772       end
773     end
774   end
775
776   # Read POI from database
777   # (only called on revert: POIs are usually read by whichways).
778   #
779   # Returns array of id, long, lat, hash of tags, (current) version.
780
781   def getpoi(id, timestamp) #:doc:
782     amf_handle_error("'getpoi' #{id}", 'node', id) do
783       id = id.to_i
784       n = Node.find(id)
785       v = n.version
786       unless timestamp == ''
787         n = OldNode.where("node_id = ? AND timestamp <= ?", id, timestamp).unredacted.order("timestamp DESC").first
788       end
789
790       if n
791         return [0, '', n.id, n.lon, n.lat, n.tags, v]
792       else
793         return [-4, 'node', id]
794       end
795     end
796   end
797
798   # Delete way and all constituent nodes.
799   # Params:
800   # * The user token
801   # * the changeset id
802   # * the id of the way to change
803   # * the version of the way that was downloaded
804   # * a hash of the id and versions of all the nodes that are in the way, if any
805   # of the nodes have been changed by someone else then, there is a problem!
806   # Returns 0 (success), unchanged way id, new way version, new node versions.
807
808   def deleteway(usertoken, changeset_id, way_id, way_version, deletednodes) #:doc:
809     amf_handle_error("'deleteway' #{way_id}", 'way', way_id) do
810       user = getuser(usertoken)
811       unless user then return -1, "You are not logged in, so the way could not be deleted." end
812       if user.blocks.active.exists? then return -1, t('application.setup_user_auth.blocked') end
813       if REQUIRE_TERMS_AGREED && user.terms_agreed.nil? then return -1, "You must accept the contributor terms before you can edit." end
814
815       way_id = way_id.to_i
816       nodeversions = {}
817       old_way = nil # returned, so scope it outside the transaction
818       # Need a transaction so that if one item fails to delete, the whole delete fails.
819       Way.transaction do
820         # -- Delete the way
821
822         old_way = Way.find(way_id)
823         delete_way = Way.new
824         delete_way.version = way_version
825         delete_way.changeset_id = changeset_id
826         delete_way.id = way_id
827         old_way.delete_with_history!(delete_way, user)
828
829         # -- Delete unwanted nodes
830
831         deletednodes.each do |id, v|
832           node = Node.find(id.to_i)
833           new_node = Node.new
834           new_node.changeset_id = changeset_id
835           new_node.version = v.to_i
836           new_node.id = id.to_i
837           begin
838             node.delete_with_history!(new_node, user)
839             nodeversions[node.id] = node.version
840           rescue OSM::APIPreconditionFailedError
841             # We don't do anything with the exception as the node is in use
842             # elsewhere and we don't want to delete it
843           end
844         end
845       end # transaction
846       [0, '', way_id, old_way.version, nodeversions]
847     end
848   end
849
850   # ====================================================================
851   # Support functions
852
853   # Authenticate token
854   # (can also be of form user:pass)
855   # When we are writing to the api, we need the actual user model,
856   # not just the id, hence this abstraction
857
858   def getuser(token) #:doc:
859     if token =~ /^(.+)\:(.+)$/
860       user = User.authenticate(:username => $1, :password => $2)
861     else
862       user = User.authenticate(:token => token)
863     end
864     user
865   end
866
867   def getlocales
868     Dir.glob("#{Rails.root}/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 = <<-EOF
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     EOF
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 = <<-EOF
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     EOF
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 = <<-EOF
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       EOF
942     unless way_ids.empty?
943       sql += <<-EOF
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         EOF
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 = <<-EOF
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     EOF
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