Redmine 3.4.4

lib/plugins/acts_as_activity_provider/init.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/lib/acts_as_activity_provider'
+ActiveRecord::Base.send(:include, Redmine::Acts::ActivityProvider)

lib/plugins/acts_as_activity_provider/lib/acts_as_activity_provider.rb

@@ -0,0 +1,87 @@
+# 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 Acts
+    module ActivityProvider
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_activity_provider(options = {})
+          unless self.included_modules.include?(Redmine::Acts::ActivityProvider::InstanceMethods)
+            cattr_accessor :activity_provider_options
+            send :include, Redmine::Acts::ActivityProvider::InstanceMethods
+          end
+
+          options.assert_valid_keys(:type, :permission, :timestamp, :author_key, :scope)
+          self.activity_provider_options ||= {}
+
+          # One model can provide different event types
+          # We store these options in activity_provider_options hash
+          event_type = options.delete(:type) || self.name.underscore.pluralize
+
+          options[:timestamp] ||= "#{table_name}.created_on"
+          options[:author_key] = "#{table_name}.#{options[:author_key]}" if options[:author_key].is_a?(Symbol)
+          self.activity_provider_options[event_type] = options
+        end
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          # Returns events of type event_type visible by user that occurred between from and to
+          def find_events(event_type, user, from, to, options)
+            provider_options = activity_provider_options[event_type]
+            raise "#{self.name} can not provide #{event_type} events." if provider_options.nil?
+
+            scope = (provider_options[:scope] || self)
+
+            if from && to
+              scope = scope.where("#{provider_options[:timestamp]} BETWEEN ? AND ?", from, to)
+            end
+
+            if options[:author]
+              return [] if provider_options[:author_key].nil?
+              scope = scope.where("#{provider_options[:author_key]} = ?", options[:author].id)
+            end
+
+            if options[:limit]
+              # id and creation time should be in same order in most cases
+              scope = scope.reorder("#{table_name}.id DESC").limit(options[:limit])
+            end
+
+            if provider_options.has_key?(:permission)
+              scope = scope.where(Project.allowed_to_condition(user, provider_options[:permission] || :view_project, options))
+            elsif respond_to?(:visible)
+              scope = scope.visible(user, options)
+            else
+              ActiveSupport::Deprecation.warn "acts_as_activity_provider with implicit :permission option is deprecated. Add a visible scope to the #{self.name} model or use explicit :permission option."
+              scope = scope.where(Project.allowed_to_condition(user, "view_#{self.name.underscore.pluralize}".to_sym, options))
+            end
+
+            scope.to_a
+          end
+        end
+      end
+    end
+  end
+end