1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285 |
- # frozen_string_literal: true
-
- # Redmine - project management software
- # Copyright (C) 2006-2021 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.
-
- class Project < ActiveRecord::Base
- include Redmine::SafeAttributes
- include Redmine::NestedSet::ProjectNestedSet
-
- # Project statuses
- STATUS_ACTIVE = 1
- STATUS_CLOSED = 5
- STATUS_ARCHIVED = 9
-
- # Maximum length for project identifiers
- IDENTIFIER_MAX_LENGTH = 100
-
- # Specific overridden Activities
- has_many :time_entry_activities
- has_many :memberships, :class_name => 'Member', :inverse_of => :project
- # Memberships of active users only
- has_many :members,
- lambda {joins(:principal).where(:users => {:type => 'User', :status => Principal::STATUS_ACTIVE})}
- has_many :enabled_modules, :dependent => :delete_all
- has_and_belongs_to_many :trackers, lambda {order(:position)}
- has_many :issues, :dependent => :destroy
- has_many :issue_changes, :through => :issues, :source => :journals
- has_many :versions, :dependent => :destroy
- belongs_to :default_version, :class_name => 'Version'
- belongs_to :default_assigned_to, :class_name => 'Principal'
- has_many :time_entries, :dependent => :destroy
- has_many :queries, :dependent => :delete_all
- has_many :documents, :dependent => :destroy
- has_many :news, lambda {includes(:author)}, :dependent => :destroy
- has_many :issue_categories, lambda {order(:name)}, :dependent => :delete_all
- has_many :boards, lambda {order(:position)}, :inverse_of => :project, :dependent => :destroy
- has_one :repository, lambda {where(:is_default => true)}
- has_many :repositories, :dependent => :destroy
- has_many :changesets, :through => :repository
- has_one :wiki, :dependent => :destroy
- # Custom field for the project issues
- has_and_belongs_to_many :issue_custom_fields,
- lambda {order(:position)},
- :class_name => 'IssueCustomField',
- :join_table => "#{table_name_prefix}custom_fields_projects#{table_name_suffix}",
- :association_foreign_key => 'custom_field_id'
- # Default Custom Query
- belongs_to :default_issue_query, :class_name => 'IssueQuery'
-
- acts_as_attachable :view_permission => :view_files,
- :edit_permission => :manage_files,
- :delete_permission => :manage_files
-
- acts_as_customizable
- acts_as_searchable :columns => ['name', 'identifier', 'description'],
- :project_key => "#{Project.table_name}.id",
- :permission => nil
- acts_as_event :title => proc {|o| "#{l(:label_project)}: #{o.name}"},
- :url => proc {|o| {:controller => 'projects', :action => 'show', :id => o}},
- :author => nil
-
- validates_presence_of :name, :identifier
- validates_uniqueness_of :identifier, :if => proc {|p| p.identifier_changed?}, :case_sensitive => true
- validates_length_of :name, :maximum => 255
- validates_length_of :homepage, :maximum => 255
- validates_length_of :identifier, :maximum => IDENTIFIER_MAX_LENGTH
- # downcase letters, digits, dashes but not digits only
- validates_format_of :identifier, :with => /\A(?!\d+$)[a-z0-9\-_]*\z/,
- :if => proc {|p| p.identifier_changed?}
- # reserved words
- validates_exclusion_of :identifier, :in => %w(new)
- validate :validate_parent
-
- after_save :update_inherited_members,
- :if => proc {|project| project.saved_change_to_inherit_members?}
- after_save :remove_inherited_member_roles, :add_inherited_member_roles,
- :if => proc {|project| project.saved_change_to_parent_id?}
- after_update :update_versions_from_hierarchy_change,
- :if => proc {|project| project.saved_change_to_parent_id?}
- before_destroy :delete_all_members
-
- scope :has_module, (lambda do |mod|
- where("#{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name=?)", mod.to_s)
- end)
- scope :active, lambda {where(:status => STATUS_ACTIVE)}
- scope :status, lambda {|arg| where(arg.blank? ? nil : {:status => arg.to_i})}
- scope :all_public, lambda {where(:is_public => true)}
- scope :visible, lambda {|*args| where(Project.visible_condition(args.shift || User.current, *args))}
- scope :allowed_to, (lambda do |*args|
- user = args.first.is_a?(Symbol) ? User.current : args.shift
- permission = args.shift
- where(Project.allowed_to_condition(user, permission, *args))
- end)
- scope :like, (lambda do |arg|
- if arg.present?
- pattern = "%#{arg.to_s.strip}%"
- where("LOWER(identifier) LIKE LOWER(:p) OR LOWER(name) LIKE LOWER(:p)", :p => pattern)
- end
- end)
- scope :sorted, lambda {order(:lft)}
- scope :having_trackers, (lambda do
- where("#{Project.table_name}.id IN (SELECT DISTINCT project_id FROM #{table_name_prefix}projects_trackers#{table_name_suffix})")
- end)
-
- def initialize(attributes=nil, *args)
- super
-
- initialized = (attributes || {}).stringify_keys
- if !initialized.key?('identifier') && Setting.sequential_project_identifiers?
- self.identifier = Project.next_identifier
- end
- if !initialized.key?('is_public')
- self.is_public = Setting.default_projects_public?
- end
- if !initialized.key?('enabled_module_names')
- self.enabled_module_names = Setting.default_projects_modules
- end
- if !initialized.key?('trackers') && !initialized.key?('tracker_ids')
- default = Setting.default_projects_tracker_ids
- if default.is_a?(Array)
- self.trackers = Tracker.where(:id => default.map(&:to_i)).sorted.to_a
- else
- self.trackers = Tracker.sorted.to_a
- end
- end
- end
-
- def identifier=(identifier)
- super unless identifier_frozen?
- end
-
- def identifier_frozen?
- errors[:identifier].blank? && !(new_record? || identifier.blank?)
- end
-
- # returns latest created projects
- # non public projects will be returned only if user is a member of those
- def self.latest(user=nil, count=5)
- visible(user).limit(count).
- order(:created_on => :desc).
- where("#{table_name}.created_on >= ?", 30.days.ago).
- to_a
- end
-
- # Returns true if the project is visible to +user+ or to the current user.
- def visible?(user=User.current)
- user.allowed_to?(:view_project, self)
- end
-
- # Returns a SQL conditions string used to find all projects visible by the specified user.
- #
- # Examples:
- # Project.visible_condition(admin) => "projects.status = 1"
- # Project.visible_condition(normal_user) => "((projects.status = 1) AND (projects.is_public = 1 OR projects.id IN (1,3,4)))"
- # Project.visible_condition(anonymous) => "((projects.status = 1) AND (projects.is_public = 1))"
- def self.visible_condition(user, options={})
- allowed_to_condition(user, :view_project, options)
- end
-
- # Returns a SQL conditions string used to find all projects for which +user+ has the given +permission+
- #
- # Valid options:
- # * :skip_pre_condition => true don't check that the module is enabled (eg. when the condition is already set elsewhere in the query)
- # * :project => project limit the condition to project
- # * :with_subprojects => true limit the condition to project and its subprojects
- # * :member => true limit the condition to the user projects
- def self.allowed_to_condition(user, permission, options={})
- perm = Redmine::AccessControl.permission(permission)
- base_statement =
- if perm && perm.read?
- "#{Project.table_name}.status <> #{Project::STATUS_ARCHIVED}"
- else
- "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}"
- end
- if !options[:skip_pre_condition] && perm && perm.project_module
- # If the permission belongs to a project module, make sure the module is enabled
- base_statement +=
- " AND EXISTS (SELECT 1 AS one FROM #{EnabledModule.table_name} em" \
- " WHERE em.project_id = #{Project.table_name}.id" \
- " AND em.name='#{perm.project_module}')"
- end
- if project = options[:project]
- project_statement = project.project_condition(options[:with_subprojects])
- base_statement = "(#{project_statement}) AND (#{base_statement})"
- end
-
- if user.admin?
- base_statement
- else
- statement_by_role = {}
- unless options[:member]
- role = user.builtin_role
- if role.allowed_to?(permission)
- s = "#{Project.table_name}.is_public = #{connection.quoted_true}"
- if user.id
- group = role.anonymous? ? Group.anonymous : Group.non_member
- principal_ids = [user.id, group.id].compact
- s =
- "(#{s} AND #{Project.table_name}.id NOT IN " \
- "(SELECT project_id FROM #{Member.table_name} " \
- "WHERE user_id IN (#{principal_ids.join(',')})))"
- end
- statement_by_role[role] = s
- end
- end
- user.project_ids_by_role.each do |role, project_ids|
- if role.allowed_to?(permission) && project_ids.any?
- statement_by_role[role] = "#{Project.table_name}.id IN (#{project_ids.join(',')})"
- end
- end
- if statement_by_role.empty?
- "1=0"
- else
- if block_given?
- statement_by_role.each do |role, statement|
- if s = yield(role, user)
- statement_by_role[role] = "(#{statement} AND (#{s}))"
- end
- end
- end
- "((#{base_statement}) AND (#{statement_by_role.values.join(' OR ')}))"
- end
- end
- end
-
- def override_roles(role)
- @override_members ||= memberships.
- joins(:principal).
- where(:users => {:type => ['GroupAnonymous', 'GroupNonMember']}).to_a
-
- group_class = role.anonymous? ? GroupAnonymous : GroupNonMember
- member = @override_members.detect {|m| m.principal.is_a? group_class}
- member ? member.roles.to_a : [role]
- end
-
- def principals
- @principals ||=
- Principal.active.joins(:members).where("#{Member.table_name}.project_id = ?", id).distinct
- end
-
- def users
- @users ||=
- User.active.joins(:members).where("#{Member.table_name}.project_id = ?", id).distinct
- end
-
- # Returns the Systemwide and project specific activities
- def activities(include_inactive=false)
- t = TimeEntryActivity.table_name
- scope = TimeEntryActivity.where("#{t}.project_id IS NULL OR #{t}.project_id = ?", id)
-
- overridden_activity_ids = self.time_entry_activities.pluck(:parent_id).compact
- if overridden_activity_ids.any?
- scope = scope.where("#{t}.id NOT IN (?)", overridden_activity_ids)
- end
- unless include_inactive
- scope = scope.active
- end
- scope
- end
-
- # Creates or updates project time entry activities
- def update_or_create_time_entry_activities(activities)
- transaction do
- activities.each do |id, activity|
- update_or_create_time_entry_activity(id, activity)
- end
- end
- end
-
- # Will create a new Project specific Activity or update an existing one
- #
- # This will raise a ActiveRecord::Rollback if the TimeEntryActivity
- # does not successfully save.
- def update_or_create_time_entry_activity(id, activity_hash)
- if activity_hash.respond_to?(:has_key?) && activity_hash.has_key?('parent_id')
- self.create_time_entry_activity_if_needed(activity_hash)
- else
- activity = project.time_entry_activities.find_by_id(id.to_i)
- activity.update(activity_hash) if activity
- end
- end
-
- # Create a new TimeEntryActivity if it overrides a system TimeEntryActivity
- #
- # This will raise a ActiveRecord::Rollback if the TimeEntryActivity
- # does not successfully save.
- def create_time_entry_activity_if_needed(activity)
- if activity['parent_id']
- parent_activity = TimeEntryActivity.find(activity['parent_id'])
- activity['name'] = parent_activity.name
- activity['position'] = parent_activity.position
- if Enumeration.overriding_change?(activity, parent_activity)
- project_activity = self.time_entry_activities.create(activity)
- if project_activity.new_record?
- raise ActiveRecord::Rollback, "Overriding TimeEntryActivity was not successfully saved"
- else
- self.time_entries.
- where(:activity_id => parent_activity.id).
- update_all(:activity_id => project_activity.id)
- end
- end
- end
- end
-
- # returns the time log activity to be used when logging time via a changeset
- def commit_logtime_activity
- activity_id = Setting.commit_logtime_activity_id.to_i
- if activity_id > 0
- activities
- .find_by('id = ? OR parent_id = ?', activity_id, activity_id)
- end
- end
-
- # Returns a :conditions SQL string that can be used to find the issues associated with this project.
- #
- # Examples:
- # project.project_condition(true) => "(projects.id = 1 OR (projects.lft > 1 AND projects.rgt < 10))"
- # project.project_condition(false) => "projects.id = 1"
- def project_condition(with_subprojects)
- cond = "#{Project.table_name}.id = #{id}"
- if with_subprojects
- cond = "(#{cond} OR (#{Project.table_name}.lft > #{lft} AND " \
- "#{Project.table_name}.rgt < #{rgt}))"
- end
- cond
- end
-
- def self.find(*args)
- if args.first && args.first.is_a?(String) && !/^\d*$/.match?(args.first)
- project = find_by_identifier(*args)
- if project.nil?
- raise ActiveRecord::RecordNotFound, "Couldn't find Project with identifier=#{args.first}"
- end
-
- project
- else
- super
- end
- end
-
- def self.find_by_param(*args)
- self.find(*args)
- end
-
- alias :base_reload :reload
- def reload(*args)
- @principals = nil
- @users = nil
- @shared_versions = nil
- @rolled_up_versions = nil
- @rolled_up_trackers = nil
- @rolled_up_statuses = nil
- @rolled_up_custom_fields = nil
- @all_issue_custom_fields = nil
- @all_time_entry_custom_fields = nil
- @to_param = nil
- @allowed_parents = nil
- @allowed_permissions = nil
- @actions_allowed = nil
- @start_date = nil
- @due_date = nil
- @override_members = nil
- @assignable_users = nil
- base_reload(*args)
- end
-
- def to_param
- if new_record?
- nil
- else
- # id is used for projects with a numeric identifier (compatibility)
- @to_param ||= (%r{^\d*$}.match?(identifier.to_s) ? id.to_s : identifier)
- end
- end
-
- def active?
- self.status == STATUS_ACTIVE
- end
-
- def closed?
- self.status == STATUS_CLOSED
- end
-
- def archived?
- self.status == STATUS_ARCHIVED
- end
-
- # Archives the project and its descendants
- def archive
- # Check that there is no issue of a non descendant project that is assigned
- # to one of the project or descendant versions
- version_ids = self_and_descendants.joins(:versions).pluck("#{Version.table_name}.id")
-
- if version_ids.any? &&
- Issue.
- joins(:project).
- where("#{Project.table_name}.lft < ? OR #{Project.table_name}.rgt > ?", lft, rgt).
- where(:fixed_version_id => version_ids).
- exists?
- return false
- end
-
- Project.transaction do
- archive!
- end
- true
- end
-
- # Unarchives the project and its archived ancestors
- def unarchive
- new_status = ancestors.any?(&:closed?) ? STATUS_CLOSED : STATUS_ACTIVE
- self_and_ancestors.status(STATUS_ARCHIVED).update_all :status => new_status
- reload
- end
-
- def close
- self_and_descendants.status(STATUS_ACTIVE).update_all :status => STATUS_CLOSED
- end
-
- def reopen
- self_and_descendants.status(STATUS_CLOSED).update_all :status => STATUS_ACTIVE
- end
-
- # Returns an array of projects the project can be moved to
- # by the current user
- def allowed_parents(user=User.current)
- return @allowed_parents if @allowed_parents
-
- @allowed_parents = Project.allowed_to(user, :add_subprojects).to_a
- @allowed_parents = @allowed_parents - self_and_descendants
- if user.allowed_to?(:add_project, nil, :global => true) || (!new_record? && parent.nil?)
- @allowed_parents << nil
- end
- unless parent.nil? || @allowed_parents.empty? || @allowed_parents.include?(parent)
- @allowed_parents << parent
- end
- @allowed_parents
- end
-
- # Sets the parent of the project and saves the project
- # Argument can be either a Project, a String, a Fixnum or nil
- def set_parent!(p)
- if p.is_a?(Project)
- self.parent = p
- else
- self.parent_id = p
- end
- save
- end
-
- # Returns a scope of the trackers used by the project and its active sub projects
- def rolled_up_trackers(include_subprojects=true)
- if include_subprojects
- @rolled_up_trackers ||= rolled_up_trackers_base_scope.
- where("#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ?", lft, rgt)
- else
- rolled_up_trackers_base_scope.
- where(:projects => {:id => id})
- end
- end
-
- def rolled_up_trackers_base_scope
- Tracker.
- joins(projects: :enabled_modules).
- where("#{Project.table_name}.status <> ?", STATUS_ARCHIVED).
- where(:enabled_modules => {:name => 'issue_tracking'}).
- distinct.
- sorted
- end
-
- def rolled_up_statuses
- issue_status_ids = WorkflowTransition.
- where(:tracker_id => rolled_up_trackers.map(&:id)).
- distinct.
- pluck(:old_status_id, :new_status_id).
- flatten.
- uniq
-
- IssueStatus.where(:id => issue_status_ids).sorted
- end
-
- # Closes open and locked project versions that are completed
- def close_completed_versions
- Version.transaction do
- versions.where(:status => %w(open locked)).each do |version|
- if version.completed?
- version.update_attribute(:status, 'closed')
- end
- end
- end
- end
-
- # Returns a scope of the Versions on subprojects
- def rolled_up_versions
- @rolled_up_versions ||=
- Version.
- joins(:project).
- where(
- "#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ?" \
- " AND #{Project.table_name}.status <> ?", lft, rgt, STATUS_ARCHIVED
- )
- end
-
- # Returns a scope of the Versions used by the project
- def shared_versions
- if new_record?
- Version.
- joins(:project).
- preload(:project).
- where("#{Project.table_name}.status <> ? AND #{Version.table_name}.sharing = 'system'",
- STATUS_ARCHIVED)
- else
- @shared_versions ||= begin
- r = root? ? self : root
- Version.
- joins(:project).
- preload(:project).
- where(
- "#{Project.table_name}.id = #{id}" \
- " OR (#{Project.table_name}.status <> #{Project::STATUS_ARCHIVED} AND (" \
- " #{Version.table_name}.sharing = 'system'" \
- " OR (#{Project.table_name}.lft >= #{r.lft}" \
- " AND #{Project.table_name}.rgt <= #{r.rgt}" \
- " AND #{Version.table_name}.sharing = 'tree')" \
- " OR (#{Project.table_name}.lft < #{lft}" \
- " AND #{Project.table_name}.rgt > #{rgt}" \
- " AND #{Version.table_name}.sharing IN ('hierarchy', 'descendants'))" \
- " OR (#{Project.table_name}.lft > #{lft}" \
- " AND #{Project.table_name}.rgt < #{rgt}" \
- " AND #{Version.table_name}.sharing = 'hierarchy')" \
- "))"
- )
- end
- end
- end
-
- # Returns a hash of project users/groups grouped by role
- def principals_by_role
- memberships.includes(:principal, :roles).inject({}) do |h, m|
- m.roles.each do |r|
- h[r] ||= []
- h[r] << m.principal
- end
- h
- end
- end
-
- # Adds user as a project member with the default role
- # Used for when a non-admin user creates a project
- def add_default_member(user)
- role = self.class.default_member_role
- member = Member.new(:project => self, :principal => user, :roles => [role])
- self.members << member
- member
- end
-
- # Default role that is given to non-admin users that
- # create a project
- def self.default_member_role
- Role.givable.find_by_id(Setting.new_project_user_role_id.to_i) || Role.givable.first
- end
-
- # Deletes all project's members
- def delete_all_members
- me, mr = Member.table_name, MemberRole.table_name
- self.class.connection.delete(
- "DELETE FROM #{mr} WHERE #{mr}.member_id IN (SELECT #{me}.id FROM #{me} " \
- "WHERE #{me}.project_id = #{id})"
- )
- Member.where(:project_id => id).delete_all
- end
-
- # Return a Principal scope of users/groups issues can be assigned to
- def assignable_users(tracker=nil)
- return @assignable_users[tracker] if @assignable_users && @assignable_users[tracker]
-
- types = ['User']
- types << 'Group' if Setting.issue_group_assignment?
-
- scope = Principal.
- active.
- joins(:members => :roles).
- where(:type => types, :members => {:project_id => id}, :roles => {:assignable => true}).
- distinct.
- sorted
-
- if tracker
- # Rejects users that cannot the view the tracker
- roles =
- Role.where(:assignable => true).select do |role|
- role.permissions_tracker?(:view_issues, tracker)
- end
- scope = scope.where(:roles => {:id => roles.map(&:id)})
- end
-
- @assignable_users ||= {}
- @assignable_users[tracker] = scope
- end
-
- # Returns the mail addresses of users that should be always notified on project events
- def recipients
- notified_users.collect {|user| user.mail}
- end
-
- # Returns the users that should be notified on project events
- def notified_users
- # TODO: User part should be extracted to User#notify_about?
- users =
- members.preload(:principal).select do |m|
- m.principal.present? &&
- (m.mail_notification? || m.principal.mail_notification == 'all')
- end
- users.collect {|m| m.principal}
- end
-
- # Returns a scope of all custom fields enabled for project issues
- # (explicitly associated custom fields and custom fields enabled for all projects)
- def all_issue_custom_fields
- if new_record?
- @all_issue_custom_fields ||= IssueCustomField.
- sorted.
- where("is_for_all = ? OR id IN (?)", true, issue_custom_field_ids)
- else
- @all_issue_custom_fields ||= IssueCustomField.
- sorted.
- where("is_for_all = ? OR id IN (SELECT DISTINCT cfp.custom_field_id" +
- " FROM #{table_name_prefix}custom_fields_projects#{table_name_suffix} cfp" +
- " WHERE cfp.project_id = ?)", true, id)
- end
- end
-
- # Returns a scope of all custom fields enabled for issues of the project
- # and its subprojects
- def rolled_up_custom_fields
- if leaf?
- all_issue_custom_fields
- else
- @rolled_up_custom_fields ||= IssueCustomField.
- sorted.
- where("is_for_all = ? OR EXISTS (SELECT 1" +
- " FROM #{table_name_prefix}custom_fields_projects#{table_name_suffix} cfp" +
- " JOIN #{Project.table_name} p ON p.id = cfp.project_id" +
- " WHERE cfp.custom_field_id = #{CustomField.table_name}.id" +
- " AND p.lft >= ? AND p.rgt <= ?)", true, lft, rgt)
- end
- end
-
- def project
- self
- end
-
- def <=>(project)
- name.casecmp(project.name)
- end
-
- def to_s
- name
- end
-
- # Returns a short description of the projects (first lines)
- def short_description(length = 255)
- description.gsub(/^(.{#{length}}[^\n\r]*).*$/m, '\1...').strip if description
- end
-
- def css_classes
- s = +'project'
- s << ' root' if root?
- s << ' child' if child?
- s << (leaf? ? ' leaf' : ' parent')
- s << ' public' if is_public?
- unless active?
- if archived?
- s << ' archived'
- else
- s << ' closed'
- end
- end
- s
- end
-
- # The earliest start date of a project, based on it's issues and versions
- def start_date
- @start_date ||=
- [
- issues.minimum('start_date'),
- shared_versions.minimum('effective_date'),
- Issue.fixed_version(shared_versions).minimum('start_date')
- ].compact.min
- end
-
- # The latest due date of an issue or version
- def due_date
- @due_date ||=
- [
- issues.maximum('due_date'),
- shared_versions.maximum('effective_date'),
- Issue.fixed_version(shared_versions).maximum('due_date')
- ].compact.max
- end
-
- def overdue?
- active? && !due_date.nil? && (due_date < User.current.today)
- end
-
- # Returns the percent completed for this project, based on the
- # progress on it's versions.
- def completed_percent(options={:include_subprojects => false})
- if options.delete(:include_subprojects)
- total = self_and_descendants.sum(&:completed_percent)
-
- total / self_and_descendants.count
- else
- if versions.count > 0
- total = versions.sum(&:completed_percent)
-
- total / versions.count
- else
- 100
- end
- end
- end
-
- # Return true if this project allows to do the specified action.
- # action can be:
- # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
- # * a permission Symbol (eg. :edit_project)
- def allows_to?(action)
- if archived?
- # No action allowed on archived projects
- return false
- end
- unless active? || Redmine::AccessControl.read_action?(action)
- # No write action allowed on closed projects
- return false
- end
-
- # No action allowed on disabled modules
- if action.is_a? Hash
- allowed_actions.include? "#{action[:controller]}/#{action[:action]}"
- else
- allowed_permissions.include? action
- end
- end
-
- def deletable?(user = User.current)
- if user.admin?
- return true
- else
- user.allowed_to?(:delete_project, self) && leaf?
- end
- end
-
- # Return the enabled module with the given name
- # or nil if the module is not enabled for the project
- def enabled_module(name)
- name = name.to_s
- enabled_modules.detect {|m| m.name == name}
- end
-
- # Return true if the module with the given name is enabled
- def module_enabled?(name)
- enabled_module(name).present?
- end
-
- def enabled_module_names=(module_names)
- if module_names && module_names.is_a?(Array)
- module_names = module_names.collect(&:to_s).reject(&:blank?)
- self.enabled_modules =
- module_names.collect do |name|
- enabled_modules.detect {|mod| mod.name == name} ||
- EnabledModule.new(:name => name)
- end
- else
- enabled_modules.clear
- end
- end
-
- # Returns an array of the enabled modules names
- def enabled_module_names
- enabled_modules.collect(&:name)
- end
-
- # Enable a specific module
- #
- # Examples:
- # project.enable_module!(:issue_tracking)
- # project.enable_module!("issue_tracking")
- def enable_module!(name)
- enabled_modules << EnabledModule.new(:name => name.to_s) unless module_enabled?(name)
- end
-
- # Disable a module if it exists
- #
- # Examples:
- # project.disable_module!(:issue_tracking)
- # project.disable_module!("issue_tracking")
- # project.disable_module!(project.enabled_modules.first)
- def disable_module!(target)
- target = enabled_modules.detect{|mod| target.to_s == mod.name} unless enabled_modules.include?(target)
- target.destroy unless target.blank?
- end
-
- safe_attributes(
- 'name',
- 'description',
- 'homepage',
- 'is_public',
- 'identifier',
- 'custom_field_values',
- 'custom_fields',
- 'tracker_ids',
- 'issue_custom_field_ids',
- 'parent_id',
- 'default_version_id',
- 'default_issue_query_id',
- 'default_assigned_to_id')
-
- safe_attributes(
- 'enabled_module_names',
- :if =>
- lambda do |project, user|
- if project.new_record?
- if user.admin?
- true
- else
- default_member_role.has_permission?(:select_project_modules)
- end
- else
- user.allowed_to?(:select_project_modules, project)
- end
- end
- )
-
- safe_attributes(
- 'inherit_members',
- :if => lambda {|project, user| project.parent.nil? || project.parent.visible?(user)})
-
- def safe_attributes=(attrs, user=User.current)
- if attrs.respond_to?(:to_unsafe_hash)
- attrs = attrs.to_unsafe_hash
- end
- return unless attrs.is_a?(Hash)
-
- attrs = attrs.deep_dup
-
- @unallowed_parent_id = nil
- if new_record? || attrs.key?('parent_id')
- parent_id_param = attrs['parent_id'].to_s
- if new_record? || parent_id_param != parent_id.to_s
- p = parent_id_param.present? ? Project.find_by_id(parent_id_param) : nil
- unless allowed_parents(user).include?(p)
- attrs.delete('parent_id')
- @unallowed_parent_id = true
- end
- end
- end
-
- # Reject custom fields values not visible by the user
- if attrs['custom_field_values'].present?
- editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
- attrs['custom_field_values'].reject! {|k, v| !editable_custom_field_ids.include?(k.to_s)}
- end
-
- # Reject custom fields not visible by the user
- if attrs['custom_fields'].present?
- editable_custom_field_ids = editable_custom_field_values(user).map {|v| v.custom_field_id.to_s}
- attrs['custom_fields'].reject! {|c| !editable_custom_field_ids.include?(c['id'].to_s)}
- end
-
- super(attrs, user)
- end
-
- # Returns an auto-generated project identifier based on the last identifier used
- def self.next_identifier
- p = Project.order('id DESC').first
- p.nil? ? nil : p.identifier.to_s.succ
- end
-
- # Copies and saves the Project instance based on the +project+.
- # Duplicates the source project's:
- # * Wiki
- # * Versions
- # * Categories
- # * Issues
- # * Members
- # * Queries
- #
- # Accepts an +options+ argument to specify what to copy
- #
- # Examples:
- # project.copy(1) # => copies everything
- # project.copy(1, :only => 'members') # => copies members only
- # project.copy(1, :only => ['members', 'versions']) # => copies members and versions
- def copy(project, options={})
- project = project.is_a?(Project) ? project : Project.find(project)
-
- to_be_copied = %w(members wiki versions issue_categories issues queries boards documents)
- to_be_copied = to_be_copied & Array.wrap(options[:only]) unless options[:only].nil?
-
- Project.transaction do
- if save
- reload
-
- self.attachments = project.attachments.map do |attachment|
- attachment.copy(:container => self)
- end
-
- to_be_copied.each do |name|
- send "copy_#{name}", project
- end
- Redmine::Hook.call_hook(:model_project_copy_before_save,
- :source_project => project,
- :destination_project => self)
- save
- else
- false
- end
- end
- end
-
- # Returns a new unsaved Project instance with attributes copied from +project+
- def self.copy_from(project)
- project = project.is_a?(Project) ? project : Project.find(project)
- # clear unique attributes
- attributes =
- project.attributes.dup.except('id', 'name', 'identifier',
- 'status', 'parent_id', 'lft', 'rgt')
- copy = Project.new(attributes)
- copy.enabled_module_names = project.enabled_module_names
- copy.trackers = project.trackers
- copy.custom_values = project.custom_values.collect {|v| v.clone}
- copy.issue_custom_fields = project.issue_custom_fields
- copy
- end
-
- # Yields the given block for each project with its level in the tree
- def self.project_tree(projects, options={}, &block)
- ancestors = []
- if options[:init_level] && projects.first
- ancestors = projects.first.ancestors.to_a
- end
- projects.sort_by(&:lft).each do |project|
- while ancestors.any? &&
- !project.is_descendant_of?(ancestors.last)
- ancestors.pop
- end
- yield project, ancestors.size
- ancestors << project
- end
- end
-
- # Returns the custom_field_values that can be edited by the given user
- def editable_custom_field_values(user=nil)
- visible_custom_field_values(user)
- end
-
- def visible_custom_field_values(user = nil)
- user ||= User.current
- custom_field_values.select do |value|
- value.custom_field.visible_by?(project, user)
- end
- end
-
- private
-
- def update_inherited_members
- if parent
- if inherit_members? && !inherit_members_before_last_save
- remove_inherited_member_roles
- add_inherited_member_roles
- elsif !inherit_members? && inherit_members_before_last_save
- remove_inherited_member_roles
- end
- end
- end
-
- def remove_inherited_member_roles
- member_roles = MemberRole.where(:member_id => membership_ids).to_a
- member_role_ids = member_roles.map(&:id)
- member_roles.each do |member_role|
- if member_role.inherited_from && !member_role_ids.include?(member_role.inherited_from)
- member_role.destroy
- end
- end
- end
-
- def add_inherited_member_roles
- if inherit_members? && parent
- parent.memberships.each do |parent_member|
- member = Member.find_or_new(self.id, parent_member.user_id)
- parent_member.member_roles.each do |parent_member_role|
- member.member_roles <<
- MemberRole.new(:role => parent_member_role.role,
- :inherited_from => parent_member_role.id)
- end
- member.save!
- end
- memberships.reset
- end
- end
-
- def update_versions_from_hierarchy_change
- Issue.update_versions_from_hierarchy_change(self)
- end
-
- def validate_parent
- if @unallowed_parent_id
- errors.add(:parent_id, :invalid)
- elsif parent_id_changed?
- unless parent.nil? || (parent.active? && move_possible?(parent))
- errors.add(:parent_id, :invalid)
- end
- end
- end
-
- # Copies wiki from +project+
- def copy_wiki(project)
- # Check that the source project has a wiki first
- unless project.wiki.nil?
- wiki = self.wiki || Wiki.new
- wiki.attributes = project.wiki.attributes.dup.except("id", "project_id")
- wiki_pages_map = {}
- project.wiki.pages.each do |page|
- # Skip pages without content
- next if page.content.nil?
-
- new_wiki_content =
- WikiContent.new(page.content.attributes.dup.except("id", "page_id", "updated_on"))
- new_wiki_page =
- WikiPage.new(page.attributes.dup.except("id", "wiki_id", "created_on", "parent_id"))
- new_wiki_page.content = new_wiki_content
- wiki.pages << new_wiki_page
- new_wiki_page.attachments =
- page.attachments.map{|attachement| attachement.copy(:container => new_wiki_page)}
- wiki_pages_map[page.id] = new_wiki_page
- end
-
- self.wiki = wiki
- wiki.save
- # Reproduce page hierarchy
- project.wiki.pages.each do |page|
- if page.parent_id && wiki_pages_map[page.id]
- wiki_pages_map[page.id].parent = wiki_pages_map[page.parent_id]
- wiki_pages_map[page.id].save
- end
- end
- end
- end
-
- # Copies versions from +project+
- def copy_versions(project)
- project.versions.each do |version|
- new_version = Version.new
- new_version.attributes =
- version.attributes.dup.except("id", "project_id", "created_on", "updated_on")
-
- new_version.attachments = version.attachments.map do |attachment|
- attachment.copy(:container => new_version)
- end
-
- self.versions << new_version
- end
- end
-
- # Copies issue categories from +project+
- def copy_issue_categories(project)
- project.issue_categories.each do |issue_category|
- new_issue_category = IssueCategory.new
- new_issue_category.attributes = issue_category.attributes.dup.except("id", "project_id")
- self.issue_categories << new_issue_category
- end
- end
-
- # Copies issues from +project+
- def copy_issues(project)
- # Stores the source issue id as a key and the copied issues as the
- # value. Used to map the two together for issue relations.
- issues_map = {}
-
- # Store status and reopen locked/closed versions
- version_statuses = versions.reject(&:open?).map {|version| [version, version.status]}
- version_statuses.each do |version, status|
- version.update_attribute :status, 'open'
- end
-
- # Get issues sorted by root_id, lft so that parent issues
- # get copied before their children
- project.issues.reorder('root_id, lft').each do |issue|
- new_issue = Issue.new
- new_issue.copy_from(issue, :subtasks => false, :link => false, :keep_status => true)
- new_issue.project = self
- # Changing project resets the custom field values
- # TODO: handle this in Issue#project=
- new_issue.custom_field_values = issue.custom_field_values.inject({}) do |h, v|
- h[v.custom_field_id] = v.value
- h
- end
- # Reassign fixed_versions by name, since names are unique per project
- if issue.fixed_version && issue.fixed_version.project == project
- new_issue.fixed_version = self.versions.detect {|v| v.name == issue.fixed_version.name}
- end
- # Reassign version custom field values
- new_issue.custom_field_values.each do |custom_value|
- if custom_value.custom_field.field_format == 'version' && custom_value.value.present?
- versions = Version.where(:id => custom_value.value).to_a
- new_value = versions.map do |version|
- if version.project == project
- self.versions.detect {|v| v.name == version.name}.try(:id)
- else
- version.id
- end
- end
- new_value.compact!
- new_value = new_value.first unless custom_value.custom_field.multiple?
- custom_value.value = new_value
- end
- end
- # Reassign the category by name, since names are unique per project
- if issue.category
- new_issue.category = self.issue_categories.detect {|c| c.name == issue.category.name}
- end
- # Parent issue
- if issue.parent_id
- if copied_parent = issues_map[issue.parent_id]
- new_issue.parent_issue_id = copied_parent.id
- end
- end
-
- self.issues << new_issue
- if new_issue.new_record?
- if logger && logger.info?
- logger.info(
- "Project#copy_issues: issue ##{issue.id} could not be copied: " \
- "#{new_issue.errors.full_messages}"
- )
- end
- else
- issues_map[issue.id] = new_issue unless new_issue.new_record?
- end
- end
-
- # Restore locked/closed version statuses
- version_statuses.each do |version, status|
- version.update_attribute :status, status
- end
-
- # Relations after in case issues related each other
- project.issues.each do |issue|
- new_issue = issues_map[issue.id]
- unless new_issue
- # Issue was not copied
- next
- end
-
- # Relations
- issue.relations_from.each do |source_relation|
- new_issue_relation = IssueRelation.new
- new_issue_relation.attributes =
- source_relation.attributes.dup.except("id", "issue_from_id", "issue_to_id")
- new_issue_relation.issue_to = issues_map[source_relation.issue_to_id]
- if new_issue_relation.issue_to.nil? && Setting.cross_project_issue_relations?
- new_issue_relation.issue_to = source_relation.issue_to
- end
- new_issue.relations_from << new_issue_relation
- end
-
- issue.relations_to.each do |source_relation|
- new_issue_relation = IssueRelation.new
- new_issue_relation.attributes =
- source_relation.attributes.dup.except("id", "issue_from_id", "issue_to_id")
- new_issue_relation.issue_from = issues_map[source_relation.issue_from_id]
- if new_issue_relation.issue_from.nil? && Setting.cross_project_issue_relations?
- new_issue_relation.issue_from = source_relation.issue_from
- end
- new_issue.relations_to << new_issue_relation
- end
- end
- end
-
- # Copies members from +project+
- def copy_members(project)
- # Copy users first, then groups to handle members with inherited and given roles
- members_to_copy = []
- members_to_copy += project.memberships.select {|m| m.principal.is_a?(User)}
- members_to_copy += project.memberships.select {|m| !m.principal.is_a?(User)}
-
- members_to_copy.each do |member|
- new_member = Member.new
- new_member.attributes = member.attributes.dup.except("id", "project_id", "created_on")
- # only copy non inherited roles
- # inherited roles will be added when copying the group membership
- role_ids = member.member_roles.reject(&:inherited?).collect(&:role_id)
- next if role_ids.empty?
-
- new_member.role_ids = role_ids
- new_member.project = self
- self.members << new_member
- end
- end
-
- # Copies queries from +project+
- def copy_queries(project)
- project.queries.each do |query|
- new_query = query.class.new
- new_query.attributes =
- query.attributes.dup.except("id", "project_id", "sort_criteria",
- "user_id", "type")
- new_query.sort_criteria = query.sort_criteria if query.sort_criteria
- new_query.project = self
- new_query.user_id = query.user_id
- new_query.role_ids = query.role_ids if query.visibility == ::Query::VISIBILITY_ROLES
- self.queries << new_query
- if query == project.default_issue_query
- self.default_issue_query = new_query
- end
- end
- end
-
- # Copies boards from +project+
- def copy_boards(project)
- project.boards.each do |board|
- new_board = Board.new
- new_board.attributes =
- board.attributes.dup.except("id", "project_id", "topics_count",
- "messages_count", "last_message_id")
- new_board.project = self
- self.boards << new_board
- end
- end
-
- # Copies documents from +project+
- def copy_documents(project)
- project.documents.each do |document|
- new_document = Document.new
- new_document.attributes = document.attributes.dup.except("id", "project_id")
- new_document.project = self
-
- new_document.attachments = document.attachments.map do |attachement|
- attachement.copy(:container => new_document)
- end
-
- self.documents << new_document
- end
- end
-
- def allowed_permissions
- @allowed_permissions ||= begin
- module_names =
- if enabled_modules.loaded?
- enabled_modules.map(&:name)
- else
- enabled_modules.pluck(:name)
- end
- Redmine::AccessControl.modules_permissions(module_names).collect {|p| p.name}
- end
- end
-
- def allowed_actions
- @actions_allowed ||= allowed_permissions.inject([]) do |actions, permission|
- actions += Redmine::AccessControl.allowed_actions(permission)
- end.flatten
- end
-
- # Archives subprojects recursively
- def archive!
- children.each do |subproject|
- subproject.send :archive!
- end
- update_attribute :status, STATUS_ARCHIVED
- end
- end
|