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