Merge pull request #3492 from harry-wood/oauth-doc

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

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 616223a068c65a11df26afba4b1e0cc8451fa4d9..1d68654055538fd597265043e2adcb52e3ceb94f 100644 (file)
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -1,18 +1,22 @@
 class ApplicationController < ActionController::Base
 class ApplicationController < ActionController::Base

+  require "timeout"
+

   include SessionPersistence
 
   protect_from_forgery :with => :exception
 
   include SessionPersistence
 
   protect_from_forgery :with => :exception
 

+  add_flash_types :warning, :error
+

   rescue_from CanCan::AccessDenied, :with => :deny_access
   check_authorization
 
   before_action :fetch_body
   around_action :better_errors_allow_inline, :if => proc { Rails.env.development? }
 
   rescue_from CanCan::AccessDenied, :with => :deny_access
   check_authorization
 
   before_action :fetch_body
   around_action :better_errors_allow_inline, :if => proc { Rails.env.development? }
 

-  attr_accessor :current_user
+  attr_accessor :current_user, :oauth_token

 
   helper_method :current_user
 
   helper_method :current_user

-  helper_method :preferred_langauges
+  helper_method :oauth_token

 
   private
 
 
   private
 


@@ -20,7 +24,11 @@ class ApplicationController < ActionController::Base
     if session[:user]
       self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
 
     if session[:user]
       self.current_user = User.where(:id => session[:user]).where("status IN ('active', 'confirmed', 'suspended')").first
 

-      if current_user.status == "suspended"
+      if session[:fingerprint] &&
+         session[:fingerprint] != current_user.fingerprint
+        reset_session
+        self.current_user = nil
+      elsif current_user.status == "suspended"

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


@@ -39,6 +47,8 @@ class ApplicationController < ActionController::Base
     elsif session[:token]
       session[:user] = current_user.id if self.current_user = User.authenticate(:token => session[:token])
     end
     elsif session[:token]
       session[:user] = current_user.id if self.current_user = User.authenticate(:token => session[:token])
     end

+
+    session[:fingerprint] = current_user.fingerprint if current_user && session[:fingerprint].nil?

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


@@ -48,7 +58,7 @@ class ApplicationController < ActionController::Base
   def require_user
     unless current_user
       if request.get?
   def require_user
     unless current_user
       if request.get?

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

       else
         head :forbidden
       end
       else
         head :forbidden
       end


@@ -56,7 +66,7 @@ class ApplicationController < ActionController::Base
   end
 
   def require_oauth
   end
 
   def require_oauth

-    @oauth = current_user.access_token(Settings.oauth_key) if current_user && Settings.key?(:oauth_key)
+    @oauth_token = current_user.oauth_token(Settings.oauth_application) if current_user && Settings.key?(:oauth_application)

   end
 
   ##
   end
 
   ##


@@ -75,7 +85,7 @@ class ApplicationController < ActionController::Base
     end
   end
 
     end
   end
 

-  def check_database_readable(need_api = false)
+  def check_database_readable(need_api: false)

     if Settings.status == "database_offline" || (need_api && Settings.status == "api_offline")
       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable
     if Settings.status == "database_offline" || (need_api && Settings.status == "api_offline")
       if request.xhr?
         report_error "Database offline for maintenance", :service_unavailable


@@ -85,7 +95,7 @@ class ApplicationController < ActionController::Base
     end
   end
 
     end
   end
 

-  def check_database_writable(need_api = false)
+  def check_database_writable(need_api: false)

     if Settings.status == "database_offline" || Settings.status == "database_readonly" ||
        (need_api && (Settings.status == "api_offline" || Settings.status == "api_readonly"))
       if request.xhr?
     if Settings.status == "database_offline" || Settings.status == "database_readonly" ||
        (need_api && (Settings.status == "api_offline" || Settings.status == "api_readonly"))
       if request.xhr?


@@ -111,9 +121,10 @@ class ApplicationController < ActionController::Base
   end
 
   def database_status
   end
 
   def database_status

-    if Settings.status == "database_offline"
+    case Settings.status
+    when "database_offline"

       "offline"
       "offline"

-    elsif Settings.status == "database_readonly"
+    when "database_readonly"

       "readonly"
     else
       "online"
       "readonly"
     else
       "online"


@@ -123,9 +134,10 @@ class ApplicationController < ActionController::Base
   def api_status
     status = database_status
     if status == "online"
   def api_status
     status = database_status
     if status == "online"

-      if Settings.status == "api_offline"
+      case Settings.status
+      when "api_offline"

         status = "offline"
         status = "offline"

-      elsif Settings.status == "api_readonly"
+      when "api_readonly"

         status = "readonly"
       end
     end
         status = "readonly"
       end
     end


@@ -149,7 +161,7 @@ class ApplicationController < ActionController::Base
     response.headers["Error"] = message
 
     if request.headers["X-Error-Format"]&.casecmp("xml")&.zero?
     response.headers["Error"] = message
 
     if request.headers["X-Error-Format"]&.casecmp("xml")&.zero?

-      result = OSM::API.new.get_xml_doc
+      result = OSM::API.new.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.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)


@@ -160,8 +172,7 @@ class ApplicationController < ActionController::Base
     end
   end
 
     end
   end
 

-  def preferred_languages(reset = false)
-    @preferred_languages = nil if reset
+  def preferred_languages

     @preferred_languages ||= if params[:locale]
                                Locale.list(params[:locale])
                              elsif current_user
     @preferred_languages ||= if params[:locale]
                                Locale.list(params[:locale])
                              elsif current_user


@@ -173,13 +184,13 @@ class ApplicationController < ActionController::Base
 
   helper_method :preferred_languages
 
 
   helper_method :preferred_languages
 

-  def set_locale(reset = false)
+  def set_locale

     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
 
     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
 

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

 
     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


@@ -195,7 +206,7 @@ class ApplicationController < ActionController::Base
     report_error e.message, :bad_request
   rescue ActiveRecord::RecordInvalid => e
     message = "#{e.record.class} #{e.record.id}: "
     report_error e.message, :bad_request
   rescue ActiveRecord::RecordInvalid => e
     message = "#{e.record.class} #{e.record.id}: "

-    e.record.errors.each { |attr, msg| message << "#{attr}: #{msg} (#{e.record[attr].inspect})" }
+    e.record.errors.each { |error| message << "#{error.attribute}: #{error.message} (#{e.record[error.attribute].inspect})" }

     report_error message, :bad_request
   rescue OSM::APIError => e
     report_error e.message, e.status
     report_error message, :bad_request
   rescue OSM::APIError => e
     report_error e.message, e.status


@@ -211,26 +222,22 @@ class ApplicationController < ActionController::Base
   # asserts that the request method is the +method+ given as a parameter
   # or raises a suitable error. +method+ should be a symbol, e.g: :put or :get.
   def assert_method(method)
   # asserts that the request method is the +method+ given as a parameter
   # 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)
+    ok = request.send(:"#{method.to_s.downcase}?")

     raise OSM::APIBadMethodError, method unless ok
   end
 
   ##
   # wrap an api call in a timeout
     raise OSM::APIBadMethodError, method unless ok
   end
 
   ##
   # wrap an api call in a timeout

-  def api_call_timeout
-    OSM::Timer.timeout(Settings.api_timeout, Timeout::Error) do
-      yield
-    end
+  def api_call_timeout(&block)
+    Timeout.timeout(Settings.api_timeout, Timeout::Error, &block)

   rescue Timeout::Error
     raise OSM::APITimeoutError
   end
 
   ##
   # wrap a web page in a timeout
   rescue Timeout::Error
     raise OSM::APITimeoutError
   end
 
   ##
   # wrap a web page in a timeout

-  def web_timeout
-    OSM::Timer.timeout(Settings.web_timeout, Timeout::Error) do
-      yield
-    end
+  def web_timeout(&block)
+    Timeout.timeout(Settings.web_timeout, Timeout::Error, &block)

   rescue ActionView::Template::Error => e
     e = e.cause
 
   rescue ActionView::Template::Error => e
     e = e.cause
 


@@ -284,9 +291,10 @@ class ApplicationController < ActionController::Base
       :style_src => %w['unsafe-inline']
     )
 
       :style_src => %w['unsafe-inline']
     )
 

-    if Settings.status == "database_offline" || Settings.status == "api_offline"
+    case Settings.status
+    when "database_offline", "api_offline"

       flash.now[:warning] = t("layouts.osm_offline")
       flash.now[:warning] = t("layouts.osm_offline")

-    elsif Settings.status == "database_readonly" || Settings.status == "api_readonly"
+    when "database_readonly", "api_readonly"

       flash.now[:warning] = t("layouts.osm_read_only")
     end
 
       flash.now[:warning] = t("layouts.osm_read_only")
     end
 


@@ -298,15 +306,13 @@ class ApplicationController < ActionController::Base
   end
 
   def preferred_editor
   end
 
   def preferred_editor

-    editor = if params[:editor]
-               params[:editor]
-             elsif current_user&.preferred_editor
-               current_user.preferred_editor
-             else
-               Settings.default_editor
-             end
-
-    editor
+    if params[:editor]
+      params[:editor]
+    elsif current_user&.preferred_editor
+      current_user.preferred_editor
+    else
+      Settings.default_editor
+    end

   end
 
   helper_method :preferred_editor
   end
 
   helper_method :preferred_editor


@@ -337,18 +343,18 @@ class ApplicationController < ActionController::Base
   end
 
   def deny_access(_exception)
   end
 
   def deny_access(_exception)

-    if current_token
+    if doorkeeper_token || current_token

       set_locale
       report_error t("oauth.permissions.missing"), :forbidden
     elsif current_user
       set_locale
       respond_to do |format|
       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.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.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.html { redirect_to login_path(:referer => request.fullpath) }

         format.any { head :forbidden }
       end
     else
         format.any { head :forbidden }
       end
     else


@@ -357,7 +363,7 @@ class ApplicationController < ActionController::Base
   end
 
   # extract authorisation credentials from headers, returns user = nil if none
   end
 
   # extract authorisation credentials from headers, returns user = nil if none

-  def get_auth_data
+  def 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
     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


@@ -375,16 +381,28 @@ class ApplicationController < ActionController::Base
 
   # clean any referer parameter
   def safe_referer(referer)
 
   # clean any referer parameter
   def safe_referer(referer)

-    referer = URI.parse(referer)
+    begin
+      referer = URI.parse(referer)
+
+      if referer.scheme == "http" || referer.scheme == "https"
+        referer.scheme = nil
+        referer.host = nil
+        referer.port = nil
+      elsif referer.scheme || referer.host || referer.port
+        referer = nil
+      end

 
 

-    if referer.scheme == "http" || referer.scheme == "https"
-      referer.scheme = nil
-      referer.host = nil
-      referer.port = nil
-    elsif referer.scheme || referer.host || referer.port
+      referer = nil if referer&.path&.first != "/"
+    rescue URI::InvalidURIError

       referer = nil
     end
 
       referer = nil
     end
 

-    referer.to_s
+    referer&.to_s

   end
   end

+
+  def scope_enabled?(scope)
+    doorkeeper_token&.includes_scope?(scope) || current_token&.includes_scope?(scope)
+  end
+
+  helper_method :scope_enabled?

 end
 end