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