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