Fix style issues found by new rubocop version

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

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 90a9672760755a6ee060e8540cb6fc71ea041d5d..618f08a1fc84e3fb6281d15b4dca21f6addfc5e1 100644 (file)
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -3,22 +3,22 @@ class ApplicationController < ActionController::Base
 
   protect_from_forgery
 
 
   protect_from_forgery
 

-  before_filter :fetch_body
+  before_action :fetch_body

 
   def authorize_web
     if session[:user]
       @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
 
 
   def authorize_web
     if session[:user]
       @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
 

-    if @user.status == "suspended"
+      if @user.status == "suspended"

         session.delete(:user)
         session_expires_automatically
 
         redirect_to :controller => "user", :action => "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'
+      # 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"

         if params[:referer]
           redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
         else
         if params[:referer]
           redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
         else


@@ -30,8 +30,8 @@ class ApplicationController < ActionController::Base
         session[:user] = @user.id
       end
     end
         session[:user] = @user.id
       end
     end

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

     reset_session
     @user = nil
   end
     reset_session
     @user = nil
   end


@@ -39,7 +39,7 @@ class ApplicationController < ActionController::Base
   def require_user
     unless @user
       if request.get?
   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
       else
         render :text => "", :status => :forbidden
       end


@@ -47,12 +47,12 @@ class ApplicationController < ActionController::Base
   end
 
   def require_oauth
   end
 
   def require_oauth

-    @oauth = @user.access_token(OAUTH_KEY) if @user and defined? OAUTH_KEY
+    @oauth = @user.access_token(OAUTH_KEY) if @user && defined? OAUTH_KEY

   end
 
   ##
   end
 
   ##

-  # requires the user to be logged in by the token or HTTP methods, or have an 
-  # OAuth token with the right capability. this method is a bit of a pain to call 
+  # requires the user to be logged in by the token or HTTP methods, or have an
+  # OAuth token with the right capability. this method is a bit of a pain to call

   # directly, since it's cumbersome to call filters with arguments in rails. to
   # make it easier to read and write the code, there are some utility methods
   # below.
   # directly, since it's cumbersome to call filters with arguments in rails. to
   # make it easier to read and write the code, there are some utility methods
   # below.


@@ -76,7 +76,7 @@ class ApplicationController < ActionController::Base
         redirect_to Hash[params].merge(:cookie_test => "true")
         return false
       else
         redirect_to Hash[params].merge(:cookie_test => "true")
         return 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)
       end
     else
       session.delete(:cookie_test)


@@ -87,26 +87,32 @@ class ApplicationController < ActionController::Base
   def require_allow_read_prefs
     require_capability(:allow_read_prefs)
   end
   def require_allow_read_prefs
     require_capability(:allow_read_prefs)
   end

+

   def require_allow_write_prefs
     require_capability(:allow_write_prefs)
   end
   def require_allow_write_prefs
     require_capability(:allow_write_prefs)
   end

+

   def require_allow_write_diary
     require_capability(:allow_write_diary)
   end
   def require_allow_write_diary
     require_capability(:allow_write_diary)
   end

+

   def require_allow_write_api
     require_capability(:allow_write_api)
 
   def require_allow_write_api
     require_capability(:allow_write_api)
 

-    if REQUIRE_TERMS_AGREED and @user.terms_agreed.nil?
+    if REQUIRE_TERMS_AGREED && @user.terms_agreed.nil?

       report_error "You must accept the contributor terms before you can edit.", :forbidden
       return false
     end
   end
       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)
   end

+

   def require_allow_write_gpx
     require_capability(:allow_write_gpx)
   end
   def require_allow_write_gpx
     require_capability(:allow_write_gpx)
   end

+

   def require_allow_write_notes
     require_capability(:allow_write_notes)
   end
   def require_allow_write_notes
     require_capability(:allow_write_notes)
   end


@@ -117,8 +123,8 @@ class ApplicationController < ActionController::Base
   def require_moderator
     unless @user.moderator?
       if request.get?
   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
       else
         render :text => "", :status => :forbidden
       end


@@ -131,12 +137,12 @@ 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 not Authenticator.new(self, [:token]).allow?
+    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)
       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'
+      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
         @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


@@ -148,31 +154,31 @@ class ApplicationController < ActionController::Base
       # check if the user has been banned
       if @user.blocks.active.exists?
         # NOTE: need slightly more helpful message than this.
       # 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
+        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.
       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?
+      if REQUIRE_TERMS_SEEN && !@user.terms_seen && flash[:skip_terms].nil?

         set_locale
         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
 
       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
 
     # handle authenticate pass/fail
     unless @user
       # no auth, the user does not exist or the password was wrong
     # make the @user object from any auth sources we have
     setup_user_auth
 
     # handle authenticate pass/fail
     unless @user
       # no auth, the user does not exist or the password was wrong

-      response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\"" 
+      response.headers["WWW-Authenticate"] = "Basic realm=\"#{realm}\""

       render :text => errormessage, :status => :unauthorized
       return false
       render :text => errormessage, :status => :unauthorized
       return false

-    end 
-  end 
+    end
+  end

 
   ##
   # to be used as a before_filter *after* authorize. this checks that
 
   ##
   # to be used as a before_filter *after* authorize. this checks that


@@ -180,26 +186,34 @@ class ApplicationController < ActionController::Base
   #
   # NOTE: this isn't a very good way of doing it - it duplicates logic
   # from require_moderator - but what we really need to do is a fairly
   #
   # NOTE: this isn't a very good way of doing it - it duplicates logic
   # from require_moderator - but what we really need to do is a fairly

-  # drastic refactoring based on :format and respond_to? but not a 
+  # drastic refactoring based on :format and respond_to? but not a

   # good idea to do that in this branch.
   # good idea to do that in this branch.

-  def authorize_moderator(errormessage="Access restricted to moderators") 
+  def authorize_moderator(errormessage = "Access restricted to moderators")

     # check user is a moderator
     unless @user.moderator?
       render :text => errormessage, :status => :forbidden
       return false
     # check user is a moderator
     unless @user.moderator?
       render :text => errormessage, :status => :forbidden
       return false

-    end 
-  end 
+    end
+  end

 
   def check_database_readable(need_api = false)
 
   def check_database_readable(need_api = false)

-    if STATUS == :database_offline or (need_api and STATUS == :api_offline)
-      redirect_to :controller => 'site', :action => 'offline'
+    if STATUS == :database_offline || (need_api && STATUS == :api_offline)
+      if request.xhr?
+        report_error "Database offline for maintenance", :service_unavailable
+      else
+        redirect_to :controller => "site", :action => "offline"
+      end

     end
   end
 
   def check_database_writable(need_api = false)
     end
   end
 
   def check_database_writable(need_api = false)

-    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'
+    if STATUS == :database_offline || STATUS == :database_readonly ||
+       (need_api && (STATUS == :api_offline || STATUS == :api_readonly))
+      if request.xhr?
+        report_error "Database offline for maintenance", :service_unavailable
+      else
+        redirect_to :controller => "site", :action => "offline"
+      end

     end
   end
 
     end
   end
 


@@ -222,7 +236,7 @@ class ApplicationController < ActionController::Base
       :offline
     elsif STATUS == :database_readonly
       :readonly
       :offline
     elsif STATUS == :database_readonly
       :readonly

-    else 
+    else

       :online
     end
   end
       :online
     end
   end


@@ -236,15 +250,13 @@ class ApplicationController < ActionController::Base
         status = :readonly
       end
     end
         status = :readonly
       end
     end

-    return status
+    status

   end
 
   def gpx_status
     status = database_status
   end
 
   def gpx_status
     status = database_status

-    if status == :online
-      status = :offline if STATUS == :gpx_offline
-    end
-    return status
+    status = :offline if status == :online && STATUS == :gpx_offline
+    status

   end
 
   def require_public_data
   end
 
   def require_public_data


@@ -256,15 +268,15 @@ class ApplicationController < ActionController::Base
 
   # Report and error to the user
   # (If anyone ever fixes Rails so it can set a http status "reason phrase",
 
   # Report and error to the user
   # (If anyone ever fixes Rails so it can set a http status "reason phrase",

-  #  rather than only a status code and having the web engine make up a 
+  #  rather than only a status code and having the web engine make up a

   #  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)
   #  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'] and
-       request.headers['X-Error-Format'].downcase == "xml"
+    if request.headers["X-Error-Format"] &&
+       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 = 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]}")


@@ -275,13 +287,13 @@ class ApplicationController < ActionController::Base
       render :text => message, :status => status, :content_type => "text/plain"
     end
   end
       render :text => message, :status => status, :content_type => "text/plain"
     end
   end

-  
+

   def set_locale
   def set_locale

-    response.header['Vary'] = 'Accept-Language'
+    response.header["Vary"] = "Accept-Language"

 
     if @user && !@user.languages.empty?
       http_accept_language.user_preferred_languages = @user.languages
 
     if @user && !@user.languages.empty?
       http_accept_language.user_preferred_languages = @user.languages

-      response.header['Vary'] = '*'
+      response.header["Vary"] = "*"

     end
 
     I18n.locale = select_locale
     end
 
     I18n.locale = select_locale


@@ -291,20 +303,20 @@ class ApplicationController < ActionController::Base
       @user.save
     end
 
       @user.save
     end
 

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

   end
 
   def select_locale(locales = I18n.available_locales)
     if params[:locale]
   end
 
   def select_locale(locales = I18n.available_locales)
     if params[:locale]

-      http_accept_language.user_preferred_languages = [ 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|
     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 ]
+        pls = [pl]

 
         while pl.match(/^(.*)-[^-]+$/)
 
         while pl.match(/^(.*)-[^-]+$/)

-          pls.push($1) if locales.include?($1) or locales.include?($1.to_sym)
+          pls.push($1) if locales.include?($1) || locales.include?($1.to_sym)

           pl = $1
         end
 
           pl = $1
         end
 


@@ -318,25 +330,23 @@ class ApplicationController < ActionController::Base
   helper_method :select_locale
 
   def api_call_handle_error
   helper_method :select_locale
 
   def api_call_handle_error

-    begin
-      yield
-    rescue ActiveRecord::RecordNotFound => ex
-      render :text => "", :status => :not_found
-    rescue LibXML::XML::Error, ArgumentError => ex
-      report_error ex.message, :bad_request
-    rescue ActiveRecord::RecordInvalid => ex
-      message = "#{ex.record.class} #{ex.record.id}: "
-      ex.record.errors.each { |attr,msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
-      report_error message, :bad_request
-    rescue OSM::APIError => ex
-      report_error ex.message, ex.status
-    rescue AbstractController::ActionNotFound => ex
-      raise
-    rescue Exception => ex
-      logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
-      ex.backtrace.each { |l| logger.info(l) }
-      report_error "#{ex.class}: #{ex.message}", :internal_server_error
-    end
+    yield
+  rescue ActiveRecord::RecordNotFound => ex
+    render :text => "", :status => :not_found
+  rescue LibXML::XML::Error, ArgumentError => ex
+    report_error ex.message, :bad_request
+  rescue ActiveRecord::RecordInvalid => ex
+    message = "#{ex.record.class} #{ex.record.id}: "
+    ex.record.errors.each { |attr, msg| message << "#{attr}: #{msg} (#{ex.record[attr].inspect})" }
+    report_error message, :bad_request
+  rescue OSM::APIError => ex
+    report_error ex.message, ex.status
+  rescue AbstractController::ActionNotFound => ex
+    raise
+  rescue StandardError => ex
+    logger.info("API threw unexpected #{ex.class} exception: #{ex.message}")
+    ex.backtrace.each { |l| logger.info(l) }
+    report_error "#{ex.class}: #{ex.message}", :internal_server_error

   end
 
   ##
   end
 
   ##


@@ -344,7 +354,7 @@ 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)
   # 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)

-    raise OSM::APIBadMethodError.new(method) unless ok
+    fail OSM::APIBadMethodError.new(method) unless ok

   end
 
   ##
   end
 
   ##


@@ -366,7 +376,7 @@ class ApplicationController < ActionController::Base
   rescue ActionView::Template::Error => ex
     ex = ex.original_exception
 
   rescue ActionView::Template::Error => ex
     ex = ex.original_exception
 

-    if ex.is_a?(ActiveRecord::StatementInvalid) and ex.message =~ /execution expired/
+    if ex.is_a?(ActiveRecord::StatementInvalid) && ex.message =~ /execution expired/

       ex = Timeout::Error.new
     end
 
       ex = Timeout::Error.new
     end
 


@@ -379,12 +389,6 @@ class ApplicationController < ActionController::Base
     render :action => "timeout"
   end
 
     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
   ##
   # ensure that there is a "this_user" instance variable
   def lookup_this_user


@@ -419,20 +423,20 @@ class ApplicationController < ActionController::Base
   end
 
   def map_layout
   end
 
   def map_layout

-    request.xhr? ? 'xhr' : 'map'
+    request.xhr? ? "xhr" : "map"

   end
 
   def preferred_editor
     editor = if params[:editor]
   end
 
   def preferred_editor
     editor = if params[:editor]

-      params[:editor]
-    elsif @user and @user.preferred_editor
-      @user.preferred_editor
-    else
-      DEFAULT_EDITOR
-    end
-
-    if request.env['HTTP_USER_AGENT'] =~ /MSIE|Trident/ and editor == 'id'
-      editor = 'potlatch2'
+               params[:editor]
+             elsif @user && @user.preferred_editor
+               @user.preferred_editor
+             else
+               DEFAULT_EDITOR
+             end
+
+    if request.env["HTTP_USER_AGENT"] =~ /MSIE|Trident/ && editor == "id"
+      editor = "potlatch2"

     end
 
     editor
     end
 
     editor


@@ -440,23 +444,23 @@ class ApplicationController < ActionController::Base
 
   helper_method :preferred_editor
 
 
   helper_method :preferred_editor
 

-private 
+  private

 
   # extract authorisation credentials from headers, returns user = nil if none
 
   # 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 
-      authdata = request.env['X-HTTP_AUTHORIZATION'].to_s.split 
-    elsif request.env.has_key? 'REDIRECT_X_HTTP_AUTHORIZATION'          # mod_fcgi 
-      authdata = request.env['REDIRECT_X_HTTP_AUTHORIZATION'].to_s.split 
-    elsif request.env.has_key? 'HTTP_AUTHORIZATION'         # regular location
-      authdata = request.env['HTTP_AUTHORIZATION'].to_s.split
-    end 
+  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
+    end

     # only basic authentication supported
     # only basic authentication supported

-    if authdata and authdata[0] == 'Basic' 
-      user, pass = Base64.decode64(authdata[1]).split(':',2)
-    end 
-    return [user, pass] 
-  end 
+    if authdata && authdata[0] == "Basic"
+      user, pass = Base64.decode64(authdata[1]).split(":", 2)
+    end
+    [user, pass]
+  end

 
   # used by oauth plugin to get the current user
   def current_user
 
   # used by oauth plugin to get the current user
   def current_user


@@ -465,11 +469,10 @@ private
 
   # used by oauth plugin to set the current user
   def current_user=(user)
 
   # used by oauth plugin to set the current user
   def current_user=(user)

-    @user=user
+    @user = user

   end
 
   # override to stop oauth plugin sending errors
   def invalid_oauth_response
   end
   end
 
   # override to stop oauth plugin sending errors
   def invalid_oauth_response
   end

-

 end
 end