Redirect after processing user changes

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

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index f7c9f591f23a0bb6a8ac04a199f310f6b015be76..fc59ffcc7c0f3535c495aa632b632e4c50baa636 100644 (file)
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -1,36 +1,24 @@
 class ApiController < ApplicationController
 
 class ApiController < ApplicationController
 

-  session :off
-  before_filter :check_read_availability, :except => [:capabilities]
+  before_filter :check_api_readable, :except => [:capabilities]

   after_filter :compress_output
   after_filter :compress_output

+  around_filter :api_call_handle_error, :api_call_timeout

 
   # Help methods for checking boundary sanity and area size
   include MapBoundary
 
 
   # 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
   def trackpoints

-    @@count+=1

     #retrieve the page number
     #retrieve the page number

-    page = params['page'].to_i
-    unless page
-        page = 0;
-    end
+    page = params['page'].to_s.to_i

 
     unless page >= 0
         report_error("Page number must be greater than or equal to 0")
         return
     end
 
 
     unless page >= 0
         report_error("Page number must be greater than or equal to 0")
         return
     end
 

-    offset = page * TRACEPOINTS_PER_PAGE
+    offset = page * APP_CONFIG['tracepoints_per_page']

 
     # Figure out the bbox
     bbox = params['bbox']
 
     # Figure out the bbox
     bbox = params['bbox']


@@ -51,10 +39,10 @@ class ApiController < ApplicationController
     end
 
     # get all the points
     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 => "gpx_id DESC, trackid ASC, timestamp ASC" )

 
     doc = XML::Document.new
 
     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'
     root = XML::Node.new 'gpx'
     root['version'] = '1.0'
     root['creator'] = 'OpenStreetMap.org'


@@ -62,31 +50,78 @@ class ApiController < ApplicationController
     
     doc.root = root
 
     
     doc.root = root
 

-    track = XML::Node.new 'trk'
-    doc.root << track
-
-    trkseg = XML::Node.new 'trkseg'
-    track << trkseg
+    # initialise these variables outside of the loop so that they
+    # stay in scope and don't get free'd up by the GC during the
+    # loop.
+    gpx_id = -1
+    trackid = -1
+    track = nil
+    trkseg = nil
+    anon_track = nil
+    anon_trkseg = nil
+    gpx_file = nil
+    timestamps = false

 
     points.each do |point|
 
     points.each do |point|

-      trkseg << point.to_xml_node()
-    end
+      if gpx_id != point.gpx_id
+        gpx_id = point.gpx_id
+        trackid = -1
+        gpx_file = Trace.find(gpx_id)
+
+        if gpx_file.trackable?
+          track = XML::Node.new 'trk'
+          doc.root << track
+          timestamps = true
+
+          if gpx_file.identifiable?
+            track << (XML::Node.new("name") << gpx_file.name)
+            track << (XML::Node.new("desc") << gpx_file.description)
+            track << (XML::Node.new("url") << url_for(:controller => 'trace', :action => 'view', :id => gpx_file.id))
+          end
+        else
+          # use the anonymous track segment if the user hasn't allowed
+          # their GPX points to be tracked.
+          timestamps = false
+          if anon_track.nil? 
+            anon_track = XML::Node.new 'trk'
+            doc.root << anon_track
+          end
+          track = anon_track
+        end
+      end
+      
+      if trackid != point.trackid
+        if gpx_file.trackable?
+          trkseg = XML::Node.new 'trkseg'
+          track << trkseg
+          trackid = point.trackid
+        else
+          if anon_trkseg.nil? 
+            anon_trkseg = XML::Node.new 'trkseg'
+            anon_track << anon_trkseg
+          end
+          trkseg = anon_trkseg
+        end
+      end

 
 

-    #exit when we have too many requests
-    if @@count > MAX_COUNT
-      render :text => doc.to_s, :content_type => "text/xml"
-      @@count = COUNT
-      exit!
+      trkseg << point.to_xml_node(timestamps)

     end
 
     end
 

-    response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
+    response.headers["Content-Disposition"] = "attachment; filename=\"tracks.gpx\""

 
     render :text => doc.to_s, :content_type => "text/xml"
   end
 
 
     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']
 
     # Figure out the bbox
     bbox = params['bbox']
 


@@ -110,7 +145,7 @@ class ApiController < ApplicationController
     end
 
     # FIXME um why is this area using a different order for the lat/lon from above???
     end
 
     # 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 = 1", :limit => APP_CONFIG['max_number_of_nodes']+1)
+    @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])
     # 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])


@@ -121,7 +156,7 @@ class ApiController < ApplicationController
       return
     end
     if node_ids.length == 0
       return
     end
     if node_ids.length == 0

-      render :text => "<osm version='#{API_VERSION}'></osm>", :content_type => "text/xml"
+      render :text => "<osm version='#{API_VERSION}' generator='#{GENERATOR}'></osm>", :content_type => "text/xml"

       return
     end
 
       return
     end
 


@@ -141,7 +176,7 @@ class ApiController < ApplicationController
     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] }
     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)
+      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 }
 
       list_of_way_nodes = ways.collect { |way|
         way.way_nodes.collect { |way_node| way_node.node_id }


@@ -156,15 +191,16 @@ class ApiController < ApplicationController
     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
 
     if nodes_to_fetch.length > 0
     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 = {}
     end
 
     visible_nodes = {}

+    changeset_cache = {}

     user_display_name_cache = {}
 
     @nodes.each do |node|
       if node.visible?
     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
         visible_nodes[node.id] = node
       end
     end


@@ -172,39 +208,34 @@ class ApiController < ApplicationController
     way_ids = Array.new
     ways.each do |way|
       if way.visible?
     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 
 
         way_ids << way.id
       end
     end 
 

-    relations = Relation.find_for_nodes(visible_nodes.keys, :conditions => "visible = 1") +
-                Relation.find_for_ways(way_ids, :conditions => "visible = 1")
+    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)
 
     # 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 = 1")
+    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|
 
     # 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"
     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
 
   end
 

+  # Get a list of the tiles that have changed within a specified time
+  # period

   def changes
     zoom = (params[:zoom] || '12').to_i
 
   def changes
     zoom = (params[:zoom] || '12').to_i
 


@@ -213,12 +244,12 @@ class ApiController < ApplicationController
       endtime = Time.parse(params[:end])
     else
       hours = (params[:hours] || '1').to_i.hours
       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
       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],
       mask = (1 << zoom) - 1
 
       tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],


@@ -246,10 +277,15 @@ class ApiController < ApplicationController
 
       render :text => doc.to_s, :content_type => "text/xml"
     else
 
       render :text => doc.to_s, :content_type => "text/xml"
     else

-      render :text => "Requested zoom is invalid", :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
 
     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
 
   def capabilities
     doc = OSM::API.new.get_xml_doc
 


@@ -259,11 +295,20 @@ class ApiController < ApplicationController
     version['maximum'] = "#{API_VERSION}";
     api << version
     area = XML::Node.new 'area'
     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
     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
 
     
     doc.root << api