Chris@1296
|
1 # Redmine - project management software
|
Chris@1296
|
2 # Copyright (C) 2006-2012 Jean-Philippe Lang
|
Chris@1296
|
3 #
|
Chris@1296
|
4 # This program is free software; you can redistribute it and/or
|
Chris@1296
|
5 # modify it under the terms of the GNU General Public License
|
Chris@1296
|
6 # as published by the Free Software Foundation; either version 2
|
Chris@1296
|
7 # of the License, or (at your option) any later version.
|
Chris@1296
|
8 #
|
Chris@1296
|
9 # This program is distributed in the hope that it will be useful,
|
Chris@1296
|
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
Chris@1296
|
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
Chris@1296
|
12 # GNU General Public License for more details.
|
Chris@1296
|
13 #
|
Chris@1296
|
14 # You should have received a copy of the GNU General Public License
|
Chris@1296
|
15 # along with this program; if not, write to the Free Software
|
Chris@1296
|
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
Chris@1296
|
17
|
Chris@1296
|
18 module Redmine
|
Chris@1296
|
19 module Acts
|
Chris@1296
|
20 module Searchable
|
Chris@1296
|
21 def self.included(base)
|
Chris@1296
|
22 base.extend ClassMethods
|
Chris@1296
|
23 end
|
Chris@1296
|
24
|
Chris@1296
|
25 module ClassMethods
|
Chris@1296
|
26 # Options:
|
Chris@1296
|
27 # * :columns - a column or an array of columns to search
|
Chris@1296
|
28 # * :project_key - project foreign key (default to project_id)
|
Chris@1296
|
29 # * :date_column - name of the datetime column (default to created_on)
|
Chris@1296
|
30 # * :sort_order - name of the column used to sort results (default to :date_column or created_on)
|
Chris@1296
|
31 # * :permission - permission required to search the model (default to :view_"objects")
|
Chris@1296
|
32 def acts_as_searchable(options = {})
|
Chris@1296
|
33 return if self.included_modules.include?(Redmine::Acts::Searchable::InstanceMethods)
|
Chris@1296
|
34
|
Chris@1296
|
35 cattr_accessor :searchable_options
|
Chris@1296
|
36 self.searchable_options = options
|
Chris@1296
|
37
|
Chris@1296
|
38 if searchable_options[:columns].nil?
|
Chris@1296
|
39 raise 'No searchable column defined.'
|
Chris@1296
|
40 elsif !searchable_options[:columns].is_a?(Array)
|
Chris@1296
|
41 searchable_options[:columns] = [] << searchable_options[:columns]
|
Chris@1296
|
42 end
|
Chris@1296
|
43
|
Chris@1296
|
44 searchable_options[:project_key] ||= "#{table_name}.project_id"
|
Chris@1296
|
45 searchable_options[:date_column] ||= "#{table_name}.created_on"
|
Chris@1296
|
46 searchable_options[:order_column] ||= searchable_options[:date_column]
|
Chris@1296
|
47
|
Chris@1296
|
48 # Should we search custom fields on this model ?
|
Chris@1296
|
49 searchable_options[:search_custom_fields] = !reflect_on_association(:custom_values).nil?
|
Chris@1296
|
50
|
Chris@1296
|
51 send :include, Redmine::Acts::Searchable::InstanceMethods
|
Chris@1296
|
52 end
|
Chris@1296
|
53 end
|
Chris@1296
|
54
|
Chris@1296
|
55 module InstanceMethods
|
Chris@1296
|
56 def self.included(base)
|
Chris@1296
|
57 base.extend ClassMethods
|
Chris@1296
|
58 end
|
Chris@1296
|
59
|
Chris@1296
|
60 module ClassMethods
|
Chris@1296
|
61 # Searches the model for the given tokens
|
Chris@1296
|
62 # projects argument can be either nil (will search all projects), a project or an array of projects
|
Chris@1296
|
63 # Returns the results and the results count
|
Chris@1296
|
64 def search(tokens, projects=nil, options={})
|
Chris@1296
|
65 if projects.is_a?(Array) && projects.empty?
|
Chris@1296
|
66 # no results
|
Chris@1296
|
67 return [[], 0]
|
Chris@1296
|
68 end
|
Chris@1296
|
69
|
Chris@1296
|
70 # TODO: make user an argument
|
Chris@1296
|
71 user = User.current
|
Chris@1296
|
72 tokens = [] << tokens unless tokens.is_a?(Array)
|
Chris@1296
|
73 projects = [] << projects unless projects.nil? || projects.is_a?(Array)
|
Chris@1296
|
74
|
Chris@1296
|
75 find_options = {:include => searchable_options[:include]}
|
Chris@1296
|
76 find_options[:order] = "#{searchable_options[:order_column]} " + (options[:before] ? 'DESC' : 'ASC')
|
Chris@1296
|
77
|
Chris@1296
|
78 limit_options = {}
|
Chris@1296
|
79 limit_options[:limit] = options[:limit] if options[:limit]
|
Chris@1296
|
80 if options[:offset]
|
Chris@1296
|
81 limit_options[:conditions] = "(#{searchable_options[:date_column]} " + (options[:before] ? '<' : '>') + "'#{connection.quoted_date(options[:offset])}')"
|
Chris@1296
|
82 end
|
Chris@1296
|
83
|
Chris@1296
|
84 columns = searchable_options[:columns]
|
Chris@1296
|
85 columns = columns[0..0] if options[:titles_only]
|
Chris@1296
|
86
|
Chris@1296
|
87 token_clauses = columns.collect {|column| "(LOWER(#{column}) LIKE ?)"}
|
Chris@1296
|
88
|
Chris@1296
|
89 if !options[:titles_only] && searchable_options[:search_custom_fields]
|
Chris@1296
|
90 searchable_custom_field_ids = CustomField.find(:all,
|
Chris@1296
|
91 :select => 'id',
|
Chris@1296
|
92 :conditions => { :type => "#{self.name}CustomField",
|
Chris@1296
|
93 :searchable => true }).collect(&:id)
|
Chris@1296
|
94 if searchable_custom_field_ids.any?
|
Chris@1296
|
95 custom_field_sql = "#{table_name}.id IN (SELECT customized_id FROM #{CustomValue.table_name}" +
|
Chris@1296
|
96 " WHERE customized_type='#{self.name}' AND customized_id=#{table_name}.id AND LOWER(value) LIKE ?" +
|
Chris@1296
|
97 " AND #{CustomValue.table_name}.custom_field_id IN (#{searchable_custom_field_ids.join(',')}))"
|
Chris@1296
|
98 token_clauses << custom_field_sql
|
Chris@1296
|
99 end
|
Chris@1296
|
100 end
|
Chris@1296
|
101
|
Chris@1296
|
102 sql = (['(' + token_clauses.join(' OR ') + ')'] * tokens.size).join(options[:all_words] ? ' AND ' : ' OR ')
|
Chris@1296
|
103
|
Chris@1296
|
104 find_options[:conditions] = [sql, * (tokens.collect {|w| "%#{w.downcase}%"} * token_clauses.size).sort]
|
Chris@1296
|
105
|
Chris@1296
|
106 scope = self
|
Chris@1296
|
107 project_conditions = []
|
Chris@1296
|
108 if searchable_options.has_key?(:permission)
|
Chris@1296
|
109 project_conditions << Project.allowed_to_condition(user, searchable_options[:permission] || :view_project)
|
Chris@1296
|
110 elsif respond_to?(:visible)
|
Chris@1296
|
111 scope = scope.visible(user)
|
Chris@1296
|
112 else
|
Chris@1296
|
113 ActiveSupport::Deprecation.warn "acts_as_searchable with implicit :permission option is deprecated. Add a visible scope to the #{self.name} model or use explicit :permission option."
|
Chris@1296
|
114 project_conditions << Project.allowed_to_condition(user, "view_#{self.name.underscore.pluralize}".to_sym)
|
Chris@1296
|
115 end
|
Chris@1296
|
116 # TODO: use visible scope options instead
|
Chris@1296
|
117 project_conditions << "#{searchable_options[:project_key]} IN (#{projects.collect(&:id).join(',')})" unless projects.nil?
|
Chris@1296
|
118 project_conditions = project_conditions.empty? ? nil : project_conditions.join(' AND ')
|
Chris@1296
|
119
|
Chris@1296
|
120 results = []
|
Chris@1296
|
121 results_count = 0
|
Chris@1296
|
122
|
Chris@1296
|
123 scope = scope.scoped({:conditions => project_conditions}).scoped(find_options)
|
Chris@1296
|
124 results_count = scope.count(:all)
|
Chris@1296
|
125 results = scope.find(:all, limit_options)
|
Chris@1296
|
126
|
Chris@1296
|
127 [results, results_count]
|
Chris@1296
|
128 end
|
Chris@1296
|
129 end
|
Chris@1296
|
130 end
|
Chris@1296
|
131 end
|
Chris@1296
|
132 end
|
Chris@1296
|
133 end
|