Fix gap for iconless nodes in history view
[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 a two preferences have a duplicate key string.
302   class APIDuplicatePreferenceError < APIError
303     def initialize(key)
304       @key = key
305     end
306
307     attr_reader :key
308
309     def status
310       :bad_request
311     end
312
313     def to_s
314       "Duplicate preferences with key #{@key}"
315     end
316   end
317
318   # Helper methods for going to/from mercator and lat/lng.
319   class Mercator
320     include Math
321
322     #init me with your bounding box and the size of your image
323     def initialize(min_lat, min_lon, max_lat, max_lon, width, height)
324       xsize = xsheet(max_lon) - xsheet(min_lon)
325       ysize = ysheet(max_lat) - ysheet(min_lat)
326       xscale = xsize / width
327       yscale = ysize / height
328       scale = [xscale, yscale].max
329
330       xpad = width * scale - xsize
331       ypad = height * scale - ysize
332
333       @width = width
334       @height = height
335
336       @tx = xsheet(min_lon) - xpad / 2
337       @ty = ysheet(min_lat) - ypad / 2
338
339       @bx = xsheet(max_lon) + xpad / 2
340       @by = ysheet(max_lat) + ypad / 2
341     end
342
343     #the following two functions will give you the x/y on the entire sheet
344
345     def ysheet(lat)
346       log(tan(PI / 4 + (lat * PI / 180 / 2))) / (PI / 180)
347     end
348
349     def xsheet(lon)
350       lon
351     end
352
353     #and these two will give you the right points on your image. all the constants can be reduced to speed things up. FIXME
354
355     def y(lat)
356       return @height - ((ysheet(lat) - @ty) / (@by - @ty) * @height)
357     end
358
359     def x(lon)
360       return  ((xsheet(lon) - @tx) / (@bx - @tx) * @width)
361     end
362   end
363
364   class GreatCircle
365     include Math
366
367     # initialise with a base position
368     def initialize(lat, lon)
369       @lat = lat * PI / 180
370       @lon = lon * PI / 180
371     end
372
373     # get the distance from the base position to a given position
374     def distance(lat, lon)
375       lat = lat * PI / 180
376       lon = lon * PI / 180
377       return 6372.795 * 2 * asin(sqrt(sin((lat - @lat) / 2) ** 2 + cos(@lat) * cos(lat) * sin((lon - @lon)/2) ** 2))
378     end
379
380     # get the worst case bounds for a given radius from the base position
381     def bounds(radius)
382       latradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2))
383
384       begin
385         lonradius = 2 * asin(sqrt(sin(radius / 6372.795 / 2) ** 2 / cos(@lat) ** 2))
386       rescue Errno::EDOM
387         lonradius = PI
388       end
389
390       minlat = (@lat - latradius) * 180 / PI
391       maxlat = (@lat + latradius) * 180 / PI
392       minlon = (@lon - lonradius) * 180 / PI
393       maxlon = (@lon + lonradius) * 180 / PI
394
395       return { :minlat => minlat, :maxlat => maxlat, :minlon => minlon, :maxlon => maxlon }
396     end
397
398     # get the SQL to use to calculate distance
399     def sql_for_distance(lat_field, lon_field)
400       "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)))"
401     end
402   end
403
404   class GeoRSS
405     def initialize(feed_title='OpenStreetMap GPS Traces', feed_description='OpenStreetMap GPS Traces', feed_url='http://www.openstreetmap.org/traces/')
406       @doc = XML::Document.new
407       @doc.encoding = XML::Encoding::UTF_8
408
409       rss = XML::Node.new 'rss'
410       @doc.root = rss
411       rss['version'] = "2.0"
412       rss['xmlns:geo'] = "http://www.w3.org/2003/01/geo/wgs84_pos#"
413       @channel = XML::Node.new 'channel'
414       rss << @channel
415       title = XML::Node.new 'title'
416       title <<  feed_title
417       @channel << title
418       description_el = XML::Node.new 'description'
419       @channel << description_el
420
421       description_el << feed_description
422       link = XML::Node.new 'link'
423       link << feed_url
424       @channel << link
425       image = XML::Node.new 'image'
426       @channel << image
427       url = XML::Node.new 'url'
428       url << 'http://www.openstreetmap.org/images/mag_map-rss2.0.png'
429       image << url
430       title = XML::Node.new 'title'
431       title << "OpenStreetMap"
432       image << title
433       width = XML::Node.new 'width'
434       width << '100'
435       image << width
436       height = XML::Node.new 'height'
437       height << '100'
438       image << height
439       link = XML::Node.new 'link'
440       link << feed_url
441       image << link
442     end
443
444     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)
445       item = XML::Node.new 'item'
446
447       title = XML::Node.new 'title'
448       item << title
449       title << title_text
450       link = XML::Node.new 'link'
451       link << url
452       item << link
453
454       guid = XML::Node.new 'guid'
455       guid << url
456       item << guid
457
458       description = XML::Node.new 'description'
459       description << description_text
460       item << description
461
462       author = XML::Node.new 'author'
463       author << author_text
464       item << author
465
466       pubDate = XML::Node.new 'pubDate'
467       pubDate << timestamp.to_s(:rfc822)
468       item << pubDate
469
470       if latitude
471         lat_el = XML::Node.new 'geo:lat'
472         lat_el << latitude.to_s
473         item << lat_el
474       end
475
476       if longitude
477         lon_el = XML::Node.new 'geo:long'
478         lon_el << longitude.to_s
479         item << lon_el
480       end
481
482       @channel << item
483     end
484
485     def to_s
486       return @doc.to_s
487     end
488   end
489
490   class API
491     def get_xml_doc
492       doc = XML::Document.new
493       doc.encoding = XML::Encoding::UTF_8
494       root = XML::Node.new 'osm'
495       root['version'] = API_VERSION.to_s
496       root['generator'] = GENERATOR
497       root['copyright'] = COPYRIGHT_OWNER
498       root['attribution'] = ATTRIBUTION_URL
499       root['license'] =  LICENSE_URL
500       doc.root = root
501       return doc
502     end
503   end
504
505   def self.IPToCountry(ip_address)
506     Timer.timeout(4) do
507       ipinfo = Quova::IpInfo.new(ip_address)
508
509       if ipinfo.status == Quova::Success then
510         country = ipinfo.country_code
511       else
512         Net::HTTP.start('api.hostip.info') do |http|
513           country = http.get("/country.php?ip=#{ip_address}").body
514           country = "GB" if country == "UK"
515         end
516       end
517
518       return country.upcase
519     end
520
521     return nil
522   rescue Exception
523     return nil
524   end
525
526   def self.IPLocation(ip_address)
527     code = OSM.IPToCountry(ip_address)
528
529     if code and country = Country.find_by_code(code)
530       return { :minlon => country.min_lon, :minlat => country.min_lat, :maxlon => country.max_lon, :maxlat => country.max_lat }
531     end
532
533     return nil
534   end
535
536   # Construct a random token of a given length
537   def self.make_token(length = 30)
538     chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
539     token = ''
540
541     length.times do
542       token += chars[(rand * chars.length).to_i].chr
543     end
544
545     return token
546   end
547
548   # Return an encrypted version of a password
549   def self.encrypt_password(password, salt)
550     return Digest::MD5.hexdigest(password) if salt.nil?
551     return Digest::MD5.hexdigest(salt + password)
552   end
553
554   # Return an SQL fragment to select a given area of the globe
555   def self.sql_for_area(bbox, prefix = nil)
556     tilesql = QuadTile.sql_for_area(bbox, prefix)
557     bbox = bbox.to_scaled
558
559     return "#{tilesql} AND #{prefix}latitude BETWEEN #{bbox.min_lat} AND #{bbox.max_lat} " +
560                       "AND #{prefix}longitude BETWEEN #{bbox.min_lon} AND #{bbox.max_lon}"
561   end
562
563   def self.legal_text_for_country(country_code)
564     file_name = File.join(Rails.root, "config", "legales", country_code.to_s + ".yml")
565     file_name = File.join(Rails.root, "config", "legales", DEFAULT_LEGALE + ".yml") unless File.exist? file_name
566     YAML::load_file(file_name)
567   end
568 end