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