app/controllers/api_controller.rb

   1 class ApiController < ApplicationController
   2
   3   skip_before_filter :verify_authenticity_token
   4   before_filter :check_api_readable, :except => [:capabilities]
   5   before_filter :setup_user_auth, :only => [:permissions]
   6   after_filter :compress_output
   7   around_filter :api_call_handle_error, :api_call_timeout
   8
   9   # Get an XML response containing a list of tracepoints that have been uploaded
  10   # within the specified bounding box, and in the specified page.
  11   def trackpoints
  12     #retrieve the page number
  13     page = params['page'].to_s.to_i
  14
  15     unless page >= 0
  16         report_error("Page number must be greater than or equal to 0")
  17         return
  18     end
  19
  20     offset = page * TRACEPOINTS_PER_PAGE
  21
  22     # Figure out the bbox
  23     # check boundary is sane and area within defined
  24     # see /config/application.yml
  25     begin
  26       bbox = BoundingBox.from_bbox_params(params)
  27       bbox.check_boundaries
  28       bbox.check_size
  29     rescue Exception => err
  30       report_error(err.message)
  31       return
  32     end
  33
  34     # get all the points
  35     points = Tracepoint.bbox(bbox).offset(offset).limit(TRACEPOINTS_PER_PAGE).order("gpx_id DESC, trackid ASC, timestamp ASC")
  36
  37     doc = XML::Document.new
  38     doc.encoding = XML::Encoding::UTF_8
  39     root = XML::Node.new 'gpx'
  40     root['version'] = '1.0'
  41     root['creator'] = 'OpenStreetMap.org'
  42     root['xmlns'] = "http://www.topografix.com/GPX/1/0"
  43
  44     doc.root = root
  45
  46     # initialise these variables outside of the loop so that they
  47     # stay in scope and don't get free'd up by the GC during the
  48     # loop.
  49     gpx_id = -1
  50     trackid = -1
  51     track = nil
  52     trkseg = nil
  53     anon_track = nil
  54     anon_trkseg = nil
  55     gpx_file = nil
  56     timestamps = false
  57
  58     points.each do |point|
  59       if gpx_id != point.gpx_id
  60         gpx_id = point.gpx_id
  61         trackid = -1
  62         gpx_file = Trace.find(gpx_id)
  63
  64         if gpx_file.trackable?
  65           track = XML::Node.new 'trk'
  66           doc.root << track
  67           timestamps = true
  68
  69           if gpx_file.identifiable?
  70             track << (XML::Node.new("name") << gpx_file.name)
  71             track << (XML::Node.new("desc") << gpx_file.description)
  72             track << (XML::Node.new("url") << url_for(:controller => 'trace', :action => 'view', :display_name => gpx_file.user.display_name, :id => gpx_file.id))
  73           end
  74         else
  75           # use the anonymous track segment if the user hasn't allowed
  76           # their GPX points to be tracked.
  77           timestamps = false
  78           if anon_track.nil?
  79             anon_track = XML::Node.new 'trk'
  80             doc.root << anon_track
  81           end
  82           track = anon_track
  83         end
  84       end
  85
  86       if trackid != point.trackid
  87         if gpx_file.trackable?
  88           trkseg = XML::Node.new 'trkseg'
  89           track << trkseg
  90           trackid = point.trackid
  91         else
  92           if anon_trkseg.nil?
  93             anon_trkseg = XML::Node.new 'trkseg'
  94             anon_track << anon_trkseg
  95           end
  96           trkseg = anon_trkseg
  97         end
  98       end
  99
 100       trkseg << point.to_xml_node(timestamps)
 101     end
 102
 103     response.headers["Content-Disposition"] = "attachment; filename=\"tracks.gpx\""
 104
 105     render :text => doc.to_s, :content_type => "text/xml"
 106   end
 107
 108   # This is probably the most common call of all. It is used for getting the
 109   # OSM data for a specified bounding box, usually for editing. First the
 110   # bounding box (bbox) is checked to make sure that it is sane. All nodes
 111   # are searched, then all the ways that reference those nodes are found.
 112   # All Nodes that are referenced by those ways are fetched and added to the list
 113   # of nodes.
 114   # Then all the relations that reference the already found nodes and ways are
 115   # fetched. All the nodes and ways that are referenced by those ways are then
 116   # fetched. Finally all the xml is returned.
 117   def map
 118     # Figure out the bbox
 119     # check boundary is sane and area within defined
 120     # see /config/application.yml
 121     begin
 122       bbox = BoundingBox.from_bbox_params(params)
 123       bbox.check_boundaries
 124       bbox.check_size
 125     rescue Exception => err
 126       report_error(err.message)
 127       return
 128     end
 129
 130     @nodes = Node.bbox(bbox).where(:visible => true).includes(:node_tags).limit(MAX_NUMBER_OF_NODES+1)
 131     # get all the nodes, by tag not yet working, waiting for change from NickB
 132     # need to be @nodes (instance var) so tests in /spec can be performed
 133     #@nodes = Node.search(bbox, params[:tag])
 134
 135     node_ids = @nodes.collect(&:id)
 136     if node_ids.length > MAX_NUMBER_OF_NODES
 137       report_error("You requested too many nodes (limit is #{MAX_NUMBER_OF_NODES}). Either request a smaller area, or use planet.osm")
 138       return
 139     end
 140     if node_ids.length == 0
 141       render :text => "<osm version='#{API_VERSION}' generator='#{GENERATOR}'></osm>", :content_type => "text/xml"
 142       return
 143     end
 144
 145     doc = OSM::API.new.get_xml_doc
 146
 147     # add bounds
 148     doc.root << bbox.add_bounds_to(XML::Node.new 'bounds')
 149
 150     # get ways
 151     # find which ways are needed
 152     ways = Array.new
 153     if node_ids.length > 0
 154       way_nodes = WayNode.find_all_by_node_id(node_ids)
 155       way_ids = way_nodes.collect { |way_node| way_node.id[0] }
 156       ways = Way.find(way_ids, :include => [:way_nodes, :way_tags])
 157
 158       list_of_way_nodes = ways.collect { |way|
 159         way.way_nodes.collect { |way_node| way_node.node_id }
 160       }
 161       list_of_way_nodes.flatten!
 162
 163     else
 164       list_of_way_nodes = Array.new
 165     end
 166
 167     # - [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
 168     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
 169
 170     if nodes_to_fetch.length > 0
 171       @nodes += Node.includes(:node_tags).find(nodes_to_fetch)
 172     end
 173
 174     visible_nodes = {}
 175     changeset_cache = {}
 176     user_display_name_cache = {}
 177
 178     @nodes.each do |node|
 179       if node.visible?
 180         doc.root << node.to_xml_node(changeset_cache, user_display_name_cache)
 181         visible_nodes[node.id] = node
 182       end
 183     end
 184
 185     way_ids = Array.new
 186     ways.each do |way|
 187       if way.visible?
 188         doc.root << way.to_xml_node(visible_nodes, changeset_cache, user_display_name_cache)
 189         way_ids << way.id
 190       end
 191     end
 192
 193     relations = Relation.nodes(visible_nodes.keys).visible +
 194                 Relation.ways(way_ids).visible
 195
 196     # we do not normally return the "other" partners referenced by an relation,
 197     # e.g. if we return a way A that is referenced by relation X, and there's
 198     # another way B also referenced, that is not returned. But we do make
 199     # an exception for cases where an relation references another *relation*;
 200     # in that case we return that as well (but we don't go recursive here)
 201     relations += Relation.relations(relations.collect { |r| r.id }).visible
 202
 203     # this "uniq" may be slightly inefficient; it may be better to first collect and output
 204     # all node-related relations, then find the *not yet covered* way-related ones etc.
 205     relations.uniq.each do |relation|
 206       doc.root << relation.to_xml_node(nil, changeset_cache, user_display_name_cache)
 207     end
 208
 209     response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
 210
 211     render :text => doc.to_s, :content_type => "text/xml"
 212   end
 213
 214   # Get a list of the tiles that have changed within a specified time
 215   # period
 216   def changes
 217     zoom = (params[:zoom] || '12').to_i
 218
 219     if params.include?(:start) and params.include?(:end)
 220       starttime = Time.parse(params[:start])
 221       endtime = Time.parse(params[:end])
 222     else
 223       hours = (params[:hours] || '1').to_i.hours
 224       endtime = Time.now.getutc
 225       starttime = endtime - hours
 226     end
 227
 228     if zoom >= 1 and zoom <= 16 and
 229        endtime > starttime and endtime - starttime <= 24.hours
 230       mask = (1 << zoom) - 1
 231
 232       tiles = Node.where(:timestamp => starttime .. endtime).group("maptile_for_point(latitude, longitude, #{zoom})").count
 233
 234       doc = OSM::API.new.get_xml_doc
 235       changes = XML::Node.new 'changes'
 236       changes["starttime"] = starttime.xmlschema
 237       changes["endtime"] = endtime.xmlschema
 238
 239       tiles.each do |tile, count|
 240         x = (tile.to_i >> zoom) & mask
 241         y = tile.to_i & mask
 242
 243         t = XML::Node.new 'tile'
 244         t["x"] = x.to_s
 245         t["y"] = y.to_s
 246         t["z"] = zoom.to_s
 247         t["changes"] = count.to_s
 248
 249         changes << t
 250       end
 251
 252       doc.root << changes
 253
 254       render :text => doc.to_s, :content_type => "text/xml"
 255     else
 256       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
 257     end
 258   end
 259
 260   # External apps that use the api are able to query the api to find out some
 261   # parameters of the API. It currently returns:
 262   # * minimum and maximum API versions that can be used.
 263   # * maximum area that can be requested in a bbox request in square degrees
 264   # * number of tracepoints that are returned in each tracepoints page
 265   def capabilities
 266     doc = OSM::API.new.get_xml_doc
 267
 268     api = XML::Node.new 'api'
 269     version = XML::Node.new 'version'
 270     version['minimum'] = "#{API_VERSION}";
 271     version['maximum'] = "#{API_VERSION}";
 272     api << version
 273     area = XML::Node.new 'area'
 274     area['maximum'] = MAX_REQUEST_AREA.to_s;
 275     api << area
 276     tracepoints = XML::Node.new 'tracepoints'
 277     tracepoints['per_page'] = TRACEPOINTS_PER_PAGE.to_s
 278     api << tracepoints
 279     waynodes = XML::Node.new 'waynodes'
 280     waynodes['maximum'] = MAX_NUMBER_OF_WAY_NODES.to_s
 281     api << waynodes
 282     changesets = XML::Node.new 'changesets'
 283     changesets['maximum_elements'] = Changeset::MAX_ELEMENTS.to_s
 284     api << changesets
 285     timeout = XML::Node.new 'timeout'
 286     timeout['seconds'] = API_TIMEOUT.to_s
 287     api << timeout
 288     status = XML::Node.new 'status'
 289     status['database'] = database_status.to_s
 290     status['api'] = api_status.to_s
 291     status['gpx'] = gpx_status.to_s
 292     api << status
 293
 294     doc.root << api
 295
 296     render :text => doc.to_s, :content_type => "text/xml"
 297   end
 298
 299   # External apps that use the api are able to query which permissions
 300   # they have. This currently returns a list of permissions granted to the current user:
 301   # * if authenticated via OAuth, this list will contain all permissions granted by the user to the access_token.
 302   # * if authenticated via basic auth all permissions are granted, so the list will contain all permissions.
 303   # * unauthenticated users have no permissions, so the list will be empty.
 304   def permissions
 305     @permissions = case
 306                    when current_token.present?
 307                      ClientApplication.all_permissions.select { |p| current_token.read_attribute(p) }
 308                    when @user
 309                      ClientApplication.all_permissions
 310                    else
 311                      []
 312                    end
 313   end
 314 end