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