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