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 STATUS == :database_readonly or 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     # if the user hasn't seen the contributor terms then don't
 108     # allow editing - they have to go to the web site and see
 109     # (but can decline) the CTs to continue.
 110     if REQUIRE_TERMS_SEEN
 111       unless @user.nil? or @user.terms_seen
 112         render :text => t('application.setup_user_auth.need_to_see_terms'), :status => :forbidden
 113       end
 114     end
 115   end
 116
 117   def authorize(realm='Web Password', errormessage="Couldn't authenticate you")
 118     # make the @user object from any auth sources we have
 119     setup_user_auth
 120
 121     # handle authenticate pass/fail
 122     unless @user
 123       # no auth, the user does not exist or the password was wrong
 124       response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""
 125       render :text => errormessage, :status => :unauthorized
 126       return false
 127     end
 128   end
 129
 130   def check_database_readable(need_api = false)
 131     if STATUS == :database_offline or (need_api and STATUS == :api_offline)
 132       redirect_to :controller => 'site', :action => 'offline'
 133     end
 134   end
 135
 136   def check_database_writable(need_api = false)
 137     if STATUS == :database_offline or STATUS == :database_readonly or
 138        (need_api and (STATUS == :api_offline or STATUS == :api_readonly))
 139       redirect_to :controller => 'site', :action => 'offline'
 140     end
 141   end
 142
 143   def check_api_readable
 144     if STATUS == :database_offline or STATUS == :api_offline
 145       report_error "Database offline for maintenance", :service_unavailable
 146       return false
 147     end
 148   end
 149
 150   def check_api_writable
 151     if STATUS == :database_offline or STATUS == :database_readonly or
 152        STATUS == :api_offline or STATUS == :api_readonly
 153       report_error "Database offline for maintenance", :service_unavailable
 154       return false
 155     end
 156   end
 157
 158   def require_public_data
 159     unless @user.data_public?
 160       report_error "You must make your edits public to upload new data", :forbidden
 161       return false
 162     end
 163   end
 164
 165   # Report and error to the user
 166   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
 167   #  rather than only a status code and having the web engine make up a
 168   #  phrase from that, we can also put the error message into the status
 169   #  message. For now, rails won't let us)
 170   def report_error(message, status = :bad_request)
 171     # Todo: some sort of escaping of problem characters in the message
 172     response.headers['Error'] = message
 173
 174     if request.headers['X-Error-Format'] and
 175        request.headers['X-Error-Format'].downcase == "xml"
 176       result = OSM::API.new.get_xml_doc
 177       result.root.name = "osmError"
 178       result.root << (XML::Node.new("status") << interpret_status(status))
 179       result.root << (XML::Node.new("message") << message)
 180
 181       render :text => result.to_s, :content_type => "text/xml"
 182     else
 183       render :text => message, :status => status
 184     end
 185   end
 186
 187   def set_locale
 188     response.header['Vary'] = 'Accept-Language'
 189
 190     if @user
 191       if !@user.languages.empty?
 192         request.user_preferred_languages = @user.languages
 193         response.header['Vary'] = '*'
 194       elsif !request.user_preferred_languages.empty?
 195         @user.languages = request.user_preferred_languages
 196         @user.save
 197       end
 198     end
 199
 200     I18n.locale = request.compatible_language_from(I18n.available_locales)
 201
 202     response.headers['Content-Language'] = I18n.locale.to_s
 203   end
 204
 205   def api_call_handle_error
 206     begin
 207       yield
 208     rescue ActiveRecord::RecordNotFound => ex
 209       render :nothing => true, :status => :not_found
 210     rescue LibXML::XML::Error, ArgumentError => ex
 211       report_error ex.message, :bad_request
 212     rescue ActiveRecord::RecordInvalid => ex
 213       message = "#{ex.record.class} #{ex.record.id}: "
 214       ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
 215       report_error message, :bad_request
 216     rescue OSM::APIError => ex
 217       report_error ex.message, ex.status
 218     rescue ActionController::UnknownAction => ex
 219       raise
 220     rescue Exception => ex
 221       logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
 222       ex.backtrace.each { |l| logger.info(l) }
 223       report_error "#{ex.class}: #{ex.message}", :internal_server_error
 224     end
 225   end
 226
 227   ##
 228   # asserts that the request method is the +method+ given as a parameter
 229   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
 230   def assert_method(method)
 231     ok = request.send((method.to_s.downcase + "?").to_sym)
 232     raise OSM::APIBadMethodError.new(method) unless ok
 233   end
 234
 235   ##
 236   # wrap an api call in a timeout
 237   def api_call_timeout
 238     SystemTimer.timeout_after(API_TIMEOUT) do
 239       yield
 240     end
 241   rescue Timeout::Error
 242     raise OSM::APITimeoutError
 243   end
 244
 245   ##
 246   # wrap a web page in a timeout
 247   def web_timeout
 248     SystemTimer.timeout_after(WEB_TIMEOUT) do
 249       yield
 250     end
 251   rescue ActionView::TemplateError => ex
 252     if ex.original_exception.is_a?(Timeout::Error)
 253       render :action => "timeout"
 254     else
 255       raise
 256     end
 257   rescue Timeout::Error
 258     render :action => "timeout"
 259   end
 260
 261   ##
 262   # extend caches_action to include the parameters, locale and logged in
 263   # status in all cache keys
 264   def self.caches_action(*actions)
 265     options = actions.extract_options!
 266     cache_path = options[:cache_path] || Hash.new
 267
 268     options[:unless] = case options[:unless]
 269                        when NilClass then Array.new
 270                        when Array then options[:unless]
 271                        else unlessp = [ options[:unless] ]
 272                        end
 273
 274     options[:unless].push(Proc.new do |controller|
 275       controller.params.include?(:page)
 276     end)
 277
 278     options[:cache_path] = Proc.new do |controller|
 279       cache_path.merge(controller.params).merge(:locale => I18n.locale)
 280     end
 281
 282     actions.push(options)
 283
 284     super *actions
 285   end
 286
 287   ##
 288   # extend expire_action to expire all variants
 289   def expire_action(options = {})
 290     I18n.available_locales.each do |locale|
 291       super options.merge(:locale => locale)
 292     end
 293   end
 294
 295   ##
 296   # is the requestor logged in?
 297   def logged_in?
 298     !@user.nil?
 299   end
 300
 301 private
 302
 303   # extract authorisation credentials from headers, returns user = nil if none
 304   def get_auth_data
 305     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it
 306       authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split
 307     elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi
 308       authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split
 309     elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
 310       authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
 311     end
 312     # only basic authentication supported
 313     if authdata and authdata[0] == 'Basic'
 314       user, pass = Base64.decode64(authdata[1]).split(':',2)
 315     end
 316     return [user, pass]
 317   end
 318
 319 end