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 Activity
Chris@909:     # Class used to retrieve activity events
Chris@909:     class Fetcher
Chris@909:       attr_reader :user, :project, :scope
Chris@909: 
Chris@909:       # Needs to be unloaded in development mode
Chris@909:       @@constantized_providers = Hash.new {|h,k| h[k] = Redmine::Activity.providers[k].collect {|t| t.constantize } }
Chris@909: 
Chris@909:       def initialize(user, options={})
Chris@909:         options.assert_valid_keys(:project, :with_subprojects, :author)
Chris@909:         @user = user
Chris@909:         @project = options[:project]
Chris@909:         @options = options
Chris@909: 
Chris@909:         @scope = event_types
Chris@909:       end
Chris@909: 
Chris@909:       # Returns an array of available event types
Chris@909:       def event_types
Chris@909:         return @event_types unless @event_types.nil?
Chris@909: 
Chris@909:         @event_types = Redmine::Activity.available_event_types
Chris@909:         @event_types = @event_types.select {|o| @project.self_and_descendants.detect {|p| @user.allowed_to?("view_#{o}".to_sym, p)}} if @project
Chris@909:         @event_types
Chris@909:       end
Chris@909: 
Chris@909:       # Yields to filter the activity scope
Chris@909:       def scope_select(&block)
Chris@909:         @scope = @scope.select {|t| yield t }
Chris@909:       end
Chris@909: 
Chris@909:       # Sets the scope
Chris@909:       # Argument can be :all, :default or an array of event types
Chris@909:       def scope=(s)
Chris@909:         case s
Chris@909:         when :all
Chris@909:           @scope = event_types
Chris@909:         when :default
Chris@909:           default_scope!
Chris@909:         else
Chris@909:           @scope = s & event_types
Chris@909:         end
Chris@909:       end
Chris@909: 
Chris@909:       # Resets the scope to the default scope
Chris@909:       def default_scope!
Chris@909:         @scope = Redmine::Activity.default_event_types
Chris@909:       end
Chris@909: 
Chris@909:       # Returns an array of events for the given date range
Chris@909:       # sorted in reverse chronological order
Chris@909:       def events(from = nil, to = nil, options={})
Chris@909:         e = []
Chris@909:         @options[:limit] = options[:limit]
Chris@909: 
Chris@909:         @scope.each do |event_type|
Chris@909:           constantized_providers(event_type).each do |provider|
Chris@909:             e += provider.find_events(event_type, @user, from, to, @options)
Chris@909:           end
Chris@909:         end
Chris@909: 
Chris@909:         e.sort! {|a,b| b.event_datetime <=> a.event_datetime}
Chris@909: 
Chris@909:         if options[:limit]
Chris@909:           e = e.slice(0, options[:limit])
Chris@909:         end
Chris@909:         e
Chris@909:       end
Chris@909: 
Chris@909:       private
Chris@909: 
Chris@909:       def constantized_providers(event_type)
Chris@909:         @@constantized_providers[event_type]
Chris@909:       end
Chris@909:     end
Chris@909:   end
Chris@909: end