app/controllers/api_controller.rb

   1 class ApiController < ApplicationController
   2
   3   session :off
   4   before_filter :check_read_availability, :except => [:capabilities]
   5   after_filter :compress_output
   6
   7   # Help methods for checking boundary sanity and area size
   8   include MapBoundary
   9
  10   #COUNT is the number of map requests to allow before exiting and starting a new process
  11   @@count = COUNT
  12
  13   # The maximum area you're allowed to request, in square degrees
  14   MAX_REQUEST_AREA = 0.25
  15
  16   # Number of GPS trace/trackpoints returned per-page
  17   TRACEPOINTS_PER_PAGE = 5000
  18
  19
  20   def trackpoints
  21     @@count+=1
  22     #retrieve the page number
  23     page = params['page'].to_i
  24     unless page
  25         page = 0;
  26     end
  27
  28     unless page >= 0
  29         report_error("Page number must be greater than or equal to 0")
  30         return
  31     end
  32
  33     offset = page * TRACEPOINTS_PER_PAGE
  34
  35     # Figure out the bbox
  36     bbox = params['bbox']
  37     unless bbox and bbox.count(',') == 3
  38       report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
  39       return
  40     end
  41
  42     bbox = bbox.split(',')
  43
  44     min_lon = bbox[0].to_f
  45     min_lat = bbox[1].to_f
  46     max_lon = bbox[2].to_f
  47     max_lat = bbox[3].to_f
  48
  49     # check the bbox is sane
  50     unless min_lon <= max_lon
  51       report_error("The minimum longitude must be less than the maximum longitude, but it wasn't")
  52       return
  53     end
  54     unless min_lat <= max_lat
  55       report_error("The minimum latitude must be less than the maximum latitude, but it wasn't")
  56       return
  57     end
  58     unless min_lon >= -180 && min_lat >= -90 && max_lon <= 180 && max_lat <= 90
  59       report_error("The latitudes must be between -90 and 90, and longitudes between -180 and 180")
  60       return
  61     end
  62
  63     # check the bbox isn't too large
  64     requested_area = (max_lat-min_lat)*(max_lon-min_lon)
  65     if requested_area > MAX_REQUEST_AREA
  66       report_error("The maximum bbox size is " + MAX_REQUEST_AREA.to_s + ", and your request was too large. Either request a smaller area, or use planet.osm")
  67       return
  68     end
  69
  70     # get all the points
  71     points = Tracepoint.find_by_area(min_lat, min_lon, max_lat, max_lon, :offset => offset, :limit => TRACEPOINTS_PER_PAGE, :order => "timestamp DESC" )
  72
  73     doc = XML::Document.new
  74     doc.encoding = 'UTF-8'
  75     root = XML::Node.new 'gpx'
  76     root['version'] = '1.0'
  77     root['creator'] = 'OpenStreetMap.org'
  78     root['xmlns'] = "http://www.topografix.com/GPX/1/0/"
  79
  80     doc.root = root
  81
  82     track = XML::Node.new 'trk'
  83     doc.root << track
  84
  85     trkseg = XML::Node.new 'trkseg'
  86     track << trkseg
  87
  88     points.each do |point|
  89       trkseg << point.to_xml_node()
  90     end
  91
  92     #exit when we have too many requests
  93     if @@count > MAX_COUNT
  94       render :text => doc.to_s, :content_type => "text/xml"
  95       @@count = COUNT
  96       exit!
  97     end
  98
  99     render :text => doc.to_s, :content_type => "text/xml"
 100
 101   end
 102
 103   def map
 104     GC.start
 105     @@count+=1
 106
 107     # Figure out the bbox
 108     bbox = params['bbox']
 109
 110     unless bbox and bbox.count(',') == 3
 111       # alternatively: report_error(TEXT['boundary_parameter_required']
 112       report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
 113       return
 114     end
 115
 116     bbox = bbox.split(',')
 117
 118     min_lon, min_lat, max_lon, max_lat = *bbox.map{|b| b.to_f }
 119
 120     # check boundary is sane and area within defined
 121     # see /config/application.yml
 122     begin
 123       check_boundaries(min_lon, min_lat, max_lon, max_lat)
 124     rescue Exception => err
 125       report_error(err.message)
 126       return
 127     end
 128
 129     # get all the nodes
 130     nodes = Node.find_by_area(min_lat, min_lon, max_lat, max_lon, :conditions => "visible = 1", :limit => APP_CONFIG['max_number_of_nodes']+1)
 131
 132     node_ids = nodes.collect {|node| node.id }
 133     if node_ids.length > APP_CONFIG['max_number_of_nodes']
 134       report_error("You requested too many nodes (limit is 50,000). Either request a smaller area, or use planet.osm")
 135       return
 136     end
 137
 138     if node_ids.length == 0
 139       render :text => "<osm version='0.5'></osm>", :content_type => "text/xml"
 140       return
 141     end
 142
 143     relations = Array.new
 144
 145     doc = OSM::API.new.get_xml_doc
 146
 147     # get ways
 148     # find which ways are needed
 149     ways = Array.new
 150     if node_ids.length > 0
 151       way_nodes = WayNode.find_all_by_node_id(node_ids)
 152       way_ids = way_nodes.collect {|way_node| way_node.id[0] }
 153       ways = Way.find(way_ids)
 154
 155       list_of_way_nodes = ways.collect { |way|
 156         way.way_nodes.collect { |way_node| way_node.node_id }
 157       }
 158       list_of_way_nodes.flatten!
 159
 160     else
 161       list_of_way_nodes = Array.new
 162     end
 163
 164     # - [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
 165     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
 166
 167     if nodes_to_fetch.length > 0
 168       nodes += Node.find(nodes_to_fetch)
 169     end
 170
 171     visible_nodes = {}
 172     user_display_name_cache = {}
 173
 174     nodes.each do |node|
 175       if node.visible?
 176         doc.root << node.to_xml_node(user_display_name_cache)
 177         visible_nodes[node.id] = node
 178       end
 179     end
 180
 181     way_ids = Array.new
 182     ways.each do |way|
 183       if way.visible?
 184         doc.root << way.to_xml_node(visible_nodes, user_display_name_cache)
 185         way_ids << way.id
 186       end
 187     end
 188
 189     # collect relationships. currently done in one big block at the end;
 190     # may need to move this upwards if people want automatic completion of
 191     # relationships, i.e. deliver referenced objects like we do with ways...
 192     relations = Array.new
 193     if visible_nodes.length > 0
 194         relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
 195             "e.visible=1 and " +
 196             "em.id = e.id and em.member_type='node' and em.member_id in (#{visible_nodes.keys.join(',')})")
 197     end
 198     if way_ids.length > 0
 199         relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
 200             "e.visible=1 and " +
 201             "em.id = e.id and em.member_type='way' and em.member_id in (#{way_ids.join(',')})")
 202     end
 203     # we do not normally return the "other" partners referenced by an relation,
 204     # e.g. if we return a way A that is referenced by relation X, and there's
 205     # another way B also referenced, that is not returned. But we do make
 206     # an exception for cases where an relation references another *relation*;
 207     # in that case we return that as well (but we don't go recursive here)
 208     relation_ids = relations.collect { |relation| relation.id }
 209     if relation_ids.length > 0
 210         relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
 211             "e.visible=1 and " +
 212             "em.id = e.id and em.member_type='relation' and em.member_id in (#{relation_ids.join(',')})")
 213     end
 214
 215     # this "uniq" may be slightly inefficient; it may be better to first collect and output
 216     # all node-related relations, then find the *not yet covered* way-related ones etc.
 217     relations.uniq.each do |relation|
 218       doc.root << relation.to_xml_node(user_display_name_cache)
 219     end
 220
 221     render :text => doc.to_s, :content_type => "text/xml"
 222
 223     #exit when we have too many requests
 224     if @@count > MAX_COUNT
 225       @@count = COUNT
 226
 227       exit!
 228     end
 229   end
 230
 231   def changes
 232     zoom = (params[:zoom] || '12').to_i
 233
 234     if params.include?(:start) and params.include?(:end)
 235       starttime = Time.parse(params[:start])
 236       endtime = Time.parse(params[:end])
 237     else
 238       hours = (params[:hours] || '1').to_i.hours
 239       endtime = Time.now
 240       starttime = endtime - hours
 241     end
 242
 243     if zoom >= 1 and zoom <= 16 and
 244        endtime >= starttime and endtime - starttime <= 24.hours
 245       mask = (1 << zoom) - 1
 246
 247       tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],
 248                          :group => "maptile_for_point(latitude, longitude, #{zoom})")
 249
 250       doc = OSM::API.new.get_xml_doc
 251       changes = XML::Node.new 'changes'
 252       changes["starttime"] = starttime.xmlschema
 253       changes["endtime"] = endtime.xmlschema
 254
 255       tiles.each do |tile, count|
 256         x = (tile.to_i >> zoom) & mask
 257         y = tile.to_i & mask
 258
 259         t = XML::Node.new 'tile'
 260         t["x"] = x.to_s
 261         t["y"] = y.to_s
 262         t["z"] = zoom.to_s
 263         t["changes"] = count.to_s
 264
 265         changes << t
 266       end
 267
 268       doc.root << changes
 269
 270       render :text => doc.to_s, :content_type => "text/xml"
 271     else
 272       render :nothing => true, :status => :bad_request
 273     end
 274   end
 275
 276   def capabilities
 277     doc = OSM::API.new.get_xml_doc
 278
 279     api = XML::Node.new 'api'
 280     version = XML::Node.new 'version'
 281     version['minimum'] = '0.5';
 282     version['maximum'] = '0.5';
 283     api << version
 284     area = XML::Node.new 'area'
 285     area['maximum'] = MAX_REQUEST_AREA.to_s;
 286     api << area
 287
 288     doc.root << api
 289
 290     render :text => doc.to_s, :content_type => "text/xml"
 291   end
 292 end