d8d7ce3c4daed893dbd58ab5d704ccecd637a3a9
[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
30 # To write to the Rails log, use logger.info("message").
31
32 # Remaining issues:
33 # * version conflict when POIs and ways are reverted
34
35 class AmfController < ApplicationController
36   require 'stringio'
37
38   include Potlatch
39
40   # Help methods for checking boundary sanity and area size
41   include MapBoundary
42
43   session :off
44   before_filter :check_api_writable
45
46   # Main AMF handlers: process the raw AMF string (using AMF library) and
47   # calls each action (private method) accordingly.
48   # ** FIXME: refactor to reduce duplication of code across read/write
49   
50   def amf_read
51     req=StringIO.new(request.raw_post+0.chr)# Get POST data as request
52                               # (cf http://www.ruby-forum.com/topic/122163)
53     req.read(2)                                                         # Skip version indicator and client ID
54     results={}                                                          # Results of each body
55
56     # Parse request
57
58         headers=AMF.getint(req)                                 # Read number of headers
59
60     headers.times do                                            # Read each header
61       name=AMF.getstring(req)                           #  |
62       req.getc                                                          #  | skip boolean
63       value=AMF.getvalue(req)                           #  |
64       header["name"]=value                                      #  |
65     end
66
67     bodies=AMF.getint(req)                                      # Read number of bodies
68     bodies.times do                                                     # Read each body
69       message=AMF.getstring(req)                        #  | get message name
70       index=AMF.getstring(req)                          #  | get index in response sequence
71       bytes=AMF.getlong(req)                            #  | get total size in bytes
72       args=AMF.getvalue(req)                            #  | get response (probably an array)
73       logger.info("Executing AMF #{message}:#{index}")
74
75       case message
76         when 'getpresets';                      results[index]=AMF.putdata(index,getpresets())
77         when 'whichways';                       results[index]=AMF.putdata(index,whichways(*args))
78         when 'whichways_deleted';       results[index]=AMF.putdata(index,whichways_deleted(*args))
79         when 'getway';                          r=AMF.putdata(index,getway(args[0].to_i))
80                                     results[index]=r
81         when 'getrelation';                     results[index]=AMF.putdata(index,getrelation(args[0].to_i))
82         when 'getway_old';                      results[index]=AMF.putdata(index,getway_old(args[0].to_i,args[1]))
83         when 'getway_history';          results[index]=AMF.putdata(index,getway_history(args[0].to_i))
84         when 'getnode_history';         results[index]=AMF.putdata(index,getnode_history(args[0].to_i))
85         when 'findgpx';                         results[index]=AMF.putdata(index,findgpx(*args))
86         when 'findrelations';           results[index]=AMF.putdata(index,findrelations(*args))
87         when 'getpoi';                          results[index]=AMF.putdata(index,getpoi(*args))
88       end
89     end
90     logger.info("encoding AMF results")
91     sendresponse(results)
92   end
93
94   def amf_write
95     req=StringIO.new(request.raw_post+0.chr)
96     req.read(2)
97     results={}
98     renumberednodes={}                                          # Shared across repeated putways
99     renumberedways={}                                           # Shared across repeated putways
100
101     headers=AMF.getint(req)                                     # Read number of headers
102     headers.times do                                            # Read each header
103       name=AMF.getstring(req)                           #  |
104       req.getc                                                          #  | skip boolean
105       value=AMF.getvalue(req)                           #  |
106       header["name"]=value                                      #  |
107     end
108
109     bodies=AMF.getint(req)                                      # Read number of bodies
110     bodies.times do                                                     # Read each body
111       message=AMF.getstring(req)                        #  | get message name
112       index=AMF.getstring(req)                          #  | get index in response sequence
113       bytes=AMF.getlong(req)                            #  | get total size in bytes
114       args=AMF.getvalue(req)                            #  | get response (probably an array)
115
116       logger.info("Executing AMF #{message}:#{index}")
117       case message
118         when 'putway';                          r=putway(renumberednodes,*args)
119                                                                         renumberednodes=r[3]
120                                                                         if r[1] != r[2] then renumberedways[r[1]] = r[2] end
121                                                                         results[index]=AMF.putdata(index,r)
122         when 'putrelation';                     results[index]=AMF.putdata(index,putrelation(renumberednodes, renumberedways, *args))
123         when 'deleteway';                       results[index]=AMF.putdata(index,deleteway(*args))
124         when 'putpoi';                          r=putpoi(*args)
125                                                                         if r[1] != r[2] then renumberednodes[r[1]] = r[2] end
126                                                                 results[index]=AMF.putdata(index,r)
127         when 'startchangeset';          results[index]=AMF.putdata(index,startchangeset(*args))
128       end
129     end
130     logger.info("encoding AMF results")
131     sendresponse(results)
132   end
133
134   private
135
136   # Start new changeset
137   
138   def startchangeset(usertoken, cstags, closeid, closecomment)
139     user = getuser(usertoken)
140     if !user then return -1,"You are not logged in, so Potlatch can't write any changes to the database." end
141
142     # close previous changeset and add comment
143     if closeid
144       cs = Changeset.find(closeid)
145       cs.set_closed_time_now
146       if cs.user_id!=user.id
147         return -2,"You cannot close that changeset because you're not the person who opened it."
148       elsif closecomment.empty?
149         cs.save!
150       else
151         cs.tags['comment']=closecomment
152         cs.save_with_tags!
153       end
154     end
155         
156     # open a new changeset
157     cs = Changeset.new
158     cs.tags = cstags
159     cs.user_id = user.id
160     # smsm1 doesn't like the next two lines and thinks they need to be abstracted to the model more/better
161     cs.created_at = Time.now.getutc
162     cs.closed_at = cs.created_at + Changeset::IDLE_TIMEOUT
163     cs.save_with_tags!
164     return [0,cs.id]
165   end
166
167   # Return presets (default tags, localisation etc.):
168   # uses POTLATCH_PRESETS global, set up in OSM::Potlatch.
169
170   def getpresets() #:doc:
171     return POTLATCH_PRESETS
172   end
173
174   ##
175   # Find all the ways, POI nodes (i.e. not part of ways), and relations
176   # in a given bounding box. Nodes are returned in full; ways and relations 
177   # are IDs only. 
178   #
179   # return is of the form: 
180   # [error_code, 
181   #  [[way_id, way_version], ...],
182   #  [[node_id, lat, lon, [tags, ...], node_version], ...],
183   #  [[rel_id, rel_version], ...]]
184   # where the ways are any visible ways which refer to any visible
185   # nodes in the bbox, nodes are any visible nodes in the bbox but not
186   # used in any way, rel is any relation which refers to either a way
187   # or node that we're returning.
188   def whichways(xmin, ymin, xmax, ymax) #:doc:
189     enlarge = [(xmax-xmin)/8,0.01].min
190     xmin -= enlarge; ymin -= enlarge
191     xmax += enlarge; ymax += enlarge
192     
193     # check boundary is sane and area within defined
194     # see /config/application.yml
195     check_boundaries(xmin, ymin, xmax, ymax)
196
197     if POTLATCH_USE_SQL then
198       ways = sql_find_ways_in_area(xmin, ymin, xmax, ymax)
199       points = sql_find_pois_in_area(xmin, ymin, xmax, ymax)
200       relations = sql_find_relations_in_area_and_ways(xmin, ymin, xmax, ymax, ways.collect {|x| x[0]})
201     else
202       # find the way ids in an area
203       nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_nodes.visible = ?", true], :include => :ways)
204       ways = nodes_in_area.inject([]) { |sum, node| 
205         visible_ways = node.ways.select { |w| w.visible? }
206         sum + visible_ways.collect { |w| [w.id,w.version] }
207       }.uniq
208       ways.delete([])
209
210       # find the node ids in an area that aren't part of ways
211       nodes_not_used_in_area = nodes_in_area.select { |node| node.ways.empty? }
212       points = nodes_not_used_in_area.collect { |n| [n.id, n.lon, n.lat, n.tags, n.version] }.uniq
213
214       # find the relations used by those nodes and ways
215       relations = Relation.find_for_nodes(nodes_in_area.collect { |n| n.id }, :conditions => {:visible => true}) +
216                   Relation.find_for_ways(ways.collect { |w| w[0] }, :conditions => {:visible => true})
217       relations = relations.collect { |relation| [relation.id,relation.version] }.uniq
218     end
219
220     [0, ways, points, relations]
221
222   rescue Exception => err
223     [-2,"Sorry - I can't get the map for that area."]
224   end
225
226   # Find deleted ways in current bounding box (similar to whichways, but ways
227   # with a deleted node only - not POIs or relations).
228
229   def whichways_deleted(xmin, ymin, xmax, ymax) #:doc:
230     enlarge = [(xmax-xmin)/8,0.01].min
231     xmin -= enlarge; ymin -= enlarge
232     xmax += enlarge; ymax += enlarge
233
234     # check boundary is sane and area within defined
235     # see /config/application.yml
236     begin
237       check_boundaries(xmin, ymin, xmax, ymax)
238     rescue Exception => err
239       return [-2,"Sorry - I can't get the map for that area."]
240     end
241
242     nodes_in_area = Node.find_by_area(ymin, xmin, ymax, xmax, :conditions => ["current_ways.visible = ?", false], :include => :ways_via_history)
243     way_ids = nodes_in_area.collect { |node| node.ways_via_history_ids }.flatten.uniq
244
245     [0,way_ids]
246   end
247
248   # Get a way including nodes and tags.
249   # Returns the way id, a Potlatch-style array of points, a hash of tags, and the version number.
250
251   def getway(wayid) #:doc:
252     if POTLATCH_USE_SQL then
253         points = sql_get_nodes_in_way(wayid)
254         tags = sql_get_tags_in_way(wayid)
255         version = sql_get_way_version(wayid)
256       else
257         # Ideally we would do ":include => :nodes" here but if we do that
258         # then rails only seems to return the first copy of a node when a
259         # way includes a node more than once
260         begin
261           way = Way.find(wayid)
262         rescue ActiveRecord::RecordNotFound
263           return [wayid,[],{}]
264         end
265
266         # check case where way has been deleted or doesn't exist
267         return [wayid,[],{}] if way.nil? or !way.visible
268
269         points = way.nodes.collect do |node|
270         nodetags=node.tags
271         nodetags.delete('created_by')
272         [node.lon, node.lat, node.id, nodetags, node.version]
273       end
274       tags = way.tags
275       version = way.version
276     end
277
278     [wayid, points, tags, version]
279   end
280   
281   # Get an old version of a way, and all constituent nodes.
282   #
283   # For undelete (version<0), always uses the most recent version of each node, 
284   # even if it's moved.  For revert (version >= 0), uses the node in existence 
285   # at the time, generating a new id if it's still visible and has been moved/
286   # retagged.
287   #
288   # Returns:
289   # 0. success code, 
290   # 1. id, 
291   # 2. array of points, 
292   # 3. hash of tags, 
293   # 4. version, 
294   # 5. is this the current, visible version? (boolean)
295   
296   def getway_old(id, timestamp) #:doc:
297     if timestamp == ''
298       # undelete
299       old_way = OldWay.find(:first, :conditions => ['visible = ? AND id = ?', true, id], :order => 'version DESC')
300       points = old_way.get_nodes_undelete unless old_way.nil?
301     else
302       begin
303         # revert
304         timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S")
305         old_way = OldWay.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC')
306         unless old_way.nil?
307           points = old_way.get_nodes_revert(timestamp)
308           if !old_way.visible
309             return [-1, "Sorry, the way was deleted at that time - please revert to a previous version."]
310           end
311         end
312       rescue ArgumentError
313         # thrown by date parsing method. leave old_way as nil for
314         # the superb error handler below.
315       end
316     end
317
318     if old_way.nil?
319       # *** FIXME: shouldn't this be returning an error?
320       return [-1, id, [], {}, -1,0]
321     else
322       curway=Way.find(id)
323       old_way.tags['history'] = "Retrieved from v#{old_way.version}"
324       return [0, id, points, old_way.tags, curway.version, (curway.version==old_way.version and curway.visible)]
325     end
326   end
327   
328   # Find history of a way.
329   # Returns 'way', id, and an array of previous versions:
330   # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
331   # - now [timestamp,user,uid]
332   #
333   # Heuristic: Find all nodes that have ever been part of the way; 
334   # get a list of their revision dates; add revision dates of the way;
335   # sort and collapse list (to within 2 seconds); trim all dates before the 
336   # start date of the way.
337
338   def getway_history(wayid) #:doc:
339
340     begin
341       # Find list of revision dates for way and all constituent nodes
342       revdates=[]
343       revusers={}
344       Way.find(wayid).old_ways.collect do |a|
345         revdates.push(a.timestamp)
346         unless revusers.has_key?(a.timestamp.to_i) then revusers[a.timestamp.to_i]=change_user(a) end
347         a.nds.each do |n|
348           Node.find(n).old_nodes.collect do |o|
349             revdates.push(o.timestamp)
350             unless revusers.has_key?(o.timestamp.to_i) then revusers[o.timestamp.to_i]=change_user(o) end
351           end
352         end
353       end
354       waycreated=revdates[0]
355       revdates.uniq!
356       revdates.sort!
357           revdates.reverse!
358
359       # Remove any dates (from nodes) before first revision date of way
360       revdates.delete_if { |d| d<waycreated }
361       # Remove any elements where 2 seconds doesn't elapse before next one
362       revdates.delete_if { |d| revdates.include?(d+1) or revdates.include?(d+2) }
363       # Collect all in one nested array
364       revdates.collect! {|d| [d.strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] }
365
366       return ['way',wayid,revdates]
367     rescue ActiveRecord::RecordNotFound
368       return ['way', wayid, []]
369     end
370   end
371   
372   # Find history of a node. Returns 'node', id, and an array of previous versions as above.
373
374   def getnode_history(nodeid) #:doc:
375     begin 
376       history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
377         [old_node.timestamp.strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node)
378       end
379       return ['node', nodeid, history]
380     rescue ActiveRecord::RecordNotFound
381       return ['node', nodeid, []]
382     end
383   end
384
385   def change_user(obj)
386     user_object = obj.changeset.user
387     user = user_object.data_public? ? user_object.display_name : 'anonymous'
388     uid  = user_object.data_public? ? user_object.id : 0
389     [user,uid]
390   end
391
392   # Find GPS traces with specified name/id.
393   # Returns array listing GPXs, each one comprising id, name and description.
394   
395   def findgpx(searchterm, usertoken)
396     user = getuser(usertoken)
397     if !uid then return -1,"You must be logged in to search for GPX traces." end
398
399     gpxs = []
400     if searchterm.to_i>0 then
401       gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,user.id] )
402       if gpx then
403         gpxs.push([gpx.id, gpx.name, gpx.description])
404       end
405     else
406       Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,user.id,searchterm] ).each do |gpx|
407       gpxs.push([gpx.id, gpx.name, gpx.description])
408           end
409         end
410     gpxs
411   end
412
413   # Get a relation with all tags and members.
414   # Returns:
415   # 0. relation id,
416   # 1. hash of tags,
417   # 2. list of members,
418   # 3. version.
419   
420   def getrelation(relid) #:doc:
421     begin
422       rel = Relation.find(relid)
423     rescue ActiveRecord::RecordNotFound
424       return [relid, {}, []]
425     end
426
427     return [relid, {}, [], nil] if rel.nil? or !rel.visible
428     [relid, rel.tags, rel.members, rel.version]
429   end
430
431   # Find relations with specified name/id.
432   # Returns array of relations, each in same form as getrelation.
433   
434   def findrelations(searchterm)
435     rels = []
436     if searchterm.to_i>0 then
437       rel = Relation.find(searchterm.to_i)
438       if rel and rel.visible then
439         rels.push([rel.id, rel.tags, rel.members])
440       end
441     else
442       RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
443       if t.relation.visible then
444               rels.push([t.relation.id, t.relation.tags, t.relation.members])
445             end
446           end
447         end
448     rels
449   end
450
451   # Save a relation.
452   # Returns
453   # 0. 0 (success),
454   # 1. original relation id (unchanged),
455   # 2. new relation id.
456
457   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
458     user = getuser(usertoken)
459     if !user then return -1,"You are not logged in, so the relation could not be saved." end
460
461     relid = relid.to_i
462     visible = (visible.to_i != 0)
463
464     new_relation = nil
465     relation = nil
466     Relation.transaction do
467       # create a new relation, or find the existing one
468       if relid > 0
469         relation = Relation.find(relid)
470       end
471       # We always need a new node, based on the data that has been sent to us
472       new_relation = Relation.new
473
474       # check the members are all positive, and correctly type
475       typedmembers = []
476       members.each do |m|
477         mid = m[1].to_i
478         if mid < 0
479           mid = renumberednodes[mid] if m[0] == 'node'
480           mid = renumberedways[mid] if m[0] == 'way'
481         end
482         if mid
483           typedmembers << [m[0], mid, m[2]]
484         end
485       end
486
487       # assign new contents
488       new_relation.members = typedmembers
489       new_relation.tags = tags
490       new_relation.visible = visible
491       new_relation.changeset_id = changeset_id
492       new_relation.version = version
493
494       # NOTE: id or relid here? id doesn't seem to be set above
495       if relid <= 0
496         # We're creating the node
497         new_relation.create_with_history(user)
498       elsif visible
499         # We're updating the node
500         relation.update_from(new_relation, user)
501       else
502         # We're deleting the node
503         relation.delete_with_history!(new_relation, user)
504       end
505     end # transaction
506       
507     if id <= 0
508       return [0, relid, new_relation.id, new_relation.version]
509     else
510       return [0, relid, relation.id, relation.version]
511     end
512   rescue OSM::APIChangesetAlreadyClosedError => ex
513     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}."]
514   rescue OSM::APIVersionMismatchError => ex
515     # Really need to check to see whether this is a server load issue, and the 
516     # last version was in the same changeset, or belongs to the same user, then
517     # we can return something different
518     return [-3, "Sorry, someone else has changed this relation since you started editing. Please click the 'Edit' tab to reload the area."]
519   rescue OSM::APIAlreadyDeletedError => ex
520     return [-1, "The relation has already been deleted."]
521   rescue OSM::APIError => ex
522     # Some error that we don't specifically catch
523     return [-2, "An unusual error happened (in 'putrelation')."]
524   end
525
526   # Save a way to the database, including all nodes. Any nodes in the previous
527   # version and no longer used are deleted.
528   # 
529   # Parameters:
530   # 0. hash of renumbered nodes (added by amf_controller)
531   # 1. current user token (for authentication)
532   # 2. current changeset
533   # 3. new way version
534   # 4. way ID
535   # 5. list of nodes in way
536   # 6. hash of way tags
537   # 7. array of nodes to change (each one is [lon,lat,id,version,tags])
538   # 
539   # Returns:
540   # 0. '0' (code for success),
541   # 1. original way id (unchanged),
542   # 2. new way id,
543   # 3. hash of renumbered nodes (old id=>new id),
544   # 4. way version,
545   # 5. hash of node versions (node=>version)
546
547   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes) #:doc:
548
549     # -- Initialise
550         
551     user = getuser(usertoken)
552     if !user then return -1,"You are not logged in, so the way could not be saved." end
553     if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
554
555     originalway = originalway.to_i
556         pointlist.collect! {|a| a.to_i }
557
558     way=nil     # this is returned, so scope it outside the transaction
559     nodeversions = {}
560     Way.transaction do
561
562       # -- Get unique nodes
563
564       if originalway <= 0
565         uniques = []
566       else
567         way = Way.find(originalway)
568         uniques = way.unshared_node_ids
569       end
570
571       #-- Update each changed node
572
573       nodes.each do |a|
574         lon = a[0].to_f
575         lat = a[1].to_f
576         id = a[2].to_i
577         version = a[3].to_i
578         if id == 0  then return -2,"Server error - node with id 0 found in way #{originalway}." end
579         if lat== 90 then return -2,"Server error - node with latitude -90 found in way #{originalway}." end
580         if renumberednodes[id] then id = renumberednodes[id] end
581
582         node = Node.new
583         node.changeset_id = changeset_id
584         node.lat = lat
585         node.lon = lon
586         node.tags = a[4]
587         node.tags.delete('created_by')
588         node.version = version
589         if id <= 0
590           # We're creating the node
591           node.create_with_history(user)
592           renumberednodes[id] = node.id
593           nodeversions[node.id] = node.version
594         else
595           # We're updating an existing node
596           previous=Node.find(id)
597           previous.update_from(node, user)
598           nodeversions[previous.id] = previous.version
599         end
600       end
601
602       # -- Save revised way
603
604           pointlist.collect! {|a|
605                 renumberednodes[a] ? renumberednodes[a]:a
606           } # renumber nodes
607       new_way = Way.new
608       new_way.tags = attributes
609       new_way.nds = pointlist
610       new_way.changeset_id = changeset_id
611       new_way.version = wayversion
612       if originalway <= 0
613         new_way.create_with_history(user)
614         way=new_way     # so we can get way.id and way.version
615       elsif way.tags!=attributes or way.nds!=pointlist or !way.visible?
616         way.update_from(new_way, user)
617       end
618
619       # -- Delete any unique nodes no longer used
620
621       uniques=uniques-pointlist
622       uniques.each do |n|
623         node = Node.find(n)
624         deleteitemrelations(user, changeset_id, id, 'node', node.version)
625         new_node = Node.new
626         new_node.changeset_id = changeset_id
627         new_node.version = node.version
628         node.delete_with_history!(new_node, user)
629       end
630
631     end # transaction
632
633     [0, originalway, way.id, renumberednodes, way.version, nodeversions]
634   rescue OSM::APIChangesetAlreadyClosedError => ex
635     return [-2, "Sorry, your changeset #{ex.changeset.id} has been closed (at #{ex.changeset.closed_at})."]
636   rescue OSM::APIVersionMismatchError => ex
637     # Really need to check to see whether this is a server load issue, and the 
638     # last version was in the same changeset, or belongs to the same user, then
639     # we can return something different
640     return [-3, "Sorry, someone else has changed this way since you started editing. Please click the 'Edit' tab to reload the area."]
641   rescue OSM::APITooManyWayNodesError => ex
642     return [-1, "You have tried to upload a really long way with #{ex.provided} points: only #{ex.max} are allowed."]
643   rescue OSM::APIAlreadyDeletedError => ex
644     return [-1, "The point has already been deleted."]
645   rescue OSM::APIError => ex
646     # Some error that we don't specifically catch
647     return [-2, "An unusual error happened (in 'putway')."]
648   end
649
650   # Save POI to the database.
651   # Refuses save if the node has since become part of a way.
652   # Returns array with:
653   # 0. 0 (success),
654   # 1. original node id (unchanged),
655   # 2. new node id,
656   # 3. version.
657
658   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
659     user = getuser(usertoken)
660     if !user then return -1,"You are not logged in, so the point could not be saved." end
661
662     id = id.to_i
663     visible = (visible.to_i == 1)
664     node = nil
665     new_node = nil
666     Node.transaction do
667       if id > 0 then
668         node = Node.find(id)
669
670         if !visible then
671           unless node.ways.empty? then return -1,"The point has since become part of a way, so you cannot save it as a POI." end
672         end
673       end
674       # We always need a new node, based on the data that has been sent to us
675       new_node = Node.new
676
677       new_node.changeset_id = changeset_id
678       new_node.version = version
679       new_node.lat = lat
680       new_node.lon = lon
681       new_node.tags = tags
682       if id <= 0 
683         # We're creating the node
684         new_node.create_with_history(user)
685       elsif visible
686         # We're updating the node
687         node.update_from(new_node, user)
688       else
689         # We're deleting the node
690         node.delete_with_history!(new_node, user)
691       end
692      end # transaction
693
694     if id <= 0
695       return [0, id, new_node.id, new_node.version]
696     else
697       return [0, id, node.id, node.version]
698     end 
699   rescue OSM::APIChangesetAlreadyClosedError => ex
700     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
701   rescue OSM::APIVersionMismatchError => ex
702     # Really need to check to see whether this is a server load issue, and the 
703     # last version was in the same changeset, or belongs to the same user, then
704     # we can return something different
705     return [-3, "Sorry, someone else has changed this point since you started editing. Please click the 'Edit' tab to reload the area."]
706   rescue OSM::APIAlreadyDeletedError => ex
707     return [-1, "The point has already been deleted"]
708   rescue OSM::APIError => ex
709     # Some error that we don't specifically catch
710     return [-2, "An unusual error happened (in 'putpoi')."]
711   end
712
713   # Read POI from database
714   # (only called on revert: POIs are usually read by whichways).
715   #
716   # Returns array of id, long, lat, hash of tags, version.
717
718   def getpoi(id,timestamp) #:doc:
719     if timestamp == '' then
720       n = Node.find(id)
721     else
722       n = OldNode.find(id, :conditions=>['timestamp=?',DateTime.strptime(timestamp, "%d %b %Y, %H:%M:%S")])
723     end
724
725     if n
726       return [n.id, n.lon, n.lat, n.tags, n.version]
727     else
728       return [nil, nil, nil, {}, nil]
729     end
730   end
731
732   # Delete way and all constituent nodes. Also removes from any relations.
733   # Params:
734   # * The user token
735   # * the changeset id
736   # * the id of the way to change
737   # * the version of the way that was downloaded
738   # * a hash of the id and versions of all the nodes that are in the way, if any 
739   # of the nodes have been changed by someone else then, there is a problem!
740   # Returns 0 (success), unchanged way id.
741
742   def deleteway(usertoken, changeset_id, way_id, way_version, node_id_version) #:doc:
743     user = getuser(usertoken)
744     unless user then return -1,"You are not logged in, so the way could not be deleted." end
745       
746     way_id = way_id.to_i
747     # Need a transaction so that if one item fails to delete, the whole delete fails.
748     Way.transaction do
749
750       # delete the way
751       old_way = Way.find(way_id)
752       delete_way = Way.new
753       delete_way.version = way_version
754       delete_way.changeset_id = changeset_id
755       old_way.delete_with_history!(delete_way, user)
756
757       old_way.unshared_node_ids.each do |node_id|
758         # delete the node
759         node = Node.find(node_id)
760         delete_node = Node.new
761         delete_node.changeset_id = changeset_id
762         if node_id_version[node_id.to_s]
763           delete_node.version = node_id_version[node_id.to_s]
764         else
765           # in case the node wasn't passed (i.e. if it was previously removed
766           # from the way in Potlatch)
767           deleteitemrelations(user, changeset_id, node_id, 'node', node.version)
768               delete_node.version = node.version
769             end
770         node.delete_with_history!(delete_node, user)
771       end
772     end # transaction
773     [0, way_id]
774   rescue OSM::APIChangesetAlreadyClosedError => ex
775     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
776   rescue OSM::APIVersionMismatchError => ex
777     # Really need to check to see whether this is a server load issue, and the 
778     # last version was in the same changeset, or belongs to the same user, then
779     # we can return something different
780     return [-3, "Sorry, someone else has changed this way since you started editing. Please click the 'Edit' tab to reload the area."]
781   rescue OSM::APIAlreadyDeletedError => ex
782     return [-1, "The way has already been deleted."]
783   rescue OSM::APIError => ex
784     # Some error that we don't specifically catch
785     return [-2, "An unusual error happened (in 'deleteway')."]
786   end
787
788
789   # ====================================================================
790   # Support functions
791
792   # Remove a node or way from all relations
793   # This is only used by putway and deleteway when deleting nodes removed 
794   # from a way (because Potlatch itself doesn't keep track of these - 
795   # possible FIXME).
796
797   def deleteitemrelations(user, changeset_id, objid, type, version) #:doc:
798     relations = RelationMember.find(:all, 
799                                                                         :conditions => ['member_type = ? and member_id = ?', type, objid], 
800                                                                         :include => :relation).collect { |rm| rm.relation }.uniq
801
802     relations.each do |rel|
803       rel.members.delete_if { |x| x[0] == type and x[1] == objid }
804       new_rel = Relation.new
805       new_rel.tags = rel.tags
806       new_rel.visible = rel.visible
807       new_rel.version = rel.version
808       new_rel.members = rel.members
809       new_rel.changeset_id = changeset_id
810       rel.update_from(new_rel, user)
811     end
812   end
813
814   # Authenticate token
815   # (can also be of form user:pass)
816   # When we are writing to the api, we need the actual user model, 
817   # not just the id, hence this abstraction
818
819   def getuser(token) #:doc:
820     if (token =~ /^(.+)\:(.+)$/) then
821       user = User.authenticate(:username => $1, :password => $2)
822     else
823       user = User.authenticate(:token => token)
824     end
825     return user
826   end
827
828   # Send AMF response
829   
830   def sendresponse(results)
831     a,b=results.length.divmod(256)
832     render :content_type => "application/x-amf", :text => proc { |response, output| 
833       # ** move amf writing loop into here - 
834       # basically we read the messages in first (into an array of some sort),
835       # then iterate through that array within here, and do all the AMF writing
836       output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
837       results.each do |k,v|
838         output.write(v)
839       end
840     }
841   end
842
843
844   # ====================================================================
845   # Alternative SQL queries for getway/whichways
846
847   def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
848     sql=<<-EOF
849     SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
850       FROM current_way_nodes
851     INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
852     INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
853        WHERE current_nodes.visible=TRUE 
854        AND current_ways.visible=TRUE 
855        AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
856     EOF
857     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
858   end
859         
860   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
861     pois=[]
862     sql=<<-EOF
863                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version 
864                         FROM current_nodes 
865        LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
866                    WHERE current_nodes.visible=TRUE
867                          AND cwn.id IS NULL
868                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
869     EOF
870     ActiveRecord::Base.connection.select_all(sql).each do |row|
871       poitags={}
872       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
873         poitags[n['k']]=n['v']
874       end
875       pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
876     end
877     pois
878   end
879         
880   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
881     # ** It would be more Potlatchy to get relations for nodes within ways
882     #    during 'getway', not here
883     sql=<<-EOF
884       SELECT DISTINCT cr.id AS relid,cr.version AS version 
885       FROM current_relations cr
886       INNER JOIN current_relation_members crm ON crm.id=cr.id 
887       INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node' 
888        WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
889       EOF
890     unless way_ids.empty?
891       sql+=<<-EOF
892        UNION
893         SELECT DISTINCT cr.id AS relid,cr.version AS version
894         FROM current_relations cr
895         INNER JOIN current_relation_members crm ON crm.id=cr.id
896          WHERE crm.member_type='way' 
897          AND crm.member_id IN (#{way_ids.join(',')})
898         EOF
899     end
900     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
901   end
902         
903   def sql_get_nodes_in_way(wayid)
904     points=[]
905     sql=<<-EOF
906       SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id 
907       FROM current_way_nodes,current_nodes 
908        WHERE current_way_nodes.id=#{wayid.to_i} 
909                    AND current_way_nodes.node_id=current_nodes.id 
910                    AND current_nodes.visible=TRUE
911       ORDER BY sequence_id
912           EOF
913     ActiveRecord::Base.connection.select_all(sql).each do |row|
914       nodetags={}
915       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
916         nodetags[n['k']]=n['v']
917       end
918       nodetags.delete('created_by')
919       points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
920     end
921     points
922   end
923         
924   def sql_get_tags_in_way(wayid)
925     tags={}
926     ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
927       tags[row['k']]=row['v']
928     end
929     tags
930   end
931
932   def sql_get_way_version(wayid)
933     ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")
934   end
935 end
936