gitlab-org--gitlab-foss/app/controllers/application_controller.rb

394 lines
11 KiB
Ruby
Raw Normal View History

require 'gon'
2015-08-04 18:21:12 -04:00
require 'fogbugz'
2013-08-21 05:33:12 -04:00
class ApplicationController < ActionController::Base
include Gitlab::GonHelper
include GitlabRoutingHelper
include PageLayoutHelper
include SafeParamsHelper
include SentryHelper
include WorkhorseHelper
include EnforcesTwoFactorAuthentication
include WithPerformanceBar
2017-09-15 13:31:32 -04:00
before_action :authenticate_sessionless_user!
before_action :authenticate_user!
before_action :enforce_terms!, if: :should_enforce_terms?
2015-11-11 23:25:31 -05:00
before_action :validate_user_service_ticket!
before_action :check_password_expiration
before_action :ldap_security_check
before_action :sentry_context
before_action :default_headers
before_action :add_gon_variables, unless: :peek_request?
before_action :configure_permitted_parameters, if: :devise_controller?
before_action :require_email, unless: :devise_controller?
around_action :set_locale
after_action :set_page_title_header, if: -> { request.format == :json }
protect_from_forgery with: :exception
helper_method :can?
helper_method :import_sources_enabled?, :github_import_enabled?, :gitea_import_enabled?, :github_import_configured?, :gitlab_import_enabled?, :gitlab_import_configured?, :bitbucket_import_enabled?, :bitbucket_import_configured?, :google_code_import_enabled?, :fogbugz_import_enabled?, :git_import_enabled?, :gitlab_project_import_enabled?
2011-10-08 17:36:38 -04:00
rescue_from Encoding::CompatibilityError do |exception|
2012-11-06 15:15:25 -05:00
log_exception(exception)
2012-09-26 16:24:52 -04:00
render "errors/encoding", layout: "errors", status: 500
end
rescue_from ActiveRecord::RecordNotFound do |exception|
2012-11-06 15:15:25 -05:00
log_exception(exception)
2015-10-09 13:07:29 -04:00
render_404
2011-10-09 17:15:28 -04:00
end
rescue_from(ActionController::UnknownFormat) do
render_404
end
rescue_from Gitlab::Access::AccessDeniedError do |exception|
render_403
end
rescue_from Gitlab::Auth::TooManyIps do |e|
head :forbidden, retry_after: Gitlab::Auth::UniqueIpsLimiter.config.unique_ips_limit_time_window
end
rescue_from Gitlab::Git::Storage::Inaccessible, GRPC::Unavailable, Gitlab::Git::CommandError do |exception|
2017-05-17 12:17:15 -04:00
Raven.capture_exception(exception) if sentry_enabled?
log_exception(exception)
headers['Retry-After'] = exception.retry_after if exception.respond_to?(:retry_after)
render_503
end
def redirect_back_or_default(default: root_path, options: {})
redirect_to request.referer.present? ? :back : default, options
end
def not_found
render_404
end
def route_not_found
if current_user
not_found
else
authenticate_user!
end
end
protected
2011-10-08 17:36:38 -04:00
def append_info_to_payload(payload)
super
payload[:remote_ip] = request.remote_ip
logged_user = auth_user
if logged_user.present?
payload[:user_id] = logged_user.try(:id)
payload[:username] = logged_user.try(:username)
end
if response.status == 422 && response.body.present? && response.content_type == 'application/json'.freeze
payload[:response] = response.body
end
end
# Controllers such as GitHttpController may use alternative methods
# (e.g. tokens) to authenticate the user, whereas Devise sets current_user
def auth_user
return current_user if current_user.present?
return try(:authenticated_user)
end
2017-11-08 13:41:07 -05:00
# This filter handles personal access tokens, and atom requests with rss tokens
2017-09-15 13:31:32 -04:00
def authenticate_sessionless_user!
2017-10-13 20:05:18 -04:00
user = Gitlab::Auth::RequestAuthenticator.new(request).find_sessionless_user
2017-09-15 13:31:32 -04:00
sessionless_sign_in(user) if user
end
2012-11-06 15:15:25 -05:00
def log_exception(exception)
Raven.capture_exception(exception) if sentry_enabled?
backtrace_cleaner = Gitlab.rails5? ? env["action_dispatch.backtrace_cleaner"] : env
application_trace = ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, exception).application_trace
application_trace.map! { |t| " #{t}\n" }
2012-11-06 15:15:25 -05:00
logger.error "\n#{exception.class.name} (#{exception.message}):\n#{application_trace.join}"
end
def after_sign_in_path_for(resource)
stored_location_for(:redirect) || stored_location_for(resource) || root_path
2012-04-13 01:12:34 -04:00
end
def after_sign_out_path_for(resource)
Gitlab::CurrentSettings.after_sign_out_path.presence || new_user_session_path
end
def can?(object, action, subject = :global)
2016-08-08 14:55:13 -04:00
Ability.allowed?(object, action, subject)
2011-10-08 17:36:38 -04:00
end
def access_denied!(message = nil)
# If we display a custom access denied message to the user, we don't want to
# hide existence of the resource, rather tell them they cannot access it using
# the provided message
status = message.present? ? :forbidden : :not_found
2017-05-09 00:15:34 -04:00
respond_to do |format|
format.any { head status }
format.html do
render "errors/access_denied",
layout: "errors",
status: status,
locals: { message: message }
end
2017-05-09 00:15:34 -04:00
end
end
def git_not_found!
render "errors/git_not_found.html", layout: "errors", status: 404
2011-10-08 17:36:38 -04:00
end
2014-02-07 11:59:55 -05:00
def render_403
2018-05-31 17:28:19 -04:00
respond_to do |format|
format.any { head :forbidden }
format.html { render "errors/access_denied", layout: "errors", status: 403 }
end
2011-10-14 11:08:25 -04:00
end
2011-10-15 11:51:58 -04:00
2014-02-07 11:59:55 -05:00
def render_404
respond_to do |format|
2018-05-31 17:28:19 -04:00
format.html { render "errors/not_found", layout: "errors", status: 404 }
# Prevent the Rails CSRF protector from thinking a missing .js file is a JavaScript file
format.js { render json: '', status: :not_found, content_type: 'application/json' }
2016-09-01 11:20:29 -04:00
format.any { head :not_found }
end
2012-12-04 22:14:05 -05:00
end
def respond_422
head :unprocessable_entity
end
2017-05-17 12:17:15 -04:00
def render_503
respond_to do |format|
format.html do
render(
file: Rails.root.join("public", "503"),
layout: false,
status: :service_unavailable
)
end
format.any { head :service_unavailable }
end
end
2011-11-20 15:32:12 -05:00
def no_cache_headers
response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
response.headers["Pragma"] = "no-cache"
response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
end
2012-01-27 18:49:14 -05:00
2013-02-02 13:32:13 -05:00
def default_headers
headers['X-Frame-Options'] = 'DENY'
headers['X-XSS-Protection'] = '1; mode=block'
2013-12-27 06:38:29 -05:00
headers['X-UA-Compatible'] = 'IE=edge'
headers['X-Content-Type-Options'] = 'nosniff'
2013-02-02 13:32:13 -05:00
end
2015-11-11 23:25:31 -05:00
def validate_user_service_ticket!
return unless signed_in? && session[:service_tickets]
valid = session[:service_tickets].all? do |provider, ticket|
Gitlab::Auth::OAuth::Session.valid?(provider, ticket)
2015-11-11 23:25:31 -05:00
end
unless valid
session[:service_tickets] = nil
sign_out current_user
redirect_to new_user_session_path
end
end
def check_password_expiration
return if session[:impersonator_id] || !current_user&.allow_password_authentication?
password_expires_at = current_user&.password_expires_at
if password_expires_at && password_expires_at < Time.now
2017-02-21 17:31:14 -05:00
return redirect_to new_profile_password_path
end
end
def ldap_security_check
if current_user && current_user.requires_ldap_check?
2016-03-10 06:37:14 -05:00
return unless current_user.try_obtain_ldap_lease
2016-03-09 13:11:24 -05:00
unless Gitlab::Auth::LDAP::Access.allowed?(current_user)
sign_out current_user
flash[:alert] = "Access denied for your LDAP account."
redirect_to new_user_session_path
end
end
end
def event_filter
# Split using comma to maintain backward compatibility Ex/ "filter1,filter2"
filters = cookies['event_filter'].split(',')[0] if cookies['event_filter'].present?
@event_filter ||= EventFilter.new(filters)
end
# JSON for infinite scroll via Pager object
def pager_json(partial, count, locals = {})
html = render_to_string(
partial,
locals: locals,
layout: false,
formats: [:html]
)
render json: {
html: html,
count: count
}
end
2016-02-03 18:21:14 -05:00
def view_to_html_string(partial, locals = {})
render_to_string(
2016-02-03 18:21:14 -05:00
partial,
locals: locals,
layout: false,
formats: [:html]
)
end
def configure_permitted_parameters
devise_parameter_sanitizer.permit(:sign_in, keys: [:username, :email, :password, :login, :remember_me, :otp_attempt])
end
def hexdigest(string)
Digest::SHA1.hexdigest string
end
def require_email
if current_user && current_user.temp_oauth_email? && session[:impersonator_id].nil?
2017-02-21 17:31:14 -05:00
return redirect_to profile_path, notice: 'Please complete your profile with email address'
end
end
def enforce_terms!
return unless current_user
return if current_user.terms_accepted?
message = _("Please accept the Terms of Service before continuing.")
if sessionless_user?
access_denied!(message)
else
# Redirect to the destination if the request is a get.
# Redirect to the source if it was a post, so the user can re-submit after
# accepting the terms.
redirect_path = if request.get?
request.fullpath
else
URI(request.referer).path if request.referer
end
flash[:notice] = message
redirect_to terms_path(redirect: redirect_path), status: :found
end
end
def import_sources_enabled?
!Gitlab::CurrentSettings.import_sources.empty?
end
2015-02-17 16:52:32 -05:00
def github_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('github')
end
def gitea_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('gitea')
2016-10-17 11:58:57 -04:00
end
def github_import_configured?
Gitlab::Auth::OAuth::Provider.enabled?(:github)
2015-02-17 16:52:32 -05:00
end
def gitlab_import_enabled?
request.host != 'gitlab.com' && Gitlab::CurrentSettings.import_sources.include?('gitlab')
end
def gitlab_import_configured?
Gitlab::Auth::OAuth::Provider.enabled?(:gitlab)
2015-02-17 16:52:32 -05:00
end
def bitbucket_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('bitbucket')
end
def bitbucket_import_configured?
Gitlab::Auth::OAuth::Provider.enabled?(:bitbucket)
2015-02-17 16:52:32 -05:00
end
def google_code_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('google_code')
end
2015-08-04 18:21:12 -04:00
def fogbugz_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('fogbugz')
2015-08-04 18:21:12 -04:00
end
def git_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('git')
end
def gitlab_project_import_enabled?
Gitlab::CurrentSettings.import_sources.include?('gitlab_project')
end
# U2F (universal 2nd factor) devices need a unique identifier for the application
# to perform authentication.
# https://developers.yubico.com/U2F/App_ID.html
def u2f_app_id
request.base_url
end
2017-04-13 02:03:47 -04:00
def set_locale(&block)
Gitlab::I18n.with_user_locale(current_user, &block)
2017-04-13 02:03:47 -04:00
end
def sessionless_sign_in(user)
if user && can?(user, :log_in)
# Notice we are passing store false, so the user is not
# actually stored in the session and a token is needed
# for every request. If you want the token to work as a
# sign in token, you can simply remove store: false.
sign_in user, store: false
end
end
def set_page_title_header
2017-09-26 12:05:19 -04:00
# Per https://tools.ietf.org/html/rfc5987, headers need to be ISO-8859-1, not UTF-8
response.headers['Page-Title'] = URI.escape(page_title('GitLab'))
end
def sessionless_user?
current_user && !session.keys.include?('warden.user.user.key')
end
def peek_request?
request.path.start_with?('/-/peek')
end
def should_enforce_terms?
return false unless Gitlab::CurrentSettings.current_application_settings.enforce_terms
!(peek_request? || devise_controller?)
end
2011-10-08 17:36:38 -04:00
end