X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/001ff5764bcf15aaa179dc5c7844038676536622..ef7f3d800cbdd49b692df10d312e5fd880e2e938:/app/controllers/api_controller.rb diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb index 95cc88869..1b9a1ad69 100644 --- a/app/controllers/api_controller.rb +++ b/app/controllers/api_controller.rb @@ -1,45 +1,37 @@ class ApiController < ApplicationController - + skip_before_filter :verify_authenticity_token before_filter :check_api_readable, :except => [:capabilities] + before_filter :setup_user_auth, :only => [:permissions] after_filter :compress_output around_filter :api_call_handle_error, :api_call_timeout - # Help methods for checking boundary sanity and area size - include MapBoundary - # 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 + # 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 + 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) + bbox = BoundingBox.from_bbox_params(params) + bbox.check_boundaries + bbox.check_size 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 => "gpx_id DESC, trackid ASC, timestamp ASC" ) + 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 @@ -47,7 +39,7 @@ class ApiController < ApplicationController 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 @@ -76,27 +68,27 @@ class ApiController < ApplicationController 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', :id => gpx_file.id)) + 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? + if anon_track.nil? anon_track = XML::Node.new 'trk' doc.root << anon_track end track = anon_track 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? + if anon_trkseg.nil? anon_trkseg = XML::Node.new 'trkseg' anon_track << anon_trkseg end @@ -112,43 +104,29 @@ class ApiController < ApplicationController 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 + # 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 + # 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. 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) + bbox = BoundingBox.from_bbox_params(params) + bbox.check_boundaries + bbox.check_size 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}, :include => :node_tags, :limit => 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]) + @nodes = Node.bbox(bbox).where(:visible => true).includes(:node_tags).limit(MAX_NUMBER_OF_NODES + 1) node_ids = @nodes.collect(&:id) if node_ids.length > MAX_NUMBER_OF_NODES @@ -163,35 +141,30 @@ class ApiController < ApplicationController 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 + doc.root << bbox.add_bounds_to(XML::Node.new 'bounds') # get ways # find which ways are needed - ways = Array.new + ways = [] if node_ids.length > 0 - way_nodes = WayNode.find_all_by_node_id(node_ids) + way_nodes = WayNode.where(:node_id => node_ids) way_ids = way_nodes.collect { |way_node| way_node.id[0] } - ways = Way.find(way_ids, :include => [:way_nodes, :way_tags]) + ways = Way.preload(:way_nodes, :way_tags).find(way_ids) - list_of_way_nodes = ways.collect { |way| - way.way_nodes.collect { |way_node| way_node.node_id } - } + list_of_way_nodes = ways.collect do |way| + way.way_nodes.collect(&:node_id) + end list_of_way_nodes.flatten! else - list_of_way_nodes = Array.new + list_of_way_nodes = [] 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, :include => :node_tags) + @nodes += Node.includes(:node_tags).find(nodes_to_fetch) end visible_nodes = {} @@ -205,23 +178,23 @@ class ApiController < ApplicationController end end - way_ids = Array.new + 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 end - end + end - relations = Relation.find_for_nodes(visible_nodes.keys, :conditions => {:visible => true}) + - Relation.find_for_ways(way_ids, :conditions => {:visible => true}) + 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*; + # 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}) + 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. @@ -239,7 +212,7 @@ class ApiController < ApplicationController def changes zoom = (params[:zoom] || '12').to_i - if params.include?(:start) and params.include?(:end) + if params.include?(:start) && params.include?(:end) starttime = Time.parse(params[:start]) endtime = Time.parse(params[:end]) else @@ -248,12 +221,11 @@ class ApiController < ApplicationController starttime = endtime - hours end - if zoom >= 1 and zoom <= 16 and - endtime > starttime and endtime - starttime <= 24.hours + if zoom >= 1 && zoom <= 16 && + endtime > starttime && endtime - starttime <= 24.hours mask = (1 << zoom) - 1 - tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime], - :group => "maptile_for_point(latitude, longitude, #{zoom})") + 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' @@ -281,8 +253,8 @@ class ApiController < ApplicationController 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: + # 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 @@ -291,11 +263,11 @@ class ApiController < ApplicationController api = XML::Node.new 'api' version = XML::Node.new 'version' - version['minimum'] = "#{API_VERSION}"; - version['maximum'] = "#{API_VERSION}"; + version['minimum'] = "#{API_VERSION}" + version['maximum'] = "#{API_VERSION}" api << version area = XML::Node.new 'area' - area['maximum'] = MAX_REQUEST_AREA.to_s; + area['maximum'] = MAX_REQUEST_AREA.to_s api << area tracepoints = XML::Node.new 'tracepoints' tracepoints['per_page'] = TRACEPOINTS_PER_PAGE.to_s @@ -309,9 +281,38 @@ class ApiController < ApplicationController 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 :text => doc.to_s, :content_type => "text/xml" end + + # 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 = case + when current_token.present? + ClientApplication.all_permissions.select { |p| current_token.read_attribute(p) } + when @user + ClientApplication.all_permissions + else + [] + end + end end