role.rb
284 lines
| 8.8 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r5213 | # Redmine - project management software | ||
|
Jean-Philippe Lang
|
r14856 | # Copyright (C) 2006-2016 Jean-Philippe Lang | ||
|
Jean-Philippe Lang
|
r330 | # | ||
| # 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. | ||||
Toshi MARUYAMA
|
r6737 | # | ||
|
Jean-Philippe Lang
|
r330 | # 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. | ||||
|
Toshi MARUYAMA
|
r6737 | # | ||
|
Jean-Philippe Lang
|
r330 | # 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 Role < ActiveRecord::Base | ||||
|
Jean-Philippe Lang
|
r9733 | # Custom coder for the permissions attribute that should be an | ||
| # array of symbols. Rails 3 uses Psych which can be *unbelievably* | ||||
| # slow on some platforms (eg. mingw32). | ||||
| class PermissionsAttributeCoder | ||||
| def self.load(str) | ||||
| str.to_s.scan(/:([a-z0-9_]+)/).flatten.map(&:to_sym) | ||||
| end | ||||
| def self.dump(value) | ||||
| YAML.dump(value) | ||||
| end | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | # Built-in roles | ||
| BUILTIN_NON_MEMBER = 1 | ||||
| BUILTIN_ANONYMOUS = 2 | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r5296 | ISSUES_VISIBILITY_OPTIONS = [ | ||
|
Jean-Philippe Lang
|
r5346 | ['all', :label_issues_visibility_all], | ||
| ['default', :label_issues_visibility_public], | ||||
|
Jean-Philippe Lang
|
r5296 | ['own', :label_issues_visibility_own] | ||
| ] | ||||
|
Jean-Philippe Lang
|
r1812 | |||
|
Jean-Philippe Lang
|
r13893 | TIME_ENTRIES_VISIBILITY_OPTIONS = [ | ||
| ['all', :label_time_entries_visibility_all], | ||||
| ['own', :label_time_entries_visibility_own] | ||||
| ] | ||||
|
Jean-Philippe Lang
|
r13202 | USERS_VISIBILITY_OPTIONS = [ | ||
| ['all', :label_users_visibility_all], | ||||
| ['members_of_visible_projects', :label_users_visibility_members_of_visible_projects] | ||||
| ] | ||||
|
Jean-Philippe Lang
|
r13144 | scope :sorted, lambda { order(:builtin, :position) } | ||
| scope :givable, lambda { order(:position).where(:builtin => 0) } | ||||
|
Toshi MARUYAMA
|
r9355 | scope :builtin, lambda { |*args| | ||
|
Jean-Philippe Lang
|
r9532 | compare = (args.first == true ? 'not' : '') | ||
| where("#{compare} builtin = 0") | ||||
|
Jean-Philippe Lang
|
r1812 | } | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r663 | before_destroy :check_deletable | ||
|
Jean-Philippe Lang
|
r9794 | has_many :workflow_rules, :dependent => :delete_all do | ||
|
Jean-Philippe Lang
|
r3040 | def copy(source_role) | ||
|
Jean-Philippe Lang
|
r9794 | WorkflowRule.copy(nil, source_role, nil, proxy_association.owner) | ||
|
Jean-Philippe Lang
|
r1237 | end | ||
| end | ||||
|
Jean-Philippe Lang
|
r11782 | has_and_belongs_to_many :custom_fields, :join_table => "#{table_name_prefix}custom_fields_roles#{table_name_suffix}", :foreign_key => "role_id" | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r13911 | has_and_belongs_to_many :managed_roles, :class_name => 'Role', | ||
| :join_table => "#{table_name_prefix}roles_managed_roles#{table_name_suffix}", | ||||
| :association_foreign_key => "managed_role_id" | ||||
|
Jean-Philippe Lang
|
r2627 | has_many :member_roles, :dependent => :destroy | ||
| has_many :members, :through => :member_roles | ||||
|
Jean-Philippe Lang
|
r14953 | acts_as_positioned :scope => :builtin | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r9733 | serialize :permissions, ::Role::PermissionsAttributeCoder | ||
|
Jean-Philippe Lang
|
r15082 | store :settings, :accessors => [:permissions_all_trackers, :permissions_tracker_ids] | ||
|
Jean-Philippe Lang
|
r663 | attr_protected :builtin | ||
|
Jean-Philippe Lang
|
r330 | |||
| validates_presence_of :name | ||||
| validates_uniqueness_of :name | ||||
|
Jean-Philippe Lang
|
r590 | validates_length_of :name, :maximum => 30 | ||
|
Jean-Philippe Lang
|
r5296 | validates_inclusion_of :issues_visibility, | ||
| :in => ISSUES_VISIBILITY_OPTIONS.collect(&:first), | ||||
|
Jean-Philippe Lang
|
r13469 | :if => lambda {|role| role.respond_to?(:issues_visibility) && role.issues_visibility_changed?} | ||
|
Jean-Philippe Lang
|
r13202 | validates_inclusion_of :users_visibility, | ||
| :in => USERS_VISIBILITY_OPTIONS.collect(&:first), | ||||
|
Jean-Philippe Lang
|
r13469 | :if => lambda {|role| role.respond_to?(:users_visibility) && role.users_visibility_changed?} | ||
|
Jean-Philippe Lang
|
r13893 | validates_inclusion_of :time_entries_visibility, | ||
| :in => TIME_ENTRIES_VISIBILITY_OPTIONS.collect(&:first), | ||||
| :if => lambda {|role| role.respond_to?(:time_entries_visibility) && role.time_entries_visibility_changed?} | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r10102 | # Copies attributes from another role, arg can be an id or a Role | ||
| def copy_from(arg, options={}) | ||||
| return unless arg.present? | ||||
| role = arg.is_a?(Role) ? arg : Role.find_by_id(arg.to_s) | ||||
| self.attributes = role.attributes.dup.except("id", "name", "position", "builtin", "permissions") | ||||
| self.permissions = role.permissions.dup | ||||
| self | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | def permissions=(perms) | ||
|
Jean-Philippe Lang
|
r1812 | perms = perms.collect {|p| p.to_sym unless p.blank? }.compact.uniq if perms | ||
|
Jean-Philippe Lang
|
r663 | write_attribute(:permissions, perms) | ||
| end | ||||
|
Jean-Philippe Lang
|
r1812 | |||
| def add_permission!(*perms) | ||||
| self.permissions = [] unless permissions.is_a?(Array) | ||||
| permissions_will_change! | ||||
| perms.each do |p| | ||||
| p = p.to_sym | ||||
| permissions << p unless permissions.include?(p) | ||||
| end | ||||
| save! | ||||
| end | ||||
| def remove_permission!(*perms) | ||||
| return unless permissions.is_a?(Array) | ||||
| permissions_will_change! | ||||
| perms.each { |p| permissions.delete(p.to_sym) } | ||||
| save! | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r1813 | # Returns true if the role has the given permission | ||
| def has_permission?(perm) | ||||
| !permissions.nil? && permissions.include?(perm.to_sym) | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r13365 | def consider_workflow? | ||
| has_permission?(:add_issues) || has_permission?(:edit_issues) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r431 | def <=>(role) | ||
|
Jean-Philippe Lang
|
r9532 | if role | ||
| if builtin == role.builtin | ||||
| position <=> role.position | ||||
| else | ||||
| builtin <=> role.builtin | ||||
| end | ||||
| else | ||||
| -1 | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2627 | end | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r2627 | def to_s | ||
| name | ||||
|
Jean-Philippe Lang
|
r431 | end | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r5213 | def name | ||
| case builtin | ||||
| when 1; l(:label_role_non_member, :default => read_attribute(:name)) | ||||
| when 2; l(:label_role_anonymous, :default => read_attribute(:name)) | ||||
| else; read_attribute(:name) | ||||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r663 | # Return true if the role is a builtin role | ||
| def builtin? | ||||
| self.builtin != 0 | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r10254 | # Return true if the role is the anonymous role | ||
| def anonymous? | ||||
| builtin == 2 | ||||
| end | ||||
|
Toshi MARUYAMA
|
r11485 | |||
|
Jean-Philippe Lang
|
r663 | # Return true if the role is a project member role | ||
| def member? | ||||
| !self.builtin? | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r663 | # Return true if role is allowed to do the specified action | ||
| # action can be: | ||||
| # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit') | ||||
| # * a permission Symbol (eg. :edit_project) | ||||
| def allowed_to?(action) | ||||
| if action.is_a? Hash | ||||
| allowed_actions.include? "#{action[:controller]}/#{action[:action]}" | ||||
| else | ||||
| allowed_permissions.include? action | ||||
| end | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r663 | # Return all the permissions that can be given to the role | ||
| def setable_permissions | ||||
| setable_permissions = Redmine::AccessControl.permissions - Redmine::AccessControl.public_permissions | ||||
| setable_permissions -= Redmine::AccessControl.members_only_permissions if self.builtin == BUILTIN_NON_MEMBER | ||||
| setable_permissions -= Redmine::AccessControl.loggedin_only_permissions if self.builtin == BUILTIN_ANONYMOUS | ||||
| setable_permissions | ||||
| end | ||||
|
Jean-Philippe Lang
|
r15082 | def permissions_tracker_ids(*args) | ||
| if args.any? | ||||
| Array(permissions_tracker_ids[args.first.to_s]).map(&:to_i) | ||||
| else | ||||
| super || {} | ||||
| end | ||||
| end | ||||
| def permissions_tracker_ids=(arg) | ||||
| h = arg.to_hash | ||||
| h.values.each {|v| v.reject!(&:blank?)} | ||||
| super(h) | ||||
| end | ||||
| # Returns true if tracker_id belongs to the list of | ||||
| # trackers for which permission is given | ||||
| def permissions_tracker_ids?(permission, tracker_id) | ||||
| permissions_tracker_ids(permission).include?(tracker_id) | ||||
| end | ||||
| def permissions_all_trackers | ||||
| super || {} | ||||
| end | ||||
| def permissions_all_trackers=(arg) | ||||
| super(arg.to_hash) | ||||
| end | ||||
| # Returns true if permission is given for all trackers | ||||
| def permissions_all_trackers?(permission) | ||||
| permissions_all_trackers[permission.to_s].to_s != '0' | ||||
| end | ||||
| # Sets the trackers that are allowed for a permission. | ||||
| # tracker_ids can be an array of tracker ids or :all for | ||||
| # no restrictions. | ||||
| # | ||||
| # Examples: | ||||
| # role.set_permission_trackers :add_issues, [1, 3] | ||||
| # role.set_permission_trackers :add_issues, :all | ||||
| def set_permission_trackers(permission, tracker_ids) | ||||
| h = {permission.to_s => (tracker_ids == :all ? '1' : '0')} | ||||
| self.permissions_all_trackers = permissions_all_trackers.merge(h) | ||||
| h = {permission.to_s => (tracker_ids == :all ? [] : tracker_ids)} | ||||
| self.permissions_tracker_ids = permissions_tracker_ids.merge(h) | ||||
| self | ||||
| end | ||||
|
Jean-Philippe Lang
|
r663 | # Find all the roles that can be given to a project member | ||
| def self.find_all_givable | ||||
|
Jean-Philippe Lang
|
r13100 | Role.givable.to_a | ||
|
Jean-Philippe Lang
|
r663 | end | ||
Eric Davis
|
r3249 | # Return the builtin 'non member' role. If the role doesn't exist, | ||
| # it will be created on the fly. | ||||
|
Jean-Philippe Lang
|
r663 | def self.non_member | ||
|
Jean-Philippe Lang
|
r6179 | find_or_create_system_role(BUILTIN_NON_MEMBER, 'Non member') | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Eric Davis
|
r3249 | # Return the builtin 'anonymous' role. If the role doesn't exist, | ||
| # it will be created on the fly. | ||||
|
Jean-Philippe Lang
|
r663 | def self.anonymous | ||
|
Jean-Philippe Lang
|
r6179 | find_or_create_system_role(BUILTIN_ANONYMOUS, 'Anonymous') | ||
|
Jean-Philippe Lang
|
r663 | end | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r330 | private | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r663 | def allowed_permissions | ||
| @allowed_permissions ||= permissions + Redmine::AccessControl.public_permissions.collect {|p| p.name} | ||||
| end | ||||
| def allowed_actions | ||||
| @actions_allowed ||= allowed_permissions.inject([]) { |actions, permission| actions += Redmine::AccessControl.allowed_actions(permission) }.flatten | ||||
| end | ||||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r663 | def check_deletable | ||
|
Jean-Philippe Lang
|
r13399 | raise "Cannot delete role" if members.any? | ||
| raise "Cannot delete builtin role" if builtin? | ||||
|
Jean-Philippe Lang
|
r2 | end | ||
|
Toshi MARUYAMA
|
r6737 | |||
|
Jean-Philippe Lang
|
r6179 | def self.find_or_create_system_role(builtin, name) | ||
|
Jean-Philippe Lang
|
r9532 | role = where(:builtin => builtin).first | ||
|
Jean-Philippe Lang
|
r6179 | if role.nil? | ||
|
Jean-Philippe Lang
|
r14953 | role = create(:name => name) do |r| | ||
|
Jean-Philippe Lang
|
r6179 | r.builtin = builtin | ||
| end | ||||
|
Jean-Philippe Lang
|
r14953 | raise "Unable to create the #{name} role (#{role.errors.full_messages.join(',')})." if role.new_record? | ||
|
Jean-Philippe Lang
|
r6179 | end | ||
| role | ||||
| end | ||||
|
Jean-Philippe Lang
|
r2 | end | ||