##// END OF EJS Templates
jro_apps » redmine
RSS
Conditions cleanup....
Jean-Philippe Lang -
r14310:7d558120d3cf
parent child
Show More
Side by Side Unified
Context file:
r14310:7d558120d3cf Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,1042 +1,1042
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2015 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 class Project < ActiveRecord::Base
19 19 include Redmine::SafeAttributes
20 20 include Redmine::NestedSet::ProjectNestedSet
21 21
22 22 # Project statuses
23 23 STATUS_ACTIVE = 1
24 24 STATUS_CLOSED = 5
25 25 STATUS_ARCHIVED = 9
26 26
27 27 # Maximum length for project identifiers
28 28 IDENTIFIER_MAX_LENGTH = 100
29 29
30 30 # Specific overridden Activities
31 31 has_many :time_entry_activities
32 32 has_many :memberships, :class_name => 'Member', :inverse_of => :project
33 33 # Memberships of active users only
34 34 has_many :members,
35 35 lambda { joins(:principal).where(:users => {:type => 'User', :status => Principal::STATUS_ACTIVE}) }
36 36 has_many :enabled_modules, :dependent => :delete_all
37 37 has_and_belongs_to_many :trackers, lambda {order(:position)}
38 38 has_many :issues, :dependent => :destroy
39 39 has_many :issue_changes, :through => :issues, :source => :journals
40 40 has_many :versions, lambda {order("#{Version.table_name}.effective_date DESC, #{Version.table_name}.name DESC")}, :dependent => :destroy
41 41 has_many :time_entries, :dependent => :destroy
42 42 has_many :queries, :class_name => 'IssueQuery', :dependent => :delete_all
43 43 has_many :documents, :dependent => :destroy
44 44 has_many :news, lambda {includes(:author)}, :dependent => :destroy
45 45 has_many :issue_categories, lambda {order("#{IssueCategory.table_name}.name")}, :dependent => :delete_all
46 46 has_many :boards, lambda {order("position ASC")}, :dependent => :destroy
47 47 has_one :repository, lambda {where(["is_default = ?", true])}
48 48 has_many :repositories, :dependent => :destroy
49 49 has_many :changesets, :through => :repository
50 50 has_one :wiki, :dependent => :destroy
51 51 # Custom field for the project issues
52 52 has_and_belongs_to_many :issue_custom_fields,
53 53 lambda {order("#{CustomField.table_name}.position")},
54 54 :class_name => 'IssueCustomField',
55 55 :join_table => "#{table_name_prefix}custom_fields_projects#{table_name_suffix}",
56 56 :association_foreign_key => 'custom_field_id'
57 57
58 58 acts_as_attachable :view_permission => :view_files,
59 59 :edit_permission => :manage_files,
60 60 :delete_permission => :manage_files
61 61
62 62 acts_as_customizable
63 63 acts_as_searchable :columns => ['name', 'identifier', 'description'], :project_key => "#{Project.table_name}.id", :permission => nil
64 64 acts_as_event :title => Proc.new {|o| "#{l(:label_project)}: #{o.name}"},
65 65 :url => Proc.new {|o| {:controller => 'projects', :action => 'show', :id => o}},
66 66 :author => nil
67 67
68 68 attr_protected :status
69 69
70 70 validates_presence_of :name, :identifier
71 71 validates_uniqueness_of :identifier, :if => Proc.new {|p| p.identifier_changed?}
72 72 validates_length_of :name, :maximum => 255
73 73 validates_length_of :homepage, :maximum => 255
74 74 validates_length_of :identifier, :in => 1..IDENTIFIER_MAX_LENGTH
75 75 # downcase letters, digits, dashes but not digits only
76 76 validates_format_of :identifier, :with => /\A(?!\d+$)[a-z0-9\-_]*\z/, :if => Proc.new { |p| p.identifier_changed? }
77 77 # reserved words
78 78 validates_exclusion_of :identifier, :in => %w( new )
79 79 validate :validate_parent
80 80
81 81 after_save :update_inherited_members, :if => Proc.new {|project| project.inherit_members_changed?}
82 82 after_save :remove_inherited_member_roles, :add_inherited_member_roles, :if => Proc.new {|project| project.parent_id_changed?}
83 83 after_update :update_versions_from_hierarchy_change, :if => Proc.new {|project| project.parent_id_changed?}
84 84 before_destroy :delete_all_members
85 85
86 86 scope :has_module, lambda {|mod|
87 87 where("#{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name=?)", mod.to_s)
88 88 }
89 89 scope :active, lambda { where(:status => STATUS_ACTIVE) }
90 90 scope :status, lambda {|arg| where(arg.blank? ? nil : {:status => arg.to_i}) }
91 91 scope :all_public, lambda { where(:is_public => true) }
92 92 scope :visible, lambda {|*args| where(Project.visible_condition(args.shift || User.current, *args)) }
93 93 scope :allowed_to, lambda {|*args|
94 94 user = User.current
95 95 permission = nil
96 96 if args.first.is_a?(Symbol)
97 97 permission = args.shift
98 98 else
99 99 user = args.shift
100 100 permission = args.shift
101 101 end
102 102 where(Project.allowed_to_condition(user, permission, *args))
103 103 }
104 104 scope :like, lambda {|arg|
105 105 if arg.blank?
106 106 where(nil)
107 107 else
108 108 pattern = "%#{arg.to_s.strip.downcase}%"
109 109 where("LOWER(identifier) LIKE :p OR LOWER(name) LIKE :p", :p => pattern)
110 110 end
111 111 }
112 112 scope :sorted, lambda {order(:lft)}
113 113 scope :having_trackers, lambda {
114 114 where("#{Project.table_name}.id IN (SELECT DISTINCT project_id FROM #{table_name_prefix}projects_trackers#{table_name_suffix})")
115 115 }
116 116
117 117 def initialize(attributes=nil, *args)
118 118 super
119 119
120 120 initialized = (attributes || {}).stringify_keys
121 121 if !initialized.key?('identifier') && Setting.sequential_project_identifiers?
122 122 self.identifier = Project.next_identifier
123 123 end
124 124 if !initialized.key?('is_public')
125 125 self.is_public = Setting.default_projects_public?
126 126 end
127 127 if !initialized.key?('enabled_module_names')
128 128 self.enabled_module_names = Setting.default_projects_modules
129 129 end
130 130 if !initialized.key?('trackers') && !initialized.key?('tracker_ids')
131 131 default = Setting.default_projects_tracker_ids
132 132 if default.is_a?(Array)
133 133 self.trackers = Tracker.where(:id => default.map(&:to_i)).sorted.to_a
134 134 else
135 135 self.trackers = Tracker.sorted.to_a
136 136 end
137 137 end
138 138 end
139 139
140 140 def identifier=(identifier)
141 141 super unless identifier_frozen?
142 142 end
143 143
144 144 def identifier_frozen?
145 145 errors[:identifier].blank? && !(new_record? || identifier.blank?)
146 146 end
147 147
148 148 # returns latest created projects
149 149 # non public projects will be returned only if user is a member of those
150 150 def self.latest(user=nil, count=5)
151 151 visible(user).limit(count).order("created_on DESC").to_a
152 152 end
153 153
154 154 # Returns true if the project is visible to +user+ or to the current user.
155 155 def visible?(user=User.current)
156 156 user.allowed_to?(:view_project, self)
157 157 end
158 158
159 159 # Returns a SQL conditions string used to find all projects visible by the specified user.
160 160 #
161 161 # Examples:
162 162 # Project.visible_condition(admin) => "projects.status = 1"
163 163 # Project.visible_condition(normal_user) => "((projects.status = 1) AND (projects.is_public = 1 OR projects.id IN (1,3,4)))"
164 164 # Project.visible_condition(anonymous) => "((projects.status = 1) AND (projects.is_public = 1))"
165 165 def self.visible_condition(user, options={})
166 166 allowed_to_condition(user, :view_project, options)
167 167 end
168 168
169 169 # Returns a SQL conditions string used to find all projects for which +user+ has the given +permission+
170 170 #
171 171 # Valid options:
172 172 # * :project => limit the condition to project
173 173 # * :with_subprojects => limit the condition to project and its subprojects
174 174 # * :member => limit the condition to the user projects
175 175 def self.allowed_to_condition(user, permission, options={})
176 176 perm = Redmine::AccessControl.permission(permission)
177 177 base_statement = (perm && perm.read? ? "#{Project.table_name}.status <> #{Project::STATUS_ARCHIVED}" : "#{Project.table_name}.status = #{Project::STATUS_ACTIVE}")
178 178 if perm && perm.project_module
179 179 # If the permission belongs to a project module, make sure the module is enabled
180 180 base_statement << " AND #{Project.table_name}.id IN (SELECT em.project_id FROM #{EnabledModule.table_name} em WHERE em.name='#{perm.project_module}')"
181 181 end
182 182 if project = options[:project]
183 183 project_statement = project.project_condition(options[:with_subprojects])
184 184 base_statement = "(#{project_statement}) AND (#{base_statement})"
185 185 end
186 186
187 187 if user.admin?
188 188 base_statement
189 189 else
190 190 statement_by_role = {}
191 191 unless options[:member]
192 192 role = user.builtin_role
193 193 if role.allowed_to?(permission)
194 194 s = "#{Project.table_name}.is_public = #{connection.quoted_true}"
195 195 if user.id
196 196 s = "(#{s} AND #{Project.table_name}.id NOT IN (SELECT project_id FROM #{Member.table_name} WHERE user_id = #{user.id}))"
197 197 end
198 198 statement_by_role[role] = s
199 199 end
200 200 end
201 201 user.projects_by_role.each do |role, projects|
202 202 if role.allowed_to?(permission) && projects.any?
203 203 statement_by_role[role] = "#{Project.table_name}.id IN (#{projects.collect(&:id).join(',')})"
204 204 end
205 205 end
206 206 if statement_by_role.empty?
207 207 "1=0"
208 208 else
209 209 if block_given?
210 210 statement_by_role.each do |role, statement|
211 211 if s = yield(role, user)
212 212 statement_by_role[role] = "(#{statement} AND (#{s}))"
213 213 end
214 214 end
215 215 end
216 216 "((#{base_statement}) AND (#{statement_by_role.values.join(' OR ')}))"
217 217 end
218 218 end
219 219 end
220 220
221 221 def override_roles(role)
222 222 @override_members ||= memberships.
223 223 joins(:principal).
224 224 where(:users => {:type => ['GroupAnonymous', 'GroupNonMember']}).to_a
225 225
226 226 group_class = role.anonymous? ? GroupAnonymous : GroupNonMember
227 227 member = @override_members.detect {|m| m.principal.is_a? group_class}
228 228 member ? member.roles.to_a : [role]
229 229 end
230 230
231 231 def principals
232 232 @principals ||= Principal.active.joins(:members).where("#{Member.table_name}.project_id = ?", id).uniq
233 233 end
234 234
235 235 def users
236 236 @users ||= User.active.joins(:members).where("#{Member.table_name}.project_id = ?", id).uniq
237 237 end
238 238
239 239 # Returns the Systemwide and project specific activities
240 240 def activities(include_inactive=false)
241 241 t = TimeEntryActivity.table_name
242 242 scope = TimeEntryActivity.where("#{t}.project_id IS NULL OR #{t}.project_id = ?", id)
243 243
244 244 overridden_activity_ids = self.time_entry_activities.pluck(:parent_id).compact
245 245 if overridden_activity_ids.any?
246 246 scope = scope.where("#{t}.id NOT IN (?)", overridden_activity_ids)
247 247 end
248 248 unless include_inactive
249 249 scope = scope.active
250 250 end
251 251 scope
252 252 end
253 253
254 254 # Will create a new Project specific Activity or update an existing one
255 255 #
256 256 # This will raise a ActiveRecord::Rollback if the TimeEntryActivity
257 257 # does not successfully save.
258 258 def update_or_create_time_entry_activity(id, activity_hash)
259 259 if activity_hash.respond_to?(:has_key?) && activity_hash.has_key?('parent_id')
260 260 self.create_time_entry_activity_if_needed(activity_hash)
261 261 else
262 262 activity = project.time_entry_activities.find_by_id(id.to_i)
263 263 activity.update_attributes(activity_hash) if activity
264 264 end
265 265 end
266 266
267 267 # Create a new TimeEntryActivity if it overrides a system TimeEntryActivity
268 268 #
269 269 # This will raise a ActiveRecord::Rollback if the TimeEntryActivity
270 270 # does not successfully save.
271 271 def create_time_entry_activity_if_needed(activity)
272 272 if activity['parent_id']
273 273 parent_activity = TimeEntryActivity.find(activity['parent_id'])
274 274 activity['name'] = parent_activity.name
275 275 activity['position'] = parent_activity.position
276 276 if Enumeration.overriding_change?(activity, parent_activity)
277 277 project_activity = self.time_entry_activities.create(activity)
278 278 if project_activity.new_record?
279 279 raise ActiveRecord::Rollback, "Overriding TimeEntryActivity was not successfully saved"
280 280 else
281 281 self.time_entries.
282 where(["activity_id = ?", parent_activity.id]).
283 update_all("activity_id = #{project_activity.id}")
282 where(:activity_id => parent_activity.id).
283 update_all(:activity_id => project_activity.id)
284 284 end
285 285 end
286 286 end
287 287 end
288 288
289 289 # Returns a :conditions SQL string that can be used to find the issues associated with this project.
290 290 #
291 291 # Examples:
292 292 # project.project_condition(true) => "(projects.id = 1 OR (projects.lft > 1 AND projects.rgt < 10))"
293 293 # project.project_condition(false) => "projects.id = 1"
294 294 def project_condition(with_subprojects)
295 295 cond = "#{Project.table_name}.id = #{id}"
296 296 cond = "(#{cond} OR (#{Project.table_name}.lft > #{lft} AND #{Project.table_name}.rgt < #{rgt}))" if with_subprojects
297 297 cond
298 298 end
299 299
300 300 def self.find(*args)
301 301 if args.first && args.first.is_a?(String) && !args.first.match(/^\d*$/)
302 302 project = find_by_identifier(*args)
303 303 raise ActiveRecord::RecordNotFound, "Couldn't find Project with identifier=#{args.first}" if project.nil?
304 304 project
305 305 else
306 306 super
307 307 end
308 308 end
309 309
310 310 def self.find_by_param(*args)
311 311 self.find(*args)
312 312 end
313 313
314 314 alias :base_reload :reload
315 315 def reload(*args)
316 316 @principals = nil
317 317 @users = nil
318 318 @shared_versions = nil
319 319 @rolled_up_versions = nil
320 320 @rolled_up_trackers = nil
321 321 @all_issue_custom_fields = nil
322 322 @all_time_entry_custom_fields = nil
323 323 @to_param = nil
324 324 @allowed_parents = nil
325 325 @allowed_permissions = nil
326 326 @actions_allowed = nil
327 327 @start_date = nil
328 328 @due_date = nil
329 329 @override_members = nil
330 330 @assignable_users = nil
331 331 base_reload(*args)
332 332 end
333 333
334 334 def to_param
335 335 if new_record?
336 336 nil
337 337 else
338 338 # id is used for projects with a numeric identifier (compatibility)
339 339 @to_param ||= (identifier.to_s =~ %r{^\d*$} ? id.to_s : identifier)
340 340 end
341 341 end
342 342
343 343 def active?
344 344 self.status == STATUS_ACTIVE
345 345 end
346 346
347 347 def archived?
348 348 self.status == STATUS_ARCHIVED
349 349 end
350 350
351 351 # Archives the project and its descendants
352 352 def archive
353 353 # Check that there is no issue of a non descendant project that is assigned
354 354 # to one of the project or descendant versions
355 355 version_ids = self_and_descendants.joins(:versions).pluck("#{Version.table_name}.id")
356 356
357 357 if version_ids.any? &&
358 358 Issue.
359 359 includes(:project).
360 360 where("#{Project.table_name}.lft < ? OR #{Project.table_name}.rgt > ?", lft, rgt).
361 361 where(:fixed_version_id => version_ids).
362 362 exists?
363 363 return false
364 364 end
365 365 Project.transaction do
366 366 archive!
367 367 end
368 368 true
369 369 end
370 370
371 371 # Unarchives the project
372 372 # All its ancestors must be active
373 373 def unarchive
374 374 return false if ancestors.detect {|a| !a.active?}
375 375 update_attribute :status, STATUS_ACTIVE
376 376 end
377 377
378 378 def close
379 379 self_and_descendants.status(STATUS_ACTIVE).update_all :status => STATUS_CLOSED
380 380 end
381 381
382 382 def reopen
383 383 self_and_descendants.status(STATUS_CLOSED).update_all :status => STATUS_ACTIVE
384 384 end
385 385
386 386 # Returns an array of projects the project can be moved to
387 387 # by the current user
388 388 def allowed_parents(user=User.current)
389 389 return @allowed_parents if @allowed_parents
390 390 @allowed_parents = Project.allowed_to(user, :add_subprojects).to_a
391 391 @allowed_parents = @allowed_parents - self_and_descendants
392 392 if user.allowed_to?(:add_project, nil, :global => true) || (!new_record? && parent.nil?)
393 393 @allowed_parents << nil
394 394 end
395 395 unless parent.nil? || @allowed_parents.empty? || @allowed_parents.include?(parent)
396 396 @allowed_parents << parent
397 397 end
398 398 @allowed_parents
399 399 end
400 400
401 401 # Sets the parent of the project with authorization check
402 402 def set_allowed_parent!(p)
403 403 ActiveSupport::Deprecation.warn "Project#set_allowed_parent! is deprecated and will be removed in Redmine 4, use #safe_attributes= instead."
404 404 p = p.id if p.is_a?(Project)
405 405 send :safe_attributes, {:project_id => p}
406 406 save
407 407 end
408 408
409 409 # Sets the parent of the project and saves the project
410 410 # Argument can be either a Project, a String, a Fixnum or nil
411 411 def set_parent!(p)
412 412 if p.is_a?(Project)
413 413 self.parent = p
414 414 else
415 415 self.parent_id = p
416 416 end
417 417 save
418 418 end
419 419
420 420 # Returns an array of the trackers used by the project and its active sub projects
421 421 def rolled_up_trackers
422 422 @rolled_up_trackers ||=
423 423 Tracker.
424 424 joins(:projects).
425 425 joins("JOIN #{EnabledModule.table_name} ON #{EnabledModule.table_name}.project_id = #{Project.table_name}.id AND #{EnabledModule.table_name}.name = 'issue_tracking'").
426 426 where("#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status <> ?", lft, rgt, STATUS_ARCHIVED).
427 427 uniq.
428 428 sorted.
429 429 to_a
430 430 end
431 431
432 432 # Closes open and locked project versions that are completed
433 433 def close_completed_versions
434 434 Version.transaction do
435 435 versions.where(:status => %w(open locked)).each do |version|
436 436 if version.completed?
437 437 version.update_attribute(:status, 'closed')
438 438 end
439 439 end
440 440 end
441 441 end
442 442
443 443 # Returns a scope of the Versions on subprojects
444 444 def rolled_up_versions
445 445 @rolled_up_versions ||=
446 446 Version.
447 447 joins(:project).
448 448 where("#{Project.table_name}.lft >= ? AND #{Project.table_name}.rgt <= ? AND #{Project.table_name}.status <> ?", lft, rgt, STATUS_ARCHIVED)
449 449 end
450 450
451 451 # Returns a scope of the Versions used by the project
452 452 def shared_versions
453 453 if new_record?
454 454 Version.
455 455 joins(:project).
456 456 preload(:project).
457 457 where("#{Project.table_name}.status <> ? AND #{Version.table_name}.sharing = 'system'", STATUS_ARCHIVED)
458 458 else
459 459 @shared_versions ||= begin
460 460 r = root? ? self : root
461 461 Version.
462 462 joins(:project).
463 463 preload(:project).
464 464 where("#{Project.table_name}.id = #{id}" +
465 465 " OR (#{Project.table_name}.status <> #{Project::STATUS_ARCHIVED} AND (" +
466 466 " #{Version.table_name}.sharing = 'system'" +
467 467 " OR (#{Project.table_name}.lft >= #{r.lft} AND #{Project.table_name}.rgt <= #{r.rgt} AND #{Version.table_name}.sharing = 'tree')" +
468 468 " OR (#{Project.table_name}.lft < #{lft} AND #{Project.table_name}.rgt > #{rgt} AND #{Version.table_name}.sharing IN ('hierarchy', 'descendants'))" +
469 469 " OR (#{Project.table_name}.lft > #{lft} AND #{Project.table_name}.rgt < #{rgt} AND #{Version.table_name}.sharing = 'hierarchy')" +
470 470 "))")
471 471 end
472 472 end
473 473 end
474 474
475 475 # Returns a hash of project users grouped by role
476 476 def users_by_role
477 477 members.includes(:user, :roles).inject({}) do |h, m|
478 478 m.roles.each do |r|
479 479 h[r] ||= []
480 480 h[r] << m.user
481 481 end
482 482 h
483 483 end
484 484 end
485 485
486 486 # Adds user as a project member with the default role
487 487 # Used for when a non-admin user creates a project
488 488 def add_default_member(user)
489 489 role = Role.givable.find_by_id(Setting.new_project_user_role_id.to_i) || Role.givable.first
490 490 member = Member.new(:project => self, :principal => user, :roles => [role])
491 491 self.members << member
492 492 member
493 493 end
494 494
495 495 # Deletes all project's members
496 496 def delete_all_members
497 497 me, mr = Member.table_name, MemberRole.table_name
498 498 self.class.connection.delete("DELETE FROM #{mr} WHERE #{mr}.member_id IN (SELECT #{me}.id FROM #{me} WHERE #{me}.project_id = #{id})")
499 499 Member.delete_all(['project_id = ?', id])
500 500 end
501 501
502 502 # Return a Principal scope of users/groups issues can be assigned to
503 503 def assignable_users
504 504 types = ['User']
505 505 types << 'Group' if Setting.issue_group_assignment?
506 506
507 507 @assignable_users ||= Principal.
508 508 active.
509 509 joins(:members => :roles).
510 510 where(:type => types, :members => {:project_id => id}, :roles => {:assignable => true}).
511 511 uniq.
512 512 sorted
513 513 end
514 514
515 515 # Returns the mail addresses of users that should be always notified on project events
516 516 def recipients
517 517 notified_users.collect {|user| user.mail}
518 518 end
519 519
520 520 # Returns the users that should be notified on project events
521 521 def notified_users
522 522 # TODO: User part should be extracted to User#notify_about?
523 523 members.select {|m| m.principal.present? && (m.mail_notification? || m.principal.mail_notification == 'all')}.collect {|m| m.principal}
524 524 end
525 525
526 526 # Returns a scope of all custom fields enabled for project issues
527 527 # (explicitly associated custom fields and custom fields enabled for all projects)
528 528 def all_issue_custom_fields
529 529 if new_record?
530 530 @all_issue_custom_fields ||= IssueCustomField.
531 531 sorted.
532 532 where("is_for_all = ? OR id IN (?)", true, issue_custom_field_ids)
533 533 else
534 534 @all_issue_custom_fields ||= IssueCustomField.
535 535 sorted.
536 536 where("is_for_all = ? OR id IN (SELECT DISTINCT cfp.custom_field_id" +
537 537 " FROM #{table_name_prefix}custom_fields_projects#{table_name_suffix} cfp" +
538 538 " WHERE cfp.project_id = ?)", true, id)
539 539 end
540 540 end
541 541
542 542 def project
543 543 self
544 544 end
545 545
546 546 def <=>(project)
547 547 name.casecmp(project.name)
548 548 end
549 549
550 550 def to_s
551 551 name
552 552 end
553 553
554 554 # Returns a short description of the projects (first lines)
555 555 def short_description(length = 255)
556 556 description.gsub(/^(.{#{length}}[^\n\r]*).*$/m, '\1...').strip if description
557 557 end
558 558
559 559 def css_classes
560 560 s = 'project'
561 561 s << ' root' if root?
562 562 s << ' child' if child?
563 563 s << (leaf? ? ' leaf' : ' parent')
564 564 unless active?
565 565 if archived?
566 566 s << ' archived'
567 567 else
568 568 s << ' closed'
569 569 end
570 570 end
571 571 s
572 572 end
573 573
574 574 # The earliest start date of a project, based on it's issues and versions
575 575 def start_date
576 576 @start_date ||= [
577 577 issues.minimum('start_date'),
578 578 shared_versions.minimum('effective_date'),
579 579 Issue.fixed_version(shared_versions).minimum('start_date')
580 580 ].compact.min
581 581 end
582 582
583 583 # The latest due date of an issue or version
584 584 def due_date
585 585 @due_date ||= [
586 586 issues.maximum('due_date'),
587 587 shared_versions.maximum('effective_date'),
588 588 Issue.fixed_version(shared_versions).maximum('due_date')
589 589 ].compact.max
590 590 end
591 591
592 592 def overdue?
593 593 active? && !due_date.nil? && (due_date < Date.today)
594 594 end
595 595
596 596 # Returns the percent completed for this project, based on the
597 597 # progress on it's versions.
598 598 def completed_percent(options={:include_subprojects => false})
599 599 if options.delete(:include_subprojects)
600 600 total = self_and_descendants.collect(&:completed_percent).sum
601 601
602 602 total / self_and_descendants.count
603 603 else
604 604 if versions.count > 0
605 605 total = versions.collect(&:completed_percent).sum
606 606
607 607 total / versions.count
608 608 else
609 609 100
610 610 end
611 611 end
612 612 end
613 613
614 614 # Return true if this project allows to do the specified action.
615 615 # action can be:
616 616 # * a parameter-like Hash (eg. :controller => 'projects', :action => 'edit')
617 617 # * a permission Symbol (eg. :edit_project)
618 618 def allows_to?(action)
619 619 if archived?
620 620 # No action allowed on archived projects
621 621 return false
622 622 end
623 623 unless active? || Redmine::AccessControl.read_action?(action)
624 624 # No write action allowed on closed projects
625 625 return false
626 626 end
627 627 # No action allowed on disabled modules
628 628 if action.is_a? Hash
629 629 allowed_actions.include? "#{action[:controller]}/#{action[:action]}"
630 630 else
631 631 allowed_permissions.include? action
632 632 end
633 633 end
634 634
635 635 # Return the enabled module with the given name
636 636 # or nil if the module is not enabled for the project
637 637 def enabled_module(name)
638 638 name = name.to_s
639 639 enabled_modules.detect {|m| m.name == name}
640 640 end
641 641
642 642 # Return true if the module with the given name is enabled
643 643 def module_enabled?(name)
644 644 enabled_module(name).present?
645 645 end
646 646
647 647 def enabled_module_names=(module_names)
648 648 if module_names && module_names.is_a?(Array)
649 649 module_names = module_names.collect(&:to_s).reject(&:blank?)
650 650 self.enabled_modules = module_names.collect {|name| enabled_modules.detect {|mod| mod.name == name} || EnabledModule.new(:name => name)}
651 651 else
652 652 enabled_modules.clear
653 653 end
654 654 end
655 655
656 656 # Returns an array of the enabled modules names
657 657 def enabled_module_names
658 658 enabled_modules.collect(&:name)
659 659 end
660 660
661 661 # Enable a specific module
662 662 #
663 663 # Examples:
664 664 # project.enable_module!(:issue_tracking)
665 665 # project.enable_module!("issue_tracking")
666 666 def enable_module!(name)
667 667 enabled_modules << EnabledModule.new(:name => name.to_s) unless module_enabled?(name)
668 668 end
669 669
670 670 # Disable a module if it exists
671 671 #
672 672 # Examples:
673 673 # project.disable_module!(:issue_tracking)
674 674 # project.disable_module!("issue_tracking")
675 675 # project.disable_module!(project.enabled_modules.first)
676 676 def disable_module!(target)
677 677 target = enabled_modules.detect{|mod| target.to_s == mod.name} unless enabled_modules.include?(target)
678 678 target.destroy unless target.blank?
679 679 end
680 680
681 681 safe_attributes 'name',
682 682 'description',
683 683 'homepage',
684 684 'is_public',
685 685 'identifier',
686 686 'custom_field_values',
687 687 'custom_fields',
688 688 'tracker_ids',
689 689 'issue_custom_field_ids',
690 690 'parent_id'
691 691
692 692 safe_attributes 'enabled_module_names',
693 693 :if => lambda {|project, user| project.new_record? || user.allowed_to?(:select_project_modules, project) }
694 694
695 695 safe_attributes 'inherit_members',
696 696 :if => lambda {|project, user| project.parent.nil? || project.parent.visible?(user)}
697 697
698 698 def safe_attributes=(attrs, user=User.current)
699 699 return unless attrs.is_a?(Hash)
700 700 attrs = attrs.deep_dup
701 701
702 702 @unallowed_parent_id = nil
703 703 if new_record? || attrs.key?('parent_id')
704 704 parent_id_param = attrs['parent_id'].to_s
705 705 if new_record? || parent_id_param != parent_id.to_s
706 706 p = parent_id_param.present? ? Project.find_by_id(parent_id_param) : nil
707 707 unless allowed_parents(user).include?(p)
708 708 attrs.delete('parent_id')
709 709 @unallowed_parent_id = true
710 710 end
711 711 end
712 712 end
713 713
714 714 super(attrs, user)
715 715 end
716 716
717 717 # Returns an auto-generated project identifier based on the last identifier used
718 718 def self.next_identifier
719 719 p = Project.order('id DESC').first
720 720 p.nil? ? nil : p.identifier.to_s.succ
721 721 end
722 722
723 723 # Copies and saves the Project instance based on the +project+.
724 724 # Duplicates the source project's:
725 725 # * Wiki
726 726 # * Versions
727 727 # * Categories
728 728 # * Issues
729 729 # * Members
730 730 # * Queries
731 731 #
732 732 # Accepts an +options+ argument to specify what to copy
733 733 #
734 734 # Examples:
735 735 # project.copy(1) # => copies everything
736 736 # project.copy(1, :only => 'members') # => copies members only
737 737 # project.copy(1, :only => ['members', 'versions']) # => copies members and versions
738 738 def copy(project, options={})
739 739 project = project.is_a?(Project) ? project : Project.find(project)
740 740
741 741 to_be_copied = %w(wiki versions issue_categories issues members queries boards)
742 742 to_be_copied = to_be_copied & Array.wrap(options[:only]) unless options[:only].nil?
743 743
744 744 Project.transaction do
745 745 if save
746 746 reload
747 747 to_be_copied.each do |name|
748 748 send "copy_#{name}", project
749 749 end
750 750 Redmine::Hook.call_hook(:model_project_copy_before_save, :source_project => project, :destination_project => self)
751 751 save
752 752 else
753 753 false
754 754 end
755 755 end
756 756 end
757 757
758 758 def member_principals
759 759 ActiveSupport::Deprecation.warn "Project#member_principals is deprecated and will be removed in Redmine 4.0. Use #memberships.active instead."
760 760 memberships.active
761 761 end
762 762
763 763 # Returns a new unsaved Project instance with attributes copied from +project+
764 764 def self.copy_from(project)
765 765 project = project.is_a?(Project) ? project : Project.find(project)
766 766 # clear unique attributes
767 767 attributes = project.attributes.dup.except('id', 'name', 'identifier', 'status', 'parent_id', 'lft', 'rgt')
768 768 copy = Project.new(attributes)
769 769 copy.enabled_module_names = project.enabled_module_names
770 770 copy.trackers = project.trackers
771 771 copy.custom_values = project.custom_values.collect {|v| v.clone}
772 772 copy.issue_custom_fields = project.issue_custom_fields
773 773 copy
774 774 end
775 775
776 776 # Yields the given block for each project with its level in the tree
777 777 def self.project_tree(projects, &block)
778 778 ancestors = []
779 779 projects.sort_by(&:lft).each do |project|
780 780 while (ancestors.any? && !project.is_descendant_of?(ancestors.last))
781 781 ancestors.pop
782 782 end
783 783 yield project, ancestors.size
784 784 ancestors << project
785 785 end
786 786 end
787 787
788 788 private
789 789
790 790 def update_inherited_members
791 791 if parent
792 792 if inherit_members? && !inherit_members_was
793 793 remove_inherited_member_roles
794 794 add_inherited_member_roles
795 795 elsif !inherit_members? && inherit_members_was
796 796 remove_inherited_member_roles
797 797 end
798 798 end
799 799 end
800 800
801 801 def remove_inherited_member_roles
802 802 member_roles = memberships.map(&:member_roles).flatten
803 803 member_role_ids = member_roles.map(&:id)
804 804 member_roles.each do |member_role|
805 805 if member_role.inherited_from && !member_role_ids.include?(member_role.inherited_from)
806 806 member_role.destroy
807 807 end
808 808 end
809 809 end
810 810
811 811 def add_inherited_member_roles
812 812 if inherit_members? && parent
813 813 parent.memberships.each do |parent_member|
814 814 member = Member.find_or_new(self.id, parent_member.user_id)
815 815 parent_member.member_roles.each do |parent_member_role|
816 816 member.member_roles << MemberRole.new(:role => parent_member_role.role, :inherited_from => parent_member_role.id)
817 817 end
818 818 member.save!
819 819 end
820 820 memberships.reset
821 821 end
822 822 end
823 823
824 824 def update_versions_from_hierarchy_change
825 825 Issue.update_versions_from_hierarchy_change(self)
826 826 end
827 827
828 828 def validate_parent
829 829 if @unallowed_parent_id
830 830 errors.add(:parent_id, :invalid)
831 831 elsif parent_id_changed?
832 832 unless parent.nil? || (parent.active? && move_possible?(parent))
833 833 errors.add(:parent_id, :invalid)
834 834 end
835 835 end
836 836 end
837 837
838 838 # Copies wiki from +project+
839 839 def copy_wiki(project)
840 840 # Check that the source project has a wiki first
841 841 unless project.wiki.nil?
842 842 wiki = self.wiki || Wiki.new
843 843 wiki.attributes = project.wiki.attributes.dup.except("id", "project_id")
844 844 wiki_pages_map = {}
845 845 project.wiki.pages.each do |page|
846 846 # Skip pages without content
847 847 next if page.content.nil?
848 848 new_wiki_content = WikiContent.new(page.content.attributes.dup.except("id", "page_id", "updated_on"))
849 849 new_wiki_page = WikiPage.new(page.attributes.dup.except("id", "wiki_id", "created_on", "parent_id"))
850 850 new_wiki_page.content = new_wiki_content
851 851 wiki.pages << new_wiki_page
852 852 wiki_pages_map[page.id] = new_wiki_page
853 853 end
854 854
855 855 self.wiki = wiki
856 856 wiki.save
857 857 # Reproduce page hierarchy
858 858 project.wiki.pages.each do |page|
859 859 if page.parent_id && wiki_pages_map[page.id]
860 860 wiki_pages_map[page.id].parent = wiki_pages_map[page.parent_id]
861 861 wiki_pages_map[page.id].save
862 862 end
863 863 end
864 864 end
865 865 end
866 866
867 867 # Copies versions from +project+
868 868 def copy_versions(project)
869 869 project.versions.each do |version|
870 870 new_version = Version.new
871 871 new_version.attributes = version.attributes.dup.except("id", "project_id", "created_on", "updated_on")
872 872 self.versions << new_version
873 873 end
874 874 end
875 875
876 876 # Copies issue categories from +project+
877 877 def copy_issue_categories(project)
878 878 project.issue_categories.each do |issue_category|
879 879 new_issue_category = IssueCategory.new
880 880 new_issue_category.attributes = issue_category.attributes.dup.except("id", "project_id")
881 881 self.issue_categories << new_issue_category
882 882 end
883 883 end
884 884
885 885 # Copies issues from +project+
886 886 def copy_issues(project)
887 887 # Stores the source issue id as a key and the copied issues as the
888 888 # value. Used to map the two together for issue relations.
889 889 issues_map = {}
890 890
891 891 # Store status and reopen locked/closed versions
892 892 version_statuses = versions.reject(&:open?).map {|version| [version, version.status]}
893 893 version_statuses.each do |version, status|
894 894 version.update_attribute :status, 'open'
895 895 end
896 896
897 897 # Get issues sorted by root_id, lft so that parent issues
898 898 # get copied before their children
899 899 project.issues.reorder('root_id, lft').each do |issue|
900 900 new_issue = Issue.new
901 901 new_issue.copy_from(issue, :subtasks => false, :link => false)
902 902 new_issue.project = self
903 903 # Changing project resets the custom field values
904 904 # TODO: handle this in Issue#project=
905 905 new_issue.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
906 906 # Reassign fixed_versions by name, since names are unique per project
907 907 if issue.fixed_version && issue.fixed_version.project == project
908 908 new_issue.fixed_version = self.versions.detect {|v| v.name == issue.fixed_version.name}
909 909 end
910 910 # Reassign version custom field values
911 911 new_issue.custom_field_values.each do |custom_value|
912 912 if custom_value.custom_field.field_format == 'version' && custom_value.value.present?
913 913 versions = Version.where(:id => custom_value.value).to_a
914 914 new_value = versions.map do |version|
915 915 if version.project == project
916 916 self.versions.detect {|v| v.name == version.name}.try(:id)
917 917 else
918 918 version.id
919 919 end
920 920 end
921 921 new_value.compact!
922 922 new_value = new_value.first unless custom_value.custom_field.multiple?
923 923 custom_value.value = new_value
924 924 end
925 925 end
926 926 # Reassign the category by name, since names are unique per project
927 927 if issue.category
928 928 new_issue.category = self.issue_categories.detect {|c| c.name == issue.category.name}
929 929 end
930 930 # Parent issue
931 931 if issue.parent_id
932 932 if copied_parent = issues_map[issue.parent_id]
933 933 new_issue.parent_issue_id = copied_parent.id
934 934 end
935 935 end
936 936
937 937 self.issues << new_issue
938 938 if new_issue.new_record?
939 939 logger.info "Project#copy_issues: issue ##{issue.id} could not be copied: #{new_issue.errors.full_messages}" if logger && logger.info?
940 940 else
941 941 issues_map[issue.id] = new_issue unless new_issue.new_record?
942 942 end
943 943 end
944 944
945 945 # Restore locked/closed version statuses
946 946 version_statuses.each do |version, status|
947 947 version.update_attribute :status, status
948 948 end
949 949
950 950 # Relations after in case issues related each other
951 951 project.issues.each do |issue|
952 952 new_issue = issues_map[issue.id]
953 953 unless new_issue
954 954 # Issue was not copied
955 955 next
956 956 end
957 957
958 958 # Relations
959 959 issue.relations_from.each do |source_relation|
960 960 new_issue_relation = IssueRelation.new
961 961 new_issue_relation.attributes = source_relation.attributes.dup.except("id", "issue_from_id", "issue_to_id")
962 962 new_issue_relation.issue_to = issues_map[source_relation.issue_to_id]
963 963 if new_issue_relation.issue_to.nil? && Setting.cross_project_issue_relations?
964 964 new_issue_relation.issue_to = source_relation.issue_to
965 965 end
966 966 new_issue.relations_from << new_issue_relation
967 967 end
968 968
969 969 issue.relations_to.each do |source_relation|
970 970 new_issue_relation = IssueRelation.new
971 971 new_issue_relation.attributes = source_relation.attributes.dup.except("id", "issue_from_id", "issue_to_id")
972 972 new_issue_relation.issue_from = issues_map[source_relation.issue_from_id]
973 973 if new_issue_relation.issue_from.nil? && Setting.cross_project_issue_relations?
974 974 new_issue_relation.issue_from = source_relation.issue_from
975 975 end
976 976 new_issue.relations_to << new_issue_relation
977 977 end
978 978 end
979 979 end
980 980
981 981 # Copies members from +project+
982 982 def copy_members(project)
983 983 # Copy users first, then groups to handle members with inherited and given roles
984 984 members_to_copy = []
985 985 members_to_copy += project.memberships.select {|m| m.principal.is_a?(User)}
986 986 members_to_copy += project.memberships.select {|m| !m.principal.is_a?(User)}
987 987
988 988 members_to_copy.each do |member|
989 989 new_member = Member.new
990 990 new_member.attributes = member.attributes.dup.except("id", "project_id", "created_on")
991 991 # only copy non inherited roles
992 992 # inherited roles will be added when copying the group membership
993 993 role_ids = member.member_roles.reject(&:inherited?).collect(&:role_id)
994 994 next if role_ids.empty?
995 995 new_member.role_ids = role_ids
996 996 new_member.project = self
997 997 self.members << new_member
998 998 end
999 999 end
1000 1000
1001 1001 # Copies queries from +project+
1002 1002 def copy_queries(project)
1003 1003 project.queries.each do |query|
1004 1004 new_query = IssueQuery.new
1005 1005 new_query.attributes = query.attributes.dup.except("id", "project_id", "sort_criteria", "user_id", "type")
1006 1006 new_query.sort_criteria = query.sort_criteria if query.sort_criteria
1007 1007 new_query.project = self
1008 1008 new_query.user_id = query.user_id
1009 1009 new_query.role_ids = query.role_ids if query.visibility == IssueQuery::VISIBILITY_ROLES
1010 1010 self.queries << new_query
1011 1011 end
1012 1012 end
1013 1013
1014 1014 # Copies boards from +project+
1015 1015 def copy_boards(project)
1016 1016 project.boards.each do |board|
1017 1017 new_board = Board.new
1018 1018 new_board.attributes = board.attributes.dup.except("id", "project_id", "topics_count", "messages_count", "last_message_id")
1019 1019 new_board.project = self
1020 1020 self.boards << new_board
1021 1021 end
1022 1022 end
1023 1023
1024 1024 def allowed_permissions
1025 1025 @allowed_permissions ||= begin
1026 1026 module_names = enabled_modules.loaded? ? enabled_modules.map(&:name) : enabled_modules.pluck(:name)
1027 1027 Redmine::AccessControl.modules_permissions(module_names).collect {|p| p.name}
1028 1028 end
1029 1029 end
1030 1030
1031 1031 def allowed_actions
1032 1032 @actions_allowed ||= allowed_permissions.inject([]) { |actions, permission| actions += Redmine::AccessControl.allowed_actions(permission) }.flatten
1033 1033 end
1034 1034
1035 1035 # Archives subprojects recursively
1036 1036 def archive!
1037 1037 children.each do |subproject|
1038 1038 subproject.send :archive!
1039 1039 end
1040 1040 update_attribute :status, STATUS_ARCHIVED
1041 1041 end
1042 1042 end
General Comments 0
You need to be logged in to leave comments. Login now