openstreetmap-website/app/controllers/api_controller.rb

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

      request.formats = formats.compact
    end
  end

  def authorize(errormessage: "Couldn't authenticate you", skip_blocks: false, skip_terms: false)
    # make the current_user object from any auth sources we have
    setup_user_auth(:skip_blocks => skip_blocks, :skip_terms => skip_terms)

    # handle authenticate pass/fail
    unless current_user
      # no auth, the user does not exist or the password was wrong
      render :plain => errormessage, :status => :unauthorized

      false
    end
  end

  def current_ability
    # Use capabilities from the oauth token if it exists and is a valid access token
    if doorkeeper_token&.accessible?
      user = User.find(doorkeeper_token.resource_owner_id)
      scopes = Set.new doorkeeper_token.scopes
      if scopes.include?("write_api")
        scopes.add("write_map")
        scopes.add("write_changeset_comments")
        scopes.delete("write_api")
      end
      ApiAbility.new(user, scopes)
    else
      ApiAbility.new(nil, Set.new)
    end
  end

  def deny_access(_exception)
    if doorkeeper_token
      set_locale
      report_error t("oauth.permissions.missing"), :forbidden
    else
      head :unauthorized
    end
  end

  def gpx_status
    status = database_status
    status = "offline" if status == "online" && Settings.status == "gpx_offline"
    status
  end

  ##
  # 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(skip_blocks: false, skip_terms: false)
    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
      unless skip_blocks
        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

      # 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 && !skip_terms
        set_locale
        report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
      end
    end
  end

  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

  ##
  # 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
      raise
    end
  rescue Timeout::Error
    ActiveRecord::Base.connection.raw_connection.cancel
    raise OSM::APITimeoutError
  end

  ##
  # 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]
    )

    raise OSM::APIRateLimitExceeded if new_changes > max_changes
  end

  def scope_enabled?(scope)
    doorkeeper_token&.includes_scope?(scope)
  end

  helper_method :scope_enabled?
end