Chris@0: # redMine - project management software Chris@0: # Copyright (C) 2006-2007 Jean-Philippe Lang Chris@0: # Chris@0: # This program is free software; you can redistribute it and/or Chris@0: # modify it under the terms of the GNU General Public License Chris@0: # as published by the Free Software Foundation; either version 2 Chris@0: # of the License, or (at your option) any later version. Chris@0: # Chris@0: # This program is distributed in the hope that it will be useful, Chris@0: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@0: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@0: # GNU General Public License for more details. Chris@0: # Chris@0: # You should have received a copy of the GNU General Public License Chris@0: # along with this program; if not, write to the Free Software Chris@0: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@0: Chris@0: module Redmine Chris@0: module Acts Chris@0: module Searchable Chris@0: def self.included(base) Chris@0: base.extend ClassMethods Chris@0: end Chris@0: Chris@0: module ClassMethods Chris@0: # Options: Chris@0: # * :columns - a column or an array of columns to search Chris@0: # * :project_key - project foreign key (default to project_id) Chris@0: # * :date_column - name of the datetime column (default to created_on) Chris@0: # * :sort_order - name of the column used to sort results (default to :date_column or created_on) Chris@0: # * :permission - permission required to search the model (default to :view_"objects") Chris@0: def acts_as_searchable(options = {}) Chris@0: return if self.included_modules.include?(Redmine::Acts::Searchable::InstanceMethods) Chris@0: Chris@0: cattr_accessor :searchable_options Chris@0: self.searchable_options = options Chris@0: Chris@0: if searchable_options[:columns].nil? Chris@0: raise 'No searchable column defined.' Chris@0: elsif !searchable_options[:columns].is_a?(Array) Chris@0: searchable_options[:columns] = [] << searchable_options[:columns] Chris@0: end Chris@0: Chris@0: searchable_options[:project_key] ||= "#{table_name}.project_id" Chris@0: searchable_options[:date_column] ||= "#{table_name}.created_on" Chris@0: searchable_options[:order_column] ||= searchable_options[:date_column] Chris@0: Chris@0: # Permission needed to search this model Chris@0: searchable_options[:permission] = "view_#{self.name.underscore.pluralize}".to_sym unless searchable_options.has_key?(:permission) Chris@0: Chris@0: # Should we search custom fields on this model ? Chris@0: searchable_options[:search_custom_fields] = !reflect_on_association(:custom_values).nil? Chris@0: Chris@0: send :include, Redmine::Acts::Searchable::InstanceMethods Chris@0: end Chris@0: end Chris@0: Chris@0: module InstanceMethods Chris@0: def self.included(base) Chris@0: base.extend ClassMethods Chris@0: end Chris@0: Chris@0: module ClassMethods Chris@0: # Searches the model for the given tokens Chris@0: # projects argument can be either nil (will search all projects), a project or an array of projects Chris@0: # Returns the results and the results count Chris@0: def search(tokens, projects=nil, options={}) Chris@0: tokens = [] << tokens unless tokens.is_a?(Array) Chris@0: projects = [] << projects unless projects.nil? || projects.is_a?(Array) Chris@0: Chris@0: find_options = {:include => searchable_options[:include]} Chris@0: find_options[:order] = "#{searchable_options[:order_column]} " + (options[:before] ? 'DESC' : 'ASC') Chris@0: Chris@0: limit_options = {} Chris@0: limit_options[:limit] = options[:limit] if options[:limit] Chris@0: if options[:offset] Chris@0: limit_options[:conditions] = "(#{searchable_options[:date_column]} " + (options[:before] ? '<' : '>') + "'#{connection.quoted_date(options[:offset])}')" Chris@0: end Chris@0: Chris@0: columns = searchable_options[:columns] Chris@0: columns = columns[0..0] if options[:titles_only] Chris@0: Chris@0: token_clauses = columns.collect {|column| "(LOWER(#{column}) LIKE ?)"} Chris@0: Chris@0: if !options[:titles_only] && searchable_options[:search_custom_fields] Chris@0: searchable_custom_field_ids = CustomField.find(:all, Chris@0: :select => 'id', Chris@0: :conditions => { :type => "#{self.name}CustomField", Chris@0: :searchable => true }).collect(&:id) Chris@0: if searchable_custom_field_ids.any? Chris@0: custom_field_sql = "#{table_name}.id IN (SELECT customized_id FROM #{CustomValue.table_name}" + Chris@0: " WHERE customized_type='#{self.name}' AND customized_id=#{table_name}.id AND LOWER(value) LIKE ?" + Chris@0: " AND #{CustomValue.table_name}.custom_field_id IN (#{searchable_custom_field_ids.join(',')}))" Chris@0: token_clauses << custom_field_sql Chris@0: end Chris@0: end Chris@0: Chris@0: sql = (['(' + token_clauses.join(' OR ') + ')'] * tokens.size).join(options[:all_words] ? ' AND ' : ' OR ') Chris@0: Chris@0: find_options[:conditions] = [sql, * (tokens.collect {|w| "%#{w.downcase}%"} * token_clauses.size).sort] Chris@0: Chris@0: project_conditions = [] Chris@0: project_conditions << (searchable_options[:permission].nil? ? Project.visible_by(User.current) : Chris@0: Project.allowed_to_condition(User.current, searchable_options[:permission])) Chris@0: project_conditions << "#{searchable_options[:project_key]} IN (#{projects.collect(&:id).join(',')})" unless projects.nil? Chris@0: Chris@0: results = [] Chris@0: results_count = 0 Chris@0: Chris@0: with_scope(:find => {:conditions => project_conditions.join(' AND ')}) do Chris@0: with_scope(:find => find_options) do Chris@0: results_count = count(:all) Chris@0: results = find(:all, limit_options) Chris@0: end Chris@0: end Chris@0: [results, results_count] Chris@0: end Chris@0: end Chris@0: end Chris@0: end Chris@0: end Chris@0: end