X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/fac305e87b9a2df59064ddad666304ceb3d7f7a7..f2ca25b75c57ab772a8f9063bea82a6bc43fed78:/app/controllers/api_controller.rb?ds=sidebyside diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb index d6b0b037a..ae1bc8755 100644 --- a/app/controllers/api_controller.rb +++ b/app/controllers/api_controller.rb @@ -1,71 +1,208 @@ class ApiController < ApplicationController - - before_filter :authorize - after_filter :compress_output - - def map - response.headers["Content-Type"] = 'application/xml' - # Figure out the bbox - bbox = params['bbox'] - unless bbox and bbox.count(',') == 3 - render :nothing => true, :status => 400 - return + skip_before_action :verify_authenticity_token + + before_action :check_api_readable + + private + + ## + # Set allowed request formats if no explicit format has been + # requested via a URL suffix. Allowed formats are taken from + # any HTTP Accept header with XML as the default. + def set_request_formats + unless params[:format] + accept_header = request.headers["HTTP_ACCEPT"] + + if accept_header + # Some clients (such asJOSM) send Accept headers which cannot be + # parse by Rails, for example: + # + # Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2 + # + # where both "*" and ".2" as a quality do not adhere to the syntax + # described in RFC 7231, section 5.3.1, etc. + # + # As a workaround, and for back compatibility, default to XML format. + mimetypes = begin + Mime::Type.parse(accept_header) + rescue Mime::Type::InvalidMimeType + Array(Mime[:xml]) + end + + # Allow XML and JSON formats, and treat an all formats wildcard + # as XML for backwards compatibility - all other formats are discarded + # which will result in a 406 Not Acceptable response being sent + formats = mimetypes.map do |mime| + if mime.symbol == :xml || mime == "*/*" then :xml + elsif mime.symbol == :json then :json + end + end + else + # Default to XML if no accept header was sent - this includes + # the unit tests which don't set one by default + formats = Array(:xml) + end + + request.formats = formats.compact end + end - bbox = bbox.split(',') - - min_lon = bbox[0].to_f - min_lat = bbox[1].to_f - max_lon = bbox[2].to_f - max_lat = bbox[3].to_f - - # get all the nodes - nodes = Node.find(:all, :conditions => ['latitude > ? AND longitude > ? AND latitude < ? AND longitude < ? AND visible = 1', min_lat, min_lon, max_lat, max_lon]) - - node_ids = nodes.collect {|node| node.id } - segments = Array.new - if node_ids.length > 0 - node_ids_sql = "(#{node_ids.join(',')})" - # get the referenced segments - segments = Segment.find_by_sql "select * from segments where node_a in #{node_ids_sql} or node_b in #{node_ids_sql}" + def authorize(realm = "Web Password", 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 + if Settings.basic_auth_support + response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" + render :plain => errormessage, :status => :unauthorized + else + render :plain => errormessage, :status => :forbidden + end + + false end - # see if we have nay missing nodes - segments_nodes = segments.collect {|segment| segment.node_a } - segments_nodes += segments.collect {|segment| segment.node_b } - - segments_nodes.uniq! - - missing_nodes = segments_nodes - node_ids + end - # get missing nodes if there are any - nodes += Node.find(missing_nodes) if missing_nodes.length > 0 + def current_ability + # 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 - doc = get_xml_doc + def deny_access(_exception) + if doorkeeper_token || current_token + 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 + render :plain => errormessage, :status => :forbidden + end + end - # get ways - # find which ways are needed - segment_ids = segments.collect {|segment| segment.id } - ways = Array.new - if segment_ids.length > 0 - way_segments = WaySegment.find_by_segment_id(segment_ids) - way_ids = way_segments.collect {|way_segment| way_segment.id } + def gpx_status + status = database_status + status = "offline" if status == "online" && Settings.status == "gpx_offline" + status + end - ways = Way.find(segment_ids) + ## + # sets up the current_user for use by other methods. this is mostly called + # from the authorize method, but can be called elsewhere if authorisation + # is optional. + 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? + if Settings.oauth_10a_support + # self.current_user setup by OAuth + else + report_error t("application.oauth_10a_disabled", :link => t("application.auth_disabled_link")), :forbidden + self.current_user = nil + end + else + 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) + else + User.authenticate(:username => username, :password => passwd) # basic auth + end + if username && current_user + if Settings.basic_auth_support + # log if we have authenticated using basic auth + logger.info "Authenticated as user #{current_user.id} using basic authentication" + else + report_error t("application.basic_auth_disabled", :link => t("application.auth_disabled_link")), :forbidden + end + end end - nodes.each do |node| - doc.root << node.to_xml_node() + # have we identified the user? + if current_user + # check if the user has been banned + user_block = current_user.blocks.active.take + unless user_block.nil? + set_locale + if user_block.zero_hour? + report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden + else + report_error t("application.setup_user_auth.blocked"), :forbidden + end + end + + # if the user hasn't seen the contributor terms then don't + # allow editing - they have to go to the web site and see + # (but can decline) the CTs to continue. + if !current_user.terms_seen && flash[:skip_terms].nil? + set_locale + report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden + end end + end - segments.each do |segment| - doc.root << segment.to_xml_node() - 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 => 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 - ways.each do |way| - doc.root << way.to_xml_node() - 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 - render :text => doc.to_s + ## + # 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