app/controllers/api_controller.rb

   1 class ApiController < ApplicationController
   2   skip_before_action :verify_authenticity_token
   3
   4   private
   5
   6   ##
   7   # Set allowed request formats if no explicit format has been
   8   # requested via a URL suffix. Allowed formats are taken from
   9   # any HTTP Accept header with XML as the default.
  10   def set_request_formats
  11     unless params[:format]
  12       accept_header = request.headers["HTTP_ACCEPT"]
  13
  14       if accept_header
  15         # Some clients (such asJOSM) send Accept headers which cannot be
  16         # parse by Rails, for example:
  17         #
  18         #   Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
  19         #
  20         # where both "*" and ".2" as a quality do not adhere to the syntax
  21         # described in RFC 7231, section 5.3.1, etc.
  22         #
  23         # As a workaround, and for back compatibility, default to XML format.
  24         mimetypes = begin
  25           Mime::Type.parse(accept_header)
  26         rescue Mime::Type::InvalidMimeType
  27           Array(Mime[:xml])
  28         end
  29
  30         # Allow XML and JSON formats, and treat an all formats wildcard
  31         # as XML for backwards compatibility - all other formats are discarded
  32         # which will result in a 406 Not Acceptable response being sent
  33         formats = mimetypes.map do |mime|
  34           if mime.symbol == :xml || mime == "*/*" then :xml
  35           elsif mime.symbol == :json then :json
  36           end
  37         end
  38       else
  39         # Default to XML if no accept header was sent - this includes
  40         # the unit tests which don't set one by default
  41         formats = Array(:xml)
  42       end
  43
  44       request.formats = formats.compact
  45     end
  46   end
  47
  48   def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you")
  49     # make the current_user object from any auth sources we have
  50     setup_user_auth
  51
  52     # handle authenticate pass/fail
  53     unless current_user
  54       # no auth, the user does not exist or the password was wrong
  55       if Settings.basic_auth_support
  56         response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
  57         render :plain => errormessage, :status => :unauthorized
  58       else
  59         render :plain => errormessage, :status => :forbidden
  60       end
  61
  62       false
  63     end
  64   end
  65
  66   def current_ability
  67     # Use capabilities from the oauth token if it exists and is a valid access token
  68     if doorkeeper_token&.accessible?
  69       ApiAbility.new(nil).merge(ApiCapability.new(doorkeeper_token))
  70     elsif Authenticator.new(self, [:token]).allow?
  71       ApiAbility.new(nil).merge(ApiCapability.new(current_token))
  72     else
  73       ApiAbility.new(current_user)
  74     end
  75   end
  76
  77   def deny_access(_exception)
  78     if doorkeeper_token || current_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     elsif Authenticator.new(self, [:token]).allow?
 109       # self.current_user setup by OAuth
 110     elsif Settings.basic_auth_support
 111       username, passwd = auth_data # parse from headers
 112       # authenticate per-scheme
 113       self.current_user = if username.nil?
 114                             nil # no authentication provided - perhaps first connect (client should retry after 401)
 115                           else
 116                             User.authenticate(:username => username, :password => passwd) # basic auth
 117                           end
 118       # log if we have authenticated using basic auth
 119       logger.info "Authenticated as user #{current_user.id} using basic authentication" if current_user
 120     end
 121
 122     # have we identified the user?
 123     if current_user
 124       # check if the user has been banned
 125       user_block = current_user.blocks.active.take
 126       unless user_block.nil?
 127         set_locale
 128         if user_block.zero_hour?
 129           report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
 130         else
 131           report_error t("application.setup_user_auth.blocked"), :forbidden
 132         end
 133       end
 134
 135       # if the user hasn't seen the contributor terms then don't
 136       # allow editing - they have to go to the web site and see
 137       # (but can decline) the CTs to continue.
 138       if !current_user.terms_seen && flash[:skip_terms].nil?
 139         set_locale
 140         report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
 141       end
 142     end
 143   end
 144
 145   def api_call_handle_error
 146     yield
 147   rescue ActionController::UnknownFormat
 148     head :not_acceptable
 149   rescue ActiveRecord::RecordNotFound => e
 150     head :not_found
 151   rescue LibXML::XML::Error, ArgumentError => e
 152     report_error e.message, :bad_request
 153   rescue ActiveRecord::RecordInvalid => e
 154     message = "#{e.record.class} #{e.record.id}: "
 155     e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }
 156     report_error message, :bad_request
 157   rescue OSM::APIError => e
 158     report_error e.message, e.status
 159   rescue AbstractController::ActionNotFound => e
 160     raise
 161   rescue StandardError => e
 162     logger.info("API threw unexpected #{e.class} exception: #{e.message}")
 163     e.backtrace.each { |l| logger.info(l) }
 164     report_error "#{e.class}: #{e.message}", :internal_server_error
 165   end
 166
 167   ##
 168   # asserts that the request method is the +method+ given as a parameter
 169   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
 170   def assert_method(method)
 171     ok = request.send(:"#{method.to_s.downcase}?")
 172     raise OSM::APIBadMethodError, method unless ok
 173   end
 174
 175   ##
 176   # wrap an api call in a timeout
 177   def api_call_timeout(&block)
 178     Timeout.timeout(Settings.api_timeout, &block)
 179   rescue ActionView::Template::Error => e
 180     e = e.cause
 181
 182     if e.is_a?(Timeout::Error) ||
 183        (e.is_a?(ActiveRecord::StatementInvalid) && e.message.include?("execution expired"))
 184       ActiveRecord::Base.connection.raw_connection.cancel
 185       raise OSM::APITimeoutError
 186     else
 187       raise
 188     end
 189   rescue Timeout::Error
 190     ActiveRecord::Base.connection.raw_connection.cancel
 191     raise OSM::APITimeoutError
 192   end
 193
 194   ##
 195   # check the api change rate limit
 196   def check_rate_limit(new_changes = 1)
 197     max_changes = ActiveRecord::Base.connection.select_value(
 198       "SELECT api_rate_limit($1)", "api_rate_limit", [current_user.id]
 199     )
 200
 201     raise OSM::APIRateLimitExceeded if new_changes > max_changes
 202   end
 203 end