Class: SearchController

Inherits:
ApplicationController show all
Defined in:
app/controllers/search_controller.rb

Overview

Redmine - project management software Copyright (C) 2006-2020 Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Instance Method Summary collapse

Methods inherited from ApplicationController

#_include_layout?, accept_api_auth, #accept_api_auth?, accept_rss_auth, #accept_rss_auth?, #api_key_from_request, #api_offset_and_limit, #api_request?, #api_switch_user_from_request, #authorize, #authorize_global, #autologin_cookie_name, #back_url, #check_if_login_required, #check_password_change, #check_project_privacy, #deny_access, #filename_for_content_disposition, #find_attachments, #find_current_user, #find_issue, #find_issues, #find_model_object, #find_optional_project, #find_optional_project_by_id, #find_project, #find_project_by_project_id, #find_project_from_association, #handle_unverified_request, #logged_user=, #logout_user, #missing_template, model_object, #parse_params_for_bulk_update, #parse_qvalues, #per_page_option, #query_statement_invalid, #record_project_usage, #redirect_back_or_default, #redirect_to_referer_or, #render_403, #render_404, #render_api_errors, #render_api_head, #render_api_ok, #render_attachment_warning_if_needed, #render_error, #render_feed, #render_validation_errors, #require_admin, #require_admin_or_api_request, #require_login, #session_expiration, #session_expired?, #set_localization, #start_user_session, #try_to_autologin, #use_layout, #user_setup, #verify_authenticity_token

Methods included from Redmine::SudoMode::Controller

#process_sudo_form, #render_sudo_form, #require_sudo_mode, #sudo_mode, #sudo_timestamp_valid?, #update_sudo_timestamp!

Methods included from Redmine::MenuManager::MenuController

#current_menu, #current_menu_item, included, #menu_items, #redirect_to_menu_item, #redirect_to_project_menu_item

Methods included from Redmine::Search::Controller

#default_search_scope, #default_search_scopes, included

Methods included from AvatarsHelper

#assignee_avatar, #author_avatar, #avatar, #avatar_edit_link

Methods included from GravatarHelper::PublicMethods

#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url

Methods included from RoutesHelper

#_new_project_issue_path, #_new_time_entry_path, #_project_calendar_path, #_project_gantt_path, #_project_issues_path, #_project_news_path, #_report_time_entries_path, #_time_entries_path, #board_path

Methods included from Redmine::Hook::Helper

#call_hook

Methods included from Redmine::Pagination

#paginate, #paginator

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, included, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

Instance Method Details

#indexObject


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'app/controllers/search_controller.rb', line 24

def index
  @question = params[:q]&.strip || ""
  @all_words = params[:all_words] ? params[:all_words].present? : true
  @titles_only = params[:titles_only] ? params[:titles_only].present? : false
  @search_attachments = params[:attachments].presence || '0'
  @open_issues = params[:open_issues] ? params[:open_issues].present? : false

  case params[:format]
  when 'xml', 'json'
    @offset, @limit = api_offset_and_limit
  else
    @offset = nil
    @limit = Setting.search_results_per_page.to_i
    @limit = 10 if @limit == 0
  end

  # quick jump to an issue
  if !api_request? && (m = @question.match(/^#?(\d+)$/)) && (issue = Issue.visible.find_by_id(m[1].to_i))
    redirect_to issue_path(issue)
    return
  end

  projects_to_search =
    case params[:scope]
    when 'all'
      nil
    when 'my_projects'
      User.current.projects
    when 'subprojects'
      @project ? (@project.self_and_descendants.to_a) : nil
    else
      @project
    end

  @object_types = Redmine::Search.available_search_types.dup
  if projects_to_search.is_a? Project
    # don't search projects
    @object_types.delete('projects')
    # only show what the user is allowed to view
    @object_types = @object_types.select {|o| User.current.allowed_to?("view_#{o}".to_sym, projects_to_search)}
  end

  @scope = @object_types.select {|t| params[t]}
  @scope = @object_types if @scope.empty?

  fetcher = Redmine::Search::Fetcher.new(
    @question, User.current, @scope, projects_to_search,
    :all_words => @all_words, :titles_only => @titles_only, :attachments => @search_attachments, :open_issues => @open_issues,
    :cache => params[:page].present?, :params => params.to_unsafe_hash
  )

  if fetcher.tokens.present?
    @result_count = fetcher.result_count
    @result_count_by_type = fetcher.result_count_by_type
    @tokens = fetcher.tokens

    @result_pages = Paginator.new @result_count, @limit, params['page']
    @offset ||= @result_pages.offset
    @results = fetcher.results(@offset, @result_pages.per_page)
  else
    @question = ""
  end
  respond_to do |format|
    format.html { render :layout => false if request.xhr? }
    format.api  { @results ||= []; render :layout => false }
  end
end