api06: simplify exception handling and add exception handling to the diff
[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 = 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     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     @nodes = Node.find_by_area(min_lat, min_lon, max_lat, max_lon, :conditions => "visible = 1", :limit => APP_CONFIG['max_number_of_nodes']+1)
113     # get all the nodes, by tag not yet working, waiting for change from NickB
114     # need to be @nodes (instance var) so tests in /spec can be performed
115     #@nodes = Node.search(bbox, params[:tag])
116
117     node_ids = @nodes.collect(&:id)
118     if node_ids.length > APP_CONFIG['max_number_of_nodes']
119       report_error("You requested too many nodes (limit is 50,000). Either request a smaller area, or use planet.osm")
120       return
121     end
122     if node_ids.length == 0
123       render :text => "<osm version='#{API_VERSION}'></osm>", :content_type => "text/xml"
124       return
125     end
126
127     relations = Array.new
128
129     doc = OSM::API.new.get_xml_doc
130
131     # get ways
132     # find which ways are needed
133     ways = Array.new
134     if node_ids.length > 0
135       way_nodes = WayNode.find_all_by_node_id(node_ids)
136       way_ids = way_nodes.collect { |way_node| way_node.id[0] }
137       ways = Way.find(way_ids)
138
139       list_of_way_nodes = ways.collect { |way|
140         way.way_nodes.collect { |way_node| way_node.node_id }
141       }
142       list_of_way_nodes.flatten!
143
144     else
145       list_of_way_nodes = Array.new
146     end
147
148     # - [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
149     nodes_to_fetch = (list_of_way_nodes.uniq - node_ids) - [0]
150
151     if nodes_to_fetch.length > 0
152       @nodes += Node.find(nodes_to_fetch)
153     end
154
155     visible_nodes = {}
156     user_display_name_cache = {}
157
158     @nodes.each do |node|
159       if node.visible?
160         doc.root << node.to_xml_node(user_display_name_cache)
161         visible_nodes[node.id] = node
162       end
163     end
164
165     way_ids = Array.new
166     ways.each do |way|
167       if way.visible?
168         doc.root << way.to_xml_node(visible_nodes, user_display_name_cache)
169         way_ids << way.id
170       end
171     end 
172
173     relations = Relation.find_for_nodes_and_ways(visible_nodes.keys, way_ids)
174
175     # we do not normally return the "other" partners referenced by an relation, 
176     # e.g. if we return a way A that is referenced by relation X, and there's 
177     # another way B also referenced, that is not returned. But we do make 
178     # an exception for cases where an relation references another *relation*; 
179     # in that case we return that as well (but we don't go recursive here)
180     relation_ids = relations.collect { |relation| relation.id }
181     if relation_ids.length > 0
182         relations += Relation.find_by_sql("select e.* from current_relations e,current_relation_members em where " +
183             "e.visible=1 and " +
184             "em.id = e.id and em.member_type='relation' and em.member_id in (#{relation_ids.join(',')})")
185     end
186
187     # this "uniq" may be slightly inefficient; it may be better to first collect and output
188     # all node-related relations, then find the *not yet covered* way-related ones etc.
189     relations.uniq.each do |relation|
190       doc.root << relation.to_xml_node(user_display_name_cache)
191     end
192
193     response.headers["Content-Disposition"] = "attachment; filename=\"map.osm\""
194
195     render :text => doc.to_s, :content_type => "text/xml"
196     
197     #exit when we have too many requests
198     if @@count > MAX_COUNT
199       @@count = COUNT
200       
201       exit!
202     end
203   end
204
205   def changes
206     zoom = (params[:zoom] || '12').to_i
207
208     if params.include?(:start) and params.include?(:end)
209       starttime = Time.parse(params[:start])
210       endtime = Time.parse(params[:end])
211     else
212       hours = (params[:hours] || '1').to_i.hours
213       endtime = Time.now
214       starttime = endtime - hours
215     end
216
217     if zoom >= 1 and zoom <= 16 and
218        endtime >= starttime and endtime - starttime <= 24.hours
219       mask = (1 << zoom) - 1
220
221       tiles = Node.count(:conditions => ["timestamp BETWEEN ? AND ?", starttime, endtime],
222                          :group => "maptile_for_point(latitude, longitude, #{zoom})")
223
224       doc = OSM::API.new.get_xml_doc
225       changes = XML::Node.new 'changes'
226       changes["starttime"] = starttime.xmlschema
227       changes["endtime"] = endtime.xmlschema
228
229       tiles.each do |tile, count|
230         x = (tile.to_i >> zoom) & mask
231         y = tile.to_i & mask
232
233         t = XML::Node.new 'tile'
234         t["x"] = x.to_s
235         t["y"] = y.to_s
236         t["z"] = zoom.to_s
237         t["changes"] = count.to_s
238
239         changes << t
240       end
241
242       doc.root << changes
243
244       render :text => doc.to_s, :content_type => "text/xml"
245     else
246       render :nothing => true, :status => :bad_request
247     end
248   end
249
250   def capabilities
251     doc = OSM::API.new.get_xml_doc
252
253     api = XML::Node.new 'api'
254     version = XML::Node.new 'version'
255     version['minimum'] = "#{API_VERSION}";
256     version['maximum'] = "#{API_VERSION}";
257     api << version
258     area = XML::Node.new 'area'
259     area['maximum'] = MAX_REQUEST_AREA.to_s;
260     api << area
261     
262     doc.root << api
263
264     render :text => doc.to_s, :content_type => "text/xml"
265   end
266 end