X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/2e2956d126908f74568878d6456412a48d259c58..901d77837b9c1a432c158f1ed5f9a90bf71b8588:/app/controllers/api_controller.rb?ds=sidebyside

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index 36ce88acd..564f71899 100644
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -1,24 +1,15 @@
 class ApiController < ApplicationController
 
-  session :off
-  before_filter :check_read_availability, :except => [:capabilities]
+  before_filter :check_api_readable, :except => [:capabilities]
   after_filter :compress_output
+  around_filter :api_call_handle_error, :api_call_timeout
 
   # 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 = 0.25
-
-  # Number of GPS trace/trackpoints returned per-page
-  TRACEPOINTS_PER_PAGE = 5000
-
-  
+  # 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
@@ -30,7 +21,7 @@ class ApiController < ApplicationController
         return
     end
 
-    offset = page * TRACEPOINTS_PER_PAGE
+    offset = page * APP_CONFIG['tracepoints_per_page']
 
     # Figure out the bbox
     bbox = params['bbox']
@@ -51,10 +42,10 @@ class ApiController < ApplicationController
     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" )
+    points = Tracepoint.find_by_area(min_lat, min_lon, max_lat, max_lon, :offset => offset, :limit => APP_CONFIG['tracepoints_per_page'], :order => "timestamp DESC" )
 
     doc = XML::Document.new
-    doc.encoding = 'UTF-8'
+    doc.encoding = XML::Encoding::UTF_8
     root = XML::Node.new 'gpx'
     root['version'] = '1.0'
     root['creator'] = 'OpenStreetMap.org'
@@ -72,20 +63,21 @@ class ApiController < ApplicationController
       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
-    GC.start
-    @@count+=1
     # Figure out the bbox
     bbox = params['bbox']
 
@@ -108,35 +100,42 @@ class ApiController < ApplicationController
       return
     end
 
-    @nodes = Node.find_by_area(min_lat, min_lon, max_lat, max_lon, :conditions => "visible = 1", :limit => APP_CONFIG['max_number_of_nodes']+1)
+    # 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}, :include => :node_tags, :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])
 
     node_ids = @nodes.collect(&:id)
     if node_ids.length > APP_CONFIG['max_number_of_nodes']
-      report_error("You requested too many nodes (limit is 50,000). Either request a smaller area, or use planet.osm")
+      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='0.5'></osm>", :content_type => "text/xml"
+      render :text => "<osm version='#{API_VERSION}' generator='#{GENERATOR}'></osm>", :content_type => "text/xml"
       return
     end
 
-    relations = Array.new
-
     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)
+      way_ids = way_nodes.collect { |way_node| way_node.id[0] }
+      ways = Way.find(way_ids, :include => [:way_nodes, :way_tags])
 
       list_of_way_nodes = ways.collect { |way|
-	      way.way_nodes.collect { |way_node| way_node.node_id }
+        way.way_nodes.collect { |way_node| way_node.node_id }
       }
       list_of_way_nodes.flatten!
 
@@ -148,15 +147,16 @@ class ApiController < ApplicationController
     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
 
     if nodes_to_fetch.length > 0
-      @nodes += Node.find(nodes_to_fetch)
+      @nodes += Node.find(nodes_to_fetch, :include => :node_tags)
     end
 
     visible_nodes = {}
+    changeset_cache = {}
     user_display_name_cache = {}
 
     @nodes.each do |node|
       if node.visible?
-        doc.root << node.to_xml_node(user_display_name_cache)
+        doc.root << node.to_xml_node(changeset_cache, user_display_name_cache)
         visible_nodes[node.id] = node
       end
     end
@@ -164,53 +164,34 @@ class ApiController < ApplicationController
     way_ids = Array.new
     ways.each do |way|
       if way.visible?
-        doc.root << way.to_xml_node(visible_nodes, user_display_name_cache)
+        doc.root << way.to_xml_node(visible_nodes, changeset_cache, user_display_name_cache)
         way_ids << way.id
       end
     end 
 
-    # collect relationships. currently done in one big block at the end;
-    # may need to move this upwards if people want automatic completion of
-    # relationships, i.e. deliver referenced objects like we do with ways...
-    relations = Array.new
-    if visible_nodes.length > 0
-        relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
-            "e.visible=1 and " +
-            "em.id = e.id and em.member_type='node' and em.member_id in (#{visible_nodes.keys.join(',')})")
-    end
-    if way_ids.length > 0
-        relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
-            "e.visible=1 and " +
-            "em.id = e.id and em.member_type='way' and em.member_id in (#{way_ids.join(',')})")
-    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)
-    relation_ids = relations.collect { |relation| relation.id }
-    if relation_ids.length > 0
-        relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
-            "e.visible=1 and " +
-            "em.id = e.id and em.member_type='relation' and em.member_id in (#{relation_ids.join(',')})")
-    end
+    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)
+      doc.root << relation.to_xml_node(nil, changeset_cache, user_display_name_cache)
     end
 
+    response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
+
     render :text => doc.to_s, :content_type => "text/xml"
-    
-    #exit when we have too many requests
-    if @@count > MAX_COUNT
-      @@count = COUNT
-      
-      exit!
-    end
   end
 
+  # Get a list of the tiles that have changed within a specified time
+  # period
   def changes
     zoom = (params[:zoom] || '12').to_i
 
@@ -219,12 +200,12 @@ class ApiController < ApplicationController
       endtime = Time.parse(params[:end])
     else
       hours = (params[:hours] || '1').to_i.hours
-      endtime = Time.now
+      endtime = Time.now.getutc
       starttime = endtime - hours
     end
 
     if zoom >= 1 and zoom <= 16 and
-       endtime >= starttime and endtime - starttime <= 24.hours
+       endtime > starttime and endtime - starttime <= 24.hours
       mask = (1 << zoom) - 1
 
       tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],
@@ -252,21 +233,38 @@ class ApiController < ApplicationController
 
       render :text => doc.to_s, :content_type => "text/xml"
     else
-      render :nothing => true, :status => :bad_request
+      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'] = '0.5';
-    version['maximum'] = '0.5';
+    version['minimum'] = "#{API_VERSION}";
+    version['maximum'] = "#{API_VERSION}";
     api << version
     area = XML::Node.new 'area'
-    area['maximum'] = MAX_REQUEST_AREA.to_s;
+    area['maximum'] = APP_CONFIG['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
+    changesets = XML::Node.new 'changesets'
+    changesets['maximum_elements'] = Changeset::MAX_ELEMENTS.to_s
+    api << changesets
+    timeout = XML::Node.new 'timeout'
+    timeout['seconds'] = APP_CONFIG['api_timeout'].to_s
+    api << timeout
     
     doc.root << api