Chris@0: # Redmine - project management software
Chris@909: # Copyright (C) 2006-2011  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@909: #
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@909: #
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 Search
Chris@909: 
Chris@0:     mattr_accessor :available_search_types
Chris@909: 
Chris@0:     @@available_search_types = []
Chris@0: 
Chris@0:     class << self
Chris@0:       def map(&block)
Chris@0:         yield self
Chris@0:       end
Chris@909: 
Chris@0:       # Registers a search provider
Chris@0:       def register(search_type, options={})
Chris@0:         search_type = search_type.to_s
Chris@0:         @@available_search_types << search_type unless @@available_search_types.include?(search_type)
Chris@0:       end
Chris@0:     end
Chris@909: 
Chris@0:     module Controller
Chris@0:       def self.included(base)
Chris@0:         base.extend(ClassMethods)
Chris@0:       end
Chris@0: 
Chris@0:       module ClassMethods
Chris@0:         @@default_search_scopes = Hash.new {|hash, key| hash[key] = {:default => nil, :actions => {}}}
Chris@0:         mattr_accessor :default_search_scopes
Chris@909: 
Chris@0:         # Set the default search scope for a controller or specific actions
Chris@0:         # Examples:
Chris@0:         #   * search_scope :issues # => sets the search scope to :issues for the whole controller
Chris@0:         #   * search_scope :issues, :only => :index
Chris@0:         #   * search_scope :issues, :only => [:index, :show]
Chris@0:         def default_search_scope(id, options = {})
Chris@0:           if actions = options[:only]
Chris@0:             actions = [] << actions unless actions.is_a?(Array)
Chris@0:             actions.each {|a| default_search_scopes[controller_name.to_sym][:actions][a.to_sym] = id.to_s}
Chris@0:           else
Chris@0:             default_search_scopes[controller_name.to_sym][:default] = id.to_s
Chris@0:           end
Chris@0:         end
Chris@0:       end
Chris@0: 
Chris@0:       def default_search_scopes
Chris@0:         self.class.default_search_scopes
Chris@0:       end
Chris@0: 
Chris@0:       # Returns the default search scope according to the current action
Chris@0:       def default_search_scope
Chris@0:         @default_search_scope ||= default_search_scopes[controller_name.to_sym][:actions][action_name.to_sym] ||
Chris@0:                                   default_search_scopes[controller_name.to_sym][:default]
Chris@0:       end
Chris@0:     end
Chris@0:   end
Chris@0: end