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