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