class ApiController < ApplicationController
skip_before_action :verify_authenticity_token
- before_action :check_api_readable, :except => [:capabilities]
- before_action :setup_user_auth, :only => [:permissions]
- around_action :api_call_handle_error, :api_call_timeout
- # Get an XML response containing a list of tracepoints that have been uploaded
- # within the specified bounding box, and in the specified page.
- def trackpoints
- # retrieve the page number
- page = params["page"].to_s.to_i
-
- unless page >= 0
- report_error("Page number must be greater than or equal to 0")
- return
- end
-
- offset = page * TRACEPOINTS_PER_PAGE
-
- # Figure out the bbox
- # check boundary is sane and area within defined
- # see /config/application.yml
- begin
- bbox = BoundingBox.from_bbox_params(params)
- bbox.check_boundaries
- bbox.check_size
- rescue StandardError => err
- report_error(err.message)
- return
- end
-
- # get all the points
- points = Tracepoint.bbox(bbox).offset(offset).limit(TRACEPOINTS_PER_PAGE).order("gpx_id DESC, trackid ASC, timestamp ASC")
-
- doc = XML::Document.new
- doc.encoding = XML::Encoding::UTF_8
- root = XML::Node.new "gpx"
- root["version"] = "1.0"
- root["creator"] = "OpenStreetMap.org"
- root["xmlns"] = "http://www.topografix.com/GPX/1/0"
-
- doc.root = root
-
- # initialise these variables outside of the loop so that they
- # stay in scope and don't get free'd up by the GC during the
- # loop.
- gpx_id = -1
- trackid = -1
- track = nil
- trkseg = nil
- anon_track = nil
- anon_trkseg = nil
- gpx_file = nil
- timestamps = false
-
- points.each do |point|
- if gpx_id != point.gpx_id
- gpx_id = point.gpx_id
- trackid = -1
- gpx_file = Trace.find(gpx_id)
-
- if gpx_file.trackable?
- track = XML::Node.new "trk"
- doc.root << track
- timestamps = true
-
- if gpx_file.identifiable?
- track << (XML::Node.new("name") << gpx_file.name)
- track << (XML::Node.new("desc") << gpx_file.description)
- track << (XML::Node.new("url") << url_for(:controller => "trace", :action => "view", :display_name => gpx_file.user.display_name, :id => gpx_file.id))
- end
- else
- # use the anonymous track segment if the user hasn't allowed
- # their GPX points to be tracked.
- timestamps = false
- if anon_track.nil?
- anon_track = XML::Node.new "trk"
- doc.root << anon_track
- end
- track = anon_track
+ 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
- end
- if trackid != point.trackid
- if gpx_file.trackable?
- trkseg = XML::Node.new "trkseg"
- track << trkseg
- trackid = point.trackid
- else
- if anon_trkseg.nil?
- anon_trkseg = XML::Node.new "trkseg"
- anon_track << anon_trkseg
+ # 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
- trkseg = anon_trkseg
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
- trkseg << point.to_xml_node(timestamps)
+ request.formats = formats.compact
end
-
- response.headers["Content-Disposition"] = "attachment; filename=\"tracks.gpx\""
-
- render :xml => doc.to_s
end
- # This is probably the most common call of all. It is used for getting the
- # OSM data for a specified bounding box, usually for editing. First the
- # bounding box (bbox) is checked to make sure that it is sane. All nodes
- # are searched, then all the ways that reference those nodes are found.
- # All Nodes that are referenced by those ways are fetched and added to the list
- # of nodes.
- # Then all the relations that reference the already found nodes and ways are
- # fetched. All the nodes and ways that are referenced by those ways are then
- # fetched. Finally all the xml is returned.
- def map
- # Figure out the bbox
- # check boundary is sane and area within defined
- # see /config/application.yml
- begin
- bbox = BoundingBox.from_bbox_params(params)
- bbox.check_boundaries
- bbox.check_size
- rescue StandardError => err
- report_error(err.message)
- return
- end
-
- nodes = Node.bbox(bbox).where(:visible => true).includes(:node_tags).limit(MAX_NUMBER_OF_NODES + 1)
+ 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
- node_ids = nodes.collect(&:id)
- if node_ids.length > MAX_NUMBER_OF_NODES
- report_error("You requested too many nodes (limit is #{MAX_NUMBER_OF_NODES}). Either request a smaller area, or use planet.osm")
- return
+ false
end
+ end
- doc = OSM::API.new.get_xml_doc
-
- # add bounds
- doc.root << bbox.add_bounds_to(XML::Node.new("bounds"))
-
- # get ways
- # find which ways are needed
- ways = []
- if node_ids.empty?
- list_of_way_nodes = []
+ 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
- way_nodes = WayNode.where(:node_id => node_ids)
- way_ids = way_nodes.collect { |way_node| way_node.id[0] }
- ways = Way.preload(:way_nodes, :way_tags).find(way_ids)
-
- list_of_way_nodes = ways.collect do |way|
- way.way_nodes.collect(&:node_id)
- end
- list_of_way_nodes.flatten!
+ ApiAbility.new(current_user)
end
+ end
- # - [0] in case some thing links to node 0 which doesn't exist. Shouldn't actually ever happen but it does. FIXME: file a ticket for this
- nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
-
- nodes += Node.includes(:node_tags).find(nodes_to_fetch) unless nodes_to_fetch.empty?
+ 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
- visible_nodes = {}
- changeset_cache = {}
- user_display_name_cache = {}
+ def gpx_status
+ status = database_status
+ status = "offline" if status == "online" && Settings.status == "gpx_offline"
+ status
+ end
- nodes.each do |node|
- if node.visible?
- doc.root << node.to_xml_node(changeset_cache, user_display_name_cache)
- visible_nodes[node.id] = node
- end
+ ##
+ # 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?
+ # self.current_user setup by OAuth
+ elsif Settings.basic_auth_support
+ 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)
+ elsif username == "token"
+ User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
+ else
+ User.authenticate(:username => username, :password => passwd) # basic auth
+ end
+ # log if we have authenticated using basic auth
+ logger.info "Authenticated as user #{current_user.id} using basic authentication" if current_user
end
- way_ids = []
- ways.each do |way|
- if way.visible?
- doc.root << way.to_xml_node(visible_nodes, changeset_cache, user_display_name_cache)
- way_ids << way.id
+ # 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
- end
- relations = Relation.nodes(visible_nodes.keys).visible +
- Relation.ways(way_ids).visible
-
- # we do not normally return the "other" partners referenced by an relation,
- # e.g. if we return a way A that is referenced by relation X, and there's
- # another way B also referenced, that is not returned. But we do make
- # an exception for cases where an relation references another *relation*;
- # in that case we return that as well (but we don't go recursive here)
- relations += Relation.relations(relations.collect(&:id)).visible
-
- # this "uniq" may be slightly inefficient; it may be better to first collect and output
- # all node-related relations, then find the *not yet covered* way-related ones etc.
- relations.uniq.each do |relation|
- doc.root << relation.to_xml_node(changeset_cache, user_display_name_cache)
+ # 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
-
- response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
-
- render :xml => doc.to_s
end
- # Get a list of the tiles that have changed within a specified time
- # period
- def changes
- zoom = (params[:zoom] || "12").to_i
-
- if params.include?(:start) && params.include?(:end)
- starttime = Time.parse(params[:start])
- endtime = Time.parse(params[:end])
- else
- hours = (params[:hours] || "1").to_i.hours
- endtime = Time.now.getutc
- starttime = endtime - hours
- end
-
- if zoom >= 1 && zoom <= 16 &&
- endtime > starttime && endtime - starttime <= 24.hours
- mask = (1 << zoom) - 1
-
- tiles = Node.where(:timestamp => starttime..endtime).group("maptile_for_point(latitude, longitude, #{zoom})").count
-
- doc = OSM::API.new.get_xml_doc
- changes = XML::Node.new "changes"
- changes["starttime"] = starttime.xmlschema
- changes["endtime"] = endtime.xmlschema
-
- tiles.each do |tile, count|
- x = (tile.to_i >> zoom) & mask
- y = tile.to_i & mask
-
- t = XML::Node.new "tile"
- t["x"] = x.to_s
- t["y"] = y.to_s
- t["z"] = zoom.to_s
- t["changes"] = count.to_s
-
- changes << t
- 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
- doc.root << changes
+ ##
+ # asserts that the request method is the +method+ given as a parameter
+ # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
+ def assert_method(method)
+ ok = request.send(:"#{method.to_s.downcase}?")
+ raise OSM::APIBadMethodError, method unless ok
+ end
- render :xml => doc.to_s
+ ##
+ # 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
- render :plain => "Requested zoom is invalid, or the supplied start is after the end time, or the start duration is more than 24 hours", :status => :bad_request
+ raise
end
+ rescue Timeout::Error
+ ActiveRecord::Base.connection.raw_connection.cancel
+ raise OSM::APITimeoutError
end
- # External apps that use the api are able to query the api to find out some
- # parameters of the API. It currently returns:
- # * minimum and maximum API versions that can be used.
- # * maximum area that can be requested in a bbox request in square degrees
- # * number of tracepoints that are returned in each tracepoints page
- def capabilities
- doc = OSM::API.new.get_xml_doc
-
- api = XML::Node.new "api"
- version = XML::Node.new "version"
- version["minimum"] = API_VERSION.to_s
- version["maximum"] = API_VERSION.to_s
- api << version
- area = XML::Node.new "area"
- area["maximum"] = MAX_REQUEST_AREA.to_s
- api << area
- notearea = XML::Node.new "note_area"
- notearea["maximum"] = MAX_NOTE_REQUEST_AREA.to_s
- api << notearea
- tracepoints = XML::Node.new "tracepoints"
- tracepoints["per_page"] = TRACEPOINTS_PER_PAGE.to_s
- api << tracepoints
- waynodes = XML::Node.new "waynodes"
- waynodes["maximum"] = MAX_NUMBER_OF_WAY_NODES.to_s
- api << waynodes
- changesets = XML::Node.new "changesets"
- changesets["maximum_elements"] = Changeset::MAX_ELEMENTS.to_s
- api << changesets
- timeout = XML::Node.new "timeout"
- timeout["seconds"] = API_TIMEOUT.to_s
- api << timeout
- status = XML::Node.new "status"
- status["database"] = database_status.to_s
- status["api"] = api_status.to_s
- status["gpx"] = gpx_status.to_s
- api << status
- doc.root << api
- policy = XML::Node.new "policy"
- blacklist = XML::Node.new "imagery"
- IMAGERY_BLACKLIST.each do |url_regex|
- xnd = XML::Node.new "blacklist"
- xnd["regex"] = url_regex.to_s
- blacklist << xnd
- end
- policy << blacklist
- doc.root << policy
-
- render :xml => doc.to_s
- end
+ ##
+ # 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]
+ )
- # External apps that use the api are able to query which permissions
- # they have. This currently returns a list of permissions granted to the current user:
- # * if authenticated via OAuth, this list will contain all permissions granted by the user to the access_token.
- # * if authenticated via basic auth all permissions are granted, so the list will contain all permissions.
- # * unauthenticated users have no permissions, so the list will be empty.
- def permissions
- @permissions = if current_token.present?
- ClientApplication.all_permissions.select { |p| current_token.read_attribute(p) }
- elsif current_user
- ClientApplication.all_permissions
- else
- []
- end
+ raise OSM::APIRateLimitExceeded if new_changes > max_changes
end
end
projects / rails.git / blobdiff