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(realm = "Web Password", 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       if Settings.basic_auth_support
  58         response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
  59         render :plain => errormessage, :status => :unauthorized
  60       else
  61         render :plain => errormessage, :status => :forbidden
  62       end
  63
  64       false
  65     end
  66   end
  67
  68   def current_ability
  69     # Use capabilities from the oauth token if it exists and is a valid access token
  70     if doorkeeper_token&.accessible?
  71       ApiAbility.new(nil).merge(ApiCapability.new(doorkeeper_token))
  72     else
  73       ApiAbility.new(current_user)
  74     end
  75   end
  76
  77   def deny_access(_exception)
  78     if doorkeeper_token
  79       set_locale
  80       report_error t("oauth.permissions.missing"), :forbidden
  81     elsif current_user
  82       head :forbidden
  83     elsif Settings.basic_auth_support
  84       realm = "Web Password"
  85       errormessage = "Couldn't authenticate you"
  86       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
  87       render :plain => errormessage, :status => :unauthorized
  88     else
  89       render :plain => errormessage, :status => :forbidden
  90     end
  91   end
  92
  93   def gpx_status
  94     status = database_status
  95     status = "offline" if status == "online" && Settings.status == "gpx_offline"
  96     status
  97   end
  98
  99   ##
 100   # sets up the current_user for use by other methods. this is mostly called
 101   # from the authorize method, but can be called elsewhere if authorisation
 102   # is optional.
 103   def setup_user_auth
 104     logger.info " setup_user_auth"
 105     # try and setup using OAuth
 106     if doorkeeper_token&.accessible?
 107       self.current_user = User.find(doorkeeper_token.resource_owner_id)
 108     else
 109       username, passwd = auth_data # parse from headers
 110       # authenticate per-scheme
 111       self.current_user = if username.nil?
 112                             nil # no authentication provided - perhaps first connect (client should retry after 401)
 113                           else
 114                             User.authenticate(:username => username, :password => passwd) # basic auth
 115                           end
 116       if username && current_user
 117         if Settings.basic_auth_support
 118           # log if we have authenticated using basic auth
 119           logger.info "Authenticated as user #{current_user.id} using basic authentication"
 120         else
 121           report_error t("application.basic_auth_disabled", :link => t("application.auth_disabled_link")), :forbidden
 122         end
 123       end
 124     end
 125
 126     # have we identified the user?
 127     if current_user
 128       # check if the user has been banned
 129       user_block = current_user.blocks.active.take
 130       unless user_block.nil?
 131         set_locale
 132         if user_block.zero_hour?
 133           report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
 134         else
 135           report_error t("application.setup_user_auth.blocked"), :forbidden
 136         end
 137       end
 138
 139       # if the user hasn't seen the contributor terms then don't
 140       # allow editing - they have to go to the web site and see
 141       # (but can decline) the CTs to continue.
 142       if !current_user.terms_seen && flash[:skip_terms].nil?
 143         set_locale
 144         report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
 145       end
 146     end
 147   end
 148
 149   def api_call_handle_error
 150     yield
 151   rescue ActionController::UnknownFormat
 152     head :not_acceptable
 153   rescue ActiveRecord::RecordNotFound => e
 154     head :not_found
 155   rescue LibXML::XML::Error, ArgumentError => e
 156     report_error e.message, :bad_request
 157   rescue ActiveRecord::RecordInvalid => e
 158     message = "#{e.record.class} #{e.record.id}: "
 159     e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
 160     report_error message, :bad_request
 161   rescue OSM::APIError => e
 162     report_error e.message, e.status
 163   rescue AbstractController::ActionNotFound => e
 164     raise
 165   rescue StandardError => e
 166     logger.info("API threw unexpected #{e.class} exception: #{e.message}")
 167     e.backtrace.each { |l| logger.info(l) }
 168     report_error "#{e.class}: #{e.message}", :internal_server_error
 169   end
 170
 171   ##
 172   # wrap an api call in a timeout
 173   def api_call_timeout(&block)
 174     Timeout.timeout(Settings.api_timeout, &block)
 175   rescue ActionView::Template::Error => e
 176     e = e.cause
 177
 178     if e.is_a?(Timeout::Error) ||
 179        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
 180       ActiveRecord::Base.connection.raw_connection.cancel
 181       raise OSM::APITimeoutError
 182     else
 183       raise
 184     end
 185   rescue Timeout::Error
 186     ActiveRecord::Base.connection.raw_connection.cancel
 187     raise OSM::APITimeoutError
 188   end
 189
 190   ##
 191   # check the api change rate limit
 192   def check_rate_limit(new_changes = 1)
 193     max_changes = ActiveRecord::Base.connection.select_value(
 194       "SELECT api_rate_limit($1)", "api_rate_limit", [current_user.id]
 195     )
 196
 197     raise OSM::APIRateLimitExceeded if new_changes > max_changes
 198   end
 199 end