Potlatch for API 0.6 now saving ways happily with node versioning... I think

[rails.git] / app / controllers / api_controller.rb

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index 9e3839697a5f099f74500f50cea76d367ec80115..0724a3712651cfd23e05fcd81c0fc38f24182be3 100644 (file)
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -1,44 +1,292 @@
 class ApiController < ApplicationController
 
 class ApiController < ApplicationController
 

+  session :off
+  before_filter :check_read_availability, :except => [:capabilities]
+  after_filter :compress_output
+
+  # Help methods for checking boundary sanity and area size
+  include MapBoundary
+
+  #COUNT is the number of map requests to allow before exiting and starting a new process
+  @@count = COUNT
+
+  # The maximum area you're allowed to request, in square degrees
+  MAX_REQUEST_AREA = APP_CONFIG['max_request_area']
+
+  # Number of GPS trace/trackpoints returned per-page
+  TRACEPOINTS_PER_PAGE = APP_CONFIG['tracepoints_per_page']
+
+  # Get an XML response containing a list of tracepoints that have been uploaded
+  # within the specified bounding box, and in the specified page.
+  def trackpoints
+    @@count+=1
+    #retrieve the page number
+    page = params['page'].to_i
+    unless page
+        page = 0;
+    end
+
+    unless page >= 0
+        report_error("Page number must be greater than or equal to 0")
+        return
+    end
+
+    offset = page * TRACEPOINTS_PER_PAGE
+
+    # Figure out the bbox
+    bbox = params['bbox']
+    unless bbox and bbox.count(',') == 3
+      report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
+      return
+    end
+
+    bbox = bbox.split(',')
+    min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox)
+    # check boundary is sane and area within defined
+    # see /config/application.yml
+    begin
+      check_boundaries(min_lon, min_lat, max_lon, max_lat)
+    rescue Exception => err
+      report_error(err.message)
+      return
+    end
+
+    # get all the points
+    points = Tracepoint.find_by_area(min_lat, min_lon, max_lat, max_lon, :offset => offset, :limit => TRACEPOINTS_PER_PAGE, :order => "timestamp DESC" )
+
+    doc = XML::Document.new
+    doc.encoding = 'UTF-8'
+    root = XML::Node.new 'gpx'
+    root['version'] = '1.0'
+    root['creator'] = 'OpenStreetMap.org'
+    root['xmlns'] = "http://www.topografix.com/GPX/1/0/"
+    
+    doc.root = root
+
+    track = XML::Node.new 'trk'
+    doc.root << track
+
+    trkseg = XML::Node.new 'trkseg'
+    track << trkseg
+
+    points.each do |point|
+      trkseg << point.to_xml_node()
+    end
+
+    #exit when we have too many requests
+    if @@count > MAX_COUNT
+      render :text => doc.to_s, :content_type => "text/xml"
+      @@count = COUNT
+      exit!
+    end
+
+    response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
+
+    render :text => doc.to_s, :content_type => "text/xml"
+  end
+
+  # This is probably the most common call of all. It is used for getting the 
+  # OSM data for a specified bounding box, usually for editing. First the
+  # bounding box (bbox) is checked to make sure that it is sane. All nodes 
+  # are searched, then all the ways that reference those nodes are found.
+  # All Nodes that are referenced by those ways are fetched and added to the list
+  # of nodes.
+  # Then all the relations that reference the already found nodes and ways are
+  # fetched. All the nodes and ways that are referenced by those ways are then 
+  # fetched. Finally all the xml is returned.

   def map
   def map

+    GC.start
+    @@count+=1
+    # Figure out the bbox

     bbox = params['bbox']
     bbox = params['bbox']

+

     unless bbox and bbox.count(',') == 3
     unless bbox and bbox.count(',') == 3

-      render :nothing => true, :status => 400
+      # alternatively: report_error(TEXT['boundary_parameter_required']
+      report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")

       return
     end
 
     bbox = bbox.split(',')
 
       return
     end
 
     bbox = bbox.split(',')
 

-    min_lat = bbox[0].to_f
-    min_lon = bbox[1].to_f
-    max_lat = bbox[2].to_f
-    max_lon = bbox[3].to_f
+    min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox)

 
 

-    nodes = Node.find(:all, :conditions => ['latitude > ? AND longitude > ? AND latitude < ? AND longitude < ? AND visible = 1', min_lat, min_lon, max_lat, max_lon])
+    # check boundary is sane and area within defined
+    # see /config/application.yml
+    begin
+      check_boundaries(min_lon, min_lat, max_lon, max_lat)
+    rescue Exception => err
+      report_error(err.message)
+      return
+    end

 
 

-    node_ids = "(#{nodes.collect {|node| node.id }})"
+    # FIXME um why is this area using a different order for the lat/lon from above???
+    @nodes = Node.find_by_area(min_lat, min_lon, max_lat, max_lon, :conditions => {:visible => true}, :limit => APP_CONFIG['max_number_of_nodes']+1)
+    # get all the nodes, by tag not yet working, waiting for change from NickB
+    # need to be @nodes (instance var) so tests in /spec can be performed
+    #@nodes = Node.search(bbox, params[:tag])

 
 

-    segments = Segment.find(:all, :condtions => ['node_a in ? or node_b in ?', node_ids, node_ids])
-    render :text => node_ids.join(',')
-    return
+    node_ids = @nodes.collect(&:id)
+    if node_ids.length > APP_CONFIG['max_number_of_nodes']
+      report_error("You requested too many nodes (limit is #{APP_CONFIG['max_number_of_nodes']}). Either request a smaller area, or use planet.osm")
+      return
+    end
+    if node_ids.length == 0
+      render :text => "<osm version='#{API_VERSION}' generator='#{GENERATOR}'></osm>", :content_type => "text/xml"
+      return
+    end

 
 

-    doc = XML::Document.new
-    doc.encoding = 'UTF-8' 
-    root = XML::Node.new 'osm'
-    root['version'] = '0.4'
-    root['generator'] = 'OpenStreetMap server'
-    doc.root = root
+    doc = OSM::API.new.get_xml_doc
+
+    # add bounds
+    bounds = XML::Node.new 'bounds'
+    bounds['minlat'] = min_lat.to_s
+    bounds['minlon'] = min_lon.to_s
+    bounds['maxlat'] = max_lat.to_s
+    bounds['maxlon'] = max_lon.to_s
+    doc.root << bounds
+
+    # get ways
+    # find which ways are needed
+    ways = Array.new
+    if node_ids.length > 0
+      way_nodes = WayNode.find_all_by_node_id(node_ids)
+      way_ids = way_nodes.collect { |way_node| way_node.id[0] }
+      ways = Way.find(way_ids)
+
+      list_of_way_nodes = ways.collect { |way|
+        way.way_nodes.collect { |way_node| way_node.node_id }
+      }
+      list_of_way_nodes.flatten!
+
+    else
+      list_of_way_nodes = Array.new
+    end
+
+    # - [0] in case some thing links to node 0 which doesn't exist. Shouldn't actually ever happen but it does. FIXME: file a ticket for this
+    nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
+
+    if nodes_to_fetch.length > 0
+      @nodes += Node.find(nodes_to_fetch)
+    end
+
+    visible_nodes = {}
+    user_display_name_cache = {}
+
+    @nodes.each do |node|
+      if node.visible?
+        doc.root << node.to_xml_node(user_display_name_cache)
+        visible_nodes[node.id] = node
+      end
+    end
+
+    way_ids = Array.new
+    ways.each do |way|
+      if way.visible?
+        doc.root << way.to_xml_node(visible_nodes, user_display_name_cache)
+        way_ids << way.id
+      end
+    end 
+
+    relations = Relation.find_for_nodes(visible_nodes.keys, :conditions => {:visible => true}) +
+                Relation.find_for_ways(way_ids, :conditions => {:visible => true})
+
+    # we do not normally return the "other" partners referenced by an relation, 
+    # e.g. if we return a way A that is referenced by relation X, and there's 
+    # another way B also referenced, that is not returned. But we do make 
+    # an exception for cases where an relation references another *relation*; 
+    # in that case we return that as well (but we don't go recursive here)
+    relations += Relation.find_for_relations(relations.collect { |r| r.id }, :conditions => {:visible => true})
+
+    # this "uniq" may be slightly inefficient; it may be better to first collect and output
+    # all node-related relations, then find the *not yet covered* way-related ones etc.
+    relations.uniq.each do |relation|
+      doc.root << relation.to_xml_node(user_display_name_cache)
+    end

 
 

-    render :text => doc.to_s
+    response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
+
+    render :text => doc.to_s, :content_type => "text/xml"

     
     

-    #el1 = XML::Node.new 'node'
-    #el1['id'] = self.id.to_s
-    #el1['lat'] = self.latitude.to_s
-    #el1['lon'] = self.longitude.to_s
-    #Node.split_tags(el1, self.tags)
-    #el1['visible'] = self.visible.to_s
-    #el1['timestamp'] = self.timestamp.xmlschema
-    #root << el1
+    #exit when we have too many requests
+    if @@count > MAX_COUNT
+      @@count = COUNT
+      
+      exit!
+    end

   end
 
   end
 

+  # Get a list of the tiles that have changed within a specified time
+  # period
+  def changes
+    zoom = (params[:zoom] || '12').to_i
+
+    if params.include?(:start) and params.include?(:end)
+      starttime = Time.parse(params[:start])
+      endtime = Time.parse(params[:end])
+    else
+      hours = (params[:hours] || '1').to_i.hours
+      endtime = Time.now
+      starttime = endtime - hours
+    end
+
+    if zoom >= 1 and zoom <= 16 and
+       endtime > starttime and endtime - starttime <= 24.hours
+      mask = (1 << zoom) - 1
+
+      tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],
+                         :group => "maptile_for_point(latitude, longitude, #{zoom})")
+
+      doc = OSM::API.new.get_xml_doc
+      changes = XML::Node.new 'changes'
+      changes["starttime"] = starttime.xmlschema
+      changes["endtime"] = endtime.xmlschema
+
+      tiles.each do |tile, count|
+        x = (tile.to_i >> zoom) & mask
+        y = tile.to_i & mask
+
+        t = XML::Node.new 'tile'
+        t["x"] = x.to_s
+        t["y"] = y.to_s
+        t["z"] = zoom.to_s
+        t["changes"] = count.to_s
+
+        changes << t
+      end
+
+      doc.root << changes
+
+      render :text => doc.to_s, :content_type => "text/xml"
+    else
+      render :text => "Requested zoom is invalid, or the supplied start is after the end time, or the start duration is more than 24 hours", :status => :bad_request
+    end
+  end
+
+  # External apps that use the api are able to query the api to find out some 
+  # parameters of the API. It currently returns: 
+  # * minimum and maximum API versions that can be used.
+  # * maximum area that can be requested in a bbox request in square degrees
+  # * number of tracepoints that are returned in each tracepoints page
+  def capabilities
+    doc = OSM::API.new.get_xml_doc
+
+    api = XML::Node.new 'api'
+    version = XML::Node.new 'version'
+    version['minimum'] = "#{API_VERSION}";
+    version['maximum'] = "#{API_VERSION}";
+    api << version
+    area = XML::Node.new 'area'
+    area['maximum'] = MAX_REQUEST_AREA.to_s;
+    api << area
+    tracepoints = XML::Node.new 'tracepoints'
+    tracepoints['per_page'] = APP_CONFIG['tracepoints_per_page'].to_s
+    api << tracepoints
+    waynodes = XML::Node.new 'waynodes'
+    waynodes['maximum'] = APP_CONFIG['max_number_of_way_nodes'].to_s
+    api << waynodes
+    
+    doc.root << api
+
+    render :text => doc.to_s, :content_type => "text/xml"
+  end

 end
 end