app/controllers/api_controller.rb

   1 class ApiController < ApplicationController
   2   skip_before_action :verify_authenticity_token
   3   before_action :api_deny_access_handler
   4
   5   authorize_resource :class => false
   6
   7   before_action :check_api_readable
   8   before_action :setup_user_auth, :only => [:permissions]
   9   around_action :api_call_handle_error, :api_call_timeout
  10
  11   # This is probably the most common call of all. It is used for getting the
  12   # OSM data for a specified bounding box, usually for editing. First the
  13   # bounding box (bbox) is checked to make sure that it is sane. All nodes
  14   # are searched, then all the ways that reference those nodes are found.
  15   # All Nodes that are referenced by those ways are fetched and added to the list
  16   # of nodes.
  17   # Then all the relations that reference the already found nodes and ways are
  18   # fetched. All the nodes and ways that are referenced by those ways are then
  19   # fetched. Finally all the xml is returned.
  20   def map
  21     # Figure out the bbox
  22     # check boundary is sane and area within defined
  23     # see /config/application.yml
  24     begin
  25       bbox = BoundingBox.from_bbox_params(params)
  26       bbox.check_boundaries
  27       bbox.check_size
  28     rescue StandardError => err
  29       report_error(err.message)
  30       return
  31     end
  32
  33     nodes = Node.bbox(bbox).where(:visible => true).includes(:node_tags).limit(MAX_NUMBER_OF_NODES + 1)
  34
  35     node_ids = nodes.collect(&:id)
  36     if node_ids.length > MAX_NUMBER_OF_NODES
  37       report_error("You requested too many nodes (limit is #{MAX_NUMBER_OF_NODES}). Either request a smaller area, or use planet.osm")
  38       return
  39     end
  40
  41     doc = OSM::API.new.get_xml_doc
  42
  43     # add bounds
  44     doc.root << bbox.add_bounds_to(XML::Node.new("bounds"))
  45
  46     # get ways
  47     # find which ways are needed
  48     ways = []
  49     if node_ids.empty?
  50       list_of_way_nodes = []
  51     else
  52       way_nodes = WayNode.where(:node_id => node_ids)
  53       way_ids = way_nodes.collect { |way_node| way_node.id[0] }
  54       ways = Way.preload(:way_nodes, :way_tags).find(way_ids)
  55
  56       list_of_way_nodes = ways.collect do |way|
  57         way.way_nodes.collect(&:node_id)
  58       end
  59       list_of_way_nodes.flatten!
  60     end
  61
  62     # - [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
  63     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
  64
  65     nodes += Node.includes(:node_tags).find(nodes_to_fetch) unless nodes_to_fetch.empty?
  66
  67     visible_nodes = {}
  68     changeset_cache = {}
  69     user_display_name_cache = {}
  70
  71     nodes.each do |node|
  72       if node.visible?
  73         doc.root << node.to_xml_node(changeset_cache, user_display_name_cache)
  74         visible_nodes[node.id] = node
  75       end
  76     end
  77
  78     way_ids = []
  79     ways.each do |way|
  80       if way.visible?
  81         doc.root << way.to_xml_node(visible_nodes, changeset_cache, user_display_name_cache)
  82         way_ids << way.id
  83       end
  84     end
  85
  86     relations = Relation.nodes(visible_nodes.keys).visible +
  87                 Relation.ways(way_ids).visible
  88
  89     # we do not normally return the "other" partners referenced by an relation,
  90     # e.g. if we return a way A that is referenced by relation X, and there's
  91     # another way B also referenced, that is not returned. But we do make
  92     # an exception for cases where an relation references another *relation*;
  93     # in that case we return that as well (but we don't go recursive here)
  94     relations += Relation.relations(relations.collect(&:id)).visible
  95
  96     # this "uniq" may be slightly inefficient; it may be better to first collect and output
  97     # all node-related relations, then find the *not yet covered* way-related ones etc.
  98     relations.uniq.each do |relation|
  99       doc.root << relation.to_xml_node(changeset_cache, user_display_name_cache)
 100     end
 101
 102     response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
 103
 104     render :xml => doc.to_s
 105   end
 106
 107   # Get a list of the tiles that have changed within a specified time
 108   # period
 109   def changes
 110     zoom = (params[:zoom] || "12").to_i
 111
 112     if params.include?(:start) && params.include?(:end)
 113       starttime = Time.parse(params[:start])
 114       endtime = Time.parse(params[:end])
 115     else
 116       hours = (params[:hours] || "1").to_i.hours
 117       endtime = Time.now.getutc
 118       starttime = endtime - hours
 119     end
 120
 121     if zoom >= 1 && zoom <= 16 &&
 122        endtime > starttime && endtime - starttime <= 24.hours
 123       mask = (1 << zoom) - 1
 124
 125       tiles = Node.where(:timestamp => starttime..endtime).group("maptile_for_point(latitude, longitude, #{zoom})").count
 126
 127       doc = OSM::API.new.get_xml_doc
 128       changes = XML::Node.new "changes"
 129       changes["starttime"] = starttime.xmlschema
 130       changes["endtime"] = endtime.xmlschema
 131
 132       tiles.each do |tile, count|
 133         x = (tile.to_i >> zoom) & mask
 134         y = tile.to_i & mask
 135
 136         t = XML::Node.new "tile"
 137         t["x"] = x.to_s
 138         t["y"] = y.to_s
 139         t["z"] = zoom.to_s
 140         t["changes"] = count.to_s
 141
 142         changes << t
 143       end
 144
 145       doc.root << changes
 146
 147       render :xml => doc.to_s
 148     else
 149       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
 150     end
 151   end
 152
 153   # External apps that use the api are able to query which permissions
 154   # they have. This currently returns a list of permissions granted to the current user:
 155   # * if authenticated via OAuth, this list will contain all permissions granted by the user to the access_token.
 156   # * if authenticated via basic auth all permissions are granted, so the list will contain all permissions.
 157   # * unauthenticated users have no permissions, so the list will be empty.
 158   def permissions
 159     @permissions = if current_token.present?
 160                      ClientApplication.all_permissions.select { |p| current_token.read_attribute(p) }
 161                    elsif current_user
 162                      ClientApplication.all_permissions
 163                    else
 164                      []
 165                    end
 166   end
 167 end