4a6237b12b3dd8cd8c71fc8bf3f9ba5697dd97e7
[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
10   if defined?(SystemTimer)
11     Timer = SystemTimer
12   else
13     require 'timeout'
14     Timer = Timeout
15   end
16
17   # The base class for API Errors.
18   class APIError < RuntimeError
19     def status
20       :internal_server_error
21     end
22
23     def to_s
24       "Generic API Error"
25     end
26   end
27
28   # Raised when an API object is not found.
29   class APINotFoundError < APIError
30     def status
31       :not_found
32     end
33
34     def to_s
35       "Object not found"
36     end
37   end
38
39   # Raised when a precondition to an API action fails sanity check.
40   class APIPreconditionFailedError < APIError
41     def initialize(message = "")
42       @message = message
43     end
44
45     def status
46       :precondition_failed
47     end
48
49     def to_s
50       "Precondition failed: #{@message}"
51     end
52   end
53
54   # Raised when to delete an already-deleted object.
55   class APIAlreadyDeletedError < APIError
56     def initialize(object = "object", object_id = "")
57       @object, @object_id = object, object_id
58     end
59
60     attr_reader :object, :object_id
61
62     def status
63       :gone
64     end
65
66     def to_s
67       "The #{object} with the id #{object_id} has already been deleted"
68     end
69   end
70
71   # Raised when the user logged in isn't the same as the changeset
72   class APIUserChangesetMismatchError < APIError
73     def status
74       :conflict
75     end
76
77     def to_s
78       "The user doesn't own that changeset"
79     end
80   end
81
82   # Raised when the changeset provided is already closed
83   class APIChangesetAlreadyClosedError < APIError
84     def initialize(changeset)
85       @changeset = changeset
86     end
87
88     attr_reader :changeset
89
90     def status
91       :conflict
92     end
93
94     def to_s
95       "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"
96     end
97   end
98
99   # Raised when a change is expecting a changeset, but the changeset doesn't exist
100   class APIChangesetMissingError < APIError
101     def status
102       :conflict
103     end
104
105     def to_s
106       "You need to supply a changeset to be able to make a change"
107     end
108   end
109
110   # Raised when a diff is uploaded containing many changeset IDs which don't match
111   # the changeset ID that the diff was uploaded to.
112   class APIChangesetMismatchError < APIError
113     def initialize(provided, allowed)
114       @provided, @allowed = provided, allowed
115     end
116
117     def status
118       :conflict
119     end
120
121     def to_s
122       "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"
123     end
124   end
125
126   # Raised when a diff upload has an unknown action. You can only have create,
127   # modify, or delete
128   class APIChangesetActionInvalid < APIError
129     def initialize(provided)
130       @provided = provided
131     end
132
133     def status
134       :bad_request
135     end
136
137     def to_s
138       "Unknown action #{@provided}, choices are create, modify, delete"
139     end
140   end
141
142   # Raised when bad XML is encountered which stops things parsing as
143   # they should.
144   class APIBadXMLError < APIError
145     def initialize(model, xml, message="")
146       @model, @xml, @message = model, xml, message
147     end
148
149     def status
150       :bad_request
151     end
152
153     def to_s
154       "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}"
155     end
156   end
157
158   # Raised when the provided version is not equal to the latest in the db.
159   class APIVersionMismatchError < APIError
160     def initialize(id, type, provided, latest)
161       @id, @type, @provided, @latest = id, type, provided, latest
162     end
163
164     attr_reader :provided, :latest, :id, :type
165
166     def status
167       :conflict
168     end
169
170     def to_s
171       "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"
172     end
173   end
174
175   # raised when a two tags have a duplicate key string in an element.
176   # this is now forbidden by the API.
177   class APIDuplicateTagsError < APIError
178     def initialize(type, id, tag_key)
179       @type, @id, @tag_key = type, id, tag_key
180     end
181
182     attr_reader :type, :id, :tag_key
183
184     def status
185       :bad_request
186     end
187
188     def to_s
189       "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"
190     end
191   end
192
193   # Raised when a way has more than the configured number of way nodes.
194   # This prevents ways from being to long and difficult to work with
195   class APITooManyWayNodesError < APIError
196     def initialize(id, provided, max)
197       @id, @provided, @max = id, provided, max
198     end
199
200     attr_reader :id, :provided, :max
201
202     def status
203       :bad_request
204     end
205
206     def to_s
207       "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"
208     end
209   end
210
211   ##
212   # raised when user input couldn't be parsed
213   class APIBadUserInput < APIError
214     def initialize(message)
215       @message = message
216     end
217
218     def status
219       :bad_request
220     end
221
222     def to_s
223       @message
224     end
225   end
226
227   ##
228   # raised when bounding box is invalid
229   class APIBadBoundingBox < APIError
230     def initialize(message)
231       @message = message
232     end
233
234     def status
235       :bad_request
236     end
237
238     def to_s
239       @message
240     end
241   end
242
243   ##
244   # raised when an API call is made using a method not supported on that URI
245   class APIBadMethodError < APIError
246     def initialize(supported_method)
247       @supported_method = supported_method
248     end
249
250     def status
251       :method_not_allowed
252     end
253
254     def to_s
255       "Only method #{@supported_method} is supported on this URI"
256     end
257   end
258
259   ##
260   # raised when an API call takes too long
261   class APITimeoutError < APIError
262     def status
263       :request_timeout
264     end
265
266     def to_s
267       "Request timed out"
268     end
269   end
270
271   ##
272   # raised when someone tries to redact a current version of
273   # an element - only historical versions can be redacted.
274   class APICannotRedactError < APIError
275     def status
276       :bad_request
277     end
278
279     def to_s
280       "Cannot redact current version of element, only historical versions may be redacted."
281     end
282   end
283
284   # Raised when the note provided is already closed
285   class APINoteAlreadyClosedError < APIError
286     def initialize(note)
287       @note = note
288     end
289
290     attr_reader :note
291
292     def status
293       :conflict
294     end
295
296     def to_s
297       "The note #{@note.id} was closed at #{@note.closed_at}"
298     end
299   end
300
301   # Raised when the note provided is already open
302   class APINoteAlreadyOpenError < APIError
303     def initialize(note)
304       @note = note
305     end
306
307     attr_reader :note
308
309     def status
310       :conflict
311     end
312
313     def to_s
314       "The note #{@note.id} is already open"
315     end
316   end
317
318   # raised when a two preferences have a duplicate key string.
319   class APIDuplicatePreferenceError < APIError
320     def initialize(key)
321       @key = key
322     end
323
324     attr_reader :key
325
326     def status
327       :bad_request
328     end
329
330     def to_s
331       "Duplicate preferences with key #{@key}"
332     end
333   end
334
335   # Helper methods for going to/from mercator and lat/lng.
336   class Mercator
337     include Math
338
339     #init me with your bounding box and the size of your image
340     def initialize(min_lat, min_lon, max_lat, max_lon, width, height)
341       xsize = xsheet(max_lon) - xsheet(min_lon)
342       ysize = ysheet(max_lat) - ysheet(min_lat)
343       xscale = xsize / width
344       yscale = ysize / height
345       scale = [xscale, yscale].max
346
347       xpad = width * scale - xsize
348       ypad = height * scale - ysize
349
350       @width = width
351       @height = height
352
353       @tx = xsheet(min_lon) - xpad / 2
354       @ty = ysheet(min_lat) - ypad / 2
355
356       @bx = xsheet(max_lon) + xpad / 2
357       @by = ysheet(max_lat) + ypad / 2
358     end
359
360     #the following two functions will give you the x/y on the entire sheet
361
362     def ysheet(lat)
363       log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
364     end
365
366     def xsheet(lon)
367       lon
368     end
369
370     #and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
371
372     def y(lat)
373       return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
374     end
375
376     def x(lon)
377       return  ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
378     end
379   end
380
381   class GreatCircle
382     include Math
383
384     # initialise with a base position
385     def initialize(lat, lon)
386       @lat = lat * PI / 180
387       @lon = lon * PI / 180
388     end
389
390     # get the distance from the base position to a given position
391     def distance(lat, lon)
392       lat = lat * PI / 180
393       lon = lon * PI / 180
394       return 6372.795 * 2 * asin(sqrt(sin((lat - @lat) / 2) ** 2 + cos(@lat) * cos(lat) * sin((lon - @lon)/2) ** 2))
395     end
396
397     # get the worst case bounds for a given radius from the base position
398     def bounds(radius)
399       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2))
400
401       begin
402         lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2))
403       rescue Errno::EDOM
404         lonradius = PI
405       end
406
407       minlat = (@lat - latradius) * 180 / PI
408       maxlat = (@lat + latradius) * 180 / PI
409       minlon = (@lon - lonradius) * 180 / PI
410       maxlon = (@lon + lonradius) * 180 / PI
411
412       return { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }
413     end
414
415     # get the SQL to use to calculate distance
416     def sql_for_distance(lat_field, lon_field)
417       "6372.795 * 2 * asin(sqrt(power(sin((radians(#{lat_field}) - #{@lat}) / 2), 2) + cos(#{@lat}) * cos(radians(#{lat_field})) * power(sin((radians(#{lon_field}) - #{@lon})/2), 2)))"
418     end
419   end
420
421   class GeoRSS
422     def initialize(feed_title='OpenStreetMap GPS Traces', feed_description='OpenStreetMap GPS Traces', feed_url='http://www.openstreetmap.org/traces/')
423       @doc = XML::Document.new
424       @doc.encoding = XML::Encoding::UTF_8
425
426       rss = XML::Node.new 'rss'
427       @doc.root = rss
428       rss['version'] = "2.0"
429       rss['xmlns:geo'] = "http://www.w3.org/2003/01/geo/wgs84_pos#"
430       @channel = XML::Node.new 'channel'
431       rss << @channel
432       title = XML::Node.new 'title'
433       title <<  feed_title
434       @channel << title
435       description_el = XML::Node.new 'description'
436       @channel << description_el
437
438       description_el << feed_description
439       link = XML::Node.new 'link'
440       link << feed_url
441       @channel << link
442       image = XML::Node.new 'image'
443       @channel << image
444       url = XML::Node.new 'url'
445       url << 'http://www.openstreetmap.org/images/mag_map-rss2.0.png'
446       image << url
447       title = XML::Node.new 'title'
448       title << "OpenStreetMap"
449       image << title
450       width = XML::Node.new 'width'
451       width << '100'
452       image << width
453       height = XML::Node.new 'height'
454       height << '100'
455       image << height
456       link = XML::Node.new 'link'
457       link << feed_url
458       image << link
459     end
460
461     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)
462       item = XML::Node.new 'item'
463
464       title = XML::Node.new 'title'
465       item << title
466       title << title_text
467       link = XML::Node.new 'link'
468       link << url
469       item << link
470
471       guid = XML::Node.new 'guid'
472       guid << url
473       item << guid
474
475       description = XML::Node.new 'description'
476       description << description_text
477       item << description
478
479       author = XML::Node.new 'author'
480       author << author_text
481       item << author
482
483       pubDate = XML::Node.new 'pubDate'
484       pubDate << timestamp.to_s(:rfc822)
485       item << pubDate
486
487       if latitude
488         lat_el = XML::Node.new 'geo:lat'
489         lat_el << latitude.to_s
490         item << lat_el
491       end
492
493       if longitude
494         lon_el = XML::Node.new 'geo:long'
495         lon_el << longitude.to_s
496         item << lon_el
497       end
498
499       @channel << item
500     end
501
502     def to_s
503       return @doc.to_s
504     end
505   end
506
507   class API
508     def get_xml_doc
509       doc = XML::Document.new
510       doc.encoding = XML::Encoding::UTF_8
511       root = XML::Node.new 'osm'
512       root['version'] = API_VERSION.to_s
513       root['generator'] = GENERATOR
514       root['copyright'] = COPYRIGHT_OWNER
515       root['attribution'] = ATTRIBUTION_URL
516       root['license'] =  LICENSE_URL
517       doc.root = root
518       return doc
519     end
520   end
521
522   def self.IPToCountry(ip_address)
523     Timer.timeout(4) do
524       ipinfo = Quova::IpInfo.new(ip_address)
525
526       if ipinfo.status == Quova::Success then
527         country = ipinfo.country_code
528       else
529         Net::HTTP.start('api.hostip.info') do |http|
530           country = http.get("/country.php?ip=#{ip_address}").body
531           country = "GB" if country == "UK"
532         end
533       end
534
535       return country.upcase
536     end
537
538     return nil
539   rescue Exception
540     return nil
541   end
542
543   def self.IPLocation(ip_address)
544     code = OSM.IPToCountry(ip_address)
545
546     if code and country = Country.find_by_code(code)
547       return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
548     end
549
550     return nil
551   end
552
553   # Parse a float, raising a specified exception on failure
554   def self.parse_float(str, klass, *args)
555     Float(str)
556   rescue
557     raise klass.new(*args)
558   end
559
560   # Construct a random token of a given length
561   def self.make_token(length = 30)
562     chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
563     token = ''
564
565     length.times do
566       token += chars[(rand * chars.length).to_i].chr
567     end
568
569     return token
570   end
571
572   # Return an encrypted version of a password
573   def self.encrypt_password(password, salt)
574     return Digest::MD5.hexdigest(password) if salt.nil?
575     return Digest::MD5.hexdigest(salt + password)
576   end
577
578   # Return an SQL fragment to select a given area of the globe
579   def self.sql_for_area(bbox, prefix = nil)
580     tilesql = QuadTile.sql_for_area(bbox, prefix)
581     bbox = bbox.to_scaled
582
583     return "#{tilesql} AND #{prefix}latitude BETWEEN #{bbox.min_lat} AND #{bbox.max_lat} " +
584                       "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"
585   end
586
587   def self.legal_text_for_country(country_code)
588     file_name = File.join(Rails.root, "config", "legales", country_code.to_s + ".yml")
589     file_name = File.join(Rails.root, "config", "legales", DEFAULT_LEGALE + ".yml") unless File.exist? file_name
590     YAML::load_file(file_name)
591   end
592 end