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

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

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index 3ef5e753aef135fc6f7fbe0ddfc162bcbc6803d3..17c98fe8b657e4c52acf6133084a786110405d90 100644 (file)
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -1,264 +1,173 @@
 class ApiController < ApplicationController
 class ApiController < ApplicationController

+  skip_before_action :verify_authenticity_token
+
+  before_action :check_api_readable
+
+  around_action :api_call_handle_error, :api_call_timeout
+
+  private
+
+  ##
+  # Set allowed request formats if no explicit format has been
+  # requested via a URL suffix. Allowed formats are taken from
+  # any HTTP Accept header with XML as the default.
+  def set_request_formats
+    unless params[:format]
+      accept_header = request.headers["HTTP_ACCEPT"]
+
+      if accept_header
+        # Some clients (such asJOSM) send Accept headers which cannot be
+        # parse by Rails, for example:
+        #
+        #   Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
+        #
+        # where both "*" and ".2" as a quality do not adhere to the syntax
+        # described in RFC 7231, section 5.3.1, etc.
+        #
+        # As a workaround, and for back compatibility, default to XML format.
+        mimetypes = begin
+          Mime::Type.parse(accept_header)
+        rescue Mime::Type::InvalidMimeType
+          Array(Mime[:xml])
+        end
+
+        # Allow XML and JSON formats, and treat an all formats wildcard
+        # as XML for backwards compatibility - all other formats are discarded
+        # which will result in a 406 Not Acceptable response being sent
+        formats = mimetypes.map do |mime|
+          if mime.symbol == :xml || mime == "*/*" then :xml
+          elsif mime.symbol == :json then :json
+          end
+        end
+      else
+        # Default to XML if no accept header was sent - this includes
+        # the unit tests which don't set one by default
+        formats = Array(:xml)
+      end

 
 

-  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
-
-  
-  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!
+      request.formats = formats.compact

     end
     end

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

   end
 
   end
 

-  def map
-    GC.start
-    @@count+=1
-    # Figure out the bbox
-    bbox = params['bbox']
+  def authorize(errormessage = "Couldn't authenticate you")
+    # make the current_user object from any auth sources we have
+    setup_user_auth

 
 

-    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(',')
+    # handle authenticate pass/fail
+    unless current_user
+      # no auth, the user does not exist or the password was wrong
+      render :plain => errormessage, :status => :unauthorized

 
 

-    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
-
-    @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])
-
-    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")
-      return
-    end
-    if node_ids.length == 0
-      render :text => "<osm version='0.5'></osm>", :content_type => "text/xml"
-      return
+      false

     end
     end

+  end

 
 

-    relations = Array.new
-
-    doc = OSM::API.new.get_xml_doc
-
-    # 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!
-
+  def current_ability
+    # Use capabilities from the oauth token if it exists and is a valid access token
+    if doorkeeper_token&.accessible?
+      ApiAbility.new(nil).merge(ApiCapability.new(doorkeeper_token))

     else
     else

-      list_of_way_nodes = Array.new
+      ApiAbility.new(current_user)

     end
     end

+  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)
+  def deny_access(_exception)
+    if doorkeeper_token
+      set_locale
+      report_error t("oauth.permissions.missing"), :forbidden
+    elsif current_user
+      head :forbidden
+    else
+      head :unauthorized

     end
     end

+  end

 
 

-    visible_nodes = {}
-    user_display_name_cache = {}
+  def gpx_status
+    status = database_status
+    status = "offline" if status == "online" && Settings.status == "gpx_offline"
+    status
+  end

 
 

-    @nodes.each do |node|
-      if node.visible?
-        doc.root << node.to_xml_node(user_display_name_cache)
-        visible_nodes[node.id] = node
+  ##
+  # sets up the current_user for use by other methods. this is mostly called
+  # from the authorize method, but can be called elsewhere if authorisation
+  # is optional.
+  def setup_user_auth
+    logger.info " setup_user_auth"
+    # try and setup using OAuth
+    self.current_user = User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token&.accessible?
+
+    # have we identified the user?
+    if current_user
+      # check if the user has been banned
+      user_block = current_user.blocks.active.take
+      unless user_block.nil?
+        set_locale
+        if user_block.zero_hour?
+          report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
+        else
+          report_error t("application.setup_user_auth.blocked"), :forbidden
+        end

       end
       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
+      # if the user hasn't seen the contributor terms then don't
+      # allow editing - they have to go to the web site and see
+      # (but can decline) the CTs to continue.
+      if !current_user.terms_seen && flash[:skip_terms].nil?
+        set_locale
+        report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden

       end
       end

-    end 
-
-    relations = Relation.find_for_nodes_and_ways(visible_nodes.keys, way_ids)
-
-    # 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
-
-    # 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, :content_type => "text/xml"
-    
-    #exit when we have too many requests
-    if @@count > MAX_COUNT
-      @@count = COUNT
-      
-      exit!

     end
   end
 
     end
   end
 

-  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
+  def api_call_handle_error
+    yield
+  rescue ActionController::UnknownFormat
+    head :not_acceptable
+  rescue ActiveRecord::RecordNotFound => e
+    head :not_found
+  rescue LibXML::XML::Error, ArgumentError => e
+    report_error e.message, :bad_request
+  rescue ActiveRecord::RecordInvalid => e
+    message = "#{e.record.class} #{e.record.id}: "
+    e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
+    report_error message, :bad_request
+  rescue OSM::APIError => e
+    report_error e.message, e.status
+  rescue AbstractController::ActionNotFound, CanCan::AccessDenied => e
+    raise
+  rescue StandardError => e
+    logger.info("API threw unexpected #{e.class} exception: #{e.message}")
+    e.backtrace.each { |l| logger.info(l) }
+    report_error "#{e.class}: #{e.message}", :internal_server_error
+  end

 
 

-      render :text => doc.to_s, :content_type => "text/xml"
+  ##
+  # wrap an api call in a timeout
+  def api_call_timeout(&)
+    Timeout.timeout(Settings.api_timeout, &)
+  rescue ActionView::Template::Error => e
+    e = e.cause
+
+    if e.is_a?(Timeout::Error) ||
+       (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
+      ActiveRecord::Base.connection.raw_connection.cancel
+      raise OSM::APITimeoutError

     else
     else

-      render :nothing => true, :status => :bad_request
+      raise

     end
     end

+  rescue Timeout::Error
+    ActiveRecord::Base.connection.raw_connection.cancel
+    raise OSM::APITimeoutError

   end
 
   end
 

-  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 << version
-    area = XML::Node.new 'area'
-    area['maximum'] = MAX_REQUEST_AREA.to_s;
-    api << area
-    
-    doc.root << api
+  ##
+  # check the api change rate limit
+  def check_rate_limit(new_changes = 1)
+    max_changes = ActiveRecord::Base.connection.select_value(
+      "SELECT api_rate_limit($1)", "api_rate_limit", [current_user.id]
+    )

 
 

-    render :text => doc.to_s, :content_type => "text/xml"
+    raise OSM::APIRateLimitExceeded if new_changes > max_changes

   end
 end
   end
 end