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