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