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