Add a global timeout that is applied to most API requests.
[rails.git] / app / controllers / application.rb
1 # Filters added to this controller will be run for all controllers in the application.
2 # Likewise, all the methods added will be available for all controllers.
3 class ApplicationController < ActionController::Base
4
5   if OSM_STATUS == :database_readonly or OSM_STATUS == :database_offline
6     session :off
7   end
8
9   def authorize_web
10     if session[:user]
11       @user = User.find(session[:user], :conditions => {:visible => true})
12     elsif session[:token]
13       @user = User.authenticate(:token => session[:token])
14       session[:user] = @user.id
15     end
16   rescue Exception => ex
17     logger.info("Exception authorizing user: #{ex.to_s}")
18     @user = nil
19   end
20
21   def require_user
22     redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri unless @user
23   end
24
25   ##
26   # sets up the @user object for use by other methods. this is mostly called
27   # from the authorize method, but can be called elsewhere if authorisation
28   # is optional.
29   def setup_user_auth
30     username, passwd = get_auth_data # parse from headers
31     # authenticate per-scheme
32     if username.nil?
33       @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
34     elsif username == 'token' 
35       @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
36     else
37       @user = User.authenticate(:username => username, :password => passwd) # basic auth
38     end
39   end
40
41   def authorize(realm='Web Password', errormessage="Couldn't authenticate you") 
42     # make the @user object from any auth sources we have
43     setup_user_auth
44
45     # handle authenticate pass/fail
46     unless @user
47       # no auth, the user does not exist or the password was wrong
48       response.headers["Status"] = "Unauthorized" 
49       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 
50       render :text => errormessage, :status => :unauthorized
51       return false
52     end 
53   end 
54
55   def check_database_readable(need_api = false)
56     if OSM_STATUS == :database_offline or (need_api and OSM_STATUS == :api_offline)
57       redirect_to :controller => 'site', :action => 'offline'
58     end
59   end
60
61   def check_database_writable(need_api = false)
62     if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
63        (need_api and (OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly))
64       redirect_to :controller => 'site', :action => 'offline'
65     end
66   end
67
68   def check_api_readable
69     if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline
70       response.headers['Error'] = "Database offline for maintenance"
71       render :nothing => true, :status => :service_unavailable
72       return false
73     end
74   end
75
76   def check_api_writable
77     if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
78        OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly
79       response.headers['Error'] = "Database offline for maintenance"
80       render :nothing => true, :status => :service_unavailable
81       return false
82     end
83   end
84
85   def require_public_data
86     unless @user.data_public?
87       response.headers['Error'] = "You must make your edits public to upload new data"
88       render :nothing => true, :status => :forbidden
89       return false
90     end
91   end
92
93   # Report and error to the user
94   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
95   #  rather than only a status code and having the web engine make up a 
96   #  phrase from that, we can also put the error message into the status
97   #  message. For now, rails won't let us)
98   def report_error(message, status = :bad_request)
99     # Todo: some sort of escaping of problem characters in the message
100     response.headers['Error'] = message
101     render :text => message, :status => status
102   end
103
104   def api_call_handle_error
105     begin
106       yield
107     rescue ActiveRecord::RecordNotFound => ex
108       render :nothing => true, :status => :not_found
109     rescue LibXML::XML::Error, ArgumentError => ex
110       report_error ex.message, :bad_request
111     rescue ActiveRecord::RecordInvalid => ex
112       message = "#{ex.record.class} #{ex.record.id}: "
113       ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
114       report_error message, :bad_request
115     rescue OSM::APIError => ex
116       render_opts = ex.render_opts
117       report_error render_opts[:text], render_opts[:status]
118     end
119   end
120
121   ##
122   # asserts that the request method is the +method+ given as a parameter
123   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
124   def assert_method(method)
125     ok = request.send((method.to_s.downcase + "?").to_sym)
126     raise OSM::APIBadMethodError.new(method) unless ok
127   end
128
129   def api_call_timeout
130     Timeout::timeout(APP_CONFIG['api_timeout'], OSM::APITimeoutError) do
131       yield
132     end
133   end
134
135 private 
136
137   # extract authorisation credentials from headers, returns user = nil if none
138   def get_auth_data 
139     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
140       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 
141     elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi 
142       authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split 
143     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
144       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
145     end 
146     # only basic authentication supported
147     if authdata and authdata[0] == 'Basic' 
148       user, pass = Base64.decode64(authdata[1]).split(':',2)
149     end 
150     return [user, pass] 
151   end 
152
153 end