app/controllers/application_controller.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 => {:status => ["active", "confirmed", "suspended"]})
  12
  13       if @user.status == "suspended"
  14         session[:user] = nil
  15         session_expires_automatically
  16
  17         redirect_to :controller => "user", :action => "suspended"
  18       end
  19     elsif session[:token]
  20       @user = User.authenticate(:token => session[:token])
  21       session[:user] = @user.id
  22     end
  23   rescue Exception => ex
  24     logger.info("Exception authorizing user: #{ex.to_s}")
  25     @user = nil
  26   end
  27
  28   def require_user
  29     redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri unless @user
  30   end
  31
  32   ##
  33   # requires the user to be logged in by the token or HTTP methods, or have an
  34   # OAuth token with the right capability. this method is a bit of a pain to call
  35   # directly, since it's cumbersome to call filters with arguments in rails. to
  36   # make it easier to read and write the code, there are some utility methods
  37   # below.
  38   def require_capability(cap)
  39     # when the current token is nil, it means the user logged in with a different
  40     # method, otherwise an OAuth token was used, which has to be checked.
  41     unless current_token.nil?
  42       unless current_token.read_attribute(cap)
  43         render :text => "OAuth token doesn't have that capability.", :status => :forbidden
  44         return false
  45       end
  46     end
  47   end
  48
  49   ##
  50   # require the user to have cookies enabled in their browser
  51   def require_cookies
  52     if request.cookies["_osm_session"].to_s == ""
  53       if params[:cookie_test].nil?
  54         redirect_to params.merge(:cookie_test => "true")
  55         return false
  56       else
  57         flash.now[:warning] = t 'application.require_cookies.cookies_needed'
  58       end
  59     end
  60   end
  61
  62   # Utility methods to make the controller filter methods easier to read and write.
  63   def require_allow_read_prefs
  64     require_capability(:allow_read_prefs)
  65   end
  66   def require_allow_write_prefs
  67     require_capability(:allow_write_prefs)
  68   end
  69   def require_allow_write_diary
  70     require_capability(:allow_write_diary)
  71   end
  72   def require_allow_write_api
  73     require_capability(:allow_write_api)
  74   end
  75   def require_allow_read_gpx
  76     require_capability(:allow_read_gpx)
  77   end
  78   def require_allow_write_gpx
  79     require_capability(:allow_write_gpx)
  80   end
  81
  82   ##
  83   # sets up the @user object for use by other methods. this is mostly called
  84   # from the authorize method, but can be called elsewhere if authorisation
  85   # is optional.
  86   def setup_user_auth
  87     # try and setup using OAuth
  88     if oauthenticate
  89       @user = current_token.user
  90     else
  91       username, passwd = get_auth_data # parse from headers
  92       # authenticate per-scheme
  93       if username.nil?
  94         @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
  95       elsif username == 'token'
  96         @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
  97       else
  98         @user = User.authenticate(:username => username, :password => passwd) # basic auth
  99       end
 100     end
 101
 102     # check if the user has been banned
 103     unless @user.nil? or @user.active_blocks.empty?
 104       # NOTE: need slightly more helpful message than this.
 105       render :text => t('application.setup_user_auth.blocked'), :status => :forbidden
 106     end
 107   end
 108
 109   def authorize(realm='Web Password', errormessage="Couldn't authenticate you")
 110     # make the @user object from any auth sources we have
 111     setup_user_auth
 112
 113     # handle authenticate pass/fail
 114     unless @user
 115       # no auth, the user does not exist or the password was wrong
 116       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
 117       render :text => errormessage, :status => :unauthorized
 118       return false
 119     end
 120   end
 121
 122   def check_database_readable(need_api = false)
 123     if OSM_STATUS == :database_offline or (need_api and OSM_STATUS == :api_offline)
 124       redirect_to :controller => 'site', :action => 'offline'
 125     end
 126   end
 127
 128   def check_database_writable(need_api = false)
 129     if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
 130        (need_api and (OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly))
 131       redirect_to :controller => 'site', :action => 'offline'
 132     end
 133   end
 134
 135   def check_api_readable
 136     if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline
 137       response.headers['Error'] = "Database offline for maintenance"
 138       render :nothing => true, :status => :service_unavailable
 139       return false
 140     end
 141   end
 142
 143   def check_api_writable
 144     if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
 145        OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly
 146       response.headers['Error'] = "Database offline for maintenance"
 147       render :nothing => true, :status => :service_unavailable
 148       return false
 149     end
 150   end
 151
 152   def require_public_data
 153     unless @user.data_public?
 154       response.headers['Error'] = "You must make your edits public to upload new data"
 155       render :nothing => true, :status => :forbidden
 156       return false
 157     end
 158   end
 159
 160   # Report and error to the user
 161   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
 162   #  rather than only a status code and having the web engine make up a
 163   #  phrase from that, we can also put the error message into the status
 164   #  message. For now, rails won't let us)
 165   def report_error(message, status = :bad_request)
 166     # Todo: some sort of escaping of problem characters in the message
 167     response.headers['Error'] = message
 168     render :text => message, :status => status
 169   end
 170
 171   def set_locale
 172     response.header['Vary'] = 'Accept-Language'
 173
 174     if @user
 175       if !@user.languages.empty?
 176         request.user_preferred_languages = @user.languages
 177         response.header['Vary'] = '*'
 178       elsif !request.user_preferred_languages.empty?
 179         @user.languages = request.user_preferred_languages
 180         @user.save
 181       end
 182     end
 183
 184     I18n.locale = request.compatible_language_from(I18n.available_locales)
 185
 186     response.headers['Content-Language'] = I18n.locale.to_s
 187   end
 188
 189   def api_call_handle_error
 190     begin
 191       yield
 192     rescue ActiveRecord::RecordNotFound => ex
 193       render :nothing => true, :status => :not_found
 194     rescue LibXML::XML::Error, ArgumentError => ex
 195       report_error ex.message, :bad_request
 196     rescue ActiveRecord::RecordInvalid => ex
 197       message = "#{ex.record.class} #{ex.record.id}: "
 198       ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
 199       report_error message, :bad_request
 200     rescue OSM::APIError => ex
 201       report_error ex.message, ex.status
 202     rescue ActionController::UnknownAction => ex
 203       raise
 204     rescue Exception => ex
 205       logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
 206       ex.backtrace.each { |l| logger.info(l) }
 207       report_error "#{ex.class}: #{ex.message}", :internal_server_error
 208     end
 209   end
 210
 211   ##
 212   # asserts that the request method is the +method+ given as a parameter
 213   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
 214   def assert_method(method)
 215     ok = request.send((method.to_s.downcase + "?").to_sym)
 216     raise OSM::APIBadMethodError.new(method) unless ok
 217   end
 218
 219   ##
 220   # wrap an api call in a timeout
 221   def api_call_timeout
 222     SystemTimer.timeout_after(APP_CONFIG['api_timeout']) do
 223       yield
 224     end
 225   rescue Timeout::Error
 226     raise OSM::APITimeoutError
 227   end
 228
 229   ##
 230   # wrap a web page in a timeout
 231   def web_timeout
 232     SystemTimer.timeout_after(APP_CONFIG['web_timeout']) do
 233       yield
 234     end
 235   rescue ActionView::TemplateError => ex
 236     if ex.original_exception.is_a?(Timeout::Error)
 237       render :action => "timeout"
 238     else
 239       raise
 240     end
 241   rescue Timeout::Error
 242     render :action => "timeout"
 243   end
 244
 245   ##
 246   # extend caches_action to include the parameters, locale and logged in
 247   # status in all cache keys
 248   def self.caches_action(*actions)
 249     options = actions.extract_options!
 250     cache_path = options[:cache_path] || Hash.new
 251
 252     options[:cache_path] = Proc.new do |controller|
 253       user = controller.instance_variable_get("@user")
 254
 255       case
 256       when user.nil? then user = :none
 257       when user.display_name == controller.params[:display_name] then user = :self
 258       when user.administrator? then user = :administrator
 259       when user.moderator? then user = :moderator
 260       else user = :other
 261       end
 262
 263       cache_path.merge(controller.params).merge(:locale => I18n.locale, :user => user)
 264     end
 265
 266     actions.push(options)
 267
 268     super *actions
 269   end
 270
 271   ##
 272   # extend expire_action to expire all variants
 273   def expire_action(options = {})
 274     path = ActionCachePath.path_for(self, options, false).gsub('?', '.').gsub(':', '.')
 275     expire_fragment(Regexp.new(Regexp.escape(path) + "\\..*"))
 276   end
 277
 278   ##
 279   # is the requestor logged in?
 280   def logged_in?
 281     !@user.nil?
 282   end
 283
 284 private
 285
 286   # extract authorisation credentials from headers, returns user = nil if none
 287   def get_auth_data
 288     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it
 289       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split
 290     elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi
 291       authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split
 292     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
 293       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
 294     end
 295     # only basic authentication supported
 296     if authdata and authdata[0] == 'Basic'
 297       user, pass = Base64.decode64(authdata[1]).split(':',2)
 298     end
 299     return [user, pass]
 300   end
 301
 302 end