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