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