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