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