debian-mirror-gitlab/app/controllers/search_controller.rb

209 lines
6.7 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
class SearchController < ApplicationController
2018-03-27 19:54:05 +05:30
include ControllerWithCrossProjectAccessCheck
2014-09-02 18:07:02 +05:30
include SearchHelper
2020-11-24 15:15:51 +05:30
include RedisTracking
2014-09-02 18:07:02 +05:30
2021-10-27 15:23:28 +05:30
RESCUE_FROM_TIMEOUT_ACTIONS = [:count, :show].freeze
2021-03-11 19:13:27 +05:30
track_redis_hll_event :show, name: 'i_search_total'
2020-11-24 15:15:51 +05:30
2019-09-30 21:07:59 +05:30
around_action :allow_gitaly_ref_name_caching
2021-11-11 11:23:49 +05:30
before_action :block_anonymous_global_searches, :check_scope_global_search_enabled, except: :opensearch
2021-11-18 22:05:49 +05:30
before_action :strip_surrounding_whitespace_from_search, except: :opensearch
2018-03-27 19:54:05 +05:30
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-09-30 23:02:18 +05:30
rescue_from ActiveRecord::QueryCanceled, with: :render_timeout
2015-09-11 14:41:01 +05:30
layout 'search'
2021-01-03 14:25:43 +05:30
feature_category :global_search
2021-11-18 22:05:49 +05:30
urgency :high, [:opensearch]
2021-01-03 14:25:43 +05:30
2014-09-02 18:07:02 +05:30
def show
2017-08-17 22:00:37 +05:30
@project = search_service.project
@group = search_service.group
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
return if params[:search].blank?
2016-09-29 09:46:39 +05:30
2020-03-13 15:44:24 +05:30
return unless search_term_valid?
2021-01-29 00:20:46 +05:30
return if check_single_commit_result?
2016-06-02 11:05:42 +05:30
@search_term = params[:search]
2021-01-29 00:20:46 +05:30
@sort = params[:sort] || default_sort
2016-06-02 11:05:42 +05:30
2021-02-22 17:27:13 +05:30
@search_service = Gitlab::View::Presenter::Factory.new(search_service, current_user: current_user).fabricate!
@scope = @search_service.scope
2021-10-27 15:23:28 +05:30
@without_count = @search_service.without_count?
2021-02-22 17:27:13 +05:30
@show_snippets = @search_service.show_snippets?
@search_results = @search_service.search_results
@search_objects = @search_service.search_objects
@search_highlight = @search_service.search_highlight
2021-12-11 22:18:48 +05:30
@aggregations = @search_service.search_aggregations
2018-03-17 18:26:18 +05:30
2020-06-23 00:09:42 +05:30
increment_search_counters
2014-09-02 18:07:02 +05:30
end
2019-10-12 21:52:04 +05:30
def count
params.require([:search, :scope])
scope = search_service.scope
2021-04-29 21:17:54 +05:30
count = 0
ApplicationRecord.with_fast_read_statement_timeout do
count = search_service.search_results.formatted_count(scope)
end
2019-10-12 21:52:04 +05:30
2021-04-17 20:07:23 +05:30
# 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-10-12 21:52:04 +05:30
render json: { count: count }
end
2020-07-28 23:09:34 +05:30
# 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-03-11 19:13:27 +05:30
def opensearch
end
2020-06-23 00:09:42 +05:30
private
2014-09-02 18:07:02 +05:30
2021-01-29 00:20:46 +05:30
# overridden in EE
def default_sort
'created_desc'
end
2020-03-13 15:44:24 +05:30
def search_term_valid?
unless search_service.valid_query_length?
flash[:alert] = t('errors.messages.search_chars_too_long', count: SearchService::SEARCH_CHAR_LIMIT)
return false
end
unless search_service.valid_terms_count?
flash[:alert] = t('errors.messages.search_terms_too_long', count: SearchService::SEARCH_TERM_LIMIT)
return false
end
true
end
2021-01-29 00:20:46 +05:30
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-08-17 22:00:37 +05:30
2021-01-29 00:20:46 +05:30
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-08-17 22:00:37 +05:30
end
2019-10-12 21:52:04 +05:30
2020-06-23 00:09:42 +05:30
def increment_search_counters
Gitlab::UsageDataCounters::SearchCounter.count(:all_searches)
2019-10-12 21:52:04 +05:30
return if params[:nav_source] != 'navbar'
2020-06-23 00:09:42 +05:30
Gitlab::UsageDataCounters::SearchCounter.count(:navbar_searches)
2019-10-12 21:52:04 +05:30
end
2020-10-24 23:57:45 +05:30
def append_info_to_payload(payload)
super
# Merging to :metadata will ensure these are logged as top level keys
2020-11-24 15:15:51 +05:30
payload[:metadata] ||= {}
2020-10-24 23:57:45 +05:30
payload[:metadata]['meta.search.group_id'] = params[:group_id]
payload[:metadata]['meta.search.project_id'] = params[:project_id]
2021-04-17 20:07:23 +05:30
payload[:metadata]['meta.search.scope'] = params[:scope] || @scope
2021-01-29 00:20:46 +05:30
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-10-24 23:57:45 +05:30
end
2020-11-24 15:15:51 +05:30
def block_anonymous_global_searches
return if params[:project_id].present? || params[:group_id].present?
return if current_user
2021-12-11 22:18:48 +05:30
return unless ::Feature.enabled?(:block_anonymous_global_searches, type: :ops)
2020-11-24 15:15:51 +05:30
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-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
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-09-30 23:02:18 +05:30
def render_timeout(exception)
2021-10-27 15:23:28 +05:30
raise exception unless action_name.to_sym.in?(RESCUE_FROM_TIMEOUT_ACTIONS)
2021-09-30 23:02:18 +05:30
log_exception(exception)
@timeout = true
2021-10-27 15:23:28 +05:30
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-09-30 23:02:18 +05:30
end
2021-11-18 22:05:49 +05:30
def strip_surrounding_whitespace_from_search
%i(term search).each { |param| params[param]&.strip! }
end
2014-09-02 18:07:02 +05:30
end
2020-11-24 15:15:51 +05:30
2021-06-08 01:23:25 +05:30
SearchController.prepend_mod_with('SearchController')