annotate app/models/.svn/text-base/project.rb.svn-base @ 853:969bb872d4bf feature_142

Close obsolete branch feature_142
author Chris Cannam
date Thu, 14 Jul 2011 14:26:44 +0100
parents cbce1fd3b1b7
children 0c939c159af4
rev   line source
Chris@441 1 # Redmine - project management software
Chris@441 2 # Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@0 3 #
Chris@0 4 # This program is free software; you can redistribute it and/or
Chris@0 5 # modify it under the terms of the GNU General Public License
Chris@0 6 # as published by the Free Software Foundation; either version 2
Chris@0 7 # of the License, or (at your option) any later version.
Chris@0 8 #
Chris@0 9 # This program is distributed in the hope that it will be useful,
Chris@0 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@0 12 # GNU General Public License for more details.
Chris@0 13 #
Chris@0 14 # You should have received a copy of the GNU General Public License
Chris@0 15 # along with this program; if not, write to the Free Software
Chris@0 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@0 17
Chris@0 18 class Project < ActiveRecord::Base
Chris@119 19 include Redmine::SafeAttributes
Chris@119 20
Chris@0 21 # Project statuses
Chris@0 22 STATUS_ACTIVE = 1
Chris@0 23 STATUS_ARCHIVED = 9
Chris@0 24
chris@37 25 # Maximum length for project identifiers
chris@37 26 IDENTIFIER_MAX_LENGTH = 100
chris@37 27
Chris@0 28 # Specific overidden Activities
Chris@0 29 has_many :time_entry_activities
Chris@0 30 has_many :members, :include => [:user, :roles], :conditions => "#{User.table_name}.type='User' AND #{User.table_name}.status=#{User::STATUS_ACTIVE}"
Chris@0 31 has_many :memberships, :class_name => 'Member'
Chris@0 32 has_many :member_principals, :class_name => 'Member',
Chris@0 33 :include => :principal,
Chris@0 34 :conditions => "#{Principal.table_name}.type='Group' OR (#{Principal.table_name}.type='User' AND #{Principal.table_name}.status=#{User::STATUS_ACTIVE})"
Chris@0 35 has_many :users, :through => :members
Chris@0 36 has_many :principals, :through => :member_principals, :source => :principal
Chris@0 37
Chris@0 38 has_many :enabled_modules, :dependent => :delete_all
Chris@0 39 has_and_belongs_to_many :trackers, :order => "#{Tracker.table_name}.position"
Chris@0 40 has_many :issues, :dependent => :destroy, :order => "#{Issue.table_name}.created_on DESC", :include => [:status, :tracker]
Chris@0 41 has_many :issue_changes, :through => :issues, :source => :journals
Chris@0 42 has_many :versions, :dependent => :destroy, :order => "#{Version.table_name}.effective_date DESC, #{Version.table_name}.name DESC"
Chris@0 43 has_many :time_entries, :dependent => :delete_all
Chris@0 44 has_many :queries, :dependent => :delete_all
Chris@0 45 has_many :documents, :dependent => :destroy
Chris@441 46 has_many :news, :dependent => :destroy, :include => :author
Chris@0 47 has_many :issue_categories, :dependent => :delete_all, :order => "#{IssueCategory.table_name}.name"
Chris@0 48 has_many :boards, :dependent => :destroy, :order => "position ASC"
Chris@0 49 has_one :repository, :dependent => :destroy
Chris@0 50 has_many :changesets, :through => :repository
Chris@0 51 has_one :wiki, :dependent => :destroy
Chris@0 52 # Custom field for the project issues
Chris@0 53 has_and_belongs_to_many :issue_custom_fields,
Chris@0 54 :class_name => 'IssueCustomField',
Chris@0 55 :order => "#{CustomField.table_name}.position",
Chris@0 56 :join_table => "#{table_name_prefix}custom_fields_projects#{table_name_suffix}",
Chris@0 57 :association_foreign_key => 'custom_field_id'
Chris@0 58
Chris@441 59 acts_as_nested_set :order => 'name', :dependent => :destroy
Chris@0 60 acts_as_attachable :view_permission => :view_files,
Chris@0 61 :delete_permission => :manage_files
Chris@0 62
Chris@0 63 acts_as_customizable
Chris@0 64 acts_as_searchable :columns => ['name', 'identifier', 'description'], :project_key => 'id', :permission => nil
Chris@0 65 acts_as_event :title => Proc.new {|o| "#{l(:label_project)}: #{o.name}"},
Chris@0 66 :url => Proc.new {|o| {:controller => 'projects', :action => 'show', :id => o}},
Chris@0 67 :author => nil
Chris@0 68
Chris@119 69 attr_protected :status
Chris@0 70
Chris@0 71 validates_presence_of :name, :identifier
chris@37 72 validates_uniqueness_of :identifier
Chris@0 73 validates_associated :repository, :wiki
chris@37 74 validates_length_of :name, :maximum => 255
Chris@0 75 validates_length_of :homepage, :maximum => 255
chris@37 76 validates_length_of :identifier, :in => 1..IDENTIFIER_MAX_LENGTH
Chris@0 77 # donwcase letters, digits, dashes but not digits only
Chris@0 78 validates_format_of :identifier, :with => /^(?!\d+$)[a-z0-9\-]*$/, :if => Proc.new { |p| p.identifier_changed? }
Chris@0 79 # reserved words
Chris@0 80 validates_exclusion_of :identifier, :in => %w( new )
Chris@0 81
Chris@441 82 before_destroy :delete_all_members
Chris@0 83
Chris@0 84 named_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] } }
Chris@0 85 named_scope :active, { :conditions => "#{Project.table_name}.status = #{STATUS_ACTIVE}"}
Chris@0 86 named_scope :all_public, { :conditions => { :is_public => true } }
Chris@441 87 named_scope :visible, lambda {|*args| {:conditions => Project.visible_condition(args.shift || User.current, *args) }}
Chris@0 88
Chris@119 89 def initialize(attributes = nil)
Chris@119 90 super
Chris@119 91
Chris@119 92 initialized = (attributes || {}).stringify_keys
Chris@119 93 if !initialized.key?('identifier') && Setting.sequential_project_identifiers?
Chris@119 94 self.identifier = Project.next_identifier
Chris@119 95 end
Chris@119 96 if !initialized.key?('is_public')
Chris@119 97 self.is_public = Setting.default_projects_public?
Chris@119 98 end
Chris@119 99 if !initialized.key?('enabled_module_names')
Chris@119 100 self.enabled_module_names = Setting.default_projects_modules
Chris@119 101 end
Chris@119 102 if !initialized.key?('trackers') && !initialized.key?('tracker_ids')
Chris@119 103 self.trackers = Tracker.all
Chris@119 104 end
Chris@119 105 end
Chris@119 106
Chris@0 107 def identifier=(identifier)
Chris@0 108 super unless identifier_frozen?
Chris@0 109 end
Chris@0 110
Chris@0 111 def identifier_frozen?
Chris@0 112 errors[:identifier].nil? && !(new_record? || identifier.blank?)
Chris@0 113 end
Chris@0 114
Chris@0 115 # returns latest created projects
Chris@0 116 # non public projects will be returned only if user is a member of those
Chris@0 117 def self.latest(user=nil, count=5)
Chris@441 118 visible(user).find(:all, :limit => count, :order => "created_on DESC")
Chris@0 119 end
Chris@0 120
Chris@441 121 def self.visible_by(user=nil)
Chris@441 122 ActiveSupport::Deprecation.warn "Project.visible_by is deprecated and will be removed in Redmine 1.3.0. Use Project.visible_condition instead."
Chris@441 123 visible_condition(user || User.current)
Chris@441 124 end
Chris@441 125
Chris@441 126 # Returns a SQL conditions string used to find all projects visible by the specified user.
Chris@0 127 #
Chris@0 128 # Examples:
Chris@441 129 # Project.visible_condition(admin) => "projects.status = 1"
Chris@441 130 # Project.visible_condition(normal_user) => "((projects.status = 1) AND (projects.is_public = 1 OR projects.id IN (1,3,4)))"
Chris@441 131 # Project.visible_condition(anonymous) => "((projects.status = 1) AND (projects.is_public = 1))"
Chris@441 132 def self.visible_condition(user, options={})
Chris@441 133 allowed_to_condition(user, :view_project, options)
Chris@0 134 end
Chris@0 135
Chris@441 136 # Returns a SQL conditions string used to find all projects for which +user+ has the given +permission+
Chris@441 137 #
Chris@441 138 # Valid options:
Chris@441 139 # * :project => limit the condition to project
Chris@441 140 # * :with_subprojects => limit the condition to project and its subprojects
Chris@441 141 # * :member => limit the condition to the user projects
Chris@0 142 def self.allowed_to_condition(user, permission, options={})
Chris@0 143 base_statement = "#{Project.table_name}.status=#{Project::STATUS_ACTIVE}"
Chris@0 144 if perm = Redmine::AccessControl.permission(permission)
Chris@0 145 unless perm.project_module.nil?
Chris@0 146 # If the permission belongs to a project module, make sure the module is enabled
Chris@0 147 base_statement << " AND #{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name='#{perm.project_module}')"
Chris@0 148 end
Chris@0 149 end
Chris@0 150 if options[:project]
Chris@0 151 project_statement = "#{Project.table_name}.id = #{options[:project].id}"
Chris@0 152 project_statement << " OR (#{Project.table_name}.lft > #{options[:project].lft} AND #{Project.table_name}.rgt < #{options[:project].rgt})" if options[:with_subprojects]
Chris@0 153 base_statement = "(#{project_statement}) AND (#{base_statement})"
Chris@0 154 end
Chris@441 155
Chris@0 156 if user.admin?
Chris@441 157 base_statement
Chris@0 158 else
Chris@441 159 statement_by_role = {}
Chris@441 160 unless options[:member]
Chris@441 161 role = user.logged? ? Role.non_member : Role.anonymous
Chris@441 162 if role.allowed_to?(permission)
Chris@441 163 statement_by_role[role] = "#{Project.table_name}.is_public = #{connection.quoted_true}"
Chris@441 164 end
Chris@441 165 end
Chris@0 166 if user.logged?
Chris@441 167 user.projects_by_role.each do |role, projects|
Chris@441 168 if role.allowed_to?(permission)
Chris@441 169 statement_by_role[role] = "#{Project.table_name}.id IN (#{projects.collect(&:id).join(',')})"
Chris@441 170 end
Chris@0 171 end
Chris@441 172 end
Chris@441 173 if statement_by_role.empty?
Chris@441 174 "1=0"
Chris@0 175 else
Chris@441 176 if block_given?
Chris@441 177 statement_by_role.each do |role, statement|
Chris@441 178 if s = yield(role, user)
Chris@441 179 statement_by_role[role] = "(#{statement} AND (#{s}))"
Chris@441 180 end
Chris@441 181 end
Chris@441 182 end
Chris@441 183 "((#{base_statement}) AND (#{statement_by_role.values.join(' OR ')}))"
Chris@0 184 end
Chris@0 185 end
Chris@0 186 end
Chris@0 187
Chris@0 188 # Returns the Systemwide and project specific activities
Chris@0 189 def activities(include_inactive=false)
Chris@0 190 if include_inactive
Chris@0 191 return all_activities
Chris@0 192 else
Chris@0 193 return active_activities
Chris@0 194 end
Chris@0 195 end
Chris@0 196
Chris@0 197 # Will create a new Project specific Activity or update an existing one
Chris@0 198 #
Chris@0 199 # This will raise a ActiveRecord::Rollback if the TimeEntryActivity
Chris@0 200 # does not successfully save.
Chris@0 201 def update_or_create_time_entry_activity(id, activity_hash)
Chris@0 202 if activity_hash.respond_to?(:has_key?) && activity_hash.has_key?('parent_id')
Chris@0 203 self.create_time_entry_activity_if_needed(activity_hash)
Chris@0 204 else
Chris@0 205 activity = project.time_entry_activities.find_by_id(id.to_i)
Chris@0 206 activity.update_attributes(activity_hash) if activity
Chris@0 207 end
Chris@0 208 end
Chris@0 209
Chris@0 210 # Create a new TimeEntryActivity if it overrides a system TimeEntryActivity
Chris@0 211 #
Chris@0 212 # This will raise a ActiveRecord::Rollback if the TimeEntryActivity
Chris@0 213 # does not successfully save.
Chris@0 214 def create_time_entry_activity_if_needed(activity)
Chris@0 215 if activity['parent_id']
Chris@0 216
Chris@0 217 parent_activity = TimeEntryActivity.find(activity['parent_id'])
Chris@0 218 activity['name'] = parent_activity.name
Chris@0 219 activity['position'] = parent_activity.position
Chris@0 220
Chris@0 221 if Enumeration.overridding_change?(activity, parent_activity)
Chris@0 222 project_activity = self.time_entry_activities.create(activity)
Chris@0 223
Chris@0 224 if project_activity.new_record?
Chris@0 225 raise ActiveRecord::Rollback, "Overridding TimeEntryActivity was not successfully saved"
Chris@0 226 else
Chris@0 227 self.time_entries.update_all("activity_id = #{project_activity.id}", ["activity_id = ?", parent_activity.id])
Chris@0 228 end
Chris@0 229 end
Chris@0 230 end
Chris@0 231 end
Chris@0 232
Chris@0 233 # Returns a :conditions SQL string that can be used to find the issues associated with this project.
Chris@0 234 #
Chris@0 235 # Examples:
Chris@0 236 # project.project_condition(true) => "(projects.id = 1 OR (projects.lft > 1 AND projects.rgt < 10))"
Chris@0 237 # project.project_condition(false) => "projects.id = 1"
Chris@0 238 def project_condition(with_subprojects)
Chris@0 239 cond = "#{Project.table_name}.id = #{id}"
Chris@0 240 cond = "(#{cond} OR (#{Project.table_name}.lft > #{lft} AND #{Project.table_name}.rgt < #{rgt}))" if with_subprojects
Chris@0 241 cond
Chris@0 242 end
Chris@0 243
Chris@0 244 def self.find(*args)
Chris@0 245 if args.first && args.first.is_a?(String) && !args.first.match(/^\d*$/)
Chris@0 246 project = find_by_identifier(*args)
Chris@0 247 raise ActiveRecord::RecordNotFound, "Couldn't find Project with identifier=#{args.first}" if project.nil?
Chris@0 248 project
Chris@0 249 else
Chris@0 250 super
Chris@0 251 end
Chris@0 252 end
Chris@0 253
Chris@0 254 def to_param
Chris@0 255 # id is used for projects with a numeric identifier (compatibility)
Chris@0 256 @to_param ||= (identifier.to_s =~ %r{^\d*$} ? id : identifier)
Chris@0 257 end
Chris@0 258
Chris@0 259 def active?
Chris@0 260 self.status == STATUS_ACTIVE
Chris@0 261 end
Chris@0 262
chris@37 263 def archived?
chris@37 264 self.status == STATUS_ARCHIVED
chris@37 265 end
chris@37 266
Chris@0 267 # Archives the project and its descendants
Chris@0 268 def archive
Chris@0 269 # Check that there is no issue of a non descendant project that is assigned
Chris@0 270 # to one of the project or descendant versions
Chris@0 271 v_ids = self_and_descendants.collect {|p| p.version_ids}.flatten
Chris@0 272 if v_ids.any? && Issue.find(:first, :include => :project,
Chris@0 273 :conditions => ["(#{Project.table_name}.lft < ? OR #{Project.table_name}.rgt > ?)" +
Chris@0 274 " AND #{Issue.table_name}.fixed_version_id IN (?)", lft, rgt, v_ids])
Chris@0 275 return false
Chris@0 276 end
Chris@0 277 Project.transaction do
Chris@0 278 archive!
Chris@0 279 end
Chris@0 280 true
Chris@0 281 end
Chris@0 282
Chris@0 283 # Unarchives the project
Chris@0 284 # All its ancestors must be active
Chris@0 285 def unarchive
Chris@0 286 return false if ancestors.detect {|a| !a.active?}
Chris@0 287 update_attribute :status, STATUS_ACTIVE
Chris@0 288 end
Chris@0 289
Chris@0 290 # Returns an array of projects the project can be moved to
Chris@0 291 # by the current user
Chris@0 292 def allowed_parents
Chris@0 293 return @allowed_parents if @allowed_parents
Chris@0 294 @allowed_parents = Project.find(:all, :conditions => Project.allowed_to_condition(User.current, :add_subprojects))
Chris@0 295 @allowed_parents = @allowed_parents - self_and_descendants
Chris@0 296 if User.current.allowed_to?(:add_project, nil, :global => true) || (!new_record? && parent.nil?)
Chris@0 297 @allowed_parents << nil
Chris@0 298 end
Chris@0 299 unless parent.nil? || @allowed_parents.empty? || @allowed_parents.include?(parent)
Chris@0 300 @allowed_parents << parent
Chris@0 301 end
Chris@0 302 @allowed_parents
Chris@0 303 end
Chris@0 304
Chris@0 305 # Sets the parent of the project with authorization check
Chris@0 306 def set_allowed_parent!(p)
Chris@0 307 unless p.nil? || p.is_a?(Project)
Chris@0 308 if p.to_s.blank?
Chris@0 309 p = nil
Chris@0 310 else
Chris@0 311 p = Project.find_by_id(p)
Chris@0 312 return false unless p
Chris@0 313 end
Chris@0 314 end
Chris@0 315 if p.nil?
Chris@0 316 if !new_record? && allowed_parents.empty?
Chris@0 317 return false
Chris@0 318 end
Chris@0 319 elsif !allowed_parents.include?(p)
Chris@0 320 return false
Chris@0 321 end
Chris@0 322 set_parent!(p)
Chris@0 323 end
Chris@0 324
Chris@0 325 # Sets the parent of the project
Chris@0 326 # Argument can be either a Project, a String, a Fixnum or nil
Chris@0 327 def set_parent!(p)
Chris@0 328 unless p.nil? || p.is_a?(Project)
Chris@0 329 if p.to_s.blank?
Chris@0 330 p = nil
Chris@0 331 else
Chris@0 332 p = Project.find_by_id(p)
Chris@0 333 return false unless p
Chris@0 334 end
Chris@0 335 end
Chris@0 336 if p == parent && !p.nil?
Chris@0 337 # Nothing to do
Chris@0 338 true
Chris@0 339 elsif p.nil? || (p.active? && move_possible?(p))
Chris@0 340 # Insert the project so that target's children or root projects stay alphabetically sorted
Chris@0 341 sibs = (p.nil? ? self.class.roots : p.children)
Chris@0 342 to_be_inserted_before = sibs.detect {|c| c.name.to_s.downcase > name.to_s.downcase }
Chris@0 343 if to_be_inserted_before
Chris@0 344 move_to_left_of(to_be_inserted_before)
Chris@0 345 elsif p.nil?
Chris@0 346 if sibs.empty?
Chris@0 347 # move_to_root adds the project in first (ie. left) position
Chris@0 348 move_to_root
Chris@0 349 else
Chris@0 350 move_to_right_of(sibs.last) unless self == sibs.last
Chris@0 351 end
Chris@0 352 else
Chris@0 353 # move_to_child_of adds the project in last (ie.right) position
Chris@0 354 move_to_child_of(p)
Chris@0 355 end
Chris@0 356 Issue.update_versions_from_hierarchy_change(self)
Chris@0 357 true
Chris@0 358 else
Chris@0 359 # Can not move to the given target
Chris@0 360 false
Chris@0 361 end
Chris@0 362 end
Chris@0 363
Chris@0 364 # Returns an array of the trackers used by the project and its active sub projects
Chris@0 365 def rolled_up_trackers
Chris@0 366 @rolled_up_trackers ||=
Chris@441 367 Tracker.find(:all, :joins => :projects,
Chris@0 368 :select => "DISTINCT #{Tracker.table_name}.*",
Chris@0 369 :conditions => ["#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status = #{STATUS_ACTIVE}", lft, rgt],
Chris@0 370 :order => "#{Tracker.table_name}.position")
Chris@0 371 end
Chris@0 372
Chris@0 373 # Closes open and locked project versions that are completed
Chris@0 374 def close_completed_versions
Chris@0 375 Version.transaction do
Chris@0 376 versions.find(:all, :conditions => {:status => %w(open locked)}).each do |version|
Chris@0 377 if version.completed?
Chris@0 378 version.update_attribute(:status, 'closed')
Chris@0 379 end
Chris@0 380 end
Chris@0 381 end
Chris@0 382 end
Chris@0 383
Chris@0 384 # Returns a scope of the Versions on subprojects
Chris@0 385 def rolled_up_versions
Chris@0 386 @rolled_up_versions ||=
Chris@0 387 Version.scoped(:include => :project,
Chris@0 388 :conditions => ["#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status = #{STATUS_ACTIVE}", lft, rgt])
Chris@0 389 end
Chris@0 390
Chris@0 391 # Returns a scope of the Versions used by the project
Chris@0 392 def shared_versions
Chris@441 393 @shared_versions ||= begin
Chris@441 394 r = root? ? self : root
Chris@0 395 Version.scoped(:include => :project,
Chris@0 396 :conditions => "#{Project.table_name}.id = #{id}" +
Chris@0 397 " OR (#{Project.table_name}.status = #{Project::STATUS_ACTIVE} AND (" +
Chris@0 398 " #{Version.table_name}.sharing = 'system'" +
Chris@441 399 " OR (#{Project.table_name}.lft >= #{r.lft} AND #{Project.table_name}.rgt <= #{r.rgt} AND #{Version.table_name}.sharing = 'tree')" +
Chris@0 400 " OR (#{Project.table_name}.lft < #{lft} AND #{Project.table_name}.rgt > #{rgt} AND #{Version.table_name}.sharing IN ('hierarchy', 'descendants'))" +
Chris@0 401 " OR (#{Project.table_name}.lft > #{lft} AND #{Project.table_name}.rgt < #{rgt} AND #{Version.table_name}.sharing = 'hierarchy')" +
Chris@0 402 "))")
Chris@441 403 end
Chris@0 404 end
Chris@0 405
Chris@0 406 # Returns a hash of project users grouped by role
Chris@0 407 def users_by_role
Chris@0 408 members.find(:all, :include => [:user, :roles]).inject({}) do |h, m|
Chris@0 409 m.roles.each do |r|
Chris@0 410 h[r] ||= []
Chris@0 411 h[r] << m.user
Chris@0 412 end
Chris@0 413 h
Chris@0 414 end
Chris@0 415 end
Chris@0 416
Chris@0 417 # Deletes all project's members
Chris@0 418 def delete_all_members
Chris@0 419 me, mr = Member.table_name, MemberRole.table_name
Chris@0 420 connection.delete("DELETE FROM #{mr} WHERE #{mr}.member_id IN (SELECT #{me}.id FROM #{me} WHERE #{me}.project_id = #{id})")
Chris@0 421 Member.delete_all(['project_id = ?', id])
Chris@0 422 end
Chris@0 423
Chris@0 424 # Users issues can be assigned to
Chris@0 425 def assignable_users
Chris@0 426 members.select {|m| m.roles.detect {|role| role.assignable?}}.collect {|m| m.user}.sort
Chris@0 427 end
Chris@0 428
Chris@0 429 # Returns the mail adresses of users that should be always notified on project events
Chris@0 430 def recipients
chris@37 431 notified_users.collect {|user| user.mail}
Chris@0 432 end
Chris@0 433
Chris@0 434 # Returns the users that should be notified on project events
Chris@0 435 def notified_users
chris@37 436 # TODO: User part should be extracted to User#notify_about?
chris@37 437 members.select {|m| m.mail_notification? || m.user.mail_notification == 'all'}.collect {|m| m.user}
Chris@0 438 end
Chris@0 439
Chris@0 440 # Returns an array of all custom fields enabled for project issues
Chris@0 441 # (explictly associated custom fields and custom fields enabled for all projects)
Chris@0 442 def all_issue_custom_fields
Chris@0 443 @all_issue_custom_fields ||= (IssueCustomField.for_all + issue_custom_fields).uniq.sort
Chris@0 444 end
Chris@441 445
Chris@441 446 # Returns an array of all custom fields enabled for project time entries
Chris@441 447 # (explictly associated custom fields and custom fields enabled for all projects)
Chris@441 448 def all_time_entry_custom_fields
Chris@441 449 @all_time_entry_custom_fields ||= (TimeEntryCustomField.for_all + time_entry_custom_fields).uniq.sort
Chris@441 450 end
Chris@0 451
Chris@0 452 def project
Chris@0 453 self
Chris@0 454 end
Chris@0 455
Chris@0 456 def <=>(project)
Chris@0 457 name.downcase <=> project.name.downcase
Chris@0 458 end
Chris@0 459
Chris@0 460 def to_s
Chris@0 461 name
Chris@0 462 end
Chris@0 463
Chris@0 464 # Returns a short description of the projects (first lines)
Chris@0 465 def short_description(length = 255)
Chris@0 466 description.gsub(/^(.{#{length}}[^\n\r]*).*$/m, '\1...').strip if description
Chris@0 467 end
chris@22 468
chris@22 469 def css_classes
chris@22 470 s = 'project'
chris@22 471 s << ' root' if root?
chris@22 472 s << ' child' if child?
chris@22 473 s << (leaf? ? ' leaf' : ' parent')
chris@22 474 s
chris@22 475 end
chris@22 476
chris@22 477 # The earliest start date of a project, based on it's issues and versions
chris@22 478 def start_date
Chris@119 479 [
Chris@119 480 issues.minimum('start_date'),
Chris@119 481 shared_versions.collect(&:effective_date),
Chris@119 482 shared_versions.collect(&:start_date)
Chris@119 483 ].flatten.compact.min
chris@22 484 end
chris@22 485
chris@22 486 # The latest due date of an issue or version
chris@22 487 def due_date
Chris@119 488 [
Chris@119 489 issues.maximum('due_date'),
Chris@119 490 shared_versions.collect(&:effective_date),
Chris@119 491 shared_versions.collect {|v| v.fixed_issues.maximum('due_date')}
Chris@119 492 ].flatten.compact.max
chris@22 493 end
chris@22 494
chris@22 495 def overdue?
chris@22 496 active? && !due_date.nil? && (due_date < Date.today)
chris@22 497 end
chris@22 498
chris@22 499 # Returns the percent completed for this project, based on the
chris@22 500 # progress on it's versions.
chris@22 501 def completed_percent(options={:include_subprojects => false})
chris@22 502 if options.delete(:include_subprojects)
chris@22 503 total = self_and_descendants.collect(&:completed_percent).sum
chris@22 504
chris@22 505 total / self_and_descendants.count
chris@22 506 else
chris@22 507 if versions.count > 0
chris@22 508 total = versions.collect(&:completed_pourcent).sum
chris@22 509
chris@22 510 total / versions.count
chris@22 511 else
chris@22 512 100
chris@22 513 end
chris@22 514 end
chris@22 515 end
Chris@0 516
Chris@0 517 # Return true if this project is allowed to do the specified action.
Chris@0 518 # action can be:
Chris@0 519 # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
Chris@0 520 # * a permission Symbol (eg. :edit_project)
Chris@0 521 def allows_to?(action)
Chris@0 522 if action.is_a? Hash
Chris@0 523 allowed_actions.include? "#{action[:controller]}/#{action[:action]}"
Chris@0 524 else
Chris@0 525 allowed_permissions.include? action
Chris@0 526 end
Chris@0 527 end
Chris@0 528
Chris@0 529 def module_enabled?(module_name)
Chris@0 530 module_name = module_name.to_s
Chris@0 531 enabled_modules.detect {|m| m.name == module_name}
Chris@0 532 end
Chris@0 533
Chris@0 534 def enabled_module_names=(module_names)
Chris@0 535 if module_names && module_names.is_a?(Array)
Chris@119 536 module_names = module_names.collect(&:to_s).reject(&:blank?)
Chris@441 537 self.enabled_modules = module_names.collect {|name| enabled_modules.detect {|mod| mod.name == name} || EnabledModule.new(:name => name)}
Chris@0 538 else
Chris@0 539 enabled_modules.clear
Chris@0 540 end
Chris@0 541 end
Chris@119 542
Chris@119 543 # Returns an array of the enabled modules names
Chris@119 544 def enabled_module_names
Chris@119 545 enabled_modules.collect(&:name)
Chris@119 546 end
Chris@119 547
Chris@119 548 safe_attributes 'name',
Chris@119 549 'description',
Chris@119 550 'homepage',
Chris@119 551 'is_public',
Chris@119 552 'identifier',
Chris@119 553 'custom_field_values',
Chris@119 554 'custom_fields',
Chris@119 555 'tracker_ids',
Chris@119 556 'issue_custom_field_ids'
chris@22 557
Chris@119 558 safe_attributes 'enabled_module_names',
Chris@119 559 :if => lambda {|project, user| project.new_record? || user.allowed_to?(:select_project_modules, project) }
Chris@119 560
chris@22 561 # Returns an array of projects that are in this project's hierarchy
chris@22 562 #
chris@22 563 # Example: parents, children, siblings
chris@22 564 def hierarchy
chris@22 565 parents = project.self_and_ancestors || []
chris@22 566 descendants = project.descendants || []
chris@22 567 project_hierarchy = parents | descendants # Set union
chris@22 568 end
Chris@0 569
Chris@0 570 # Returns an auto-generated project identifier based on the last identifier used
Chris@0 571 def self.next_identifier
Chris@0 572 p = Project.find(:first, :order => 'created_on DESC')
Chris@0 573 p.nil? ? nil : p.identifier.to_s.succ
Chris@0 574 end
Chris@0 575
Chris@0 576 # Copies and saves the Project instance based on the +project+.
Chris@0 577 # Duplicates the source project's:
Chris@0 578 # * Wiki
Chris@0 579 # * Versions
Chris@0 580 # * Categories
Chris@0 581 # * Issues
Chris@0 582 # * Members
Chris@0 583 # * Queries
Chris@0 584 #
Chris@0 585 # Accepts an +options+ argument to specify what to copy
Chris@0 586 #
Chris@0 587 # Examples:
Chris@0 588 # project.copy(1) # => copies everything
Chris@0 589 # project.copy(1, :only => 'members') # => copies members only
Chris@0 590 # project.copy(1, :only => ['members', 'versions']) # => copies members and versions
Chris@0 591 def copy(project, options={})
Chris@0 592 project = project.is_a?(Project) ? project : Project.find(project)
Chris@0 593
Chris@0 594 to_be_copied = %w(wiki versions issue_categories issues members queries boards)
Chris@0 595 to_be_copied = to_be_copied & options[:only].to_a unless options[:only].nil?
Chris@0 596
Chris@0 597 Project.transaction do
Chris@0 598 if save
Chris@0 599 reload
Chris@0 600 to_be_copied.each do |name|
Chris@0 601 send "copy_#{name}", project
Chris@0 602 end
Chris@0 603 Redmine::Hook.call_hook(:model_project_copy_before_save, :source_project => project, :destination_project => self)
Chris@0 604 save
Chris@0 605 end
Chris@0 606 end
Chris@0 607 end
Chris@0 608
Chris@0 609
Chris@0 610 # Copies +project+ and returns the new instance. This will not save
Chris@0 611 # the copy
Chris@0 612 def self.copy_from(project)
Chris@0 613 begin
Chris@0 614 project = project.is_a?(Project) ? project : Project.find(project)
Chris@0 615 if project
Chris@0 616 # clear unique attributes
Chris@0 617 attributes = project.attributes.dup.except('id', 'name', 'identifier', 'status', 'parent_id', 'lft', 'rgt')
Chris@0 618 copy = Project.new(attributes)
Chris@0 619 copy.enabled_modules = project.enabled_modules
Chris@0 620 copy.trackers = project.trackers
Chris@0 621 copy.custom_values = project.custom_values.collect {|v| v.clone}
Chris@0 622 copy.issue_custom_fields = project.issue_custom_fields
Chris@0 623 return copy
Chris@0 624 else
Chris@0 625 return nil
Chris@0 626 end
Chris@0 627 rescue ActiveRecord::RecordNotFound
Chris@0 628 return nil
Chris@0 629 end
Chris@0 630 end
chris@37 631
chris@37 632 # Yields the given block for each project with its level in the tree
chris@37 633 def self.project_tree(projects, &block)
chris@37 634 ancestors = []
chris@37 635 projects.sort_by(&:lft).each do |project|
chris@37 636 while (ancestors.any? && !project.is_descendant_of?(ancestors.last))
chris@37 637 ancestors.pop
chris@37 638 end
chris@37 639 yield project, ancestors.size
chris@37 640 ancestors << project
chris@37 641 end
chris@37 642 end
Chris@0 643
Chris@0 644 private
Chris@0 645
Chris@0 646 # Copies wiki from +project+
Chris@0 647 def copy_wiki(project)
Chris@0 648 # Check that the source project has a wiki first
Chris@0 649 unless project.wiki.nil?
Chris@0 650 self.wiki ||= Wiki.new
Chris@0 651 wiki.attributes = project.wiki.attributes.dup.except("id", "project_id")
Chris@0 652 wiki_pages_map = {}
Chris@0 653 project.wiki.pages.each do |page|
Chris@0 654 # Skip pages without content
Chris@0 655 next if page.content.nil?
Chris@0 656 new_wiki_content = WikiContent.new(page.content.attributes.dup.except("id", "page_id", "updated_on"))
Chris@0 657 new_wiki_page = WikiPage.new(page.attributes.dup.except("id", "wiki_id", "created_on", "parent_id"))
Chris@0 658 new_wiki_page.content = new_wiki_content
Chris@0 659 wiki.pages << new_wiki_page
Chris@0 660 wiki_pages_map[page.id] = new_wiki_page
Chris@0 661 end
Chris@0 662 wiki.save
Chris@0 663 # Reproduce page hierarchy
Chris@0 664 project.wiki.pages.each do |page|
Chris@0 665 if page.parent_id && wiki_pages_map[page.id]
Chris@0 666 wiki_pages_map[page.id].parent = wiki_pages_map[page.parent_id]
Chris@0 667 wiki_pages_map[page.id].save
Chris@0 668 end
Chris@0 669 end
Chris@0 670 end
Chris@0 671 end
Chris@0 672
Chris@0 673 # Copies versions from +project+
Chris@0 674 def copy_versions(project)
Chris@0 675 project.versions.each do |version|
Chris@0 676 new_version = Version.new
Chris@0 677 new_version.attributes = version.attributes.dup.except("id", "project_id", "created_on", "updated_on")
Chris@0 678 self.versions << new_version
Chris@0 679 end
Chris@0 680 end
Chris@0 681
Chris@0 682 # Copies issue categories from +project+
Chris@0 683 def copy_issue_categories(project)
Chris@0 684 project.issue_categories.each do |issue_category|
Chris@0 685 new_issue_category = IssueCategory.new
Chris@0 686 new_issue_category.attributes = issue_category.attributes.dup.except("id", "project_id")
Chris@0 687 self.issue_categories << new_issue_category
Chris@0 688 end
Chris@0 689 end
Chris@0 690
Chris@0 691 # Copies issues from +project+
Chris@441 692 # Note: issues assigned to a closed version won't be copied due to validation rules
Chris@0 693 def copy_issues(project)
Chris@0 694 # Stores the source issue id as a key and the copied issues as the
Chris@0 695 # value. Used to map the two togeather for issue relations.
Chris@0 696 issues_map = {}
Chris@0 697
Chris@0 698 # Get issues sorted by root_id, lft so that parent issues
Chris@0 699 # get copied before their children
Chris@0 700 project.issues.find(:all, :order => 'root_id, lft').each do |issue|
Chris@0 701 new_issue = Issue.new
Chris@0 702 new_issue.copy_from(issue)
Chris@0 703 new_issue.project = self
Chris@0 704 # Reassign fixed_versions by name, since names are unique per
Chris@0 705 # project and the versions for self are not yet saved
Chris@0 706 if issue.fixed_version
Chris@0 707 new_issue.fixed_version = self.versions.select {|v| v.name == issue.fixed_version.name}.first
Chris@0 708 end
Chris@0 709 # Reassign the category by name, since names are unique per
Chris@0 710 # project and the categories for self are not yet saved
Chris@0 711 if issue.category
Chris@0 712 new_issue.category = self.issue_categories.select {|c| c.name == issue.category.name}.first
Chris@0 713 end
Chris@0 714 # Parent issue
Chris@0 715 if issue.parent_id
Chris@0 716 if copied_parent = issues_map[issue.parent_id]
Chris@0 717 new_issue.parent_issue_id = copied_parent.id
Chris@0 718 end
Chris@0 719 end
Chris@0 720
Chris@0 721 self.issues << new_issue
Chris@119 722 if new_issue.new_record?
Chris@119 723 logger.info "Project#copy_issues: issue ##{issue.id} could not be copied: #{new_issue.errors.full_messages}" if logger && logger.info
Chris@119 724 else
Chris@119 725 issues_map[issue.id] = new_issue unless new_issue.new_record?
Chris@119 726 end
Chris@0 727 end
Chris@0 728
Chris@0 729 # Relations after in case issues related each other
Chris@0 730 project.issues.each do |issue|
Chris@0 731 new_issue = issues_map[issue.id]
Chris@119 732 unless new_issue
Chris@119 733 # Issue was not copied
Chris@119 734 next
Chris@119 735 end
Chris@0 736
Chris@0 737 # Relations
Chris@0 738 issue.relations_from.each do |source_relation|
Chris@0 739 new_issue_relation = IssueRelation.new
Chris@0 740 new_issue_relation.attributes = source_relation.attributes.dup.except("id", "issue_from_id", "issue_to_id")
Chris@0 741 new_issue_relation.issue_to = issues_map[source_relation.issue_to_id]
Chris@0 742 if new_issue_relation.issue_to.nil? && Setting.cross_project_issue_relations?
Chris@0 743 new_issue_relation.issue_to = source_relation.issue_to
Chris@0 744 end
Chris@0 745 new_issue.relations_from << new_issue_relation
Chris@0 746 end
Chris@0 747
Chris@0 748 issue.relations_to.each do |source_relation|
Chris@0 749 new_issue_relation = IssueRelation.new
Chris@0 750 new_issue_relation.attributes = source_relation.attributes.dup.except("id", "issue_from_id", "issue_to_id")
Chris@0 751 new_issue_relation.issue_from = issues_map[source_relation.issue_from_id]
Chris@0 752 if new_issue_relation.issue_from.nil? && Setting.cross_project_issue_relations?
Chris@0 753 new_issue_relation.issue_from = source_relation.issue_from
Chris@0 754 end
Chris@0 755 new_issue.relations_to << new_issue_relation
Chris@0 756 end
Chris@0 757 end
Chris@0 758 end
Chris@0 759
Chris@0 760 # Copies members from +project+
Chris@0 761 def copy_members(project)
Chris@119 762 # Copy users first, then groups to handle members with inherited and given roles
Chris@119 763 members_to_copy = []
Chris@119 764 members_to_copy += project.memberships.select {|m| m.principal.is_a?(User)}
Chris@119 765 members_to_copy += project.memberships.select {|m| !m.principal.is_a?(User)}
Chris@119 766
Chris@119 767 members_to_copy.each do |member|
Chris@0 768 new_member = Member.new
Chris@0 769 new_member.attributes = member.attributes.dup.except("id", "project_id", "created_on")
Chris@0 770 # only copy non inherited roles
Chris@0 771 # inherited roles will be added when copying the group membership
Chris@0 772 role_ids = member.member_roles.reject(&:inherited?).collect(&:role_id)
Chris@0 773 next if role_ids.empty?
Chris@0 774 new_member.role_ids = role_ids
Chris@0 775 new_member.project = self
Chris@0 776 self.members << new_member
Chris@0 777 end
Chris@0 778 end
Chris@0 779
Chris@0 780 # Copies queries from +project+
Chris@0 781 def copy_queries(project)
Chris@0 782 project.queries.each do |query|
Chris@0 783 new_query = Query.new
Chris@0 784 new_query.attributes = query.attributes.dup.except("id", "project_id", "sort_criteria")
Chris@0 785 new_query.sort_criteria = query.sort_criteria if query.sort_criteria
Chris@0 786 new_query.project = self
Chris@0 787 self.queries << new_query
Chris@0 788 end
Chris@0 789 end
Chris@0 790
Chris@0 791 # Copies boards from +project+
Chris@0 792 def copy_boards(project)
Chris@0 793 project.boards.each do |board|
Chris@0 794 new_board = Board.new
Chris@0 795 new_board.attributes = board.attributes.dup.except("id", "project_id", "topics_count", "messages_count", "last_message_id")
Chris@0 796 new_board.project = self
Chris@0 797 self.boards << new_board
Chris@0 798 end
Chris@0 799 end
Chris@0 800
Chris@0 801 def allowed_permissions
Chris@0 802 @allowed_permissions ||= begin
Chris@0 803 module_names = enabled_modules.all(:select => :name).collect {|m| m.name}
Chris@0 804 Redmine::AccessControl.modules_permissions(module_names).collect {|p| p.name}
Chris@0 805 end
Chris@0 806 end
Chris@0 807
Chris@0 808 def allowed_actions
Chris@0 809 @actions_allowed ||= allowed_permissions.inject([]) { |actions, permission| actions += Redmine::AccessControl.allowed_actions(permission) }.flatten
Chris@0 810 end
Chris@0 811
Chris@0 812 # Returns all the active Systemwide and project specific activities
Chris@0 813 def active_activities
Chris@0 814 overridden_activity_ids = self.time_entry_activities.collect(&:parent_id)
Chris@0 815
Chris@0 816 if overridden_activity_ids.empty?
Chris@0 817 return TimeEntryActivity.shared.active
Chris@0 818 else
Chris@0 819 return system_activities_and_project_overrides
Chris@0 820 end
Chris@0 821 end
Chris@0 822
Chris@0 823 # Returns all the Systemwide and project specific activities
Chris@0 824 # (inactive and active)
Chris@0 825 def all_activities
Chris@0 826 overridden_activity_ids = self.time_entry_activities.collect(&:parent_id)
Chris@0 827
Chris@0 828 if overridden_activity_ids.empty?
Chris@0 829 return TimeEntryActivity.shared
Chris@0 830 else
Chris@0 831 return system_activities_and_project_overrides(true)
Chris@0 832 end
Chris@0 833 end
Chris@0 834
Chris@0 835 # Returns the systemwide active activities merged with the project specific overrides
Chris@0 836 def system_activities_and_project_overrides(include_inactive=false)
Chris@0 837 if include_inactive
Chris@0 838 return TimeEntryActivity.shared.
Chris@0 839 find(:all,
Chris@0 840 :conditions => ["id NOT IN (?)", self.time_entry_activities.collect(&:parent_id)]) +
Chris@0 841 self.time_entry_activities
Chris@0 842 else
Chris@0 843 return TimeEntryActivity.shared.active.
Chris@0 844 find(:all,
Chris@0 845 :conditions => ["id NOT IN (?)", self.time_entry_activities.collect(&:parent_id)]) +
Chris@0 846 self.time_entry_activities.active
Chris@0 847 end
Chris@0 848 end
Chris@0 849
Chris@0 850 # Archives subprojects recursively
Chris@0 851 def archive!
Chris@0 852 children.each do |subproject|
Chris@0 853 subproject.send :archive!
Chris@0 854 end
Chris@0 855 update_attribute :status, STATUS_ARCHIVED
Chris@0 856 end
Chris@0 857 end