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