Rubocop fixes for ruby 2.5

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

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 9954b775b7b25afa8e028b1d71d0f6902ba22717..3ab09b63d805bc67899c6e54dabeac86f7d5fa69 100644 (file)
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -1,70 +1,60 @@
 class ApplicationController < ActionController::Base
   include SessionPersistence
 
 class ApplicationController < ActionController::Base
   include SessionPersistence
 

-  protect_from_forgery
+  protect_from_forgery :with => :exception
+
+  rescue_from CanCan::AccessDenied, :with => :deny_access
+  check_authorization

 
   before_action :fetch_body
 
   before_action :fetch_body

+  around_action :better_errors_allow_inline, :if => proc { Rails.env.development? }
+
+  attr_accessor :current_user
+  helper_method :current_user
+
+  private

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

-      @user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
+      self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first

 
 

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

         session.delete(:user)
         session_expires_automatically
 
         session.delete(:user)
         session_expires_automatically
 

-        redirect_to :controller => "user", :action => "suspended"
+        redirect_to :controller => "users", :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).
 
       # 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"
+      elsif !current_user.terms_seen && flash[:skip_terms].nil?
+        flash[:notice] = t "users.terms.you need to accept or decline"

         if params[:referer]
         if params[:referer]

-          redirect_to :controller => "user", :action => "terms", :referer => params[:referer]
+          redirect_to :controller => "users", :action => "terms", :referer => params[:referer]

         else
         else

-          redirect_to :controller => "user", :action => "terms", :referer => request.fullpath
+          redirect_to :controller => "users", :action => "terms", :referer => request.fullpath

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

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

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

-    @user = nil
+    self.current_user = nil

   end
 
   def require_user
   end
 
   def require_user

-    unless @user
+    unless current_user

       if request.get?
       if request.get?

-        redirect_to :controller => "user", :action => "login", :referer => request.fullpath
+        redirect_to :controller => "users", :action => "login", :referer => request.fullpath

       else
       else

-        render :text => "", :status => :forbidden
+        head :forbidden

       end
     end
   end
 
   def require_oauth
       end
     end
   end
 
   def require_oauth

-    @oauth = @user.access_token(OAUTH_KEY) if @user && defined? OAUTH_KEY
-  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
-  # 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.
-  def require_capability(cap)
-    # when the current token is nil, it means the user logged in with a different
-    # method, otherwise an OAuth token was used, which has to be checked.
-    unless current_token.nil?
-      unless current_token.read_attribute(cap)
-        report_error "OAuth token doesn't have that capability.", :forbidden
-        return false
-      end
-    end
+    @oauth = current_user.access_token(Settings.oauth_key) if current_user && Settings.key?(:oauth_key)

   end
 
   ##
   end
 
   ##


@@ -73,8 +63,8 @@ class ApplicationController < ActionController::Base
     if request.cookies["_osm_session"].to_s == ""
       if params[:cookie_test].nil?
         session[:cookie_test] = true
     if request.cookies["_osm_session"].to_s == ""
       if params[:cookie_test].nil?
         session[:cookie_test] = true

-        redirect_to Hash[params].merge(:cookie_test => "true")
-        return false
+        redirect_to params.to_unsafe_h.merge(:cookie_test => "true")
+        false

       else
         flash.now[:warning] = t "application.require_cookies.cookies_needed"
       end
       else
         flash.now[:warning] = t "application.require_cookies.cookies_needed"
       end


@@ -83,121 +73,8 @@ class ApplicationController < ActionController::Base
     end
   end
 
     end
   end
 

-  # Utility methods to make the controller filter methods easier to read and write.
-  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_diary
-    require_capability(:allow_write_diary)
-  end
-
-  def require_allow_write_api
-    require_capability(:allow_write_api)
-
-    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
-
-  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_notes
-    require_capability(:allow_write_notes)
-  end
-
-  ##
-  # require that the user is a moderator, or fill out a helpful error message
-  # and return them to the index for the controller this is wrapped from.
-  def require_moderator
-    unless @user.moderator?
-      if request.get?
-        flash[:error] = t("application.require_moderator.not_a_moderator")
-        redirect_to :action => "index"
-      else
-        render :text => "", :status => :forbidden
-      end
-    end
-  end
-
-  ##
-  # sets up the @user object for use by other methods. this is mostly called
-  # from the authorize method, but can be called elsewhere if authorisation
-  # is optional.
-  def setup_user_auth
-    # try and setup using OAuth
-    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
-    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
-      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 && !@user.terms_seen && flash[:skip_terms].nil?
-        set_locale
-        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")
-    # 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}\""
-      render :text => errormessage, :status => :unauthorized
-      return false
-    end
-  end
-
-  ##
-  # to be used as a before_filter *after* authorize. this checks that
-  # the user is a moderator and, if not, returns a forbidden error.
-  #
-  # 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
-  # good idea to do that in this branch.
-  def authorize_moderator(errormessage = "Access restricted to moderators")
-    # check user is a moderator
-    unless @user.moderator?
-      render :text => errormessage, :status => :forbidden
-      return false
-    end
-  end
-

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

-    if STATUS == :database_offline || (need_api && STATUS == :api_offline)
+    if Settings.status == "database_offline" || (need_api && Settings.status == "api_offline")

       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
       else
       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
       else


@@ -207,8 +84,8 @@ class ApplicationController < ActionController::Base
   end
 
   def check_database_writable(need_api = false)
   end
 
   def check_database_writable(need_api = false)

-    if STATUS == :database_offline || STATUS == :database_readonly ||
-       (need_api && (STATUS == :api_offline || STATUS == :api_readonly))
+    if Settings.status == "database_offline" || Settings.status == "database_readonly" ||
+       (need_api && (Settings.status == "api_offline" || Settings.status == "api_readonly"))

       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
       else
       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
       else


@@ -218,51 +95,45 @@ class ApplicationController < ActionController::Base
   end
 
   def check_api_readable
   end
 
   def check_api_readable

-    if api_status == :offline
+    if api_status == "offline"

       report_error "Database offline for maintenance", :service_unavailable
       report_error "Database offline for maintenance", :service_unavailable

-      return false
+      false

     end
   end
 
   def check_api_writable
     end
   end
 
   def check_api_writable

-    unless api_status == :online
+    unless api_status == "online"

       report_error "Database offline for maintenance", :service_unavailable
       report_error "Database offline for maintenance", :service_unavailable

-      return false
+      false

     end
   end
 
   def database_status
     end
   end
 
   def database_status

-    if STATUS == :database_offline
-      :offline
-    elsif STATUS == :database_readonly
-      :readonly
+    if Settings.status == "database_offline"
+      "offline"
+    elsif Settings.status == "database_readonly"
+      "readonly"

     else
     else

-      :online
+      "online"

     end
   end
 
   def api_status
     status = database_status
     end
   end
 
   def api_status
     status = database_status

-    if status == :online
-      if STATUS == :api_offline
-        status = :offline
-      elsif STATUS == :api_readonly
-        status = :readonly
+    if status == "online"
+      if Settings.status == "api_offline"
+        status = "offline"
+      elsif Settings.status == "api_readonly"
+        status = "readonly"

       end
     end
     status
   end
 
       end
     end
     status
   end
 

-  def gpx_status
-    status = database_status
-    status = :offline if status == :online && STATUS == :gpx_offline
-    status
-  end
-

   def require_public_data
   def require_public_data

-    unless @user.data_public?
+    unless current_user.data_public?

       report_error "You must make your edits public to upload new data", :forbidden
       report_error "You must make your edits public to upload new data", :forbidden

-      return false
+      false

     end
   end
 
     end
   end
 


@@ -275,38 +146,38 @@ class ApplicationController < ActionController::Base
     # 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"]&.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]}")
       result.root << (XML::Node.new("message") << message)
 
       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"
+      render :xml => result.to_s

     else
     else

-      render :text => message, :status => status, :content_type => "text/plain"
+      render :plain => message, :status => status

     end
   end
 
     end
   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
+  def preferred_languages(reset = false)
+    @preferred_languages = nil if reset
+    @preferred_languages ||= if params[:locale]
+                               Locale.list(params[:locale])
+                             elsif current_user
+                               current_user.preferred_languages
+                             else
+                               Locale.list(http_accept_language.user_preferred_languages)
+                             end

   end
 
   helper_method :preferred_languages
 
   end
 
   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
+  def set_locale(reset = false)
+    if current_user&.languages&.empty? && !http_accept_language.user_preferred_languages.empty?
+      current_user.languages = http_accept_language.user_preferred_languages
+      current_user.save

     end
 
     end
 

-    I18n.locale = Locale.available.preferred(preferred_languages)
+    I18n.locale = Locale.available.preferred(preferred_languages(reset))

 
     response.headers["Vary"] = "Accept-Language"
     response.headers["Content-Language"] = I18n.locale.to_s
 
     response.headers["Vary"] = "Accept-Language"
     response.headers["Content-Language"] = I18n.locale.to_s


@@ -315,7 +186,7 @@ class ApplicationController < ActionController::Base
   def api_call_handle_error
     yield
   rescue ActiveRecord::RecordNotFound => ex
   def api_call_handle_error
     yield
   rescue ActiveRecord::RecordNotFound => ex

-    render :text => "", :status => :not_found
+    head :not_found

   rescue LibXML::XML::Error, ArgumentError => ex
     report_error ex.message, :bad_request
   rescue ActiveRecord::RecordInvalid => ex
   rescue LibXML::XML::Error, ArgumentError => ex
     report_error ex.message, :bad_request
   rescue ActiveRecord::RecordInvalid => ex


@@ -337,13 +208,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)
   # 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, method unless ok

   end
 
   ##
   # wrap an api call in a timeout
   def api_call_timeout
   end
 
   ##
   # wrap an api call in a timeout
   def api_call_timeout

-    OSM::Timer.timeout(API_TIMEOUT) do
+    OSM::Timer.timeout(Settings.api_timeout, Timeout::Error) do

       yield
     end
   rescue Timeout::Error
       yield
     end
   rescue Timeout::Error


@@ -353,17 +224,14 @@ class ApplicationController < ActionController::Base
   ##
   # wrap a web page in a timeout
   def web_timeout
   ##
   # wrap a web page in a timeout
   def web_timeout

-    OSM::Timer.timeout(WEB_TIMEOUT) do
+    OSM::Timer.timeout(Settings.web_timeout, Timeout::Error) do

       yield
     end
   rescue ActionView::Template::Error => ex
       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
+    ex = ex.cause

 
 

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

       render :action => "timeout"
     else
       raise
       render :action => "timeout"
     else
       raise


@@ -373,22 +241,20 @@ class ApplicationController < ActionController::Base
   end
 
   ##
   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])
-      render_unknown_user params[:display_name]
-    end
+  # ensure that there is a "user" instance variable
+  def lookup_user
+    render_unknown_user params[:display_name] unless @user = User.active.find_by(:display_name => params[:display_name])

   end
 
   ##
   # render a "no such user" page
   def render_unknown_user(name)
   end
 
   ##
   # render a "no such user" page
   def render_unknown_user(name)

-    @title = t "user.no_such_user.title"
+    @title = t "users.no_such_user.title"

     @not_found_user = name
 
     respond_to do |format|
     @not_found_user = name
 
     respond_to do |format|

-      format.html { render :template => "user/no_such_user", :status => :not_found }
-      format.all { render :text => "", :status => :not_found }
+      format.html { render :template => "users/no_such_user", :status => :not_found }
+      format.all { head :not_found }

     end
   end
 
     end
   end
 


@@ -406,16 +272,34 @@ class ApplicationController < ActionController::Base
   end
 
   def map_layout
   end
 
   def map_layout

+    append_content_security_policy_directives(
+      :child_src => %w[http://127.0.0.1:8111 https://127.0.0.1:8112],
+      :frame_src => %w[http://127.0.0.1:8111 https://127.0.0.1:8112],
+      :connect_src => [Settings.nominatim_url, Settings.overpass_url, Settings.fossgis_osrm_url, Settings.graphhopper_url],
+      :form_action => %w[render.openstreetmap.org],
+      :style_src => %w['unsafe-inline']
+    )
+
+    if Settings.status == "database_offline" || Settings.status == "api_offline"
+      flash.now[:warning] = t("layouts.osm_offline")
+    elsif Settings.status == "database_readonly" || Settings.status == "api_readonly"
+      flash.now[:warning] = t("layouts.osm_read_only")
+    end
+

     request.xhr? ? "xhr" : "map"
   end
 
     request.xhr? ? "xhr" : "map"
   end
 

+  def allow_thirdparty_images
+    append_content_security_policy_directives(:img_src => %w[*])
+  end
+

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

-             elsif @user && @user.preferred_editor
-               @user.preferred_editor
+             elsif current_user&.preferred_editor
+               current_user.preferred_editor

              else
              else

-               DEFAULT_EDITOR
+               Settings.default_editor

              end
 
     editor
              end
 
     editor


@@ -423,7 +307,55 @@ class ApplicationController < ActionController::Base
 
   helper_method :preferred_editor
 
 
   helper_method :preferred_editor
 

-  private
+  def update_totp
+    if Settings.key?(:totp_key)
+      cookies["_osm_totp_token"] = {
+        :value => ROTP::TOTP.new(Settings.totp_key, :interval => 3600).now,
+        :domain => "openstreetmap.org",
+        :expires => 1.hour.from_now
+      }
+    end
+  end
+
+  def better_errors_allow_inline
+    yield
+  rescue StandardError
+    append_content_security_policy_directives(
+      :script_src => %w['unsafe-inline'],
+      :style_src => %w['unsafe-inline']
+    )
+
+    raise
+  end
+
+  def current_ability
+    # Use capabilities from the oauth token if it exists and is a valid access token
+    if Authenticator.new(self, [:token]).allow?
+      Ability.new(nil).merge(Capability.new(current_token))
+    else
+      Ability.new(current_user)
+    end
+  end
+
+  def deny_access(_exception)
+    if current_token
+      set_locale
+      report_error t("oauth.permissions.missing"), :forbidden
+    elsif current_user
+      set_locale
+      respond_to do |format|
+        format.html { redirect_to :controller => "errors", :action => "forbidden" }
+        format.any { report_error t("application.permission_denied"), :forbidden }
+      end
+    elsif request.get?
+      respond_to do |format|
+        format.html { redirect_to :controller => "users", :action => "login", :referer => request.fullpath }
+        format.any { head :forbidden }
+      end
+    else
+      head :forbidden
+    end
+  end

 
   # extract authorisation credentials from headers, returns user = nil if none
   def get_auth_data
 
   # extract authorisation credentials from headers, returns user = nil if none
   def get_auth_data


@@ -435,23 +367,10 @@ class ApplicationController < ActionController::Base
       authdata = request.env["HTTP_AUTHORIZATION"].to_s.split
     end
     # only basic authentication supported
       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)
-    end
+    user, pass = Base64.decode64(authdata[1]).split(":", 2) if authdata && authdata[0] == "Basic"

     [user, pass]
   end
 
     [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
   # override to stop oauth plugin sending errors

-  def invalid_oauth_response
-  end
+  def invalid_oauth_response; end

 end
 end