jro_apps/redmine Commit - r13513:886b9c14d0cb

Fixed that Redmine::Activity::Fetcher should consider activity provider permission option if given (#18832)....

Jean-Philippe Lang -

r13513:886b9c14d0cb

parent child

Context file:

r13513:886b9c14d0cb

Collapse all files

lib/redmine/activity.rb +6 0

             # Redmine - project management software
             # Copyright (C) 2006-2015  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
                 mattr_accessor :available_event_types, :default_event_types, :providers
                 @@available_event_types = []
                 @@default_event_types = []
                 @@providers = Hash.new {|h,k| h[k]=[] }
                 class << self
                   def map(&block)
                     yield self
                   end
                   # Registers an activity provider
                   def register(event_type, options={})
                     options.assert_valid_keys(:class_name, :default)
                     event_type = event_type.to_s
                     providers = options[:class_name] || event_type.classify
                     providers = ([] << providers) unless providers.is_a?(Array)
                     @@available_event_types << event_type unless @@available_event_types.include?(event_type)
                     @@default_event_types << event_type unless options[:default] == false
                     @@providers[event_type] += providers
                   end
+                  def delete(event_type)
+                    @@available_event_types.delete event_type
+                    @@default_event_types.delete event_type
+                    @@providers.delete(event_type)
+                  end
                 end
               end
             end

lib/redmine/activity/fetcher.rb +20 -5

             # Redmine - project management software
             # Copyright (C) 2006-2015  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
-                  # Needs to be unloaded in development mode
-                  @@constantized_providers = Hash.new {|h,k| h[k] = Redmine::Activity.providers[k].collect {|t| t.constantize } }
                   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
-                    @event_types = @event_types.select {|o| @project.self_and_descendants.detect {|p| @user.allowed_to?("view_#{o}".to_sym, p)}} if @project
+                    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)
-                    @@constantized_providers[event_type]
+                    Redmine::Activity.providers[event_type].map(&:constantize)
                   end
                 end
               end
             end

test/unit/activity_test.rb +60 0

             # Redmine - project management software
             # Copyright (C) 2006-2015  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.
             require File.expand_path('../../test_helper', __FILE__)
             class ActivityTest < ActiveSupport::TestCase
               fixtures :projects, :versions, :attachments, :users, :roles, :members, :member_roles, :issues, :journals, :journal_details,
                        :trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages, :time_entries,
                        :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions
               def setup
                 @project = Project.find(1)
               end
               def test_activity_without_subprojects
                 events = find_events(User.anonymous, :project => @project)
                 assert_not_nil events
                 assert events.include?(Issue.find(1))
                 assert !events.include?(Issue.find(4))
                 # subproject issue
                 assert !events.include?(Issue.find(5))
               end
               def test_activity_with_subprojects
                 events = find_events(User.anonymous, :project => @project, :with_subprojects => 1)
                 assert_not_nil events
                 assert events.include?(Issue.find(1))
                 # subproject issue
                 assert events.include?(Issue.find(5))
               end
               def test_global_activity_anonymous
                 events = find_events(User.anonymous)
                 assert_not_nil events
                 assert events.include?(Issue.find(1))
                 assert events.include?(Message.find(5))
                 # Issue of a private project
                 assert !events.include?(Issue.find(4))
                 # Private issue and comment
                 assert !events.include?(Issue.find(14))
                 assert !events.include?(Journal.find(5))
               end
               def test_global_activity_logged_user
                 events = find_events(User.find(2)) # manager
                 assert_not_nil events
                 assert events.include?(Issue.find(1))
                 # Issue of a private project the user belongs to
                 assert events.include?(Issue.find(4))
               end
               def test_user_activity
                 user = User.find(2)
                 events = Redmine::Activity::Fetcher.new(User.anonymous, :author => user).events(nil, nil, :limit => 10)
                 assert(events.size > 0)
                 assert(events.size <= 10)
                 assert_nil(events.detect {|e| e.event_author != user})
               end
               def test_files_activity
                 f = Redmine::Activity::Fetcher.new(User.anonymous, :project => Project.find(1))
                 f.scope = ['files']
                 events = f.events
                 assert_kind_of Array, events
                 assert events.include?(Attachment.find_by_container_type_and_container_id('Project', 1))
                 assert events.include?(Attachment.find_by_container_type_and_container_id('Version', 1))
                 assert_equal [Attachment], events.collect(&:class).uniq
                 assert_equal %w(Project Version), events.collect(&:container_type).uniq.sort
               end
               def test_event_group_for_issue
                 issue = Issue.find(1)
                 assert_equal issue, issue.event_group
               end
               def test_event_group_for_journal
                 issue = Issue.find(1)
                 journal = issue.journals.first
                 assert_equal issue, journal.event_group
               end
               def test_event_group_for_issue_time_entry
                 time = TimeEntry.where(:issue_id => 1).first
                 assert_equal time.issue, time.event_group
               end
               def test_event_group_for_project_time_entry
                 time = TimeEntry.where(:issue_id => nil).first
                 assert_equal time, time.event_group
               end
               def test_event_group_for_message
                 message = Message.find(1)
                 reply = message.children.first
                 assert_equal message, message.event_group
                 assert_equal message, reply.event_group
               end
               def test_event_group_for_wiki_content_version
                 content = WikiContent::Version.find(1)
                 assert_equal content.page, content.event_group
               end
+              class TestActivityProviderWithPermission
+                def self.activity_provider_options
+                  {'test' => {:permission => :custom_permission}}
+                end
+              end
+              class TestActivityProviderWithNilPermission
+                def self.activity_provider_options
+                  {'test' => {:permission => nil}}
+                end
+              end
+              class TestActivityProviderWithoutPermission
+                def self.activity_provider_options
+                  {'test' => {}}
+                end
+              end
+              class MockUser
+                def initialize(*permissions)
+                  @permissions = permissions
+                end
+                def allowed_to?(permission, *args)
+                  @permissions.include?(permission)
+                end
+              end
+              def test_event_types_should_consider_activity_provider_permission
+                Redmine::Activity.register 'test', :class_name => 'ActivityTest::TestActivityProviderWithPermission'
+                user = MockUser.new(:custom_permission)
+                f = Redmine::Activity::Fetcher.new(user, :project => Project.find(1))
+                assert_include 'test', f.event_types
+              ensure
+                Redmine::Activity.delete 'test'
+              end
+              def test_event_types_should_include_activity_provider_with_nil_permission
+                Redmine::Activity.register 'test', :class_name => 'ActivityTest::TestActivityProviderWithNilPermission'
+                user = MockUser.new()
+                f = Redmine::Activity::Fetcher.new(user, :project => Project.find(1))
+                assert_include 'test', f.event_types
+              ensure
+                Redmine::Activity.delete 'test'
+              end
+              def test_event_types_should_use_default_permission_for_activity_provider_without_permission
+                Redmine::Activity.register 'test', :class_name => 'ActivityTest::TestActivityProviderWithoutPermission'
+                user = MockUser.new()
+                f = Redmine::Activity::Fetcher.new(user, :project => Project.find(1))
+                assert_not_include 'test', f.event_types
+                user = MockUser.new(:view_test)
+                f = Redmine::Activity::Fetcher.new(user, :project => Project.find(1))
+                assert_include 'test', f.event_types
+              ensure
+                Redmine::Activity.delete 'test'
+              end
               private
               def find_events(user, options={})
                 Redmine::Activity::Fetcher.new(user, options).events(Date.today - 30, Date.today + 1)
               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