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 default request format to xml unless a client requests a specific format,
- # which can be done via (a) URL suffix and/or (b) HTTP Accept header, where
- # the URL suffix always takes precedence over the Accept header.
- def set_default_request_format
+ # 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.nil?
- # e.g. unit tests don't set an Accept: header by default, force XML in this case
- request.format = "xml"
- return
- end
-
- req_mimetypes = []
-
- # Some clients (JOSM) send Accept headers which cannot be parsed by Rails, example: *; q=.2
- # To be fair, JOSM's Accept header doesn't adhere to RFC 7231, section 5.3.1, et al. either
- # As a workaround for backwards compatibility, we're assuming XML format
- begin
- req_mimetypes = Mime::Type.parse(accept_header)
- rescue Mime::Type::InvalidMimeType
- request.format = "xml"
- return
- end
- # req_mimetypes contains all Accept header MIME types with descending priority
- req_mimetypes.each do |mime|
- if mime.symbol == :xml
- request.format = "xml"
- break
+ 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
- if mime.symbol == :json
- request.format = "json"
- break
+ # 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
-
- # Any format, not explicitly requesting XML or JSON -> assume XML as default
- if mime == "*/*"
- request.format = "xml"
- break
- end
-
- # In case the client requests some other format besides XML, JSON and */*,
- # we deliberately don't set request.format. The framework will return an
- # ActionController::UnknownFormat error to the client later on in this case.
+ 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(realm = "Web Password", errormessage = "Couldn't authenticate you")
+ def authorize(errormessage = "Couldn't authenticate you")
# make the current_user object from any auth sources we have
setup_user_auth
# handle authenticate pass/fail
unless current_user
# no auth, the user does not exist or the password was wrong
- response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
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 Authenticator.new(self, [:token]).allow?
- ApiAbility.new(nil).merge(ApiCapability.new(current_token))
+ if doorkeeper_token&.accessible?
+ ApiAbility.new(nil).merge(ApiCapability.new(doorkeeper_token))
else
ApiAbility.new(current_user)
end
end
def deny_access(_exception)
- if current_token
+ if doorkeeper_token
set_locale
report_error t("oauth.permissions.missing"), :forbidden
elsif current_user
head :forbidden
else
- realm = "Web Password"
- errormessage = "Couldn't authenticate you"
- response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
- render :plain => errormessage, :status => :unauthorized
+ head :unauthorized
end
end
# 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
- unless Authenticator.new(self, [:token]).allow?
- username, passwd = get_auth_data # parse from headers
- # authenticate per-scheme
- self.current_user = if username.nil?
- nil # no authentication provided - perhaps first connect (client should retry after 401)
- elsif username == "token"
- User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
- else
- User.authenticate(:username => username, :password => passwd) # basic auth
- end
- end
+ self.current_user = User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token&.accessible?
# have we identified the user?
if current_user
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
end
projects / rails.git / blobdiff