2018-09-14 05:42:05 +00:00
# frozen_string_literal: true
2012-03-15 23:14:39 +00:00
class SearchController < ApplicationController
2017-12-11 14:21:06 +00:00
include ControllerWithCrossProjectAccessCheck
2014-01-18 12:16:46 +00:00
include SearchHelper
2020-08-28 12:10:37 +00:00
include RedisTracking
2014-01-18 12:16:46 +00:00
2021-07-28 15:09:57 +00:00
RESCUE_FROM_TIMEOUT_ACTIONS = [ :count , :show ] . freeze
2021-02-11 15:09:11 +00:00
track_redis_hll_event :show , name : 'i_search_total'
2020-08-28 12:10:37 +00:00
2019-06-26 23:19:59 +00:00
around_action :allow_gitaly_ref_name_caching
2021-08-26 21:11:25 +00:00
before_action :block_anonymous_global_searches , :check_scope_global_search_enabled , except : :opensearch
2017-12-11 14:21:06 +00:00
skip_before_action :authenticate_user!
requires_cross_project_access if : - > do
search_term_present = params [ :search ] . present? || params [ :term ] . present?
search_term_present && ! params [ :project_id ] . present?
end
2021-07-09 12:08:17 +00:00
rescue_from ActiveRecord :: QueryCanceled , with : :render_timeout
2015-05-01 08:39:11 +00:00
layout 'search'
2015-04-30 17:06:18 +00:00
2020-10-05 12:08:47 +00:00
feature_category :global_search
2012-03-15 23:14:39 +00:00
def show
2017-03-31 13:03:55 +00:00
@project = search_service . project
@group = search_service . group
2015-04-28 09:48:42 +00:00
2016-11-07 18:36:58 +00:00
return if params [ :search ] . blank?
2016-09-09 11:08:49 +00:00
2019-12-26 21:07:49 +00:00
return unless search_term_valid?
2020-10-22 03:08:25 +00:00
return if check_single_commit_result?
2016-04-19 07:52:15 +00:00
@search_term = params [ :search ]
2020-10-26 12:08:44 +00:00
@sort = params [ :sort ] || default_sort
2016-04-19 07:52:15 +00:00
2020-12-01 15:09:28 +00:00
@search_service = Gitlab :: View :: Presenter :: Factory . new ( search_service , current_user : current_user ) . fabricate!
@scope = @search_service . scope
2021-08-13 09:09:58 +00:00
@without_count = @search_service . without_count?
2020-12-01 15:09:28 +00:00
@show_snippets = @search_service . show_snippets?
@search_results = @search_service . search_results
@search_objects = @search_service . search_objects
@search_highlight = @search_service . search_highlight
2017-08-23 16:53:29 +00:00
2020-05-25 06:08:38 +00:00
increment_search_counters
2013-10-23 20:27:40 +00:00
end
2014-01-18 12:16:46 +00:00
2019-07-15 17:59:57 +00:00
def count
params . require ( [ :search , :scope ] )
scope = search_service . scope
2021-04-15 18:09:01 +00:00
count = 0
ApplicationRecord . with_fast_read_statement_timeout do
count = search_service . search_results . formatted_count ( scope )
end
2019-07-15 17:59:57 +00:00
2021-02-25 18:11:05 +00:00
# Users switching tabs will keep fetching the same tab counts so it's a
# good idea to cache in their browser just for a short time. They can still
# clear cache if they are seeing an incorrect count but inaccurate count is
# not such a bad thing.
expires_in 1 . minute
2019-07-15 17:59:57 +00:00
render json : { count : count }
end
2020-07-10 09:09:01 +00:00
# rubocop: disable CodeReuse/ActiveRecord
def autocomplete
term = params [ :term ]
if params [ :project_id ] . present?
@project = Project . find_by ( id : params [ :project_id ] )
@project = nil unless can? ( current_user , :read_project , @project )
end
@ref = params [ :project_ref ] if params [ :project_ref ] . present?
render json : search_autocomplete_opts ( term ) . to_json
end
# rubocop: enable CodeReuse/ActiveRecord
2021-02-01 12:09:03 +00:00
def opensearch
end
2017-01-11 04:20:32 +00:00
private
2020-10-26 12:08:44 +00:00
# overridden in EE
def default_sort
'created_desc'
end
2019-12-26 21:07:49 +00:00
def search_term_valid?
2020-01-14 18:08:31 +00:00
unless search_service . valid_query_length?
flash [ :alert ] = t ( 'errors.messages.search_chars_too_long' , count : SearchService :: SEARCH_CHAR_LIMIT )
2019-12-26 21:07:49 +00:00
return false
end
2020-01-14 18:08:31 +00:00
unless search_service . valid_terms_count?
flash [ :alert ] = t ( 'errors.messages.search_terms_too_long' , count : SearchService :: SEARCH_TERM_LIMIT )
2019-12-26 21:07:49 +00:00
return false
end
true
end
2020-10-22 03:08:25 +00:00
def check_single_commit_result?
return false if params [ :force_search_results ]
return false unless @project . present?
# download_code project policy grants user the read_commit ability
return false unless Ability . allowed? ( current_user , :download_code , @project )
2017-01-11 04:20:32 +00:00
2020-10-22 03:08:25 +00:00
query = params [ :search ] . strip . downcase
return false unless Commit . valid_hash? ( query )
commit = @project . commit_by ( oid : query )
return false unless commit . present?
link = search_path ( safe_params . merge ( force_search_results : true ) )
flash [ :notice ] = html_escape ( _ ( " You have been redirected to the only result; see the %{a_start}search results%{a_end} instead. " ) ) % { a_start : " <a href= \" #{ link } \" ><u> " . html_safe , a_end : '</u></a>' . html_safe }
redirect_to project_commit_path ( @project , commit )
true
2017-01-11 04:20:32 +00:00
end
2019-07-29 09:58:58 +00:00
2020-05-25 06:08:38 +00:00
def increment_search_counters
Gitlab :: UsageDataCounters :: SearchCounter . count ( :all_searches )
2019-07-29 09:58:58 +00:00
return if params [ :nav_source ] != 'navbar'
2020-05-25 06:08:38 +00:00
Gitlab :: UsageDataCounters :: SearchCounter . count ( :navbar_searches )
2019-07-29 09:58:58 +00:00
end
2020-07-30 12:09:33 +00:00
def append_info_to_payload ( payload )
super
# Merging to :metadata will ensure these are logged as top level keys
2020-09-14 03:09:21 +00:00
payload [ :metadata ] || = { }
2020-07-30 12:09:33 +00:00
payload [ :metadata ] [ 'meta.search.group_id' ] = params [ :group_id ]
payload [ :metadata ] [ 'meta.search.project_id' ] = params [ :project_id ]
2021-02-24 18:11:28 +00:00
payload [ :metadata ] [ 'meta.search.scope' ] = params [ :scope ] || @scope
2020-10-24 06:08:52 +00:00
payload [ :metadata ] [ 'meta.search.filters.confidential' ] = params [ :confidential ]
payload [ :metadata ] [ 'meta.search.filters.state' ] = params [ :state ]
payload [ :metadata ] [ 'meta.search.force_search_results' ] = params [ :force_search_results ]
2020-07-30 12:09:33 +00:00
end
2020-09-11 12:08:50 +00:00
def block_anonymous_global_searches
return if params [ :project_id ] . present? || params [ :group_id ] . present?
return if current_user
return unless :: Feature . enabled? ( :block_anonymous_global_searches )
store_location_for ( :user , request . fullpath )
redirect_to new_user_session_path , alert : _ ( 'You must be logged in to search across all of GitLab' )
end
2021-07-09 12:08:17 +00:00
2021-08-26 21:11:25 +00:00
def check_scope_global_search_enabled
return if params [ :project_id ] . present? || params [ :group_id ] . present?
search_allowed = case params [ :scope ]
when 'blobs'
Feature . enabled? ( :global_search_code_tab , current_user , type : :ops , default_enabled : true )
when 'commits'
Feature . enabled? ( :global_search_commits_tab , current_user , type : :ops , default_enabled : true )
when 'issues'
Feature . enabled? ( :global_search_issues_tab , current_user , type : :ops , default_enabled : true )
when 'merge_requests'
Feature . enabled? ( :global_search_merge_requests_tab , current_user , type : :ops , default_enabled : true )
when 'wiki_blobs'
Feature . enabled? ( :global_search_wiki_tab , current_user , type : :ops , default_enabled : true )
else
true
end
return if search_allowed
redirect_to search_path , alert : _ ( 'Global Search is disabled for this scope' )
end
2021-07-09 12:08:17 +00:00
def render_timeout ( exception )
2021-07-28 15:09:57 +00:00
raise exception unless action_name . to_sym . in? ( RESCUE_FROM_TIMEOUT_ACTIONS )
2021-07-09 12:08:17 +00:00
log_exception ( exception )
@timeout = true
2021-07-28 15:09:57 +00:00
if count_action_name?
render json : { } , status : :request_timeout
else
render status : :request_timeout
end
end
def count_action_name?
action_name . to_sym == :count
2021-07-09 12:08:17 +00:00
end
2012-03-15 23:14:39 +00:00
end
2020-08-28 12:10:37 +00:00
2021-05-11 21:10:21 +00:00
SearchController . prepend_mod_with ( 'SearchController' )