Add support for domain based ACLs

[rails.git] / app / controllers / application_controller.rb

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 66ab92a5cf379fa374d986a99261c72f170ee5d1..a90a295fb35349c397784599a437ce5941ab45cf 100644 (file)
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -1,25 +1,56 @@
-# Filters added to this controller will be run for all controllers in the application.
-# Likewise, all the methods added will be available for all controllers.

 class ApplicationController < ActionController::Base
 
 class ApplicationController < ActionController::Base
 

-  if OSM_STATUS == :database_readonly or OSM_STATUS == :database_offline
-    session :off
+  protect_from_forgery
+
+  if STATUS == :database_readonly or STATUS == :database_offline
+    after_filter :clear_session
+    wrap_parameters false
+
+    def clear_session
+      session.clear
+    end
+
+    def self.cache_sweeper(*sweepers)
+    end

   end
 
   def authorize_web
     if session[:user]
   end
 
   def authorize_web
     if session[:user]

-      @user = User.find(session[:user], :conditions => {:visible => true})
+      @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
+
+      if @user.display_name != cookies["_osm_username"]
+        logger.info "Session user '#{@user.display_name}' does not match cookie user '#{cookies['_osm_username']}'"
+        reset_session
+        @user = nil
+      elsif @user.status == "suspended"
+        session.delete(:user)
+        session_expires_automatically
+
+        redirect_to :controller => "user", :action => "suspended"
+
+        # don't allow access to any auth-requiring part of the site unless
+        # the new CTs have been seen (and accept/decline chosen).
+      elsif !@user.terms_seen and flash[:skip_terms].nil?
+        flash[:notice] = t 'user.terms.you need to accept or decline'
+        if params[:referer]
+          redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
+        else
+          redirect_to :controller => "user", :action => "terms", :referer => request.fullpath
+        end
+      end

     elsif session[:token]
     elsif session[:token]

-      @user = User.authenticate(:token => session[:token])
-      session[:user] = @user.id
+      if @user = User.authenticate(:token => session[:token])
+        session[:user] = @user.id
+      end

     end
   rescue Exception => ex
     logger.info("Exception authorizing user: #{ex.to_s}")
     end
   rescue Exception => ex
     logger.info("Exception authorizing user: #{ex.to_s}")

+    reset_session

     @user = nil
   end
 
   def require_user
     @user = nil
   end
 
   def require_user

-    redirect_to :controller => 'user', :action => 'login', :referer => request.request_uri unless @user
+    redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath unless @user

   end
 
   ##
   end
 
   ##


@@ -33,7 +64,7 @@ class ApplicationController < ActionController::Base
     # method, otherwise an OAuth token was used, which has to be checked.
     unless current_token.nil?
       unless current_token.read_attribute(cap)
     # method, otherwise an OAuth token was used, which has to be checked.
     unless current_token.nil?
       unless current_token.read_attribute(cap)

-        render :text => "OAuth token doesn't have that capability.", :status => :forbidden
+        report_error "OAuth token doesn't have that capability.", :forbidden

         return false
       end
     end
         return false
       end
     end


@@ -44,11 +75,14 @@ class ApplicationController < ActionController::Base
   def require_cookies
     if request.cookies["_osm_session"].to_s == ""
       if params[:cookie_test].nil?
   def require_cookies
     if request.cookies["_osm_session"].to_s == ""
       if params[:cookie_test].nil?

+        session[:cookie_test] = true

         redirect_to params.merge(:cookie_test => "true")
         return false
       else
         flash.now[:warning] = t 'application.require_cookies.cookies_needed'
       end
         redirect_to params.merge(:cookie_test => "true")
         return false
       else
         flash.now[:warning] = t 'application.require_cookies.cookies_needed'
       end

+    else
+      session.delete(:cookie_test)

     end
   end
 
     end
   end
 


@@ -64,6 +98,11 @@ class ApplicationController < ActionController::Base
   end
   def require_allow_write_api
     require_capability(:allow_write_api)
   end
   def require_allow_write_api
     require_capability(:allow_write_api)

+
+    if REQUIRE_TERMS_AGREED and @user.terms_agreed.nil?
+      report_error "You must accept the contributor terms before you can edit.", :forbidden
+      return false
+    end

   end
   def require_allow_read_gpx
     require_capability(:allow_read_gpx)
   end
   def require_allow_read_gpx
     require_capability(:allow_read_gpx)


@@ -78,9 +117,7 @@ class ApplicationController < ActionController::Base
   # is optional.
   def setup_user_auth
     # try and setup using OAuth
   # is optional.
   def setup_user_auth
     # try and setup using OAuth

-    if oauthenticate
-      @user = current_token.user
-    else
+    if not Authenticator.new(self, [:token]).allow?

       username, passwd = get_auth_data # parse from headers
       # authenticate per-scheme
       if username.nil?
       username, passwd = get_auth_data # parse from headers
       # authenticate per-scheme
       if username.nil?


@@ -92,10 +129,21 @@ class ApplicationController < ActionController::Base
       end
     end
 
       end
     end
 

-    # check if the user has been banned
-    unless @user.nil? or @user.active_blocks.empty?
-      # NOTE: need slightly more helpful message than this.
-      render :text => t('application.setup_user_auth.blocked'), :status => :forbidden
+    # have we identified the user?
+    if @user
+      # check if the user has been banned
+      if not  @user.active_blocks.empty?
+        # NOTE: need slightly more helpful message than this.
+        report_error t('application.setup_user_auth.blocked'), :forbidden
+      end
+
+      # if the user hasn't seen the contributor terms then don't
+      # allow editing - they have to go to the web site and see
+      # (but can decline) the CTs to continue.
+      if REQUIRE_TERMS_SEEN and not @user.terms_seen and flash[:skip_terms].nil?
+        set_locale
+        report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden
+      end

     end
   end
 
     end
   end
 


@@ -113,39 +161,36 @@ class ApplicationController < ActionController::Base
   end 
 
   def check_database_readable(need_api = false)
   end 
 
   def check_database_readable(need_api = false)

-    if OSM_STATUS == :database_offline or (need_api and OSM_STATUS == :api_offline)
+    if STATUS == :database_offline or (need_api and STATUS == :api_offline)

       redirect_to :controller => 'site', :action => 'offline'
     end
   end
 
   def check_database_writable(need_api = false)
       redirect_to :controller => 'site', :action => 'offline'
     end
   end
 
   def check_database_writable(need_api = false)

-    if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
-       (need_api and (OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly))
+    if STATUS == :database_offline or STATUS == :database_readonly or
+       (need_api and (STATUS == :api_offline or STATUS == :api_readonly))

       redirect_to :controller => 'site', :action => 'offline'
     end
   end
 
   def check_api_readable
       redirect_to :controller => 'site', :action => 'offline'
     end
   end
 
   def check_api_readable

-    if OSM_STATUS == :database_offline or OSM_STATUS == :api_offline
-      response.headers['Error'] = "Database offline for maintenance"
-      render :nothing => true, :status => :service_unavailable
+    if STATUS == :database_offline or STATUS == :api_offline
+      report_error "Database offline for maintenance", :service_unavailable

       return false
     end
   end
 
   def check_api_writable
       return false
     end
   end
 
   def check_api_writable

-    if OSM_STATUS == :database_offline or OSM_STATUS == :database_readonly or
-       OSM_STATUS == :api_offline or OSM_STATUS == :api_readonly
-      response.headers['Error'] = "Database offline for maintenance"
-      render :nothing => true, :status => :service_unavailable
+    if STATUS == :database_offline or STATUS == :database_readonly or
+       STATUS == :api_offline or STATUS == :api_readonly
+      report_error "Database offline for maintenance", :service_unavailable

       return false
     end
   end
 
   def require_public_data
     unless @user.data_public?
       return false
     end
   end
 
   def require_public_data
     unless @user.data_public?

-      response.headers['Error'] = "You must make your edits public to upload new data"
-      render :nothing => true, :status => :forbidden
+      report_error "You must make your edits public to upload new data", :forbidden

       return false
     end
   end
       return false
     end
   end


@@ -158,7 +203,18 @@ class ApplicationController < ActionController::Base
   def report_error(message, status = :bad_request)
     # Todo: some sort of escaping of problem characters in the message
     response.headers['Error'] = message
   def report_error(message, status = :bad_request)
     # Todo: some sort of escaping of problem characters in the message
     response.headers['Error'] = message

-    render :text => message, :status => status
+
+    if request.headers['X-Error-Format'] and
+       request.headers['X-Error-Format'].downcase == "xml"
+      result = OSM::API.new.get_xml_doc
+      result.root.name = "osmError"
+      result.root << (XML::Node.new("status") << "#{Rack::Utils.status_code(status)} #{Rack::Utils::HTTP_STATUS_CODES[status]}")
+      result.root << (XML::Node.new("message") << message)
+
+      render :text => result.to_s, :content_type => "text/xml"
+    else
+      render :text => message, :status => status
+    end

   end
   
   def set_locale
   end
   
   def set_locale


@@ -174,7 +230,25 @@ class ApplicationController < ActionController::Base
       end
     end
 
       end
     end
 

-    I18n.locale = request.compatible_language_from(I18n.available_locales)
+    if request.compatible_language_from(I18n.available_locales).nil?
+      request.user_preferred_languages = request.user_preferred_languages.collect do |pl|
+        pls = [ pl ]
+
+        while pl.match(/^(.*)-[^-]+$/)
+          pls.push($1) if I18n.available_locales.include?($1.to_sym)
+          pl = $1
+        end
+
+        pls
+      end.flatten
+
+      if @user and not request.compatible_language_from(I18n.available_locales).nil?
+        @user.languages = request.user_preferred_languages
+        @user.save        
+      end
+    end
+
+    I18n.locale = request.compatible_language_from(I18n.available_locales) || I18n.default_locale

 
     response.headers['Content-Language'] = I18n.locale.to_s
   end
 
     response.headers['Content-Language'] = I18n.locale.to_s
   end


@@ -192,6 +266,8 @@ class ApplicationController < ActionController::Base
       report_error message, :bad_request
     rescue OSM::APIError => ex
       report_error ex.message, ex.status
       report_error message, :bad_request
     rescue OSM::APIError => ex
       report_error ex.message, ex.status

+    rescue ActionController::UnknownAction => ex
+      raise

     rescue Exception => ex
       logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
       ex.backtrace.each { |l| logger.info(l) }
     rescue Exception => ex
       logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
       ex.backtrace.each { |l| logger.info(l) }


@@ -207,13 +283,80 @@ class ApplicationController < ActionController::Base
     raise OSM::APIBadMethodError.new(method) unless ok
   end
 
     raise OSM::APIBadMethodError.new(method) unless ok
   end
 

+  ##
+  # wrap an api call in a timeout

   def api_call_timeout
   def api_call_timeout

-    Timeout::timeout(APP_CONFIG['api_timeout'], OSM::APITimeoutError) do
+    OSM::Timer.timeout(API_TIMEOUT) do
+      yield
+    end
+  rescue Timeout::Error
+    raise OSM::APITimeoutError
+  end
+
+  ##
+  # wrap a web page in a timeout
+  def web_timeout
+    OSM::Timer.timeout(WEB_TIMEOUT) do

       yield
     end
       yield
     end

+  rescue ActionView::Template::Error => ex
+    ex = ex.original_exception
+
+    if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /^Timeout::Error/
+      ex = Timeout::Error.new
+    end
+
+    if ex.is_a?(Timeout::Error)
+      render :action => "timeout"
+    else
+      raise
+    end
+  rescue Timeout::Error
+    render :action => "timeout"
+  end
+
+  ##
+  # extend caches_action to include the parameters, locale and logged in
+  # status in all cache keys
+  def self.caches_action(*actions)
+    options = actions.extract_options!
+    cache_path = options[:cache_path] || Hash.new
+
+    options[:unless] = case options[:unless]
+                       when NilClass then Array.new
+                       when Array then options[:unless]
+                       else unlessp = [ options[:unless] ]
+                       end
+
+    options[:unless].push(Proc.new do |controller|
+      controller.params.include?(:page)
+    end)
+
+    options[:cache_path] = Proc.new do |controller|
+      cache_path.merge(controller.params).merge(:locale => I18n.locale)
+    end
+
+    actions.push(options)
+
+    super *actions
+  end
+
+  ##
+  # extend expire_action to expire all variants
+  def expire_action(options = {})
+    I18n.available_locales.each do |locale|
+      super options.merge(:locale => locale)
+    end
+  end
+
+  ##
+  # is the requestor logged in?
+  def logged_in?
+    !@user.nil?

   end
 
 private 
   end
 
 private 

+

   # extract authorisation credentials from headers, returns user = nil if none
   def get_auth_data 
     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 
   # extract authorisation credentials from headers, returns user = nil if none
   def get_auth_data 
     if request.env.has_key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it 


@@ -230,4 +373,18 @@ private
     return [user, pass] 
   end 
 
     return [user, pass] 
   end 
 

+  # used by oauth plugin to get the current user
+  def current_user
+    @user
+  end
+
+  # used by oauth plugin to set the current user
+  def current_user=(user)
+    @user=user
+  end
+
+  # override to stop oauth plugin sending errors
+  def invalid_oauth_response
+  end
+

 end
 end