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