579c50e95a725217070beb7532d2880899636c5d
[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_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   def authorize(realm='Web Password', errormessage="Couldn't authenticate you") 
26     username, passwd = get_auth_data # parse from headers
27     # authenticate per-scheme
28     if username.nil?
29       @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
30     elsif username == 'token' 
31       @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
32     else
33       @user = User.authenticate(:username => username, :password => passwd) # basic auth
34     end
35
36     # handle authenticate pass/fail
37     unless @user
38       # no auth, the user does not exist or the password was wrong
39       response.headers["Status"] = "Unauthorized" 
40       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 
41       render :text => errormessage, :status => :unauthorized
42       return false
43     end 
44   end 
45
46   def check_database_availability(need_api = false)
47     if OSM_STATUS == :database_offline or (need_api and OSM_STATUS == :api_offline)
48       redirect_to :controller => 'site', :action => 'offline'
49     end
50   end
51
52   def check_read_availability
53     if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline
54       response.headers['Error'] = "Database offline for maintenance"
55       render :nothing => true, :status => :service_unavailable
56       return false
57     end
58   end
59
60   def check_write_availability
61     if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly
62       response.headers['Error'] = "Database offline for maintenance"
63       render :nothing => true, :status => :service_unavailable
64       return false
65     end
66   end
67
68   # Report and error to the user
69   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
70   #  rather than only a status code and having the web engine make up a 
71   #  phrase from that, we can also put the error message into the status
72   #  message. For now, rails won't let us)
73   def report_error(message)
74     render :text => message, :status => :bad_request
75     # Todo: some sort of escaping of problem characters in the message
76     response.headers['Error'] = message
77   end
78
79 private 
80
81   # extract authorisation credentials from headers, returns user = nil if none
82   def get_auth_data 
83     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
84       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 
85     elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi 
86       authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split 
87     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
88       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
89     end 
90     # only basic authentication supported
91     if authdata and authdata[0] == 'Basic' 
92       user, pass = Base64.decode64(authdata[1]).split(':',2)
93     end 
94     return [user, pass] 
95   end 
96
97 end