redmine/app/helpers/search_helper.rb

# frozen_string_literal: true

# Redmine - project management software
# Copyright (C) 2006-  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.

module SearchHelper
  def highlight_tokens(text, tokens)
    return text unless text && tokens && !tokens.empty?

    re_tokens = tokens.collect {|t| Regexp.escape(t)}
    regexp = Regexp.new "(#{re_tokens.join('|')})", Regexp::IGNORECASE
    result = +''
    text.split(regexp).each_with_index do |words, i|
      if result.length > 1200
        # maximum length of the preview reached
        result << '...'
        break
      end
      if i.even?
        result << h(words.length > 100 ? "#{words.slice(0..44)} ... #{words.slice(-45..-1)}" : words)
      else
        t = (tokens.index(words.downcase) || 0) % 4
        result << content_tag('span', h(words), :class => "highlight token-#{t}")
      end
    end
    result.html_safe
  end

  def type_label(t)
    l("label_#{t.singularize}_plural", :default => t.to_s.humanize)
  end

  def project_select_tag
    options = [[l(:label_project_all), 'all']]
    options << [l(:label_my_projects), 'my_projects'] unless User.current.memberships.empty?
    options << [l(:label_my_bookmarks), 'bookmarks'] unless User.current.bookmarked_project_ids.empty?
    options << [l(:label_and_its_subprojects, @project.name), 'subprojects'] unless @project.nil? || @project.descendants.active.empty?
    options << [@project.name, ''] unless @project.nil?
    label_tag("scope", l(:description_project_scope), :class => "hidden-for-sighted") +
    select_tag('scope', options_for_select(options, params[:scope].to_s)) if options.size > 1
  end

  def render_results_by_type(results_by_type)
    links = []
    # Sorts types by results count
    results_by_type.keys.sort_by {|k| results_by_type[k]}.reverse_each do |t|
      c = results_by_type[t]
      next if c == 0

      text = "#{type_label(t)} (#{c})"
      links << link_to(h(text), :q => params[:q], :titles_only => params[:titles_only],
                       :all_words => params[:all_words], :scope => params[:scope], t => 1)
    end
    ('<ul>'.html_safe +
        links.map {|link| content_tag('li', link)}.join(' ').html_safe +
        '</ul>'.html_safe) unless links.empty?
  end

  def issues_filter_path(question, options)
    projects_scope = options[:projects_scope]
    titles_only = options[:titles_only]
    all_words = options[:all_words]
    open_issues = options[:open_issues]

    field_to_search = titles_only ? 'subject' : 'any_searchable'
    params = {
      :set_filter => 1,
      :f => ['status_id', field_to_search],
      :op => {
        'status_id' => open_issues ? 'o' : '*',
        field_to_search => all_words ? '~' : '*~'
      },
      :v => {field_to_search => [question]},
      :sort => 'updated_on:desc'
    }

    case projects_scope
    when 'all'
      # nothing to do
    when 'my_projects'
      params[:f] << 'project_id'
      params[:op]['project_id'] = '='
      params[:v]['project_id'] = ['mine']
    when 'bookmarks'
      params[:f] << 'project_id'
      params[:op]['project_id'] = '='
      params[:v]['project_id'] = ['bookmarks']
    when 'subprojects'
      params[:f] << 'subproject_id'
      params[:op]['subproject_id'] = '*'
      params[:project_id] = @project.id
    else
      if @project
        # current project only
        params[:f] << 'subproject_id'
        params[:op]['subproject_id'] = '!*'
        params[:project_id] = @project.id
      end
      # else all projects
    end

    issues_path(params)
  end
end