X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/bf31791f65fee149b660c1395d59204309f906fa..dcd55590709ab18657cdbe5ab4ddd5e360ba6b43:/app/controllers/api_controller.rb diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb index c0af0d3e5..44efdc071 100644 --- a/app/controllers/api_controller.rb +++ b/app/controllers/api_controller.rb @@ -1,276 +1,88 @@ class ApiController < ApplicationController + skip_before_action :verify_authenticity_token - session :off - before_filter :check_api_readable, :except => [:capabilities] - after_filter :compress_output + private - # Help methods for checking boundary sanity and area size - include MapBoundary + def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you") + # make the current_user object from any auth sources we have + setup_user_auth - # The maximum area you're allowed to request, in square degrees - MAX_REQUEST_AREA = APP_CONFIG['max_request_area'] - - # Number of GPS trace/trackpoints returned per-page - TRACEPOINTS_PER_PAGE = APP_CONFIG['tracepoints_per_page'] - - # 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_i - unless page - page = 0; - end - - 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 - bbox = params['bbox'] - unless bbox and bbox.count(',') == 3 - report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat") - return - end - - bbox = bbox.split(',') - min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox) - # check boundary is sane and area within defined - # see /config/application.yml - begin - check_boundaries(min_lon, min_lat, max_lon, max_lat) - rescue Exception => err - report_error(err.message) - return - end - - # get all the points - points = Tracepoint.find_by_area(min_lat, min_lon, max_lat, max_lon, :offset => offset, :limit => TRACEPOINTS_PER_PAGE, :order => "timestamp DESC" ) - - 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 - - track = XML::Node.new 'trk' - doc.root << track - - trkseg = XML::Node.new 'trkseg' - track << trkseg - - points.each do |point| - trkseg << point.to_xml_node() + # handle authenticate pass/fail + unless current_user + # no auth, the user does not exist or the password was wrong + response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" + render :plain => errormessage, :status => :unauthorized + false end - - response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\"" - - render :text => doc.to_s, :content_type => "text/xml" 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 - bbox = params['bbox'] - - unless bbox and bbox.count(',') == 3 - # alternatively: report_error(TEXT['boundary_parameter_required'] - report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat") - return - end - - bbox = bbox.split(',') - - min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox) - - # check boundary is sane and area within defined - # see /config/application.yml - begin - check_boundaries(min_lon, min_lat, max_lon, max_lat) - rescue Exception => err - report_error(err.message) - return - end - - # FIXME um why is this area using a different order for the lat/lon from above??? - @nodes = Node.find_by_area(min_lat, min_lon, max_lat, max_lon, :conditions => {:visible => true}, :limit => APP_CONFIG['max_number_of_nodes']+1) - # get all the nodes, by tag not yet working, waiting for change from NickB - # need to be @nodes (instance var) so tests in /spec can be performed - #@nodes = Node.search(bbox, params[:tag]) - - node_ids = @nodes.collect(&:id) - if node_ids.length > APP_CONFIG['max_number_of_nodes'] - report_error("You requested too many nodes (limit is #{APP_CONFIG['max_number_of_nodes']}). Either request a smaller area, or use planet.osm") - return - end - if node_ids.length == 0 - render :text => "", :content_type => "text/xml" - return - end - - doc = OSM::API.new.get_xml_doc - - # add bounds - bounds = XML::Node.new 'bounds' - bounds['minlat'] = min_lat.to_s - bounds['minlon'] = min_lon.to_s - bounds['maxlat'] = max_lat.to_s - bounds['maxlon'] = max_lon.to_s - doc.root << bounds - - # get ways - # find which ways are needed - ways = Array.new - if node_ids.length > 0 - way_nodes = WayNode.find_all_by_node_id(node_ids) - way_ids = way_nodes.collect { |way_node| way_node.id[0] } - ways = Way.find(way_ids) - - list_of_way_nodes = ways.collect { |way| - way.way_nodes.collect { |way_node| way_node.node_id } - } - list_of_way_nodes.flatten! - + def current_ability + # Use capabilities from the oauth token if it exists and is a valid access token + if Authenticator.new(self, [:token]).allow? + ApiAbility.new(nil).merge(ApiCapability.new(current_token)) else - list_of_way_nodes = Array.new - 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] - - if nodes_to_fetch.length > 0 - @nodes += Node.find(nodes_to_fetch) - end - - visible_nodes = {} - changeset_cache = {} - user_display_name_cache = {} - - @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 + ApiAbility.new(current_user) end - - way_ids = Array.new - 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 - end - end - - relations = Relation.find_for_nodes(visible_nodes.keys, :conditions => {:visible => true}) + - Relation.find_for_ways(way_ids, :conditions => {:visible => true}) - - # 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.find_for_relations(relations.collect { |r| r.id }, :conditions => {:visible => true}) - - # 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) - end - - response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\"" - - render :text => doc.to_s, :content_type => "text/xml" 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) and params.include?(:end) - starttime = Time.parse(params[:start]) - endtime = Time.parse(params[:end]) + def deny_access(_exception) + if current_token + set_locale + report_error t("oauth.permissions.missing"), :forbidden + elsif current_user + head :forbidden else - hours = (params[:hours] || '1').to_i.hours - endtime = Time.now.getutc - starttime = endtime - hours + realm = "Web Password" + errormessage = "Couldn't authenticate you" + response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" + render :plain => errormessage, :status => :unauthorized end + end - if zoom >= 1 and zoom <= 16 and - endtime > starttime and endtime - starttime <= 24.hours - mask = (1 << zoom) - 1 - - tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime], - :group => "maptile_for_point(latitude, longitude, #{zoom})") - - 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 + def gpx_status + status = database_status + status = "offline" if status == "online" && Settings.status == "gpx_offline" + status + end - 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 + ## + # 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 + # try and setup using OAuth + unless Authenticator.new(self, [:token]).allow? + username, passwd = get_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 + end - changes << t + # 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 - doc.root << changes - - render :text => doc.to_s, :content_type => "text/xml" - else - render :text => "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 + # 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 - - # 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}"; - version['maximum'] = "#{API_VERSION}"; - api << version - area = XML::Node.new 'area' - area['maximum'] = MAX_REQUEST_AREA.to_s; - api << area - tracepoints = XML::Node.new 'tracepoints' - tracepoints['per_page'] = APP_CONFIG['tracepoints_per_page'].to_s - api << tracepoints - waynodes = XML::Node.new 'waynodes' - waynodes['maximum'] = APP_CONFIG['max_number_of_way_nodes'].to_s - api << waynodes - changesets = XML::Node.new 'changesets' - changesets['maximum_elements'] = Changeset::MAX_ELEMENTS.to_s - api << changesets - - doc.root << api - - render :text => doc.to_s, :content_type => "text/xml" - end end