app/controllers/api_controller.rb

   1 class ApiController < ApplicationController
   2   skip_before_action :verify_authenticity_token
   3
   4   before_action :check_api_readable
   5
   6   private
   7
   8   ##
   9   # Set allowed request formats if no explicit format has been
  10   # requested via a URL suffix. Allowed formats are taken from
  11   # any HTTP Accept header with XML as the default.
  12   def set_request_formats
  13     unless params[:format]
  14       accept_header = request.headers["HTTP_ACCEPT"]
  15
  16       if accept_header
  17         # Some clients (such asJOSM) send Accept headers which cannot be
  18         # parse by Rails, for example:
  19         #
  20         #   Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
  21         #
  22         # where both "*" and ".2" as a quality do not adhere to the syntax
  23         # described in RFC 7231, section 5.3.1, etc.
  24         #
  25         # As a workaround, and for back compatibility, default to XML format.
  26         mimetypes = begin
  27           Mime::Type.parse(accept_header)
  28         rescue Mime::Type::InvalidMimeType
  29           Array(Mime[:xml])
  30         end
  31
  32         # Allow XML and JSON formats, and treat an all formats wildcard
  33         # as XML for backwards compatibility - all other formats are discarded
  34         # which will result in a 406 Not Acceptable response being sent
  35         formats = mimetypes.map do |mime|
  36           if mime.symbol == :xml || mime == "*/*" then :xml
  37           elsif mime.symbol == :json then :json
  38           end
  39         end
  40       else
  41         # Default to XML if no accept header was sent - this includes
  42         # the unit tests which don't set one by default
  43         formats = Array(:xml)
  44       end
  45
  46       request.formats = formats.compact
  47     end
  48   end
  49
  50   def authorize(errormessage = "Couldn't authenticate you")
  51     # make the current_user object from any auth sources we have
  52     setup_user_auth
  53
  54     # handle authenticate pass/fail
  55     unless current_user
  56       # no auth, the user does not exist or the password was wrong
  57       render :plain => errormessage, :status => :unauthorized
  58
  59       false
  60     end
  61   end
  62
  63   def current_ability
  64     # Use capabilities from the oauth token if it exists and is a valid access token
  65     if doorkeeper_token&.accessible?
  66       ApiAbility.new(nil).merge(ApiCapability.new(doorkeeper_token))
  67     else
  68       ApiAbility.new(current_user)
  69     end
  70   end
  71
  72   def deny_access(_exception)
  73     if doorkeeper_token
  74       set_locale
  75       report_error t("oauth.permissions.missing"), :forbidden
  76     elsif current_user
  77       head :forbidden
  78     else
  79       head :unauthorized
  80     end
  81   end
  82
  83   def gpx_status
  84     status = database_status
  85     status = "offline" if status == "online" && Settings.status == "gpx_offline"
  86     status
  87   end
  88
  89   ##
  90   # sets up the current_user for use by other methods. this is mostly called
  91   # from the authorize method, but can be called elsewhere if authorisation
  92   # is optional.
  93   def setup_user_auth
  94     logger.info " setup_user_auth"
  95     # try and setup using OAuth
  96     self.current_user = User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token&.accessible?
  97
  98     # have we identified the user?
  99     if current_user
 100       # check if the user has been banned
 101       user_block = current_user.blocks.active.take
 102       unless user_block.nil?
 103         set_locale
 104         if user_block.zero_hour?
 105           report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
 106         else
 107           report_error t("application.setup_user_auth.blocked"), :forbidden
 108         end
 109       end
 110
 111       # if the user hasn't seen the contributor terms then don't
 112       # allow editing - they have to go to the web site and see
 113       # (but can decline) the CTs to continue.
 114       if !current_user.terms_seen && flash[:skip_terms].nil?
 115         set_locale
 116         report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
 117       end
 118     end
 119   end
 120
 121   def api_call_handle_error
 122     yield
 123   rescue ActionController::UnknownFormat
 124     head :not_acceptable
 125   rescue ActiveRecord::RecordNotFound => e
 126     head :not_found
 127   rescue LibXML::XML::Error, ArgumentError => e
 128     report_error e.message, :bad_request
 129   rescue ActiveRecord::RecordInvalid => e
 130     message = "#{e.record.class} #{e.record.id}: "
 131     e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
 132     report_error message, :bad_request
 133   rescue OSM::APIError => e
 134     report_error e.message, e.status
 135   rescue AbstractController::ActionNotFound => e
 136     raise
 137   rescue StandardError => e
 138     logger.info("API threw unexpected #{e.class} exception: #{e.message}")
 139     e.backtrace.each { |l| logger.info(l) }
 140     report_error "#{e.class}: #{e.message}", :internal_server_error
 141   end
 142
 143   ##
 144   # wrap an api call in a timeout
 145   def api_call_timeout(&)
 146     Timeout.timeout(Settings.api_timeout, &)
 147   rescue ActionView::Template::Error => e
 148     e = e.cause
 149
 150     if e.is_a?(Timeout::Error) ||
 151        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
 152       ActiveRecord::Base.connection.raw_connection.cancel
 153       raise OSM::APITimeoutError
 154     else
 155       raise
 156     end
 157   rescue Timeout::Error
 158     ActiveRecord::Base.connection.raw_connection.cancel
 159     raise OSM::APITimeoutError
 160   end
 161
 162   ##
 163   # check the api change rate limit
 164   def check_rate_limit(new_changes = 1)
 165     max_changes = ActiveRecord::Base.connection.select_value(
 166       "SELECT api_rate_limit($1)", "api_rate_limit", [current_user.id]
 167     )
 168
 169     raise OSM::APIRateLimitExceeded if new_changes > max_changes
 170   end
 171 end