jro_apps/redmine Commit - r13474:576a13e99d50

Option to search attachment filenames and description (#4383)....

Jean-Philippe Lang -

r13474:576a13e99d50

parent child

Context file:

r13474:576a13e99d50

Collapse all files

app/controllers/search_controller.rb +3 -1

                 @question.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'
                 # quick jump to an issue
                 if (m = @question.match(/^#?(\d+)$/)) && (issue = Issue.visible.find_by_id(m[1].to_i))
                 fetcher = Redmine::Search::Fetcher.new(
                   @question, User.current, @scope, projects_to_search,
-                  :all_words => @all_words, :titles_only => @titles_only, :cache => params[:page].present?
+                  :all_words => @all_words, :titles_only => @titles_only, :attachments => @search_attachments,
+                  :cache => params[:page].present?
                 )
                 if fetcher.tokens.present?

app/models/project.rb +1 -1

                                  :delete_permission => :manage_files
               acts_as_customizable
-              acts_as_searchable :columns => ['name', 'identifier', 'description'], :project_key => 'id', :permission => nil
+              acts_as_searchable :columns => ['name', 'identifier', 'description'], :project_key => "#{Project.table_name}.id", :permission => nil
               acts_as_event :title => Proc.new {|o| "#{l(:label_project)}: #{o.name}"},
                             :url => Proc.new {|o| {:controller => 'projects', :action => 'show', :id => o}},
                             :author => nil

app/views/search/index.html.erb +21 -1

@@ -17,9 +17,21
17	<% end %>	17	<% end %>
18	</p>	18	</p>
19		19
		20	<fieldset class="collapsible collapsed">
		21	<legend onclick="toggleFieldset(this);"><%= l(:label_options) %></legend>
		22	<div id="options-content" style="display:none;">
		23	<p>
		24	<label><%= radio_button_tag 'attachments', '0', @search_attachments == '0' %> <%= l(:label_search_attachments_no) %></label>
		25	<label><%= radio_button_tag 'attachments', '1', @search_attachments == '1' %> <%= l(:label_search_attachments_yes) %></label>
		26	<label><%= radio_button_tag 'attachments', 'only', @search_attachments == 'only' %> <%= l(:label_search_attachments_only) %></label>
		27	</p>
		28	</div>
		29	</fieldset>
		30	<%= hidden_field_tag 'options', '', :id => 'show-options' %>
		31
		32	</div>
20	<p><%= submit_tag l(:button_submit) %></p>	33	<p><%= submit_tag l(:button_submit) %></p>
21	<% end %>	34	<% end %>
22	</div>
23		35
24	<% if @results %>	36	<% if @results %>
25	<div id="search-results-counts">	37	<div id="search-results-counts">
@@ -53,4 +65,12 $("#search-types a").click(function(e){
53	$("#search-form").submit();	65	$("#search-form").submit();
54	}	66	}
55	});	67	});
		68
		69	$("#search-form").submit(function(){
		70	$("#show-options").val($("#options-content").is(":visible") ? '1' : '0');
		71	});
		72
		73	<% if params[:options] == '1' %>
		74	toggleFieldset($("#options-content"));
		75	<% end %>
56	<% end %>	76	<% end %>

config/locales/en.yml +3 0

               label_edit_attachments: Edit attached files
               label_link_copied_issue: Link copied issue
               label_ask: Ask
+              label_search_attachments_yes: Search attachment filenames and descriptions
+              label_search_attachments_no: Do not search attachments
+              label_search_attachments_only: Search attachments only
               button_login: Login
               button_submit: Submit

config/locales/fr.yml +3 0

               label_edit_attachments: Modifier les fichiers attachés
               label_link_copied_issue: Lier la demande copiée
               label_ask: Demander
+              label_search_attachments_yes: Rechercher les noms et descriptions de fichiers
+              label_search_attachments_no: Ne pas rechercher les fichiers
+              label_search_attachments_only: Rechercher les fichiers uniquement
               button_login: Connexion
               button_submit: Soumettre

lib/plugins/acts_as_searchable/lib/acts_as_searchable.rb +50 -34

                       # Should we search additional associations on this model ?
                       searchable_options[:search_custom_fields] = reflect_on_association(:custom_values).present?
+                      searchable_options[:search_attachments] = reflect_on_association(:attachments).present?
                       searchable_options[:search_journals] = reflect_on_association(:journals).present?
                       send :include, Redmine::Acts::Searchable::InstanceMethods
                       # Valid options:
                       # * :titles_only - searches tokens in the first searchable column only
                       # * :all_words - searches results that match all token
+                      # * :
                       # * :limit - maximum number of results to return
                       #
                       # Example:
                         columns = searchable_options[:columns]
                         columns = columns[0..0] if options[:titles_only]
-                        token_clauses = columns.collect {|column| "(#{search_token_match_statement(column)})"}
+                        r = []
-                        sql = (['(' + token_clauses.join(' OR ') + ')'] * tokens.size).join(options[:all_words] ? ' AND ' : ' OR ')
+                        queries = 0
-                        tokens_conditions = [sql, * (tokens.collect {|w| "%#{w}%"} * token_clauses.size).sort]
-                        r = fetch_ranks_and_ids(search_scope(user, projects).where(tokens_conditions), options[:limit])
+                        unless options[:attachments] == 'only'
-                        sort_and_limit_results = false
+                          r = fetch_ranks_and_ids(
+                            search_scope(user, projects).
-                        if !options[:titles_only] && searchable_options[:search_custom_fields]
+                            where(search_tokens_condition(columns, tokens, options[:all_words])),
-                          searchable_custom_fields = CustomField.where(:type => "#{self.name}CustomField", :searchable => true).to_a
+                            options[:limit]
+                          )
+                          queries += 1
-                          if searchable_custom_fields.any?
+                          if !options[:titles_only] && searchable_options[:search_custom_fields]
-                            fields_by_visibility = searchable_custom_fields.group_by {|field|
+                            searchable_custom_fields = CustomField.where(:type => "#{self.name}CustomField", :searchable => true).to_a
-                              field.visibility_by_project_condition(searchable_options[:project_key], user, "#{CustomValue.table_name}.custom_field_id")
+                            if searchable_custom_fields.any?
-                            clauses = []
+                              fields_by_visibility = searchable_custom_fields.group_by {|field|
-                            fields_by_visibility.each do |visibility, fields|
+                                field.visibility_by_project_condition(searchable_options[:project_key], user, "#{CustomValue.table_name}.custom_field_id")
-                              clauses << "(#{CustomValue.table_name}.custom_field_id IN (#{fields.map(&:id).join(',')}) AND (#{visibility}))"
-                            end
+                              clauses = []
-                            visibility = clauses.join(' OR ')
+                              fields_by_visibility.each do |visibility, fields|
+                                clauses << "(#{CustomValue.table_name}.custom_field_id IN (#{fields.map(&:id).join(',')}) AND (#{visibility}))"
+                              end
+                              visibility = clauses.join(' OR ')
-                            sql = ([search_token_match_statement("#{CustomValue.table_name}.value")] * tokens.size).join(options[:all_words] ? ' AND ' : ' OR ')
+                              r |= fetch_ranks_and_ids(
-                            tokens_conditions = [sql, * tokens.collect {|w| "%#{w}%"}.sort]
+                                search_scope(user, projects).
+                                joins(:custom_values).
+                                where(visibility).
+                                where(search_tokens_condition(["#{CustomValue.table_name}.value"], tokens, options[:all_words])),
+                                options[:limit]
+                              )
+                              queries += 1
+                            end
+                          end
+                          if !options[:titles_only] && searchable_options[:search_journals]
                             r |= fetch_ranks_and_ids(
                               search_scope(user, projects).
-                              joins(:custom_values).
+                              joins(:journals).
-                              where(visibility).
+                              where("#{Journal.table_name}.private_notes = ? OR (#{Project.allowed_to_condition(user, :view_private_notes)})", false).
-                              where(tokens_conditions),
+                              where(search_tokens_condition(["#{Journal.table_name}.notes"], tokens, options[:all_words])),
                               options[:limit]
                             )
+                            queries += 1
-                            sort_and_limit_results = true
                           end
                         end
-                        if !options[:titles_only] && searchable_options[:search_journals]
+                        if searchable_options[:search_attachments] && (options[:titles_only] ? options[:attachments] == 'only' : options[:attachments] != '0')
-                          sql = ([search_token_match_statement("#{Journal.table_name}.notes")] * tokens.size).join(options[:all_words] ? ' AND ' : ' OR ')
-                          tokens_conditions = [sql, * tokens.collect {|w| "%#{w}%"}.sort]
                           r |= fetch_ranks_and_ids(
                             search_scope(user, projects).
-                            joins(:journals).
+                            joins(:attachments).
-                            where("#{Journal.table_name}.private_notes = ? OR (#{Project.allowed_to_condition(user, :view_private_notes)})", false).
+                            where(search_tokens_condition(["#{Attachment.table_name}.filename", "#{Attachment.table_name}.description"], tokens, options[:all_words])),
-                            where(tokens_conditions),
                             options[:limit]
                           )
+                          queries += 1
-                          sort_and_limit_results = true
                         end
-                        if sort_and_limit_results
+                        if queries > 1
                           r = r.sort.reverse
                           if options[:limit] && r.size > options[:limit]
                             r = r[0, options[:limit]]
                         r
                       end
+                      def search_tokens_condition(columns, tokens, all_words)
+                        token_clauses = columns.map {|column| "(#{search_token_match_statement(column)})"}
+                        sql = (['(' + token_clauses.join(' OR ') + ')'] * tokens.size).join(all_words ? ' AND ' : ' OR ')
+                        [sql, * (tokens.collect {|w| "%#{w}%"} * token_clauses.size).sort]
+                      end
+                      private :search_tokens_condition
                       def search_token_match_statement(column, value='?')
                         case connection.adapter_name
                         when /postgresql/i

public/stylesheets/application.css +2 0

             p.pagination {margin-top:8px; font-size: 90%}
+            #search-form fieldset p {margin:0.2em 0;}
             /***** Tabular forms ******/
             .tabular p{
               margin: 0;

test/functional/search_controller_test.rb +29 0

@@ -180,6 +180,35 class SearchControllerTest < ActionController::TestCase
180	assert results.include?(Issue.find(7))	180	assert results.include?(Issue.find(7))
181	end	181	end
182		182
		183	def test_search_without_attachments
		184	issue = Issue.generate! :subject => 'search_attachments'
		185	attachment = Attachment.generate! :container => Issue.find(1), :filename => 'search_attachments.patch'
		186
		187	get :index, :id => 1, :q => 'search_attachments', :attachments => '0'
		188	results = assigns(:results)
		189	assert_equal 1, results.size
		190	assert_equal issue, results.first
		191	end
		192
		193	def test_search_attachments_only
		194	issue = Issue.generate! :subject => 'search_attachments'
		195	attachment = Attachment.generate! :container => Issue.find(1), :filename => 'search_attachments.patch'
		196
		197	get :index, :id => 1, :q => 'search_attachments', :attachments => 'only'
		198	results = assigns(:results)
		199	assert_equal 1, results.size
		200	assert_equal attachment.container, results.first
		201	end
		202
		203	def test_search_with_attachments
		204	Issue.generate! :subject => 'search_attachments'
		205	Attachment.generate! :container => Issue.find(1), :filename => 'search_attachments.patch'
		206
		207	get :index, :id => 1, :q => 'search_attachments', :attachments => '1'
		208	results = assigns(:results)
		209	assert_equal 2, results.size
		210	end
		211
183	def test_search_all_words	212	def test_search_all_words
184	# 'all words' is on by default	213	# 'all words' is on by default
185	get :index, :id => 1, :q => 'recipe updating saving', :all_words => '1'	214	get :index, :id => 1, :q => 'recipe updating saving', :all_words => '1'

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages