Merge remote-tracking branch 'upstream/pull/1895'

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

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index c17ff679854075f34760a13bfea6cf7971f1fecb..021ada0cdcaae4a77ad5745e5baeba5627ab16fb 100644 (file)
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -1,237 +1,226 @@
 class ApiController < ApplicationController
 class ApiController < ApplicationController

+  skip_before_action :verify_authenticity_token
+  before_action :check_api_readable, :except => [:capabilities]
+  before_action :setup_user_auth, :only => [:permissions]
+  around_action :api_call_handle_error, :api_call_timeout

 
 

-  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 = 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
   def trackpoints

-    @@count+=1
-    #retrieve the page number
-    page = params['page'].to_i
-    unless page
-        page = 0;
-    end
+    # retrieve the page number
+    page = params["page"].to_s.to_i

 
     unless page >= 0
 
     unless page >= 0

-        report_error("Page number must be greater than or equal to 0")
-        return
+      report_error("Page number must be greater than or equal to 0")
+      return

     end
 
     offset = page * TRACEPOINTS_PER_PAGE
 
     # Figure out the bbox
     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 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
+      bbox = BoundingBox.from_bbox_params(params)
+      bbox.check_boundaries
+      bbox.check_size
+    rescue StandardError => err

       report_error(err.message)
       return
     end
 
     # get all the points
       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" )
+    points = Tracepoint.bbox(bbox).offset(offset).limit(TRACEPOINTS_PER_PAGE).order("gpx_id DESC, trackid ASC, timestamp ASC")

 
     doc = XML::Document.new
 
     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
+    doc.encoding = XML::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"

 
 

-    track = XML::Node.new 'trk'
-    doc.root << track
+    doc.root = root

 
 

-    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 => "traces", :action => "view", :display_name => gpx_file.user.display_name, :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
 

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

 
 

+    render :xml => doc.to_s

   end
 
   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
     # Figure out the bbox

-    bbox = params['bbox']
-
-    unless bbox and bbox.count(',') == 3
-      # 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(',')
-
-    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 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
+      bbox = BoundingBox.from_bbox_params(params)
+      bbox.check_boundaries
+      bbox.check_size
+    rescue StandardError => err

       report_error(err.message)
       return
     end
 
       report_error(err.message)
       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)
-    # 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])
+    nodes = Node.bbox(bbox).where(:visible => true).includes(:node_tags).limit(MAX_NUMBER_OF_NODES + 1)

 
 

-    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")
+    node_ids = nodes.collect(&:id)
+    if node_ids.length > MAX_NUMBER_OF_NODES
+      report_error("You requested too many nodes (limit is #{MAX_NUMBER_OF_NODES}). Either request a smaller area, or use planet.osm")

       return
     end
       return
     end

-    if node_ids.length == 0
-      render :text => "<osm version='0.5'></osm>", :content_type => "text/xml"
-      return
-    end
-
-    relations = Array.new

 
     doc = OSM::API.new.get_xml_doc
 
 
     doc = OSM::API.new.get_xml_doc
 

+    # add bounds
+    doc.root << bbox.add_bounds_to(XML::Node.new("bounds"))
+

     # get ways
     # find which ways are needed
     # 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)
+    ways = []
+    if node_ids.empty?
+      list_of_way_nodes = []
+    else
+      way_nodes = WayNode.where(:node_id => node_ids)

       way_ids = way_nodes.collect { |way_node| way_node.id[0] }
       way_ids = way_nodes.collect { |way_node| way_node.id[0] }

-      ways = Way.find(way_ids)
+      ways = Way.preload(:way_nodes, :way_tags).find(way_ids)

 
 

-      list_of_way_nodes = ways.collect { |way|
-        way.way_nodes.collect { |way_node| way_node.node_id }
-      }
+      list_of_way_nodes = ways.collect do |way|
+        way.way_nodes.collect(&:node_id)
+      end

       list_of_way_nodes.flatten!
       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]
 
     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
+    nodes += Node.includes(:node_tags).find(nodes_to_fetch) unless nodes_to_fetch.empty?

 
     visible_nodes = {}
 
     visible_nodes = {}

+    changeset_cache = {}

     user_display_name_cache = {}
 
     user_display_name_cache = {}
 

-    @nodes.each do |node|
+    nodes.each do |node|

       if node.visible?
       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
 

-    way_ids = Array.new
+    way_ids = []

     ways.each do |way|
       if way.visible?
     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
         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
     end

-    # 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*; 
+
+    relations = Relation.nodes(visible_nodes.keys).visible +
+                Relation.ways(way_ids).visible
+
+    # 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)
     # 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.relations(relations.collect(&:id)).visible

 
     # 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(changeset_cache, user_display_name_cache)

     end
 
     end
 

-    render :text => doc.to_s, :content_type => "text/xml"
-    
-    #exit when we have too many requests
-    if @@count > MAX_COUNT
-      @@count = COUNT
-      
-      exit!
-    end
+    response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
+
+    render :xml => doc.to_s

   end
 
   end
 

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

   def changes
   def changes

-    zoom = (params[:zoom] || '12').to_i
+    zoom = (params[:zoom] || "12").to_i

 
 

-    if params.include?(:start) and params.include?(:end)
+    if params.include?(:start) && params.include?(:end)

       starttime = Time.parse(params[:start])
       endtime = Time.parse(params[:end])
     else
       starttime = Time.parse(params[:start])
       endtime = Time.parse(params[:end])
     else

-      hours = (params[:hours] || '1').to_i.hours
-      endtime = Time.now
+      hours = (params[:hours] || "1").to_i.hours
+      endtime = Time.now.getutc

       starttime = endtime - hours
     end
 
       starttime = endtime - hours
     end
 

-    if zoom >= 1 and zoom <= 16 and
-       endtime >= starttime and endtime - starttime <= 24.hours
+    if zoom >= 1 && zoom <= 16 &&
+       endtime > starttime && endtime - starttime <= 24.hours

       mask = (1 << zoom) - 1
 
       mask = (1 << zoom) - 1
 

-      tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],
-                         :group => "maptile_for_point(latitude, longitude, #{zoom})")
+      tiles = Node.where(:timestamp => starttime..endtime).group("maptile_for_point(latitude, longitude, #{zoom})").count

 
       doc = OSM::API.new.get_xml_doc
 
       doc = OSM::API.new.get_xml_doc

-      changes = XML::Node.new 'changes'
+      changes = XML::Node.new "changes"

       changes["starttime"] = starttime.xmlschema
       changes["endtime"] = endtime.xmlschema
 
       changes["starttime"] = starttime.xmlschema
       changes["endtime"] = endtime.xmlschema
 


@@ -239,7 +228,7 @@ class ApiController < ApplicationController
         x = (tile.to_i >> zoom) & mask
         y = tile.to_i & mask
 
         x = (tile.to_i >> zoom) & mask
         y = tile.to_i & mask
 

-        t = XML::Node.new 'tile'
+        t = XML::Node.new "tile"

         t["x"] = x.to_s
         t["y"] = y.to_s
         t["z"] = zoom.to_s
         t["x"] = x.to_s
         t["y"] = y.to_s
         t["z"] = zoom.to_s


@@ -250,26 +239,74 @@ class ApiController < ApplicationController
 
       doc.root << changes
 
 
       doc.root << changes
 

-      render :text => doc.to_s, :content_type => "text/xml"
+      render :xml => doc.to_s

     else
     else

-      render :nothing => true, :status => :bad_request
+      render :plain => "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
 

-    api = XML::Node.new 'api'
-    version = XML::Node.new 'version'
-    version['minimum'] = '0.5';
-    version['maximum'] = '0.5';
+    api = XML::Node.new "api"
+    version = XML::Node.new "version"
+    version["minimum"] = API_VERSION.to_s
+    version["maximum"] = API_VERSION.to_s

     api << version
     api << version

-    area = XML::Node.new 'area'
-    area['maximum'] = MAX_REQUEST_AREA.to_s;
+    area = XML::Node.new "area"
+    area["maximum"] = MAX_REQUEST_AREA.to_s

     api << area
     api << area

-    
+    notearea = XML::Node.new "note_area"
+    notearea["maximum"] = MAX_NOTE_REQUEST_AREA.to_s
+    api << notearea
+    tracepoints = XML::Node.new "tracepoints"
+    tracepoints["per_page"] = TRACEPOINTS_PER_PAGE.to_s
+    api << tracepoints
+    waynodes = XML::Node.new "waynodes"
+    waynodes["maximum"] = 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"] = API_TIMEOUT.to_s
+    api << timeout
+    status = XML::Node.new "status"
+    status["database"] = database_status.to_s
+    status["api"] = api_status.to_s
+    status["gpx"] = gpx_status.to_s
+    api << status

     doc.root << api
     doc.root << api

+    policy = XML::Node.new "policy"
+    blacklist = XML::Node.new "imagery"
+    IMAGERY_BLACKLIST.each do |url_regex|
+      xnd = XML::Node.new "blacklist"
+      xnd["regex"] = url_regex.to_s
+      blacklist << xnd
+    end
+    policy << blacklist
+    doc.root << policy
+
+    render :xml => doc.to_s
+  end

 
 

-    render :text => doc.to_s, :content_type => "text/xml"
+  # External apps that use the api are able to query which permissions
+  # they have. This currently returns a list of permissions granted to the current user:
+  # * if authenticated via OAuth, this list will contain all permissions granted by the user to the access_token.
+  # * if authenticated via basic auth all permissions are granted, so the list will contain all permissions.
+  # * unauthenticated users have no permissions, so the list will be empty.
+  def permissions
+    @permissions = if current_token.present?
+                     ClientApplication.all_permissions.select { |p| current_token.read_attribute(p) }
+                   elsif current_user
+                     ClientApplication.all_permissions
+                   else
+                     []
+                   end

   end
 end
   end
 end