kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
944 lines
33 KiB
944 lines
33 KiB
#-- encoding: UTF-8
|
|
#-- copyright
|
|
# OpenProject is a project management system.
|
|
# Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License version 3.
|
|
#
|
|
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
|
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
|
# Copyright (C) 2010-2013 the ChiliProject Team
|
|
#
|
|
# 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.
|
|
#
|
|
# See doc/COPYRIGHT.rdoc for more details.
|
|
#++
|
|
|
|
class Project < ActiveRecord::Base
|
|
include Redmine::SafeAttributes
|
|
extend Pagination::Model
|
|
|
|
include Project::Copy
|
|
|
|
# Project statuses
|
|
STATUS_ACTIVE = 1
|
|
STATUS_ARCHIVED = 9
|
|
|
|
# Maximum length for project identifiers
|
|
IDENTIFIER_MAX_LENGTH = 100
|
|
|
|
# reserved identifiers
|
|
RESERVED_IDENTIFIERS = %w( new level_list )
|
|
|
|
# Specific overridden Activities
|
|
has_many :time_entry_activities
|
|
has_many :members, include: [:user, :roles], conditions: "#{User.table_name}.type='User' AND #{User.table_name}.status=#{User::STATUSES[:active]}"
|
|
has_many :possible_assignee_members,
|
|
class_name: 'Member',
|
|
include: [:principal, :roles],
|
|
conditions: Proc.new { self.class.possible_principles_condition }
|
|
has_many :possible_responsible_members,
|
|
class_name: 'Member',
|
|
include: [:principal, :roles],
|
|
conditions: Proc.new { self.class.possible_principles_condition }
|
|
has_many :memberships, class_name: 'Member'
|
|
has_many :member_principals, class_name: 'Member',
|
|
include: :principal,
|
|
conditions: "#{Principal.table_name}.type='Group' OR " +
|
|
"(#{Principal.table_name}.type='User' AND " +
|
|
"(#{Principal.table_name}.status=#{User::STATUSES[:active]} OR " +
|
|
"#{Principal.table_name}.status=#{User::STATUSES[:registered]}))"
|
|
has_many :users, through: :members
|
|
has_many :principals, through: :member_principals, source: :principal
|
|
|
|
has_many :enabled_modules, dependent: :delete_all
|
|
has_and_belongs_to_many :types, order: "#{Type.table_name}.position"
|
|
has_many :work_packages, order: "#{WorkPackage.table_name}.created_at DESC", include: [:status, :type]
|
|
has_many :work_package_changes, through: :work_packages, source: :journals
|
|
has_many :versions, dependent: :destroy, order: "#{Version.table_name}.effective_date DESC, #{Version.table_name}.name DESC"
|
|
has_many :time_entries, dependent: :delete_all
|
|
has_many :queries, dependent: :delete_all
|
|
has_many :news, dependent: :destroy, include: :author
|
|
has_many :categories, dependent: :delete_all, order: "#{Category.table_name}.name"
|
|
has_many :boards, dependent: :destroy, order: 'position ASC'
|
|
has_one :repository, dependent: :destroy
|
|
has_many :changesets, through: :repository
|
|
has_one :wiki, dependent: :destroy
|
|
# Custom field for the project work units
|
|
has_and_belongs_to_many :work_package_custom_fields,
|
|
class_name: 'WorkPackageCustomField',
|
|
order: "#{CustomField.table_name}.position",
|
|
join_table: "#{table_name_prefix}custom_fields_projects#{table_name_suffix}",
|
|
association_foreign_key: 'custom_field_id'
|
|
|
|
acts_as_nested_set order_column: :name, dependent: :destroy
|
|
|
|
acts_as_customizable
|
|
acts_as_searchable columns: ["#{table_name}.name", "#{table_name}.identifier", "#{table_name}.description", "#{table_name}.summary"], project_key: 'id', permission: nil
|
|
acts_as_event title: Proc.new { |o| "#{Project.model_name.human}: #{o.name}" },
|
|
url: Proc.new { |o| { controller: '/projects', action: 'show', id: o } },
|
|
author: nil,
|
|
datetime: :created_on
|
|
|
|
attr_protected :status
|
|
|
|
validates_presence_of :name, :identifier
|
|
# TODO: we temporarily disable this validation because it leads to failed tests
|
|
# it implicitly assumes a db:seed-created standard type to be present and currently
|
|
# neither development nor deployment setups are prepared for this
|
|
# validates_presence_of :types
|
|
validates_uniqueness_of :identifier
|
|
validates_associated :repository, :wiki
|
|
validates_length_of :name, maximum: 255
|
|
validates_length_of :homepage, maximum: 255
|
|
validates_length_of :identifier, in: 1..IDENTIFIER_MAX_LENGTH
|
|
# downcase letters, digits, dashes but not digits only
|
|
validates_format_of :identifier, with: /\A(?!\d+$)[a-z0-9\-_]*\z/,
|
|
if: -> (p) { p.identifier_changed? }
|
|
# reserved words
|
|
validates_exclusion_of :identifier, in: RESERVED_IDENTIFIERS
|
|
|
|
before_destroy :delete_all_members
|
|
before_destroy :destroy_all_work_packages
|
|
|
|
scope :has_module, lambda { |mod| { conditions: ["#{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name=?)", mod.to_s] } }
|
|
scope :active, lambda { |*_args| where(status: STATUS_ACTIVE) }
|
|
scope :public, lambda { |*_args| where(is_public: true) }
|
|
scope :visible, ->(user = User.current) { { conditions: Project.visible_by(user) } }
|
|
|
|
# timelines stuff
|
|
|
|
scope :selectable_projects
|
|
|
|
belongs_to :project_type, class_name: '::ProjectType'
|
|
|
|
belongs_to :responsible, class_name: 'User'
|
|
|
|
has_many :timelines, class_name: '::Timeline',
|
|
dependent: :destroy
|
|
|
|
has_many :reportings_via_source, class_name: '::Reporting',
|
|
foreign_key: 'project_id',
|
|
dependent: :delete_all
|
|
|
|
has_many :reportings_via_target, class_name: '::Reporting',
|
|
foreign_key: 'reporting_to_project_id',
|
|
dependent: :delete_all
|
|
|
|
has_many :reporting_to_projects, through: :reportings_via_source,
|
|
source: :reporting_to_project
|
|
|
|
has_many :project_a_associations, class_name: '::ProjectAssociation',
|
|
foreign_key: 'project_a_id',
|
|
dependent: :delete_all
|
|
|
|
has_many :project_b_associations, class_name: '::ProjectAssociation',
|
|
foreign_key: 'project_b_id',
|
|
dependent: :delete_all
|
|
|
|
has_many :associated_a_projects, through: :project_a_associations,
|
|
source: :project_b
|
|
|
|
has_many :associated_b_projects, through: :project_b_associations,
|
|
source: :project_a
|
|
|
|
include TimelinesCollectionProxy
|
|
|
|
collection_proxy :project_associations, for: [:project_a_associations,
|
|
:project_b_associations] do
|
|
def visible(user = User.current)
|
|
all.select { |assoc| assoc.visible?(user) }
|
|
end
|
|
end
|
|
|
|
collection_proxy :associated_projects, for: [:associated_a_projects,
|
|
:associated_b_projects] do
|
|
def visible(user = User.current)
|
|
all.select { |other| other.visible?(user) }
|
|
end
|
|
end
|
|
|
|
collection_proxy :reportings, for: [:reportings_via_source,
|
|
:reportings_via_target],
|
|
leave_public: true
|
|
|
|
def associated_project_candidates(_user = User.current)
|
|
# TODO: Check if admins shouldn't see all projects here
|
|
projects = Project.visible.all
|
|
projects.delete(self)
|
|
projects -= associated_projects
|
|
projects.select(&:allows_association?)
|
|
end
|
|
|
|
def associated_project_candidates_by_type(user = User.current)
|
|
# TODO: values need sorting by project tree
|
|
associated_project_candidates(user).group_by(&:project_type)
|
|
end
|
|
|
|
def project_associations_by_type(_user = User.current)
|
|
# TODO: values need sorting by project tree
|
|
project_associations.visible.group_by do |a|
|
|
a.project(self).project_type
|
|
end
|
|
end
|
|
|
|
def reporting_to_project_candidates(_user = User.current)
|
|
# TODO: Check if admins shouldn't see all projects here
|
|
projects = Project.visible.all
|
|
projects.delete(self)
|
|
projects -= reporting_to_projects
|
|
projects
|
|
end
|
|
|
|
def visible?(user = User.current)
|
|
self.active? and (self.is_public? or user.admin? or user.member_of?(self))
|
|
end
|
|
|
|
def allows_association?
|
|
if project_type.present?
|
|
project_type.allows_association
|
|
else
|
|
true
|
|
end
|
|
end
|
|
|
|
def copy_allowed?
|
|
User.current.allowed_to?(:copy_projects, self) && (parent.nil? || User.current.allowed_to?(:add_subprojects, parent))
|
|
end
|
|
|
|
def self.selectable_projects
|
|
Project.visible.select { |p| User.current.member_of? p }.sort_by(&:to_s)
|
|
end
|
|
|
|
def self.search_scope(query)
|
|
# overwritten from Pagination::Model
|
|
visible.like(query)
|
|
end
|
|
|
|
# end timelines
|
|
|
|
def initialize(attributes = nil, options = {})
|
|
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?('types') && !initialized.key?('type_ids')
|
|
self.types = Type.default
|
|
end
|
|
end
|
|
|
|
def identifier=(identifier)
|
|
super unless identifier_frozen?
|
|
end
|
|
|
|
def identifier_frozen?
|
|
errors[:identifier].nil? && !(new_record? || identifier.blank?)
|
|
end
|
|
|
|
def possible_members(criteria, limit)
|
|
Principal.active_or_registered.like(criteria).not_in_project(self).find(:all, limit: limit)
|
|
end
|
|
|
|
def add_member(user, roles)
|
|
members.build.tap do |m|
|
|
m.principal = user
|
|
m.roles = Array(roles)
|
|
end
|
|
end
|
|
|
|
def add_member!(user, roles)
|
|
add_member(user, roles)
|
|
save
|
|
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)
|
|
find(:all, limit: count, conditions: visible_by(user), order: 'created_on DESC')
|
|
end
|
|
|
|
def self.latest_for(user, options = {})
|
|
limit = options.fetch(:count) { 5 }
|
|
|
|
conditions = visible_by(user)
|
|
|
|
where(conditions).limit(limit).newest_first
|
|
end
|
|
|
|
# table_name shouldn't be needed :(
|
|
def self.newest_first
|
|
order "#{table_name}.created_on DESC"
|
|
end
|
|
|
|
# Returns a SQL :conditions string used to find all active projects for the specified user.
|
|
#
|
|
# Examples:
|
|
# Projects.visible_by(admin) => "projects.status = 1"
|
|
# Projects.visible_by(normal_user) => "projects.status = 1 AND projects.is_public = 1"
|
|
def self.visible_by(user = nil)
|
|
user ||= User.current
|
|
if user && user.admin?
|
|
return "#{Project.table_name}.status=#{Project::STATUS_ACTIVE}"
|
|
elsif user && user.memberships.any?
|
|
return "#{Project.table_name}.status=#{Project::STATUS_ACTIVE} AND (#{Project.table_name}.is_public = #{connection.quoted_true} or #{Project.table_name}.id IN (#{user.memberships.map(&:project_id).join(',')}))"
|
|
else
|
|
return "#{Project.table_name}.status=#{Project::STATUS_ACTIVE} AND #{Project.table_name}.is_public = #{connection.quoted_true}"
|
|
end
|
|
end
|
|
|
|
# Returns a SQL conditions string used to find all projects for which +user+ has the given +permission+
|
|
#
|
|
# Valid options:
|
|
# * :project => limit the condition to project
|
|
# * :with_subprojects => limit the condition to project and its subprojects
|
|
# * :member => limit the condition to the user projects
|
|
def self.allowed_to_condition(user, permission, options = {})
|
|
base_statement = "#{Project.table_name}.status=#{Project::STATUS_ACTIVE}"
|
|
if perm = Redmine::AccessControl.permission(permission)
|
|
unless perm.project_module.nil?
|
|
# If the permission belongs to a project module, make sure the module is enabled
|
|
base_statement << " AND #{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name='#{perm.project_module}')"
|
|
end
|
|
end
|
|
if options[:project]
|
|
project_statement = "#{Project.table_name}.id = #{options[:project].id}"
|
|
project_statement << " OR (#{Project.table_name}.lft > #{options[:project].lft} AND #{Project.table_name}.rgt < #{options[:project].rgt})" if options[:with_subprojects]
|
|
base_statement = "(#{project_statement}) AND (#{base_statement})"
|
|
end
|
|
|
|
if user.admin?
|
|
base_statement
|
|
else
|
|
statement_by_role = {}
|
|
if user.logged?
|
|
if Role.non_member.allowed_to?(permission) && !options[:member]
|
|
statement_by_role[Role.non_member] = "#{Project.table_name}.is_public = #{connection.quoted_true}"
|
|
end
|
|
user.projects_by_role.each do |role, projects|
|
|
if role.allowed_to?(permission)
|
|
statement_by_role[role] = "#{Project.table_name}.id IN (#{projects.map(&:id).join(',')})"
|
|
end
|
|
end
|
|
else
|
|
if Role.anonymous.allowed_to?(permission) && !options[:member]
|
|
statement_by_role[Role.anonymous] = "#{Project.table_name}.is_public = #{connection.quoted_true}"
|
|
end
|
|
end
|
|
if statement_by_role.empty?
|
|
'1=0'
|
|
else
|
|
"((#{base_statement}) AND (#{statement_by_role.values.join(' OR ')}))"
|
|
end
|
|
end
|
|
end
|
|
|
|
# Returns the Systemwide and project specific activities
|
|
def activities(include_inactive = false)
|
|
if include_inactive
|
|
return all_activities
|
|
else
|
|
return active_activities
|
|
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')
|
|
create_time_entry_activity_if_needed(activity_hash)
|
|
else
|
|
activity = project.time_entry_activities.find_by_id(id.to_i)
|
|
activity.update_attributes(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.overridding_change?(activity, parent_activity)
|
|
project_activity = time_entry_activities.create(activity)
|
|
|
|
if project_activity.new_record?
|
|
raise ActiveRecord::Rollback, 'Overridding TimeEntryActivity was not successfully saved'
|
|
else
|
|
time_entries.update_all("activity_id = #{project_activity.id}", ['activity_id = ?', parent_activity.id])
|
|
end
|
|
end
|
|
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}"
|
|
cond = "(#{cond} OR (#{Project.table_name}.lft > #{lft} AND #{Project.table_name}.rgt < #{rgt}))" if with_subprojects
|
|
cond
|
|
end
|
|
|
|
def self.find(*args)
|
|
if args.first && args.first.is_a?(String) && !args.first.match(/\A\d*\z/)
|
|
project = find_by_identifier(*args)
|
|
raise ActiveRecord::RecordNotFound, "Couldn't find Project with identifier=#{args.first}" if project.nil?
|
|
project
|
|
else
|
|
super
|
|
end
|
|
end
|
|
|
|
def self.find_visible(user, *args)
|
|
with_scope(find: where(Project.visible_by(user))) do
|
|
find(*args)
|
|
end
|
|
end
|
|
|
|
def to_param
|
|
# id is used for projects with a numeric identifier (compatibility)
|
|
@to_param ||= (identifier.to_s =~ %r{\A\d*\z} ? id : identifier)
|
|
end
|
|
|
|
def active?
|
|
status == STATUS_ACTIVE
|
|
end
|
|
|
|
def archived?
|
|
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
|
|
v_ids = self_and_descendants.map(&:version_ids).flatten
|
|
if v_ids.any? && WorkPackage.find(:first, include: :project,
|
|
conditions: ["(#{Project.table_name}.lft < ? OR #{Project.table_name}.rgt > ?)" +
|
|
" AND #{WorkPackage.table_name}.fixed_version_id IN (?)", lft, rgt, v_ids])
|
|
return false
|
|
end
|
|
Project.transaction do
|
|
archive!
|
|
end
|
|
true
|
|
end
|
|
|
|
# Unarchives the project
|
|
# All its ancestors must be active
|
|
def unarchive
|
|
return false if ancestors.detect { |a| !a.active? }
|
|
update_attribute :status, STATUS_ACTIVE
|
|
end
|
|
|
|
# Returns an array of projects the project can be moved to
|
|
# by the current user
|
|
def allowed_parents
|
|
return @allowed_parents if @allowed_parents
|
|
@allowed_parents = Project.find(:all, conditions: Project.allowed_to_condition(User.current, :add_subprojects))
|
|
@allowed_parents = @allowed_parents - self_and_descendants
|
|
if User.current.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 with authorization check
|
|
def set_allowed_parent!(p)
|
|
unless p.nil? || p.is_a?(Project)
|
|
if p.to_s.blank?
|
|
p = nil
|
|
else
|
|
p = Project.find_by_id(p)
|
|
return false unless p
|
|
end
|
|
end
|
|
if p.nil?
|
|
if !new_record? && allowed_parents.empty?
|
|
return false
|
|
end
|
|
elsif !allowed_parents.include?(p)
|
|
return false
|
|
end
|
|
set_parent!(p)
|
|
end
|
|
|
|
# Sets the parent of the project
|
|
# Argument can be either a Project, a String, a Fixnum or nil
|
|
def set_parent!(p)
|
|
unless p.nil? || p.is_a?(Project)
|
|
if p.to_s.blank?
|
|
p = nil
|
|
else
|
|
p = Project.find_by_id(p)
|
|
return false unless p
|
|
end
|
|
end
|
|
if p == parent && !p.nil?
|
|
# Nothing to do
|
|
true
|
|
elsif p.nil? || (p.active? && move_possible?(p))
|
|
# Insert the project so that target's children or root projects stay alphabetically sorted
|
|
sibs = (p.nil? ? self.class.roots : p.children)
|
|
to_be_inserted_before = sibs.detect { |c| c.name.to_s.downcase > name.to_s.downcase }
|
|
if to_be_inserted_before
|
|
move_to_left_of(to_be_inserted_before)
|
|
elsif p.nil?
|
|
if sibs.empty?
|
|
# move_to_root adds the project in first (ie. left) position
|
|
move_to_root
|
|
else
|
|
move_to_right_of(sibs.last) unless self == sibs.last
|
|
end
|
|
else
|
|
# move_to_child_of adds the project in last (ie.right) position
|
|
move_to_child_of(p)
|
|
end
|
|
WorkPackage.update_versions_from_hierarchy_change(self)
|
|
true
|
|
else
|
|
# Can not move to the given target
|
|
false
|
|
end
|
|
end
|
|
|
|
# Returns an array of the types used by the project and its active sub projects
|
|
def rolled_up_types
|
|
@rolled_up_types ||=
|
|
Type.find(:all, joins: :projects,
|
|
select: "DISTINCT #{Type.table_name}.*",
|
|
conditions: ["#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status = #{STATUS_ACTIVE}", lft, rgt],
|
|
order: "#{Type.table_name}.position")
|
|
end
|
|
|
|
# Closes open and locked project versions that are completed
|
|
def close_completed_versions
|
|
Version.transaction do
|
|
versions.find(:all, conditions: { 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.scoped(include: :project,
|
|
conditions: ["#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status = #{STATUS_ACTIVE}", lft, rgt])
|
|
end
|
|
|
|
# Returns a scope of the Versions used by the project
|
|
def shared_versions
|
|
@shared_versions ||= begin
|
|
r = root? ? self : root
|
|
Version.scoped(include: :project,
|
|
conditions: "#{Project.table_name}.id = #{id}" +
|
|
" OR (#{Project.table_name}.status = #{Project::STATUS_ACTIVE} 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
|
|
|
|
# Returns a hash of project users grouped by role
|
|
def users_by_role
|
|
members.find(:all, include: [:user, :roles]).inject({}) do |h, m|
|
|
m.roles.each do |r|
|
|
h[r] ||= []
|
|
h[r] << m.user
|
|
end
|
|
h
|
|
end
|
|
end
|
|
|
|
# Deletes all project's members
|
|
def delete_all_members
|
|
me, mr = Member.table_name, MemberRole.table_name
|
|
connection.delete("DELETE FROM #{mr} WHERE #{mr}.member_id IN (SELECT #{me}.id FROM #{me} WHERE #{me}.project_id = #{id})")
|
|
Member.destroy_all(['project_id = ?', id])
|
|
end
|
|
|
|
def destroy_all_work_packages
|
|
work_packages.each do |wp|
|
|
begin
|
|
wp.reload
|
|
wp.destroy
|
|
rescue ActiveRecord::RecordNotFound => e
|
|
end
|
|
end
|
|
end
|
|
|
|
# Users/groups a work_package can be assigned to
|
|
def possible_assignees
|
|
possible_assignee_members.map(&:principal).compact.sort
|
|
end
|
|
|
|
# Users who can become responsible for a work_package
|
|
def possible_responsibles
|
|
possible_responsible_members.map(&:principal).compact.sort
|
|
end
|
|
|
|
# Returns the mail adresses of users that should be always notified on project events
|
|
def recipients
|
|
notified_users.map(&: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?
|
|
members.select { |m| m.mail_notification? || m.user.mail_notification == 'all' }.map(&:user)
|
|
end
|
|
|
|
# Returns an array of all custom fields enabled for project issues
|
|
# (explictly associated custom fields and custom fields enabled for all projects)
|
|
#
|
|
# Supports the :include option.
|
|
def all_work_package_custom_fields(options = {})
|
|
@all_work_package_custom_fields ||= (
|
|
WorkPackageCustomField.for_all(options) + (
|
|
if options.include? :include
|
|
WorkPackageCustomField.joins(:projects)
|
|
.where(projects: { id: id })
|
|
.includes(options[:include]) # use #preload instead of #includes if join gets too big
|
|
else
|
|
work_package_custom_fields
|
|
end
|
|
)
|
|
).uniq.sort
|
|
end
|
|
|
|
def project
|
|
self
|
|
end
|
|
|
|
def <=>(project)
|
|
name.downcase <=> project.name.downcase
|
|
end
|
|
|
|
def to_s
|
|
name
|
|
end
|
|
|
|
# Returns a short description of the projects (first lines)
|
|
def short_description(length = 255)
|
|
case
|
|
when summary.present?
|
|
summary
|
|
when description.present?
|
|
description.gsub(/\A(.{#{length}}[^\n\r]*).*\z/m, '\1...').strip
|
|
else
|
|
''
|
|
end
|
|
end
|
|
|
|
def css_classes
|
|
s = 'project'
|
|
s << ' root' if root?
|
|
s << ' child' if child?
|
|
s << (leaf? ? ' leaf' : ' parent')
|
|
s
|
|
end
|
|
|
|
# The earliest start date of a project, based on it's issues and versions
|
|
def start_date
|
|
[
|
|
work_packages.minimum('start_date'),
|
|
shared_versions.map(&:effective_date),
|
|
shared_versions.map(&:start_date)
|
|
].flatten.compact.min
|
|
end
|
|
|
|
# The latest due date of an issue or version
|
|
def due_date
|
|
[
|
|
work_packages.maximum('due_date'),
|
|
shared_versions.map(&:effective_date),
|
|
shared_versions.map { |v| v.fixed_issues.maximum('due_date') }
|
|
].flatten.compact.max
|
|
end
|
|
|
|
def overdue?
|
|
active? && !due_date.nil? && (due_date < Date.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.map(&:completed_percent).sum
|
|
|
|
total / self_and_descendants.count
|
|
else
|
|
if versions.count > 0
|
|
total = versions.map(&:completed_percent).sum
|
|
|
|
total / versions.count
|
|
else
|
|
100
|
|
end
|
|
end
|
|
end
|
|
|
|
# Return true if this project 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 allows_to?(action)
|
|
if action.is_a? Hash
|
|
allowed_actions.include? "#{action[:controller]}/#{action[:action]}"
|
|
else
|
|
allowed_permissions.include? action
|
|
end
|
|
end
|
|
|
|
def module_enabled?(module_name)
|
|
module_name = module_name.to_s
|
|
enabled_modules.any? { |m| m.name == module_name }
|
|
end
|
|
|
|
def enabled_module_names=(module_names)
|
|
if module_names && module_names.is_a?(Array)
|
|
module_names = module_names.map(&:to_s).reject(&:blank?)
|
|
self.enabled_modules = module_names.map { |name| enabled_modules.detect { |mod| mod.name == name } || EnabledModule.new(name: name) }
|
|
else
|
|
enabled_modules.clear
|
|
end
|
|
end
|
|
|
|
# Returns an array of the enabled modules names
|
|
def enabled_module_names
|
|
enabled_modules.map(&:name)
|
|
end
|
|
|
|
safe_attributes 'name',
|
|
'description',
|
|
'summary',
|
|
'homepage',
|
|
'is_public',
|
|
'identifier',
|
|
'custom_field_values',
|
|
'custom_fields',
|
|
'type_ids',
|
|
'work_package_custom_field_ids',
|
|
'project_type_id',
|
|
'type_ids',
|
|
'responsible_id'
|
|
|
|
safe_attributes 'enabled_module_names',
|
|
if: lambda { |project, user| project.new_record? || user.allowed_to?(:select_project_modules, project) }
|
|
|
|
# Returns an array of projects that are in this project's hierarchy
|
|
#
|
|
# Example: parents, children, siblings
|
|
def hierarchy
|
|
parents = project.self_and_ancestors || []
|
|
descendants = project.descendants || []
|
|
parents | descendants # Set union
|
|
end
|
|
|
|
# Returns an auto-generated project identifier based on the last identifier used
|
|
def self.next_identifier
|
|
p = Project.find(:first, order: 'created_on DESC')
|
|
p.nil? ? nil : p.identifier.to_s.succ
|
|
end
|
|
|
|
# builds up a project hierarchy helper structure for use with #project_tree_from_hierarchy
|
|
#
|
|
# it expects a simple list of projects with a #lft column (awesome_nested_set)
|
|
# and returns a hierarchy based on #lft
|
|
#
|
|
# the result is a nested list of root level projects that contain their child projects
|
|
# but, each entry is actually a ruby hash wrapping the project and child projects
|
|
# the keys are :project and :children where :children is in the same format again
|
|
#
|
|
# result = [ root_level_project_info_1, root_level_project_info_2, ... ]
|
|
#
|
|
# where each entry has the form
|
|
#
|
|
# project_info = { :project => the_project, :children => [ child_info_1, child_info_2, ... ] }
|
|
#
|
|
# if a project has no children the :children array is just empty
|
|
#
|
|
def self.build_projects_hierarchy(projects)
|
|
ancestors = []
|
|
result = []
|
|
|
|
projects.sort_by(&:lft).each do |project|
|
|
while ancestors.any? && !project.is_descendant_of?(ancestors.last[:project])
|
|
# before we pop back one level, we sort the child projects by name
|
|
ancestors.last[:children] = ancestors.last[:children].sort_by { |h| h[:project].name.downcase if h[:project].name }
|
|
ancestors.pop
|
|
end
|
|
|
|
current_hierarchy = { project: project, children: [] }
|
|
current_tree = ancestors.any? ? ancestors.last[:children] : result
|
|
|
|
current_tree << current_hierarchy
|
|
ancestors << current_hierarchy
|
|
end
|
|
|
|
# at the end the root level must be sorted as well
|
|
result.sort_by { |h| h[:project].name.downcase if h[:project].name }
|
|
end
|
|
|
|
def self.project_tree_from_hierarchy(projects_hierarchy, level, &block)
|
|
projects_hierarchy.each do |hierarchy|
|
|
project, children = hierarchy[:project], hierarchy[:children]
|
|
yield project, level
|
|
# recursively show children
|
|
project_tree_from_hierarchy(children, level + 1, &block) if children.any?
|
|
end
|
|
end
|
|
|
|
# Yields the given block for each project with its level in the tree
|
|
def self.project_tree(projects, &block)
|
|
projects_hierarchy = build_projects_hierarchy(projects)
|
|
project_tree_from_hierarchy(projects_hierarchy, 0, &block)
|
|
end
|
|
|
|
def self.project_level_list(projects)
|
|
list = []
|
|
project_tree(projects) do |project, level|
|
|
|
|
element = {
|
|
project: project,
|
|
level: level
|
|
}
|
|
|
|
element.merge!(yield(project)) if block_given?
|
|
|
|
list << element
|
|
end
|
|
list
|
|
end
|
|
|
|
def add_issue(attributes = {})
|
|
ActiveSupport::Deprecation.warn 'Project.add_issue is deprecated. Use Project.add_work_package instead.'
|
|
add_work_package attributes
|
|
end
|
|
|
|
def add_work_package(attributes = {})
|
|
WorkPackage.new do |i|
|
|
i.project = self
|
|
|
|
type_attribute = attributes.delete(:type) || attributes.delete(:type_id)
|
|
|
|
i.type = if type_attribute
|
|
project.types.find(type_attribute)
|
|
else
|
|
project.types.first
|
|
end
|
|
|
|
i.attributes = attributes
|
|
end
|
|
end
|
|
|
|
def allowed_permissions
|
|
@allowed_permissions ||= begin
|
|
names = enabled_modules.loaded? ? enabled_module_names : enabled_modules.all(select: :name).map(&:name)
|
|
|
|
Redmine::AccessControl.modules_permissions(names).map(&:name)
|
|
end
|
|
end
|
|
|
|
def allowed_actions
|
|
@actions_allowed ||= allowed_permissions.inject([]) { |actions, permission| actions += Redmine::AccessControl.allowed_actions(permission) }.flatten
|
|
end
|
|
|
|
# Returns all the active Systemwide and project specific activities
|
|
def active_activities
|
|
overridden_activity_ids = time_entry_activities.map(&:parent_id)
|
|
|
|
if overridden_activity_ids.empty?
|
|
return TimeEntryActivity.shared.active
|
|
else
|
|
return system_activities_and_project_overrides
|
|
end
|
|
end
|
|
|
|
# Returns all the Systemwide and project specific activities
|
|
# (inactive and active)
|
|
def all_activities
|
|
overridden_activity_ids = time_entry_activities.map(&:parent_id)
|
|
|
|
if overridden_activity_ids.empty?
|
|
return TimeEntryActivity.shared
|
|
else
|
|
return system_activities_and_project_overrides(true)
|
|
end
|
|
end
|
|
|
|
# Returns the systemwide active activities merged with the project specific overrides
|
|
def system_activities_and_project_overrides(include_inactive = false)
|
|
if include_inactive
|
|
return TimeEntryActivity.shared
|
|
.find(:all,
|
|
conditions: ['id NOT IN (?)', time_entry_activities.map(&:parent_id)]) +
|
|
time_entry_activities
|
|
else
|
|
return TimeEntryActivity.shared.active
|
|
.find(:all,
|
|
conditions: ['id NOT IN (?)', time_entry_activities.map(&:parent_id)]) +
|
|
time_entry_activities.active
|
|
end
|
|
end
|
|
|
|
# Archives subprojects recursively
|
|
def archive!
|
|
children.each do |subproject|
|
|
subproject.send :archive!
|
|
end
|
|
update_attribute :status, STATUS_ARCHIVED
|
|
end
|
|
|
|
protected
|
|
|
|
def self.possible_principles_condition
|
|
condition = Setting.work_package_group_assignment? ?
|
|
["(#{Principal.table_name}.type=? OR #{Principal.table_name}.type=?)", 'User', 'Group'] :
|
|
["(#{Principal.table_name}.type=?)", 'User']
|
|
|
|
condition[0] += " AND #{User.table_name}.status=? AND roles.assignable = ?"
|
|
condition << User::STATUSES[:active]
|
|
condition << true
|
|
|
|
sanitize_sql_array condition
|
|
end
|
|
end
|
|
|