jro_apps/redmine Commit - r3330:c11d30ebc9f5

Makes search providers extensible (#3936)....

Jean-Philippe Lang -

r3330:c11d30ebc9f5

parent child

Context file:

r3330:c11d30ebc9f5

Collapse all files

app/controllers/search_controller.rb +1 -1

             # redMine - project management software
             # Copyright (C) 2006  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class SearchController < ApplicationController
               before_filter :find_optional_project
               helper :messages
               include MessagesHelper
               def index
                 @question = params[:q] || ""
                 @question.strip!
                 @all_words = params[:all_words] || (params[:submit] ? false : true)
                 @titles_only = !params[:titles_only].nil?
                 projects_to_search =
                   case params[:scope]
                   when 'all'
                     nil
                   when 'my_projects'
                     User.current.memberships.collect(&:project)
                   when 'subprojects'
                     @project ? (@project.self_and_descendants.active) : nil
                   else
                     @project
                   end
                 offset = nil
                 begin; offset = params[:offset].to_time if params[:offset]; rescue; end
                 # quick jump to an issue
                 if @question.match(/^#?(\d+)$/) && Issue.visible.find_by_id($1)
                   redirect_to :controller => "issues", :action => "show", :id => $1
                   return
                 end
-                @object_types = %w(issues news documents changesets wiki_pages messages projects)
+                @object_types = Redmine::Search.available_search_types.dup
                 if projects_to_search.is_a? Project
                   # don't search projects
                   @object_types.delete('projects')
                   # only show what the user is allowed to view
                   @object_types = @object_types.select {|o| User.current.allowed_to?("view_#{o}".to_sym, projects_to_search)}
                 end
                 @scope = @object_types.select {|t| params[t]}
                 @scope = @object_types if @scope.empty?
                 # extract tokens from the question
                 # eg. hello "bye bye" => ["hello", "bye bye"]
                 @tokens = @question.scan(%r{((\s|^)"[\s\w]+"(\s|$)|\S+)}).collect {|m| m.first.gsub(%r{(^\s*"\s*|\s*"\s*$)}, '')}
                 # tokens must be at least 2 characters long
                 @tokens = @tokens.uniq.select {|w| w.length > 1 }
                 if !@tokens.empty?
                   # no more than 5 tokens to search for
                   @tokens.slice! 5..-1 if @tokens.size > 5
                   # strings used in sql like statement
                   like_tokens = @tokens.collect {|w| "%#{w.downcase}%"}
                   @results = []
                   @results_by_type = Hash.new {|h,k| h[k] = 0}
                   limit = 10
                   @scope.each do |s|
                     r, c = s.singularize.camelcase.constantize.search(like_tokens, projects_to_search,
                       :all_words => @all_words,
                       :titles_only => @titles_only,
                       :limit => (limit+1),
                       :offset => offset,
                       :before => params[:previous].nil?)
                     @results += r
                     @results_by_type[s] += c
                   end
                   @results = @results.sort {|a,b| b.event_datetime <=> a.event_datetime}
                   if params[:previous].nil?
                     @pagination_previous_date = @results[0].event_datetime if offset && @results[0]
                     if @results.size > limit
                       @pagination_next_date = @results[limit-1].event_datetime
                       @results = @results[0, limit]
                     end
                   else
                     @pagination_next_date = @results[-1].event_datetime if offset && @results[-1]
                     if @results.size > limit
                       @pagination_previous_date = @results[-(limit)].event_datetime
                       @results = @results[-(limit), limit]
                     end
                   end
                 else
                   @question = ""
                 end
                 render :layout => false if request.xhr?
               end
             private
               def find_optional_project
                 return true unless params[:id]
                 @project = Project.find(params[:id])
                 check_project_privacy
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

lib/redmine.rb +11 0

             require 'redmine/access_control'
             require 'redmine/menu_manager'
             require 'redmine/activity'
+            require 'redmine/search'
             require 'redmine/mime_type'
             require 'redmine/core_ext'
             require 'redmine/themes'
             require 'redmine/hook'
             require 'redmine/plugin'
             require 'redmine/wiki_formatting'
             require 'redmine/scm/base'
             begin
               require_library_or_gem 'RMagick' unless Object.const_defined?(:Magick)
             rescue LoadError
               # RMagick is not available
             end
             if RUBY_VERSION < '1.9'
               require 'faster_csv'
             else
               require 'csv'
               FCSV = CSV
             end
             Redmine::Scm::Base.add "Subversion"
             Redmine::Scm::Base.add "Darcs"
             Redmine::Scm::Base.add "Mercurial"
             Redmine::Scm::Base.add "Cvs"
             Redmine::Scm::Base.add "Bazaar"
             Redmine::Scm::Base.add "Git"
             Redmine::Scm::Base.add "Filesystem"
             # Permissions
             Redmine::AccessControl.map do |map|
               map.permission :view_project, {:projects => [:show, :activity]}, :public => true
               map.permission :search_project, {:search => :index}, :public => true
               map.permission :add_project, {:projects => :add}, :require => :loggedin
               map.permission :edit_project, {:projects => [:settings, :edit]}, :require => :member
               map.permission :select_project_modules, {:projects => :modules}, :require => :member
               map.permission :manage_members, {:projects => :settings, :members => [:new, :edit, :destroy, :autocomplete_for_member]}, :require => :member
               map.permission :manage_versions, {:projects => [:settings, :add_version], :versions => [:edit, :close_completed, :destroy]}, :require => :member
               map.permission :add_subprojects, {:projects => :add}, :require => :member
               map.project_module :issue_tracking do |map|
                 # Issue categories
                 map.permission :manage_categories, {:projects => [:settings, :add_issue_category], :issue_categories => [:edit, :destroy]}, :require => :member
                 # Issues
                 map.permission :view_issues, {:projects => :roadmap,
                                               :issues => [:index, :changes, :show, :context_menu],
                                               :versions => [:show, :status_by],
                                               :queries => :index,
                                               :reports => [:issue_report, :issue_report_details]}
                 map.permission :add_issues, {:issues => [:new, :update_form]}
                 map.permission :edit_issues, {:issues => [:edit, :reply, :bulk_edit, :update_form]}
                 map.permission :manage_issue_relations, {:issue_relations => [:new, :destroy]}
                 map.permission :add_issue_notes, {:issues => [:edit, :reply]}
                 map.permission :edit_issue_notes, {:journals => :edit}, :require => :loggedin
                 map.permission :edit_own_issue_notes, {:journals => :edit}, :require => :loggedin
                 map.permission :move_issues, {:issues => :move}, :require => :loggedin
                 map.permission :delete_issues, {:issues => :destroy}, :require => :member
                 # Queries
                 map.permission :manage_public_queries, {:queries => [:new, :edit, :destroy]}, :require => :member
                 map.permission :save_queries, {:queries => [:new, :edit, :destroy]}, :require => :loggedin
                 # Gantt & calendar
                 map.permission :view_gantt, :issues => :gantt
                 map.permission :view_calendar, :issues => :calendar
                 # Watchers
                 map.permission :view_issue_watchers, {}
                 map.permission :add_issue_watchers, {:watchers => :new}
                 map.permission :delete_issue_watchers, {:watchers => :destroy}
               end
               map.project_module :time_tracking do |map|
                 map.permission :log_time, {:timelog => :edit}, :require => :loggedin
                 map.permission :view_time_entries, :timelog => [:details, :report]
                 map.permission :edit_time_entries, {:timelog => [:edit, :destroy]}, :require => :member
                 map.permission :edit_own_time_entries, {:timelog => [:edit, :destroy]}, :require => :loggedin
                 map.permission :manage_project_activities, {:projects => [:save_activities, :reset_activities]}, :require => :member
               end
               map.project_module :news do |map|
                 map.permission :manage_news, {:news => [:new, :edit, :destroy, :destroy_comment]}, :require => :member
                 map.permission :view_news, {:news => [:index, :show]}, :public => true
                 map.permission :comment_news, {:news => :add_comment}
               end
               map.project_module :documents do |map|
                 map.permission :manage_documents, {:documents => [:new, :edit, :destroy, :add_attachment]}, :require => :loggedin
                 map.permission :view_documents, :documents => [:index, :show, :download]
               end
               map.project_module :files do |map|
                 map.permission :manage_files, {:projects => :add_file}, :require => :loggedin
                 map.permission :view_files, :projects => :list_files, :versions => :download
               end
               map.project_module :wiki do |map|
                 map.permission :manage_wiki, {:wikis => [:edit, :destroy]}, :require => :member
                 map.permission :rename_wiki_pages, {:wiki => :rename}, :require => :member
                 map.permission :delete_wiki_pages, {:wiki => :destroy}, :require => :member
                 map.permission :view_wiki_pages, :wiki => [:index, :special]
                 map.permission :export_wiki_pages, {}
                 map.permission :view_wiki_edits, :wiki => [:history, :diff, :annotate]
                 map.permission :edit_wiki_pages, :wiki => [:edit, :preview, :add_attachment]
                 map.permission :delete_wiki_pages_attachments, {}
                 map.permission :protect_wiki_pages, {:wiki => :protect}, :require => :member
               end
               map.project_module :repository do |map|
                 map.permission :manage_repository, {:repositories => [:edit, :committers, :destroy]}, :require => :member
                 map.permission :browse_repository, :repositories => [:show, :browse, :entry, :annotate, :changes, :diff, :stats, :graph]
                 map.permission :view_changesets, :repositories => [:show, :revisions, :revision]
                 map.permission :commit_access, {}
               end
               map.project_module :boards do |map|
                 map.permission :manage_boards, {:boards => [:new, :edit, :destroy]}, :require => :member
                 map.permission :view_messages, {:boards => [:index, :show], :messages => [:show]}, :public => true
                 map.permission :add_messages, {:messages => [:new, :reply, :quote]}
                 map.permission :edit_messages, {:messages => :edit}, :require => :member
                 map.permission :edit_own_messages, {:messages => :edit}, :require => :loggedin
                 map.permission :delete_messages, {:messages => :destroy}, :require => :member
                 map.permission :delete_own_messages, {:messages => :destroy}, :require => :loggedin
               end
             end
             Redmine::MenuManager.map :top_menu do |menu|
               menu.push :home, :home_path
               menu.push :my_page, { :controller => 'my', :action => 'page' }, :if => Proc.new { User.current.logged? }
               menu.push :projects, { :controller => 'projects', :action => 'index' }, :caption => :label_project_plural
               menu.push :administration, { :controller => 'admin', :action => 'index' }, :if => Proc.new { User.current.admin? }, :last => true
               menu.push :help, Redmine::Info.help_url, :last => true
             end
             Redmine::MenuManager.map :account_menu do |menu|
               menu.push :login, :signin_path, :if => Proc.new { !User.current.logged? }
               menu.push :register, { :controller => 'account', :action => 'register' }, :if => Proc.new { !User.current.logged? && Setting.self_registration? }
               menu.push :my_account, { :controller => 'my', :action => 'account' }, :if => Proc.new { User.current.logged? }
               menu.push :logout, :signout_path, :if => Proc.new { User.current.logged? }
             end
             Redmine::MenuManager.map :application_menu do |menu|
               # Empty
             end
             Redmine::MenuManager.map :admin_menu do |menu|
               # Empty
             end
             Redmine::MenuManager.map :project_menu do |menu|
               menu.push :overview, { :controller => 'projects', :action => 'show' }
               menu.push :activity, { :controller => 'projects', :action => 'activity' }
               menu.push :roadmap, { :controller => 'projects', :action => 'roadmap' },
                           :if => Proc.new { |p| p.shared_versions.any? }
               menu.push :issues, { :controller => 'issues', :action => 'index' }, :param => :project_id, :caption => :label_issue_plural
               menu.push :new_issue, { :controller => 'issues', :action => 'new' }, :param => :project_id, :caption => :label_issue_new,
                           :html => { :accesskey => Redmine::AccessKeys.key_for(:new_issue) }
               menu.push :news, { :controller => 'news', :action => 'index' }, :param => :project_id, :caption => :label_news_plural
               menu.push :documents, { :controller => 'documents', :action => 'index' }, :param => :project_id, :caption => :label_document_plural
               menu.push :wiki, { :controller => 'wiki', :action => 'index', :page => nil },
                           :if => Proc.new { |p| p.wiki && !p.wiki.new_record? }
               menu.push :boards, { :controller => 'boards', :action => 'index', :id => nil }, :param => :project_id,
                           :if => Proc.new { |p| p.boards.any? }, :caption => :label_board_plural
               menu.push :files, { :controller => 'projects', :action => 'list_files' }, :caption => :label_file_plural
               menu.push :repository, { :controller => 'repositories', :action => 'show' },
                           :if => Proc.new { |p| p.repository && !p.repository.new_record? }
               menu.push :settings, { :controller => 'projects', :action => 'settings' }, :last => true
             end
             Redmine::Activity.map do |activity|
               activity.register :issues, :class_name => %w(Issue Journal)
               activity.register :changesets
               activity.register :news
               activity.register :documents, :class_name => %w(Document Attachment)
               activity.register :files, :class_name => 'Attachment'
               activity.register :wiki_edits, :class_name => 'WikiContent::Version', :default => false
               activity.register :messages, :default => false
               activity.register :time_entries, :default => false
             end
+            Redmine::Search.map do |search|
+              search.register :issues
+              search.register :news
+              search.register :documents
+              search.register :changesets
+              search.register :wiki_pages
+              search.register :messages
+              search.register :projects
+            end
             Redmine::WikiFormatting.map do |format|
               format.register :textile, Redmine::WikiFormatting::Textile::Formatter, Redmine::WikiFormatting::Textile::Helper
             end

lib/redmine/search.rb +17 0

             # Redmine - project management software
             # Copyright (C) 2006-2009  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             module Redmine
               module Search
+                mattr_accessor :available_search_types
+                @@available_search_types = []
+                class << self
+                  def map(&block)
+                    yield self
+                  end
+                  # Registers a search provider
+                  def register(search_type, options={})
+                    search_type = search_type.to_s
+                    @@available_search_types << search_type unless @@available_search_types.include?(search_type)
+                  end
+                end
                 module Controller
                   def self.included(base)
                     base.extend(ClassMethods)
                   end
                   module ClassMethods
                     @@default_search_scopes = Hash.new {|hash, key| hash[key] = {:default => nil, :actions => {}}}
                     mattr_accessor :default_search_scopes
                     # Set the default search scope for a controller or specific actions
                     # Examples:
                     #   * search_scope :issues # => sets the search scope to :issues for the whole controller
                     #   * search_scope :issues, :only => :index
                     #   * search_scope :issues, :only => [:index, :show]
                     def default_search_scope(id, options = {})
                       if actions = options[:only]
                         actions = [] << actions unless actions.is_a?(Array)
                         actions.each {|a| default_search_scopes[controller_name.to_sym][:actions][a.to_sym] = id.to_s}
                       else
                         default_search_scopes[controller_name.to_sym][:default] = id.to_s
                       end
                     end
                   end
                   def default_search_scopes
                     self.class.default_search_scopes
                   end
                   # Returns the default search scope according to the current action
                   def default_search_scope
                     @default_search_scope ||= default_search_scopes[controller_name.to_sym][:actions][action_name.to_sym] ||
                                               default_search_scopes[controller_name.to_sym][:default]
                   end
                 end
               end
             end

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