Adding an extra test to make sure that the correct response is returned when an inval...
[rails.git] / lib / osm.rb
1 # The OSM module provides support functions for OSM.
2 module OSM
3
4   require 'time'
5   require 'rexml/parsers/sax2parser'
6   require 'rexml/text'
7   require 'xml/libxml'
8   require 'digest/md5'
9   require 'RMagick'
10
11   # The base class for API Errors.
12   class APIError < RuntimeError
13     def render_opts
14       { :text => "", :status => :internal_server_error }
15     end
16   end
17
18   # Raised when an API object is not found.
19   class APINotFoundError < APIError
20   end
21
22   # Raised when a precondition to an API action fails sanity check.
23   class APIPreconditionFailedError < APIError
24     def render_opts
25       { :text => "", :status => :precondition_failed }
26     end
27   end
28
29   # Raised when to delete an already-deleted object.
30   class APIAlreadyDeletedError < APIError
31     def render_opts
32       { :text => "", :status => :gone }
33     end
34   end
35
36   # Raised when the user logged in isn't the same as the changeset
37   class APIUserChangesetMismatchError < APIError
38     def render_opts
39       { :text => "The user doesn't own that changeset", :status => :conflict }
40     end
41   end
42
43   # Raised when the changeset provided is already closed
44   class APIChangesetAlreadyClosedError < APIError
45     def render_opts
46       { :text => "The supplied changeset has already been closed", :status => :conflict }
47     end
48   end
49   
50   # Raised when a change is expecting a changeset, but the changeset doesn't exist
51   class APIChangesetMissingError < APIError
52     def render_opts
53       { :text => "You need to supply a changeset to be able to make a change", :status => :conflict }
54     end
55   end
56
57   # Raised when a diff is uploaded containing many changeset IDs which don't match
58   # the changeset ID that the diff was uploaded to.
59   class APIChangesetMismatchError < APIError
60     def initialize(provided, allowed)
61       @provided, @allowed = provided, allowed
62     end
63     
64     def render_opts
65       { :text => "Changeset mismatch: Provided #{@provided} but only " +
66         "#{@allowed} is allowed.", :status => :conflict }
67     end
68   end
69   
70   # Raised when a diff upload has an unknown action. You can only have create,
71   # modify, or delete
72   class APIChangesetActionInvalid < APIError
73     def initialize(provided)
74       @provided = provided
75     end
76     
77     def render_opts
78       { :text => "Unknown action #{@provided}, choices are create, modify, delete.",
79       :status => :bad_request }
80     end
81   end
82
83   # Raised when bad XML is encountered which stops things parsing as
84   # they should.
85   class APIBadXMLError < APIError
86     def initialize(model, xml)
87       @model, @xml = model, xml
88     end
89
90     def render_opts
91       { :text => "Cannot parse valid #{@model} from xml string #{@xml}",
92         :status => :bad_request }
93     end
94   end
95
96   # Raised when the provided version is not equal to the latest in the db.
97   class APIVersionMismatchError < APIError
98     def initialize(provided, latest)
99       @provided, @latest = provided, latest
100     end
101
102     attr_reader :provided, :latest
103
104     def render_opts
105       { :text => "Version mismatch: Provided " + provided.to_s +
106       ", server had: " + latest.to_s, :status => :conflict }
107     end
108   end
109
110   # raised when a two tags have a duplicate key string in an element.
111   # this is now forbidden by the API.
112   class APIDuplicateTagsError < APIError
113     def initialize(type, id, tag_key)
114       @type, @id, @tag_key = type, id, tag_key
115     end
116
117     attr_reader :type, :id, :tag_key
118
119     def render_opts
120       { :text => "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}.",
121         :status => :bad_request }
122     end
123   end
124   
125   # Raised when a way has more than the configured number of way nodes.
126   # This prevents ways from being to long and difficult to work with
127   class APITooManyWayNodesError < APIError
128     def initialize(provided, max)
129       @provided, @max = provided, max
130     end
131     
132     attr_reader :provided, :max
133     
134     def render_opts
135       { :text => "You tried to add #{provided} nodes to the way, however only #{max} are allowed",
136       :status => :bad_request }
137     end
138   end
139
140   # Helper methods for going to/from mercator and lat/lng.
141   class Mercator
142     include Math
143
144     #init me with your bounding box and the size of your image
145     def initialize(min_lat, min_lon, max_lat, max_lon, width, height)
146       xsize = xsheet(max_lon) - xsheet(min_lon)
147       ysize = ysheet(max_lat) - ysheet(min_lat)
148       xscale = xsize / width
149       yscale = ysize / height
150       scale = [xscale, yscale].max
151
152       xpad = width * scale - xsize
153       ypad = height * scale - ysize
154
155       @width = width
156       @height = height
157
158       @tx = xsheet(min_lon) - xpad / 2
159       @ty = ysheet(min_lat) - ypad / 2
160
161       @bx = xsheet(max_lon) + xpad / 2
162       @by = ysheet(max_lat) + ypad / 2
163     end
164
165     #the following two functions will give you the x/y on the entire sheet
166
167     def ysheet(lat)
168       log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
169     end
170
171     def xsheet(lon)
172       lon
173     end
174
175     #and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
176
177     def y(lat)
178       return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
179     end
180
181     def x(lon)
182       return  ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
183     end
184   end
185
186   class GreatCircle
187     include Math
188
189     # initialise with a base position
190     def initialize(lat, lon)
191       @lat = lat * PI / 180
192       @lon = lon * PI / 180
193     end
194
195     # get the distance from the base position to a given position
196     def distance(lat, lon)
197       lat = lat * PI / 180
198       lon = lon * PI / 180
199       return 6372.795 * 2 * asin(sqrt(sin((lat - @lat) / 2) ** 2 + cos(@lat) * cos(lat) * sin((lon - @lon)/2) ** 2))
200     end
201
202     # get the worst case bounds for a given radius from the base position
203     def bounds(radius)
204       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2))
205       lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2))
206       minlat = (@lat - latradius) * 180 / PI
207       maxlat = (@lat + latradius) * 180 / PI
208       minlon = (@lon - lonradius) * 180 / PI
209       maxlon = (@lon + lonradius) * 180 / PI
210       return { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }
211     end
212   end
213
214   class GeoRSS
215     def initialize(feed_title='OpenStreetMap GPS Traces', feed_description='OpenStreetMap GPS Traces', feed_url='http://www.openstreetmap.org/traces/')
216       @doc = XML::Document.new
217       @doc.encoding = 'UTF-8' 
218
219       rss = XML::Node.new 'rss'
220       @doc.root = rss
221       rss['version'] = "2.0"
222       rss['xmlns:geo'] = "http://www.w3.org/2003/01/geo/wgs84_pos#"
223       @channel = XML::Node.new 'channel'
224       rss << @channel
225       title = XML::Node.new 'title'
226       title <<  feed_title
227       @channel << title
228       description_el = XML::Node.new 'description'
229       @channel << description_el
230
231       description_el << feed_description
232       link = XML::Node.new 'link'
233       link << feed_url
234       @channel << link
235       image = XML::Node.new 'image'
236       @channel << image
237       url = XML::Node.new 'url'
238       url << 'http://www.openstreetmap.org/images/mag_map-rss2.0.png'
239       image << url
240       title = XML::Node.new 'title'
241       title << "OpenStreetMap"
242       image << title
243       width = XML::Node.new 'width'
244       width << '100'
245       image << width
246       height = XML::Node.new 'height'
247       height << '100'
248       image << height
249       link = XML::Node.new 'link'
250       link << feed_url
251       image << link
252     end
253
254     def add(latitude=0, longitude=0, title_text='dummy title', author_text='anonymous', url='http://www.example.com/', description_text='dummy description', timestamp=DateTime.now)
255       item = XML::Node.new 'item'
256
257       title = XML::Node.new 'title'
258       item << title
259       title << title_text
260       link = XML::Node.new 'link'
261       link << url
262       item << link
263
264       guid = XML::Node.new 'guid'
265       guid << url
266       item << guid
267
268       description = XML::Node.new 'description'
269       description << description_text
270       item << description
271
272       author = XML::Node.new 'author'
273       author << author_text
274       item << author
275
276       pubDate = XML::Node.new 'pubDate'
277       pubDate << timestamp.to_s(:rfc822)
278       item << pubDate
279
280       if latitude
281         lat_el = XML::Node.new 'geo:lat'
282         lat_el << latitude.to_s
283         item << lat_el
284       end
285
286       if longitude
287         lon_el = XML::Node.new 'geo:long'
288         lon_el << longitude.to_s
289         item << lon_el
290       end
291
292       @channel << item
293     end
294
295     def to_s
296       return @doc.to_s
297     end
298   end
299
300   class API
301     def get_xml_doc
302       doc = XML::Document.new
303       doc.encoding = 'UTF-8' 
304       root = XML::Node.new 'osm'
305       root['version'] = API_VERSION
306       root['generator'] = GENERATOR
307       doc.root = root
308       return doc
309     end
310   end
311
312   def self.IPLocation(ip_address)
313     Timeout::timeout(4) do
314       Net::HTTP.start('api.hostip.info') do |http|
315         country = http.get("/country.php?ip=#{ip_address}").body
316         country = "GB" if country == "UK"
317         Net::HTTP.start('ws.geonames.org') do |http|
318           xml = REXML::Document.new(http.get("/countryInfo?country=#{country}").body)
319           xml.elements.each("geonames/country") do |ele|
320             minlon = ele.get_text("bBoxWest").to_s
321             minlat = ele.get_text("bBoxSouth").to_s
322             maxlon = ele.get_text("bBoxEast").to_s
323             maxlat = ele.get_text("bBoxNorth").to_s
324             return { :minlon => minlon, :minlat => minlat, :maxlon => maxlon, :maxlat => maxlat }
325           end
326         end
327       end
328     end
329
330     return nil
331   rescue Exception
332     return nil
333   end
334
335   # Construct a random token of a given length
336   def self.make_token(length = 30)
337     chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
338     token = ''
339
340     length.times do
341       token += chars[(rand * chars.length).to_i].chr
342     end
343
344     return token
345   end
346
347   # Return an encrypted version of a password
348   def self.encrypt_password(password, salt)
349     return Digest::MD5.hexdigest(password) if salt.nil?
350     return Digest::MD5.hexdigest(salt + password)
351   end
352
353   # Return an SQL fragment to select a given area of the globe
354   def self.sql_for_area(minlat, minlon, maxlat, maxlon, prefix = nil)
355     tilesql = QuadTile.sql_for_area(minlat, minlon, maxlat, maxlon, prefix)
356     minlat = (minlat * 10000000).round
357     minlon = (minlon * 10000000).round
358     maxlat = (maxlat * 10000000).round
359     maxlon = (maxlon * 10000000).round
360
361     return "#{tilesql} AND #{prefix}latitude BETWEEN #{minlat} AND #{maxlat} AND #{prefix}longitude BETWEEN #{minlon} AND #{maxlon}"
362   end
363
364
365 end