Redmine 3.4.4

lib/redmine/activity/fetcher.rb

@@ -0,0 +1,110 @@
+# Redmine - project management software
+# Copyright (C) 2006-2017  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 Activity
+    # Class used to retrieve activity events
+    class Fetcher
+      attr_reader :user, :project, :scope
+
+      def initialize(user, options={})
+        options.assert_valid_keys(:project, :with_subprojects, :author)
+        @user = user
+        @project = options[:project]
+        @options = options
+
+        @scope = event_types
+      end
+
+      # Returns an array of available event types
+      def event_types
+        return @event_types unless @event_types.nil?
+
+        @event_types = Redmine::Activity.available_event_types
+        if @project
+          projects = @project.self_and_descendants
+          @event_types = @event_types.select do |event_type|
+            keep = false
+            constantized_providers(event_type).each do |provider|
+              options = provider.activity_provider_options[event_type]
+              permission = options[:permission]
+              unless options.key?(:permission)
+                permission ||= "view_#{event_type}".to_sym
+              end
+              if permission
+                keep |= projects.any? {|p| @user.allowed_to?(permission, p)}
+              else
+                keep = true
+              end
+            end
+            keep
+          end
+        end
+        @event_types
+      end
+
+      # Yields to filter the activity scope
+      def scope_select(&block)
+        @scope = @scope.select {|t| yield t }
+      end
+
+      # Sets the scope
+      # Argument can be :all, :default or an array of event types
+      def scope=(s)
+        case s
+        when :all
+          @scope = event_types
+        when :default
+          default_scope!
+        else
+          @scope = s & event_types
+        end
+      end
+
+      # Resets the scope to the default scope
+      def default_scope!
+        @scope = Redmine::Activity.default_event_types
+      end
+
+      # Returns an array of events for the given date range
+      # sorted in reverse chronological order
+      def events(from = nil, to = nil, options={})
+        e = []
+        @options[:limit] = options[:limit]
+
+        @scope.each do |event_type|
+          constantized_providers(event_type).each do |provider|
+            e += provider.find_events(event_type, @user, from, to, @options)
+          end
+        end
+
+        e.sort! {|a,b| b.event_datetime <=> a.event_datetime}
+
+        if options[:limit]
+          e = e.slice(0, options[:limit])
+        end
+        e
+      end
+
+      private
+
+      def constantized_providers(event_type)
+        Redmine::Activity.providers[event_type].map(&:constantize)
+      end
+    end
+  end
+end