more testing of the api. Changing the generator so that it is a constant to come...
[rails.git] / 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 = APP_CONFIG['max_request_area']
15
16   # Number of GPS trace/trackpoints returned per-page
17   TRACEPOINTS_PER_PAGE = APP_CONFIG['tracepoints_per_page']
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     min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox)
44     # check boundary is sane and area within defined
45     # see /config/application.yml
46     begin
47       check_boundaries(min_lon, min_lat, max_lon, max_lat)
48     rescue Exception => err
49       report_error(err.message)
50       return
51     end
52
53     # get all the points
54     points = Tracepoint.find_by_area(min_lat, min_lon, max_lat, max_lon, :offset => offset, :limit => TRACEPOINTS_PER_PAGE, :order => "timestamp DESC" )
55
56     doc = XML::Document.new
57     doc.encoding = 'UTF-8'
58     root = XML::Node.new 'gpx'
59     root['version'] = '1.0'
60     root['creator'] = 'OpenStreetMap.org'
61     root['xmlns'] = "http://www.topografix.com/GPX/1/0/"
62     
63     doc.root = root
64
65     track = XML::Node.new 'trk'
66     doc.root << track
67
68     trkseg = XML::Node.new 'trkseg'
69     track << trkseg
70
71     points.each do |point|
72       trkseg << point.to_xml_node()
73     end
74
75     #exit when we have too many requests
76     if @@count > MAX_COUNT
77       render :text => doc.to_s, :content_type => "text/xml"
78       @@count = COUNT
79       exit!
80     end
81
82     response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
83
84     render :text => doc.to_s, :content_type => "text/xml"
85   end
86
87   def map
88     GC.start
89     @@count+=1
90     # Figure out the bbox
91     bbox = params['bbox']
92
93     unless bbox and bbox.count(',') == 3
94       # alternatively: report_error(TEXT['boundary_parameter_required']
95       report_error("The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
96       return
97     end
98
99     bbox = bbox.split(',')
100
101     min_lon, min_lat, max_lon, max_lat = sanitise_boundaries(bbox)
102
103     # check boundary is sane and area within defined
104     # see /config/application.yml
105     begin
106       check_boundaries(min_lon, min_lat, max_lon, max_lat)
107     rescue Exception => err
108       report_error(err.message)
109       return
110     end
111
112     # FIXME um why is this area using a different order for the lat/lon from above???
113     @nodes = Node.find_by_area(min_lat, min_lon, max_lat, max_lon, :conditions => "visible = 1", :limit => APP_CONFIG['max_number_of_nodes']+1)
114     # get all the nodes, by tag not yet working, waiting for change from NickB
115     # need to be @nodes (instance var) so tests in /spec can be performed
116     #@nodes = Node.search(bbox, params[:tag])
117
118     node_ids = @nodes.collect(&:id)
119     if node_ids.length > APP_CONFIG['max_number_of_nodes']
120       report_error("You requested too many nodes (limit is #{APP_CONFIG['max_number_of_nodes']}). Either request a smaller area, or use planet.osm")
121       return
122     end
123     if node_ids.length == 0
124       render :text => "<osm version='#{API_VERSION}'></osm>", :content_type => "text/xml"
125       return
126     end
127
128     doc = OSM::API.new.get_xml_doc
129
130     # add bounds
131     bounds = XML::Node.new 'bounds'
132     bounds['minlat'] = min_lat.to_s
133     bounds['minlon'] = min_lon.to_s
134     bounds['maxlat'] = max_lat.to_s
135     bounds['maxlon'] = max_lon.to_s
136     doc.root << bounds
137
138     # get ways
139     # find which ways are needed
140     ways = Array.new
141     if node_ids.length > 0
142       way_nodes = WayNode.find_all_by_node_id(node_ids)
143       way_ids = way_nodes.collect { |way_node| way_node.id[0] }
144       ways = Way.find(way_ids)
145
146       list_of_way_nodes = ways.collect { |way|
147         way.way_nodes.collect { |way_node| way_node.node_id }
148       }
149       list_of_way_nodes.flatten!
150
151     else
152       list_of_way_nodes = Array.new
153     end
154
155     # - [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
156     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
157
158     if nodes_to_fetch.length > 0
159       @nodes += Node.find(nodes_to_fetch)
160     end
161
162     visible_nodes = {}
163     user_display_name_cache = {}
164
165     @nodes.each do |node|
166       if node.visible?
167         doc.root << node.to_xml_node(user_display_name_cache)
168         visible_nodes[node.id] = node
169       end
170     end
171
172     way_ids = Array.new
173     ways.each do |way|
174       if way.visible?
175         doc.root << way.to_xml_node(visible_nodes, user_display_name_cache)
176         way_ids << way.id
177       end
178     end 
179
180     relations = Relation.find_for_nodes(visible_nodes.keys, :conditions => "visible = 1") +
181                 Relation.find_for_ways(way_ids, :conditions => "visible = 1")
182
183     # we do not normally return the "other" partners referenced by an relation, 
184     # e.g. if we return a way A that is referenced by relation X, and there's 
185     # another way B also referenced, that is not returned. But we do make 
186     # an exception for cases where an relation references another *relation*; 
187     # in that case we return that as well (but we don't go recursive here)
188     relations += Relation.find_for_relations(relations.collect { |r| r.id }, :conditions => "visible = 1")
189
190     # this "uniq" may be slightly inefficient; it may be better to first collect and output
191     # all node-related relations, then find the *not yet covered* way-related ones etc.
192     relations.uniq.each do |relation|
193       doc.root << relation.to_xml_node(user_display_name_cache)
194     end
195
196     response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
197
198     render :text => doc.to_s, :content_type => "text/xml"
199     
200     #exit when we have too many requests
201     if @@count > MAX_COUNT
202       @@count = COUNT
203       
204       exit!
205     end
206   end
207
208   def changes
209     zoom = (params[:zoom] || '12').to_i
210
211     if params.include?(:start) and params.include?(:end)
212       starttime = Time.parse(params[:start])
213       endtime = Time.parse(params[:end])
214     else
215       hours = (params[:hours] || '1').to_i.hours
216       endtime = Time.now
217       starttime = endtime - hours
218     end
219
220     if zoom >= 1 and zoom <= 16 and
221        endtime >= starttime and endtime - starttime <= 24.hours
222       mask = (1 << zoom) - 1
223
224       tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],
225                          :group => "maptile_for_point(latitude, longitude, #{zoom})")
226
227       doc = OSM::API.new.get_xml_doc
228       changes = XML::Node.new 'changes'
229       changes["starttime"] = starttime.xmlschema
230       changes["endtime"] = endtime.xmlschema
231
232       tiles.each do |tile, count|
233         x = (tile.to_i >> zoom) & mask
234         y = tile.to_i & mask
235
236         t = XML::Node.new 'tile'
237         t["x"] = x.to_s
238         t["y"] = y.to_s
239         t["z"] = zoom.to_s
240         t["changes"] = count.to_s
241
242         changes << t
243       end
244
245       doc.root << changes
246
247       render :text => doc.to_s, :content_type => "text/xml"
248     else
249       render :text => "Requested zoom is invalid", :status => :bad_request
250     end
251   end
252
253   def capabilities
254     doc = OSM::API.new.get_xml_doc
255
256     api = XML::Node.new 'api'
257     version = XML::Node.new 'version'
258     version['minimum'] = "#{API_VERSION}";
259     version['maximum'] = "#{API_VERSION}";
260     api << version
261     area = XML::Node.new 'area'
262     area['maximum'] = MAX_REQUEST_AREA.to_s;
263     api << area
264     tracepoints = XML::Node.new 'tracepoints'
265     tracepoints['per_page'] = APP_CONFIG['tracepoints_per_page'].to_s
266     api << tracepoints
267     
268     doc.root << api
269
270     render :text => doc.to_s, :content_type => "text/xml"
271   end
272 end