]> git.openstreetmap.org Git - rails.git/blobdiff - app/controllers/application_controller.rb
Merge remote-tracking branch 'openstreetmap/pull/1449'
[rails.git] / app / controllers / application_controller.rb
index 3b706966a39a598aa0addeff77bf2c87086d2974..8eb5f240906579f6fdb21fff01a293fc8c0483ea 100644 (file)
@@ -3,7 +3,7 @@ class ApplicationController < ActionController::Base
 
   protect_from_forgery
 
-  before_filter :fetch_body
+  before_action :fetch_body
 
   def authorize_web
     if session[:user]
@@ -18,7 +18,7 @@ class ApplicationController < ActionController::Base
       # 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 && flash[:skip_terms].nil?
-        flash[:notice] = t 'user.terms.you need to accept or decline'
+        flash[:notice] = t "user.terms.you need to accept or decline"
         if params[:referer]
           redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
         else
@@ -39,7 +39,7 @@ class ApplicationController < ActionController::Base
   def require_user
     unless @user
       if request.get?
-        redirect_to :controller => 'user', :action => 'login', :referer => request.fullpath
+        redirect_to :controller => "user", :action => "login", :referer => request.fullpath
       else
         render :text => "", :status => :forbidden
       end
@@ -62,7 +62,7 @@ class ApplicationController < ActionController::Base
     unless current_token.nil?
       unless current_token.read_attribute(cap)
         report_error "OAuth token doesn't have that capability.", :forbidden
-        return false
+        false
       end
     end
   end
@@ -74,9 +74,9 @@ class ApplicationController < ActionController::Base
       if params[:cookie_test].nil?
         session[:cookie_test] = true
         redirect_to Hash[params].merge(:cookie_test => "true")
-        return false
+        false
       else
-        flash.now[:warning] = t 'application.require_cookies.cookies_needed'
+        flash.now[:warning] = t "application.require_cookies.cookies_needed"
       end
     else
       session.delete(:cookie_test)
@@ -123,8 +123,8 @@ class ApplicationController < ActionController::Base
   def require_moderator
     unless @user.moderator?
       if request.get?
-        flash[:error] = t('application.require_moderator.not_a_moderator')
-        redirect_to :action => 'index'
+        flash[:error] = t("application.require_moderator.not_a_moderator")
+        redirect_to :action => "index"
       else
         render :text => "", :status => :forbidden
       end
@@ -140,21 +140,26 @@ class ApplicationController < ActionController::Base
     unless Authenticator.new(self, [:token]).allow?
       username, passwd = get_auth_data # parse from headers
       # authenticate per-scheme
-      if username.nil?
-        @user = nil # no authentication provided - perhaps first connect (client should retry after 401)
-      elsif username == 'token'
-        @user = User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
-      else
-        @user = User.authenticate(:username => username, :password => passwd) # basic auth
-      end
+      @user = if username.nil?
+                nil # no authentication provided - perhaps first connect (client should retry after 401)
+              elsif username == "token"
+                User.authenticate(:token => passwd) # preferred - random token for user from db, passed in basic auth
+              else
+                User.authenticate(:username => username, :password => passwd) # basic auth
+              end
     end
 
     # have we identified the user?
     if @user
       # check if the user has been banned
-      if @user.blocks.active.exists?
-        # NOTE: need slightly more helpful message than this.
-        report_error t('application.setup_user_auth.blocked'), :forbidden
+      user_block = @user.blocks.active.take
+      unless user_block.nil?
+        set_locale
+        if user_block.zero_hour?
+          report_error t("application.setup_user_auth.blocked_zero_hour"), :forbidden
+        else
+          report_error t("application.setup_user_auth.blocked"), :forbidden
+        end
       end
 
       # if the user hasn't seen the contributor terms then don't
@@ -162,12 +167,12 @@ class ApplicationController < ActionController::Base
       # (but can decline) the CTs to continue.
       if REQUIRE_TERMS_SEEN && !@user.terms_seen && flash[:skip_terms].nil?
         set_locale
-        report_error t('application.setup_user_auth.need_to_see_terms'), :forbidden
+        report_error t("application.setup_user_auth.need_to_see_terms"), :forbidden
       end
     end
   end
 
-  def authorize(realm = 'Web Password', errormessage = "Couldn't authenticate you")
+  def authorize(realm = "Web Password", errormessage = "Couldn't authenticate you")
     # make the @user object from any auth sources we have
     setup_user_auth
 
@@ -192,7 +197,7 @@ class ApplicationController < ActionController::Base
     # check user is a moderator
     unless @user.moderator?
       render :text => errormessage, :status => :forbidden
-      return false
+      false
     end
   end
 
@@ -201,7 +206,7 @@ class ApplicationController < ActionController::Base
       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
       else
-        redirect_to :controller => 'site', :action => 'offline'
+        redirect_to :controller => "site", :action => "offline"
       end
     end
   end
@@ -212,7 +217,7 @@ class ApplicationController < ActionController::Base
       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
       else
-        redirect_to :controller => 'site', :action => 'offline'
+        redirect_to :controller => "site", :action => "offline"
       end
     end
   end
@@ -220,14 +225,14 @@ class ApplicationController < ActionController::Base
   def check_api_readable
     if api_status == :offline
       report_error "Database offline for maintenance", :service_unavailable
-      return false
+      false
     end
   end
 
   def check_api_writable
     unless api_status == :online
       report_error "Database offline for maintenance", :service_unavailable
-      return false
+      false
     end
   end
 
@@ -262,7 +267,7 @@ class ApplicationController < ActionController::Base
   def require_public_data
     unless @user.data_public?
       report_error "You must make your edits public to upload new data", :forbidden
-      return false
+      false
     end
   end
 
@@ -272,11 +277,11 @@ class ApplicationController < ActionController::Base
   #  phrase from that, we can also put the error message into the status
   #  message. For now, rails won't let us)
   def report_error(message, status = :bad_request)
-    # Todo: some sort of escaping of problem characters in the message
-    response.headers['Error'] = message
+    # TODO: some sort of escaping of problem characters in the message
+    response.headers["Error"] = message
 
-    if request.headers['X-Error-Format'] &&
-       request.headers['X-Error-Format'].downcase == "xml"
+    if request.headers["X-Error-Format"] &&
+       request.headers["X-Error-Format"].casecmp("xml").zero?
       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]}")
@@ -288,47 +293,30 @@ class ApplicationController < ActionController::Base
     end
   end
 
-  def set_locale
-    response.header['Vary'] = 'Accept-Language'
-
-    if @user && !@user.languages.empty?
-      http_accept_language.user_preferred_languages = @user.languages
-      response.header['Vary'] = '*'
-    end
+  def preferred_languages
+    @languages ||= if params[:locale]
+                     Locale.list(params[:locale])
+                   elsif @user
+                     @user.preferred_languages
+                   else
+                     Locale.list(http_accept_language.user_preferred_languages)
+                   end
+  end
 
-    I18n.locale = select_locale
+  helper_method :preferred_languages
 
+  def set_locale
     if @user && @user.languages.empty? && !http_accept_language.user_preferred_languages.empty?
       @user.languages = http_accept_language.user_preferred_languages
       @user.save
     end
 
-    response.headers['Content-Language'] = I18n.locale.to_s
-  end
-
-  def select_locale(locales = I18n.available_locales)
-    if params[:locale]
-      http_accept_language.user_preferred_languages = [params[:locale]]
-    end
-
-    if http_accept_language.compatible_language_from(locales).nil?
-      http_accept_language.user_preferred_languages = http_accept_language.user_preferred_languages.collect do |pl|
-        pls = [pl]
-
-        while pl.match(/^(.*)-[^-]+$/)
-          pls.push($1) if locales.include?($1) || locales.include?($1.to_sym)
-          pl = $1
-        end
-
-        pls
-      end.flatten
-    end
+    I18n.locale = Locale.available.preferred(preferred_languages)
 
-    http_accept_language.compatible_language_from(locales) || I18n.default_locale
+    response.headers["Vary"] = "Accept-Language"
+    response.headers["Content-Language"] = I18n.locale.to_s
   end
 
-  helper_method :select_locale
-
   def api_call_handle_error
     yield
   rescue ActiveRecord::RecordNotFound => ex
@@ -354,13 +342,13 @@ class ApplicationController < ActionController::Base
   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
   def assert_method(method)
     ok = request.send((method.to_s.downcase + "?").to_sym)
-    fail OSM::APIBadMethodError.new(method) unless ok
+    raise OSM::APIBadMethodError.new(method) unless ok
   end
 
   ##
   # wrap an api call in a timeout
   def api_call_timeout
-    OSM::Timer.timeout(API_TIMEOUT) do
+    OSM::Timer.timeout(API_TIMEOUT, Timeout::Error) do
       yield
     end
   rescue Timeout::Error
@@ -370,17 +358,13 @@ class ApplicationController < ActionController::Base
   ##
   # wrap a web page in a timeout
   def web_timeout
-    OSM::Timer.timeout(WEB_TIMEOUT) do
+    OSM::Timer.timeout(WEB_TIMEOUT, Timeout::Error) do
       yield
     end
   rescue ActionView::Template::Error => ex
     ex = ex.original_exception
 
     if ex.is_a?(ActiveRecord::StatementInvalid) && ex.message =~ /execution expired/
-      ex = Timeout::Error.new
-    end
-
-    if ex.is_a?(Timeout::Error)
       render :action => "timeout"
     else
       raise
@@ -389,16 +373,10 @@ class ApplicationController < ActionController::Base
     render :action => "timeout"
   end
 
-  ##
-  # is the requestor logged in?
-  def logged_in?
-    !@user.nil?
-  end
-
   ##
   # ensure that there is a "this_user" instance variable
   def lookup_this_user
-    unless @this_user = User.active.find_by_display_name(params[:display_name])
+    unless @this_user = User.active.find_by(:display_name => params[:display_name])
       render_unknown_user params[:display_name]
     end
   end
@@ -429,7 +407,7 @@ class ApplicationController < ActionController::Base
   end
 
   def map_layout
-    request.xhr? ? 'xhr' : 'map'
+    request.xhr? ? "xhr" : "map"
   end
 
   def preferred_editor
@@ -441,29 +419,35 @@ class ApplicationController < ActionController::Base
                DEFAULT_EDITOR
              end
 
-    if request.env['HTTP_USER_AGENT'] =~ /MSIE|Trident/ && editor == 'id'
-      editor = 'potlatch2'
-    end
-
     editor
   end
 
   helper_method :preferred_editor
 
+  def update_totp
+    if defined?(TOTP_KEY)
+      cookies["_osm_totp_token"] = {
+        :value => ROTP::TOTP.new(TOTP_KEY, :interval => 3600).now,
+        :domain => "openstreetmap.org",
+        :expires => 1.hour.from_now
+      }
+    end
+  end
+
   private
 
   # extract authorisation credentials from headers, returns user = nil if none
   def get_auth_data
-    if request.env.key? 'X-HTTP_AUTHORIZATION'          # where mod_rewrite might have put it
-      authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split
-    elsif request.env.key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi
-      authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split
-    elsif request.env.key? 'HTTP_AUTHORIZATION'         # regular location
-      authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
+    if request.env.key? "X-HTTP_AUTHORIZATION" # where mod_rewrite might have put it
+      authdata = request.env["X-HTTP_AUTHORIZATION"].to_s.split
+    elsif request.env.key? "REDIRECT_X_HTTP_AUTHORIZATION" # mod_fcgi
+      authdata = request.env["REDIRECT_X_HTTP_AUTHORIZATION"].to_s.split
+    elsif request.env.key? "HTTP_AUTHORIZATION" # regular location
+      authdata = request.env["HTTP_AUTHORIZATION"].to_s.split
     end
     # only basic authentication supported
-    if authdata && authdata[0] == 'Basic'
-      user, pass = Base64.decode64(authdata[1]).split(':', 2)
+    if authdata && authdata[0] == "Basic"
+      user, pass = Base64.decode64(authdata[1]).split(":", 2)
     end
     [user, pass]
   end
@@ -479,6 +463,5 @@ class ApplicationController < ActionController::Base
   end
 
   # override to stop oauth plugin sending errors
-  def invalid_oauth_response
-  end
+  def invalid_oauth_response; end
 end