Move api error handling and timeouts to parent class

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

diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb
index a8067a49325935df340ebb08ae67489bb114c7b1..6ce8a0ef2d18045309e36784db5cb07d0f53483e 100644 (file)
--- a/app/controllers/api_controller.rb
+++ b/app/controllers/api_controller.rb
@@ -1,6 +1,10 @@
 class ApiController < ApplicationController
   skip_before_action :verify_authenticity_token
 
 class ApiController < ApplicationController
   skip_before_action :verify_authenticity_token
 

+  before_action :check_api_readable
+
+  around_action :api_call_handle_error, :api_call_timeout
+

   private
 
   ##
   private
 
   ##


@@ -45,19 +49,14 @@ class ApiController < ApplicationController
     end
   end
 
     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
     # 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

-      if Settings.basic_auth_support
-        response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
-        render :plain => errormessage, :status => :unauthorized
-      else
-        render :plain => errormessage, :status => :forbidden
-      end
+      render :plain => errormessage, :status => :unauthorized

 
       false
     end
 
       false
     end


@@ -67,26 +66,19 @@ class ApiController < ApplicationController
     # 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))
     # 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))

-    elsif Authenticator.new(self, [:token]).allow?
-      ApiAbility.new(nil).merge(ApiCapability.new(current_token))

     else
       ApiAbility.new(current_user)
     end
   end
 
   def deny_access(_exception)
     else
       ApiAbility.new(current_user)
     end
   end
 
   def deny_access(_exception)

-    if doorkeeper_token || current_token
+    if doorkeeper_token

       set_locale
       report_error t("oauth.permissions.missing"), :forbidden
     elsif current_user
       head :forbidden
       set_locale
       report_error t("oauth.permissions.missing"), :forbidden
     elsif current_user
       head :forbidden

-    elsif Settings.basic_auth_support
-      realm = "Web Password"
-      errormessage = "Couldn't authenticate you"
-      response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
-      render :plain => errormessage, :status => :unauthorized

     else
     else

-      render :plain => errormessage, :status => :forbidden
+      head :unauthorized

     end
   end
 
     end
   end
 


@@ -103,23 +95,7 @@ class ApiController < ApplicationController
   def setup_user_auth
     logger.info " setup_user_auth"
     # try and setup using OAuth
   def setup_user_auth
     logger.info " setup_user_auth"
     # try and setup using OAuth

-    if doorkeeper_token&.accessible?
-      self.current_user = User.find(doorkeeper_token.resource_owner_id)
-    elsif Authenticator.new(self, [:token]).allow?
-      # self.current_user setup by OAuth
-    elsif Settings.basic_auth_support
-      username, passwd = 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
-      # log if we have authenticated using basic auth
-      logger.info "Authenticated as user #{current_user.id} using basic authentication" if current_user
-    end
+    self.current_user = User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token&.accessible?

 
     # have we identified the user?
     if current_user
 
     # have we identified the user?
     if current_user


@@ -143,4 +119,55 @@ class ApiController < ApplicationController
       end
     end
   end
       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(&block)
+    Timeout.timeout(Settings.api_timeout, &block)
+  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
 end