Handle differences in interval constant formatting.
[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.getutc
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       begin
302         # revert
303         timestamp = DateTime.strptime(timestamp.to_s, "%d %b %Y, %H:%M:%S")
304         old_way = OldWay.find(:first, :conditions => ['id = ? AND timestamp <= ?', id, timestamp], :order => 'timestamp DESC')
305         unless old_way.nil?
306           points = old_way.get_nodes_revert(timestamp)
307           if !old_way.visible
308             return [-1, "Sorry, the way was deleted at that time - please revert to a previous version."]
309           end
310         end
311       rescue ArgumentError
312         # thrown by date parsing method. leave old_way as nil for
313         # the superb error handler below.
314       end
315     end
316
317     if old_way.nil?
318       # *** FIXME: shouldn't this be returning an error?
319       return [-1, id, [], {}, -1,0]
320     else
321       curway=Way.find(id)
322       old_way.tags['history'] = "Retrieved from v#{old_way.version}"
323       return [0, id, points, old_way.tags, curway.version, (curway.version==old_way.version and curway.visible)]
324     end
325   end
326   
327   # Find history of a way.
328   # Returns 'way', id, and an array of previous versions:
329   # - formerly [old_way.version, old_way.timestamp.strftime("%d %b %Y, %H:%M"), old_way.visible ? 1 : 0, user, uid]
330   # - now [timestamp,user,uid]
331   #
332   # Heuristic: Find all nodes that have ever been part of the way; 
333   # get a list of their revision dates; add revision dates of the way;
334   # sort and collapse list (to within 2 seconds); trim all dates before the 
335   # start date of the way.
336
337   def getway_history(wayid) #:doc:
338
339     begin
340       # Find list of revision dates for way and all constituent nodes
341       revdates=[]
342       revusers={}
343       Way.find(wayid).old_ways.collect do |a|
344         revdates.push(a.timestamp)
345         unless revusers.has_key?(a.timestamp.to_i) then revusers[a.timestamp.to_i]=change_user(a) end
346         a.nds.each do |n|
347           Node.find(n).old_nodes.collect do |o|
348             revdates.push(o.timestamp)
349             unless revusers.has_key?(o.timestamp.to_i) then revusers[o.timestamp.to_i]=change_user(o) end
350           end
351         end
352       end
353       waycreated=revdates[0]
354       revdates.uniq!
355       revdates.sort!
356           revdates.reverse!
357
358       # Remove any dates (from nodes) before first revision date of way
359       revdates.delete_if { |d| d<waycreated }
360       # Remove any elements where 2 seconds doesn't elapse before next one
361       revdates.delete_if { |d| revdates.include?(d+1) or revdates.include?(d+2) }
362       # Collect all in one nested array
363       revdates.collect! {|d| [d.strftime("%d %b %Y, %H:%M:%S")] + revusers[d.to_i] }
364
365       return ['way',wayid,revdates]
366     rescue ActiveRecord::RecordNotFound
367       return ['way', wayid, []]
368     end
369   end
370   
371   # Find history of a node. Returns 'node', id, and an array of previous versions as above.
372
373   def getnode_history(nodeid) #:doc:
374     begin 
375       history = Node.find(nodeid).old_nodes.reverse.collect do |old_node|
376         [old_node.timestamp.strftime("%d %b %Y, %H:%M:%S")] + change_user(old_node)
377       end
378       return ['node', nodeid, history]
379     rescue ActiveRecord::RecordNotFound
380       return ['node', nodeid, []]
381     end
382   end
383
384   def change_user(obj)
385     user_object = obj.changeset.user
386     user = user_object.data_public? ? user_object.display_name : 'anonymous'
387     uid  = user_object.data_public? ? user_object.id : 0
388     [user,uid]
389   end
390
391   # Find GPS traces with specified name/id.
392   # Returns array listing GPXs, each one comprising id, name and description.
393   
394   def findgpx(searchterm, usertoken)
395     user = getuser(usertoken)
396     if !uid then return -1,"You must be logged in to search for GPX traces." end
397
398     gpxs = []
399     if searchterm.to_i>0 then
400       gpx = Trace.find(searchterm.to_i, :conditions => ["visible=? AND (public=? OR user_id=?)",true,true,user.id] )
401       if gpx then
402         gpxs.push([gpx.id, gpx.name, gpx.description])
403       end
404     else
405       Trace.find(:all, :limit => 21, :conditions => ["visible=? AND (public=? OR user_id=?) AND MATCH(name) AGAINST (?)",true,true,user.id,searchterm] ).each do |gpx|
406       gpxs.push([gpx.id, gpx.name, gpx.description])
407           end
408         end
409     gpxs
410   end
411
412   # Get a relation with all tags and members.
413   # Returns:
414   # 0. relation id,
415   # 1. hash of tags,
416   # 2. list of members,
417   # 3. version.
418   
419   def getrelation(relid) #:doc:
420     begin
421       rel = Relation.find(relid)
422     rescue ActiveRecord::RecordNotFound
423       return [relid, {}, []]
424     end
425
426     return [relid, {}, [], nil] if rel.nil? or !rel.visible
427     [relid, rel.tags, rel.members, rel.version]
428   end
429
430   # Find relations with specified name/id.
431   # Returns array of relations, each in same form as getrelation.
432   
433   def findrelations(searchterm)
434     rels = []
435     if searchterm.to_i>0 then
436       rel = Relation.find(searchterm.to_i)
437       if rel and rel.visible then
438         rels.push([rel.id, rel.tags, rel.members])
439       end
440     else
441       RelationTag.find(:all, :limit => 11, :conditions => ["match(v) against (?)", searchterm] ).each do |t|
442       if t.relation.visible then
443               rels.push([t.relation.id, t.relation.tags, t.relation.members])
444             end
445           end
446         end
447     rels
448   end
449
450   # Save a relation.
451   # Returns
452   # 0. 0 (success),
453   # 1. original relation id (unchanged),
454   # 2. new relation id.
455
456   def putrelation(renumberednodes, renumberedways, usertoken, changeset_id, version, relid, tags, members, visible) #:doc:
457     user = getuser(usertoken)
458     if !user then return -1,"You are not logged in, so the relation could not be saved." end
459
460     relid = relid.to_i
461     visible = (visible.to_i != 0)
462
463     new_relation = nil
464     relation = nil
465     Relation.transaction do
466       # create a new relation, or find the existing one
467       if relid > 0
468         relation = Relation.find(relid)
469       end
470       # We always need a new node, based on the data that has been sent to us
471       new_relation = Relation.new
472
473       # check the members are all positive, and correctly type
474       typedmembers = []
475       members.each do |m|
476         mid = m[1].to_i
477         if mid < 0
478           mid = renumberednodes[mid] if m[0] == 'node'
479           mid = renumberedways[mid] if m[0] == 'way'
480         end
481         if mid
482           typedmembers << [m[0], mid, m[2]]
483         end
484       end
485
486       # assign new contents
487       new_relation.members = typedmembers
488       new_relation.tags = tags
489       new_relation.visible = visible
490       new_relation.changeset_id = changeset_id
491       new_relation.version = version
492
493       # NOTE: id or relid here? id doesn't seem to be set above
494       if relid <= 0
495         # We're creating the node
496         new_relation.create_with_history(user)
497       elsif visible
498         # We're updating the node
499         relation.update_from(new_relation, user)
500       else
501         # We're deleting the node
502         relation.delete_with_history!(new_relation, user)
503       end
504     end # transaction
505       
506     if id <= 0
507       return [0, relid, new_relation.id, new_relation.version]
508     else
509       return [0, relid, relation.id, relation.version]
510     end
511   rescue OSM::APIChangesetAlreadyClosedError => ex
512     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}."]
513   rescue OSM::APIVersionMismatchError => ex
514     # Really need to check to see whether this is a server load issue, and the 
515     # last version was in the same changeset, or belongs to the same user, then
516     # we can return something different
517     return [-3, "Sorry, someone else has changed this relation since you started editing. Please click the 'Edit' tab to reload the area."]
518   rescue OSM::APIAlreadyDeletedError => ex
519     return [-1, "The relation has already been deleted."]
520   rescue OSM::APIError => ex
521     # Some error that we don't specifically catch
522     return [-2, "Something really bad happened :-( ."]
523   end
524
525   # Save a way to the database, including all nodes. Any nodes in the previous
526   # version and no longer used are deleted.
527   # 
528   # Parameters:
529   # 0. hash of renumbered nodes (added by amf_controller)
530   # 1. current user token (for authentication)
531   # 2. current changeset
532   # 3. new way version
533   # 4. way ID
534   # 5. list of nodes in way
535   # 6. hash of way tags
536   # 7. array of nodes to change (each one is [lon,lat,id,version,tags])
537   # 
538   # Returns:
539   # 0. '0' (code for success),
540   # 1. original way id (unchanged),
541   # 2. new way id,
542   # 3. hash of renumbered nodes (old id=>new id),
543   # 4. way version,
544   # 5. hash of node versions (node=>version)
545
546   def putway(renumberednodes, usertoken, changeset_id, wayversion, originalway, pointlist, attributes, nodes) #:doc:
547
548     # -- Initialise
549         
550     user = getuser(usertoken)
551     if !user then return -1,"You are not logged in, so the way could not be saved." end
552     if pointlist.length < 2 then return -2,"Server error - way is only #{points.length} points long." end
553
554     originalway = originalway.to_i
555         pointlist.collect! {|a| a.to_i }
556
557     way=nil     # this is returned, so scope it outside the transaction
558     nodeversions = {}
559     Way.transaction do
560
561       # -- Get unique nodes
562
563       if originalway <= 0
564         uniques = []
565       else
566         way = Way.find(originalway)
567         uniques = way.unshared_node_ids
568       end
569
570       #-- Update each changed node
571
572       nodes.each do |a|
573         lon = a[0].to_f
574         lat = a[1].to_f
575         id = a[2].to_i
576         version = a[3].to_i
577         if id == 0  then return -2,"Server error - node with id 0 found in way #{originalway}." end
578         if lat== 90 then return -2,"Server error - node with latitude -90 found in way #{originalway}." end
579         if renumberednodes[id] then id = renumberednodes[id] end
580
581         node = Node.new
582         node.changeset_id = changeset_id
583         node.lat = lat
584         node.lon = lon
585         node.tags = a[4]
586         node.tags.delete('created_by')
587         node.version = version
588         if id <= 0
589           # We're creating the node
590           node.create_with_history(user)
591           renumberednodes[id] = node.id
592           nodeversions[node.id] = node.version
593         else
594           # We're updating an existing node
595           previous=Node.find(id)
596           previous.update_from(node, user)
597           nodeversions[previous.id] = previous.version
598         end
599       end
600
601       # -- Save revised way
602
603           pointlist.collect! {|a|
604                 renumberednodes[a] ? renumberednodes[a]:a
605           } # renumber nodes
606       new_way = Way.new
607       new_way.tags = attributes
608       new_way.nds = pointlist
609       new_way.changeset_id = changeset_id
610       new_way.version = wayversion
611       if originalway <= 0
612         new_way.create_with_history(user)
613         way=new_way     # so we can get way.id and way.version
614       elsif way.tags!=attributes or way.nds!=pointlist or !way.visible?
615         way.update_from(new_way, user)
616       end
617
618       # -- Delete any unique nodes no longer used
619
620       uniques=uniques-pointlist
621       uniques.each do |n|
622         node = Node.find(n)
623         deleteitemrelations(user, changeset_id, id, 'node', node.version)
624         new_node = Node.new
625         new_node.changeset_id = changeset_id
626         new_node.version = node.version
627         node.delete_with_history!(new_node, user)
628       end
629
630     end # transaction
631
632     [0, originalway, way.id, renumberednodes, way.version, nodeversions]
633   rescue OSM::APIChangesetAlreadyClosedError => ex
634     return [-2, "Sorry, your changeset #{ex.changeset.id} has been closed (at #{ex.changeset.closed_at})."]
635   rescue OSM::APIVersionMismatchError => ex
636     # Really need to check to see whether this is a server load issue, and the 
637     # last version was in the same changeset, or belongs to the same user, then
638     # we can return something different
639     return [-3, "Sorry, someone else has changed this way since you started editing. Please click the 'Edit' tab to reload the area."]
640   rescue OSM::APITooManyWayNodesError => ex
641     return [-1, "You have tried to upload a really long way with #{ex.provided} points: only #{ex.max} are allowed."]
642   rescue OSM::APIAlreadyDeletedError => ex
643     return [-1, "The point has already been deleted."]
644   rescue OSM::APIError => ex
645     # Some error that we don't specifically catch
646     return [-2, "Something really bad happened :-(."]
647   end
648
649   # Save POI to the database.
650   # Refuses save if the node has since become part of a way.
651   # Returns array with:
652   # 0. 0 (success),
653   # 1. original node id (unchanged),
654   # 2. new node id,
655   # 3. version.
656
657   def putpoi(usertoken, changeset_id, version, id, lon, lat, tags, visible) #:doc:
658     user = getuser(usertoken)
659     if !user then return -1,"You are not logged in, so the point could not be saved." end
660
661     id = id.to_i
662     visible = (visible.to_i == 1)
663     node = nil
664     new_node = nil
665     Node.transaction do
666       if id > 0 then
667         node = Node.find(id)
668
669         if !visible then
670           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
671         end
672       end
673       # We always need a new node, based on the data that has been sent to us
674       new_node = Node.new
675
676       new_node.changeset_id = changeset_id
677       new_node.version = version
678       new_node.lat = lat
679       new_node.lon = lon
680       new_node.tags = tags
681       if id <= 0 
682         # We're creating the node
683         new_node.create_with_history(user)
684       elsif visible
685         # We're updating the node
686         node.update_from(new_node, user)
687       else
688         # We're deleting the node
689         node.delete_with_history!(new_node, user)
690       end
691      end # transaction
692
693     if id <= 0
694       return [0, id, new_node.id, new_node.version]
695     else
696       return [0, id, node.id, node.version]
697     end 
698   rescue OSM::APIChangesetAlreadyClosedError => ex
699     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
700   rescue OSM::APIVersionMismatchError => ex
701     # Really need to check to see whether this is a server load issue, and the 
702     # last version was in the same changeset, or belongs to the same user, then
703     # we can return something different
704     return [-3, "Sorry, someone else has changed this point since you started editing. Please click the 'Edit' tab to reload the area."]
705   rescue OSM::APIAlreadyDeletedError => ex
706     return [-1, "The point has already been deleted"]
707   rescue OSM::APIError => ex
708     # Some error that we don't specifically catch
709     return [-2, "Something really bad happened :-()"]
710   end
711
712   # Read POI from database
713   # (only called on revert: POIs are usually read by whichways).
714   #
715   # Returns array of id, long, lat, hash of tags, version.
716
717   def getpoi(id,timestamp) #:doc:
718     if timestamp == '' then
719       n = Node.find(id)
720     else
721       n = OldNode.find(id, :conditions=>['timestamp=?',DateTime.strptime(timestamp, "%d %b %Y, %H:%M:%S")])
722     end
723
724     if n
725       return [n.id, n.lon, n.lat, n.tags, n.version]
726     else
727       return [nil, nil, nil, {}, nil]
728     end
729   end
730
731   # Delete way and all constituent nodes. Also removes from any relations.
732   # Params:
733   # * The user token
734   # * the changeset id
735   # * the id of the way to change
736   # * the version of the way that was downloaded
737   # * a hash of the id and versions of all the nodes that are in the way, if any 
738   # of the nodes have been changed by someone else then, there is a problem!
739   # Returns 0 (success), unchanged way id.
740
741   def deleteway(usertoken, changeset_id, way_id, way_version, node_id_version) #:doc:
742     user = getuser(usertoken)
743     unless user then return -1,"You are not logged in, so the way could not be deleted." end
744       
745     way_id = way_id.to_i
746     # Need a transaction so that if one item fails to delete, the whole delete fails.
747     Way.transaction do
748
749       # delete the way
750       old_way = Way.find(way_id)
751       delete_way = Way.new
752       delete_way.version = way_version
753       delete_way.changeset_id = changeset_id
754       old_way.delete_with_history!(delete_way, user)
755
756       old_way.unshared_node_ids.each do |node_id|
757         # delete the node
758         node = Node.find(node_id)
759         delete_node = Node.new
760         delete_node.changeset_id = changeset_id
761         if node_id_version[node_id.to_s]
762           delete_node.version = node_id_version[node_id.to_s]
763         else
764           # in case the node wasn't passed (i.e. if it was previously removed
765           # from the way in Potlatch)
766           deleteitemrelations(user, changeset_id, node_id, 'node', node.version)
767               delete_node.version = node.version
768             end
769         node.delete_with_history!(delete_node, user)
770       end
771     end # transaction
772     [0, way_id]
773   rescue OSM::APIChangesetAlreadyClosedError => ex
774     return [-1, "The changeset #{ex.changeset.id} was closed at #{ex.changeset.closed_at}"]
775   rescue OSM::APIVersionMismatchError => ex
776     # Really need to check to see whether this is a server load issue, and the 
777     # last version was in the same changeset, or belongs to the same user, then
778     # we can return something different
779     return [-3, "Sorry, someone else has changed this way since you started editing. Please click the 'Edit' tab to reload the area."]
780   rescue OSM::APIAlreadyDeletedError => ex
781     return [-1, "The way has already been deleted."]
782   rescue OSM::APIError => ex
783     # Some error that we don't specifically catch
784     return [-2, "Something really bad happened :-( ."]
785   end
786
787
788   # ====================================================================
789   # Support functions
790
791   # Remove a node or way from all relations
792   # This is only used by putway and deleteway when deleting nodes removed 
793   # from a way (because Potlatch itself doesn't keep track of these - 
794   # possible FIXME).
795
796   def deleteitemrelations(user, changeset_id, objid, type, version) #:doc:
797     relations = RelationMember.find(:all, 
798                                                                         :conditions => ['member_type = ? and member_id = ?', type, objid], 
799                                                                         :include => :relation).collect { |rm| rm.relation }.uniq
800
801     relations.each do |rel|
802       rel.members.delete_if { |x| x[0] == type and x[1] == objid }
803       new_rel = Relation.new
804       new_rel.tags = rel.tags
805       new_rel.visible = rel.visible
806       new_rel.version = rel.version
807       new_rel.members = rel.members
808       new_rel.changeset_id = changeset_id
809       rel.update_from(new_rel, user)
810     end
811   end
812
813   # Authenticate token
814   # (can also be of form user:pass)
815   # When we are writing to the api, we need the actual user model, 
816   # not just the id, hence this abstraction
817
818   def getuser(token) #:doc:
819     if (token =~ /^(.+)\:(.+)$/) then
820       user = User.authenticate(:username => $1, :password => $2)
821     else
822       user = User.authenticate(:token => token)
823     end
824     return user
825   end
826
827   # Send AMF response
828   
829   def sendresponse(results)
830     a,b=results.length.divmod(256)
831     render :content_type => "application/x-amf", :text => proc { |response, output| 
832       # ** move amf writing loop into here - 
833       # basically we read the messages in first (into an array of some sort),
834       # then iterate through that array within here, and do all the AMF writing
835       output.write 0.chr+0.chr+0.chr+0.chr+a.chr+b.chr
836       results.each do |k,v|
837         output.write(v)
838       end
839     }
840   end
841
842
843   # ====================================================================
844   # Alternative SQL queries for getway/whichways
845
846   def sql_find_ways_in_area(xmin,ymin,xmax,ymax)
847     sql=<<-EOF
848     SELECT DISTINCT current_ways.id AS wayid,current_ways.version AS version
849       FROM current_way_nodes
850     INNER JOIN current_nodes ON current_nodes.id=current_way_nodes.node_id
851     INNER JOIN current_ways  ON current_ways.id =current_way_nodes.id
852        WHERE current_nodes.visible=TRUE 
853        AND current_ways.visible=TRUE 
854        AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
855     EOF
856     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['wayid'].to_i,a['version'].to_i] }
857   end
858         
859   def sql_find_pois_in_area(xmin,ymin,xmax,ymax)
860     pois=[]
861     sql=<<-EOF
862                   SELECT current_nodes.id,current_nodes.latitude*0.0000001 AS lat,current_nodes.longitude*0.0000001 AS lon,current_nodes.version 
863                         FROM current_nodes 
864        LEFT OUTER JOIN current_way_nodes cwn ON cwn.node_id=current_nodes.id 
865                    WHERE current_nodes.visible=TRUE
866                          AND cwn.id IS NULL
867                          AND #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "current_nodes.")}
868     EOF
869     ActiveRecord::Base.connection.select_all(sql).each do |row|
870       poitags={}
871       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
872         poitags[n['k']]=n['v']
873       end
874       pois << [row['id'].to_i, row['lon'].to_f, row['lat'].to_f, poitags, row['version'].to_i]
875     end
876     pois
877   end
878         
879   def sql_find_relations_in_area_and_ways(xmin,ymin,xmax,ymax,way_ids)
880     # ** It would be more Potlatchy to get relations for nodes within ways
881     #    during 'getway', not here
882     sql=<<-EOF
883       SELECT DISTINCT cr.id AS relid,cr.version AS version 
884       FROM current_relations cr
885       INNER JOIN current_relation_members crm ON crm.id=cr.id 
886       INNER JOIN current_nodes cn ON crm.member_id=cn.id AND crm.member_type='node' 
887        WHERE #{OSM.sql_for_area(ymin, xmin, ymax, xmax, "cn.")}
888       EOF
889     unless way_ids.empty?
890       sql+=<<-EOF
891        UNION
892         SELECT DISTINCT cr.id AS relid,cr.version AS version
893         FROM current_relations cr
894         INNER JOIN current_relation_members crm ON crm.id=cr.id
895          WHERE crm.member_type='way' 
896          AND crm.member_id IN (#{way_ids.join(',')})
897         EOF
898     end
899     return ActiveRecord::Base.connection.select_all(sql).collect { |a| [a['relid'].to_i,a['version'].to_i] }
900   end
901         
902   def sql_get_nodes_in_way(wayid)
903     points=[]
904     sql=<<-EOF
905       SELECT latitude*0.0000001 AS lat,longitude*0.0000001 AS lon,current_nodes.id 
906       FROM current_way_nodes,current_nodes 
907        WHERE current_way_nodes.id=#{wayid.to_i} 
908                    AND current_way_nodes.node_id=current_nodes.id 
909                    AND current_nodes.visible=TRUE
910       ORDER BY sequence_id
911           EOF
912     ActiveRecord::Base.connection.select_all(sql).each do |row|
913       nodetags={}
914       ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_node_tags WHERE id=#{row['id']}").each do |n|
915         nodetags[n['k']]=n['v']
916       end
917       nodetags.delete('created_by')
918       points << [row['lon'].to_f,row['lat'].to_f,row['id'].to_i,nodetags]
919     end
920     points
921   end
922         
923   def sql_get_tags_in_way(wayid)
924     tags={}
925     ActiveRecord::Base.connection.select_all("SELECT k,v FROM current_way_tags WHERE id=#{wayid.to_i}").each do |row|
926       tags[row['k']]=row['v']
927     end
928     tags
929   end
930
931   def sql_get_way_version(wayid)
932     ActiveRecord::Base.connection.select_one("SELECT version FROM current_ways WHERE id=#{wayid.to_i}")
933   end
934 end
935