To check out this repository please hg clone the following URL, or open the URL using EasyMercurial or your preferred Mercurial client.

Statistics Download as Zip
| Branch: | Tag: | Revision:

root / app / models / issue.rb @ 956:fa2a1b6cda26

History | View | Annotate | Download (34.5 KB)

1
# Redmine - project management software
2
# Copyright (C) 2006-2011  Jean-Philippe Lang
3
#
4
# This program is free software; you can redistribute it and/or
5
# modify it under the terms of the GNU General Public License
6
# as published by the Free Software Foundation; either version 2
7
# of the License, or (at your option) any later version.
8
#
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
# GNU General Public License for more details.
13
#
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17

    
18
class Issue < ActiveRecord::Base
19
  include Redmine::SafeAttributes
20

    
21
  belongs_to :project
22
  belongs_to :tracker
23
  belongs_to :status, :class_name => 'IssueStatus', :foreign_key => 'status_id'
24
  belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
25
  belongs_to :assigned_to, :class_name => 'Principal', :foreign_key => 'assigned_to_id'
26
  belongs_to :fixed_version, :class_name => 'Version', :foreign_key => 'fixed_version_id'
27
  belongs_to :priority, :class_name => 'IssuePriority', :foreign_key => 'priority_id'
28
  belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'
29

    
30
  has_many :journals, :as => :journalized, :dependent => :destroy
31
  has_many :time_entries, :dependent => :delete_all
32
  has_and_belongs_to_many :changesets, :order => "#{Changeset.table_name}.committed_on ASC, #{Changeset.table_name}.id ASC"
33

    
34
  has_many :relations_from, :class_name => 'IssueRelation', :foreign_key => 'issue_from_id', :dependent => :delete_all
35
  has_many :relations_to, :class_name => 'IssueRelation', :foreign_key => 'issue_to_id', :dependent => :delete_all
36

    
37
  acts_as_nested_set :scope => 'root_id', :dependent => :destroy
38
  acts_as_attachable :after_add => :attachment_added, :after_remove => :attachment_removed
39
  acts_as_customizable
40
  acts_as_watchable
41
  acts_as_searchable :columns => ['subject', "#{table_name}.description", "#{Journal.table_name}.notes"],
42
                     :include => [:project, :journals],
43
                     # sort by id so that limited eager loading doesn't break with postgresql
44
                     :order_column => "#{table_name}.id"
45
  acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id} (#{o.status}): #{o.subject}"},
46
                :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}},
47
                :type => Proc.new {|o| 'issue' + (o.closed? ? ' closed' : '') }
48

    
49
  acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]},
50
                            :author_key => :author_id
51

    
52
  DONE_RATIO_OPTIONS = %w(issue_field issue_status)
53

    
54
  attr_reader :current_journal
55

    
56
  validates_presence_of :subject, :priority, :project, :tracker, :author, :status
57

    
58
  validates_length_of :subject, :maximum => 255
59
  validates_inclusion_of :done_ratio, :in => 0..100
60
  validates_numericality_of :estimated_hours, :allow_nil => true
61
  validate :validate_issue
62

    
63
  named_scope :visible, lambda {|*args| { :include => :project,
64
                                          :conditions => Issue.visible_condition(args.shift || User.current, *args) } }
65

    
66
  named_scope :open, :conditions => ["#{IssueStatus.table_name}.is_closed = ?", false], :include => :status
67

    
68
  named_scope :recently_updated, :order => "#{Issue.table_name}.updated_on DESC"
69
  named_scope :with_limit, lambda { |limit| { :limit => limit} }
70
  named_scope :on_active_project, :include => [:status, :project, :tracker],
71
                                  :conditions => ["#{Project.table_name}.status=#{Project::STATUS_ACTIVE}"]
72

    
73
  named_scope :without_version, lambda {
74
    {
75
      :conditions => { :fixed_version_id => nil}
76
    }
77
  }
78

    
79
  named_scope :with_query, lambda {|query|
80
    {
81
      :conditions => Query.merge_conditions(query.statement)
82
    }
83
  }
84

    
85
  before_create :default_assign
86
  before_save :close_duplicates, :update_done_ratio_from_issue_status
87
  after_save :reschedule_following_issues, :update_nested_set_attributes, :update_parent_attributes, :create_journal
88
  after_destroy :update_parent_attributes
89

    
90
  # Returns a SQL conditions string used to find all issues visible by the specified user
91
  def self.visible_condition(user, options={})
92
    Project.allowed_to_condition(user, :view_issues, options) do |role, user|
93
      case role.issues_visibility
94
      when 'all'
95
        nil
96
      when 'default'
97
        user_ids = [user.id] + user.groups.map(&:id)
98
        "(#{table_name}.is_private = #{connection.quoted_false} OR #{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
99
      when 'own'
100
        user_ids = [user.id] + user.groups.map(&:id)
101
        "(#{table_name}.author_id = #{user.id} OR #{table_name}.assigned_to_id IN (#{user_ids.join(',')}))"
102
      else
103
        '1=0'
104
      end
105
    end
106
  end
107

    
108
  # Returns true if usr or current user is allowed to view the issue
109
  def visible?(usr=nil)
110
    (usr || User.current).allowed_to?(:view_issues, self.project) do |role, user|
111
      case role.issues_visibility
112
      when 'all'
113
        true
114
      when 'default'
115
        !self.is_private? || self.author == user || user.is_or_belongs_to?(assigned_to)
116
      when 'own'
117
        self.author == user || user.is_or_belongs_to?(assigned_to)
118
      else
119
        false
120
      end
121
    end
122
  end
123

    
124
  def after_initialize
125
    if new_record?
126
      # set default values for new records only
127
      self.status ||= IssueStatus.default
128
      self.priority ||= IssuePriority.default
129
    end
130
  end
131

    
132
  # Overrides Redmine::Acts::Customizable::InstanceMethods#available_custom_fields
133
  def available_custom_fields
134
    (project && tracker) ? (project.all_issue_custom_fields & tracker.custom_fields.all) : []
135
  end
136

    
137
  def copy_from(arg)
138
    issue = arg.is_a?(Issue) ? arg : Issue.visible.find(arg)
139
    self.attributes = issue.attributes.dup.except("id", "root_id", "parent_id", "lft", "rgt", "created_on", "updated_on")
140
    self.custom_field_values = issue.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
141
    self.status = issue.status
142
    self
143
  end
144

    
145
  # Moves/copies an issue to a new project and tracker
146
  # Returns the moved/copied issue on success, false on failure
147
  def move_to_project(*args)
148
    ret = Issue.transaction do
149
      move_to_project_without_transaction(*args) || raise(ActiveRecord::Rollback)
150
    end || false
151
  end
152

    
153
  def move_to_project_without_transaction(new_project, new_tracker = nil, options = {})
154
    options ||= {}
155
    issue = options[:copy] ? self.class.new.copy_from(self) : self
156

    
157
    if new_project && issue.project_id != new_project.id
158
      # delete issue relations
159
      unless Setting.cross_project_issue_relations?
160
        issue.relations_from.clear
161
        issue.relations_to.clear
162
      end
163
      # issue is moved to another project
164
      # reassign to the category with same name if any
165
      new_category = issue.category.nil? ? nil : new_project.issue_categories.find_by_name(issue.category.name)
166
      issue.category = new_category
167
      # Keep the fixed_version if it's still valid in the new_project
168
      unless new_project.shared_versions.include?(issue.fixed_version)
169
        issue.fixed_version = nil
170
      end
171
      issue.project = new_project
172
      if issue.parent && issue.parent.project_id != issue.project_id
173
        issue.parent_issue_id = nil
174
      end
175
    end
176
    if new_tracker
177
      issue.tracker = new_tracker
178
      issue.reset_custom_values!
179
    end
180
    if options[:copy]
181
      issue.author = User.current
182
      issue.custom_field_values = self.custom_field_values.inject({}) {|h,v| h[v.custom_field_id] = v.value; h}
183
      issue.status = if options[:attributes] && options[:attributes][:status_id]
184
                       IssueStatus.find_by_id(options[:attributes][:status_id])
185
                     else
186
                       self.status
187
                     end
188
    end
189
    # Allow bulk setting of attributes on the issue
190
    if options[:attributes]
191
      issue.attributes = options[:attributes]
192
    end
193
    if issue.save
194
      if options[:copy]
195
        if current_journal && current_journal.notes.present?
196
          issue.init_journal(current_journal.user, current_journal.notes)
197
          issue.current_journal.notify = false
198
          issue.save
199
        end
200
      else
201
        # Manually update project_id on related time entries
202
        TimeEntry.update_all("project_id = #{new_project.id}", {:issue_id => id})
203

    
204
        issue.children.each do |child|
205
          unless child.move_to_project_without_transaction(new_project)
206
            # Move failed and transaction was rollback'd
207
            return false
208
          end
209
        end
210
      end
211
    else
212
      return false
213
    end
214
    issue
215
  end
216

    
217
  def status_id=(sid)
218
    self.status = nil
219
    write_attribute(:status_id, sid)
220
  end
221

    
222
  def priority_id=(pid)
223
    self.priority = nil
224
    write_attribute(:priority_id, pid)
225
  end
226

    
227
  def tracker_id=(tid)
228
    self.tracker = nil
229
    result = write_attribute(:tracker_id, tid)
230
    @custom_field_values = nil
231
    result
232
  end
233

    
234
  def description=(arg)
235
    if arg.is_a?(String)
236
      arg = arg.gsub(/(\r\n|\n|\r)/, "\r\n")
237
    end
238
    write_attribute(:description, arg)
239
  end
240

    
241
  # Overrides attributes= so that tracker_id gets assigned first
242
  def attributes_with_tracker_first=(new_attributes, *args)
243
    return if new_attributes.nil?
244
    new_tracker_id = new_attributes['tracker_id'] || new_attributes[:tracker_id]
245
    if new_tracker_id
246
      self.tracker_id = new_tracker_id
247
    end
248
    send :attributes_without_tracker_first=, new_attributes, *args
249
  end
250
  # Do not redefine alias chain on reload (see #4838)
251
  alias_method_chain(:attributes=, :tracker_first) unless method_defined?(:attributes_without_tracker_first=)
252

    
253
  def estimated_hours=(h)
254
    write_attribute :estimated_hours, (h.is_a?(String) ? h.to_hours : h)
255
  end
256

    
257
  safe_attributes 'tracker_id',
258
    'status_id',
259
    'parent_issue_id',
260
    'category_id',
261
    'assigned_to_id',
262
    'priority_id',
263
    'fixed_version_id',
264
    'subject',
265
    'description',
266
    'start_date',
267
    'due_date',
268
    'done_ratio',
269
    'estimated_hours',
270
    'custom_field_values',
271
    'custom_fields',
272
    'lock_version',
273
    :if => lambda {|issue, user| issue.new_record? || user.allowed_to?(:edit_issues, issue.project) }
274

    
275
  safe_attributes 'status_id',
276
    'assigned_to_id',
277
    'fixed_version_id',
278
    'done_ratio',
279
    :if => lambda {|issue, user| issue.new_statuses_allowed_to(user).any? }
280

    
281
  safe_attributes 'is_private',
282
    :if => lambda {|issue, user|
283
      user.allowed_to?(:set_issues_private, issue.project) ||
284
        (issue.author == user && user.allowed_to?(:set_own_issues_private, issue.project))
285
    }
286

    
287
  # Safely sets attributes
288
  # Should be called from controllers instead of #attributes=
289
  # attr_accessible is too rough because we still want things like
290
  # Issue.new(:project => foo) to work
291
  # TODO: move workflow/permission checks from controllers to here
292
  def safe_attributes=(attrs, user=User.current)
293
    return unless attrs.is_a?(Hash)
294

    
295
    # User can change issue attributes only if he has :edit permission or if a workflow transition is allowed
296
    attrs = delete_unsafe_attributes(attrs, user)
297
    return if attrs.empty?
298

    
299
    # Tracker must be set before since new_statuses_allowed_to depends on it.
300
    if t = attrs.delete('tracker_id')
301
      self.tracker_id = t
302
    end
303

    
304
    if attrs['status_id']
305
      unless new_statuses_allowed_to(user).collect(&:id).include?(attrs['status_id'].to_i)
306
        attrs.delete('status_id')
307
      end
308
    end
309

    
310
    unless leaf?
311
      attrs.reject! {|k,v| %w(priority_id done_ratio start_date due_date estimated_hours).include?(k)}
312
    end
313

    
314
    if attrs.has_key?('parent_issue_id')
315
      if !user.allowed_to?(:manage_subtasks, project)
316
        attrs.delete('parent_issue_id')
317
      elsif !attrs['parent_issue_id'].blank?
318
        attrs.delete('parent_issue_id') unless Issue.visible(user).exists?(attrs['parent_issue_id'].to_i)
319
      end
320
    end
321

    
322
    self.attributes = attrs
323
  end
324

    
325
  def done_ratio
326
    if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
327
      status.default_done_ratio
328
    else
329
      read_attribute(:done_ratio)
330
    end
331
  end
332

    
333
  def self.use_status_for_done_ratio?
334
    Setting.issue_done_ratio == 'issue_status'
335
  end
336

    
337
  def self.use_field_for_done_ratio?
338
    Setting.issue_done_ratio == 'issue_field'
339
  end
340

    
341
  def validate_issue
342
    if self.due_date.nil? && @attributes['due_date'] && !@attributes['due_date'].empty?
343
      errors.add :due_date, :not_a_date
344
    end
345

    
346
    if self.due_date and self.start_date and self.due_date < self.start_date
347
      errors.add :due_date, :greater_than_start_date
348
    end
349

    
350
    if start_date && soonest_start && start_date < soonest_start
351
      errors.add :start_date, :invalid
352
    end
353

    
354
    if fixed_version
355
      if !assignable_versions.include?(fixed_version)
356
        errors.add :fixed_version_id, :inclusion
357
      elsif reopened? && fixed_version.closed?
358
        errors.add :base, I18n.t(:error_can_not_reopen_issue_on_closed_version)
359
      end
360
    end
361

    
362
    # Checks that the issue can not be added/moved to a disabled tracker
363
    if project && (tracker_id_changed? || project_id_changed?)
364
      unless project.trackers.include?(tracker)
365
        errors.add :tracker_id, :inclusion
366
      end
367
    end
368

    
369
    # Checks parent issue assignment
370
    if @parent_issue
371
      if @parent_issue.project_id != project_id
372
        errors.add :parent_issue_id, :not_same_project
373
      elsif !new_record?
374
        # moving an existing issue
375
        if @parent_issue.root_id != root_id
376
          # we can always move to another tree
377
        elsif move_possible?(@parent_issue)
378
          # move accepted inside tree
379
        else
380
          errors.add :parent_issue_id, :not_a_valid_parent
381
        end
382
      end
383
    end
384
  end
385

    
386
  # Set the done_ratio using the status if that setting is set.  This will keep the done_ratios
387
  # even if the user turns off the setting later
388
  def update_done_ratio_from_issue_status
389
    if Issue.use_status_for_done_ratio? && status && status.default_done_ratio
390
      self.done_ratio = status.default_done_ratio
391
    end
392
  end
393

    
394
  def init_journal(user, notes = "")
395
    @current_journal ||= Journal.new(:journalized => self, :user => user, :notes => notes)
396
    @issue_before_change = self.clone
397
    @issue_before_change.status = self.status
398
    @custom_values_before_change = {}
399
    self.custom_values.each {|c| @custom_values_before_change.store c.custom_field_id, c.value }
400
    # Make sure updated_on is updated when adding a note.
401
    updated_on_will_change!
402
    @current_journal
403
  end
404

    
405
  # Return true if the issue is closed, otherwise false
406
  def closed?
407
    self.status.is_closed?
408
  end
409

    
410
  # Return true if the issue is being reopened
411
  def reopened?
412
    if !new_record? && status_id_changed?
413
      status_was = IssueStatus.find_by_id(status_id_was)
414
      status_new = IssueStatus.find_by_id(status_id)
415
      if status_was && status_new && status_was.is_closed? && !status_new.is_closed?
416
        return true
417
      end
418
    end
419
    false
420
  end
421

    
422
  # Return true if the issue is being closed
423
  def closing?
424
    if !new_record? && status_id_changed?
425
      status_was = IssueStatus.find_by_id(status_id_was)
426
      status_new = IssueStatus.find_by_id(status_id)
427
      if status_was && status_new && !status_was.is_closed? && status_new.is_closed?
428
        return true
429
      end
430
    end
431
    false
432
  end
433

    
434
  # Returns true if the issue is overdue
435
  def overdue?
436
    !due_date.nil? && (due_date < Date.today) && !status.is_closed?
437
  end
438

    
439
  # Is the amount of work done less than it should for the due date
440
  def behind_schedule?
441
    return false if start_date.nil? || due_date.nil?
442
    done_date = start_date + ((due_date - start_date+1)* done_ratio/100).floor
443
    return done_date <= Date.today
444
  end
445

    
446
  # Does this issue have children?
447
  def children?
448
    !leaf?
449
  end
450

    
451
  # Users the issue can be assigned to
452
  def assignable_users
453
    users = project.assignable_users
454
    users << author if author
455
    users << assigned_to if assigned_to
456
    users.uniq.sort
457
  end
458

    
459
  # Versions that the issue can be assigned to
460
  def assignable_versions
461
    @assignable_versions ||= (project.shared_versions.open + [Version.find_by_id(fixed_version_id_was)]).compact.uniq.sort
462
  end
463

    
464
  # Returns true if this issue is blocked by another issue that is still open
465
  def blocked?
466
    !relations_to.detect {|ir| ir.relation_type == 'blocks' && !ir.issue_from.closed?}.nil?
467
  end
468

    
469
  # Returns an array of status that user is able to apply
470
  def new_statuses_allowed_to(user, include_default=false)
471
    statuses = status.find_new_statuses_allowed_to(
472
      user.roles_for_project(project),
473
      tracker,
474
      author == user,
475
      assigned_to_id_changed? ? assigned_to_id_was == user.id : assigned_to_id == user.id
476
      )
477
    statuses << status unless statuses.empty?
478
    statuses << IssueStatus.default if include_default
479
    statuses = statuses.uniq.sort
480
    blocked? ? statuses.reject {|s| s.is_closed?} : statuses
481
  end
482

    
483
  # Returns the mail adresses of users that should be notified
484
  def recipients
485
    notified = project.notified_users
486
    # Author and assignee are always notified unless they have been
487
    # locked or don't want to be notified
488
    notified << author if author && author.active? && author.notify_about?(self)
489
    if assigned_to
490
      if assigned_to.is_a?(Group)
491
        notified += assigned_to.users.select {|u| u.active? && u.notify_about?(self)}
492
      else
493
        notified << assigned_to if assigned_to.active? && assigned_to.notify_about?(self)
494
      end
495
    end
496
    notified.uniq!
497
    # Remove users that can not view the issue
498
    notified.reject! {|user| !visible?(user)}
499
    notified.collect(&:mail)
500
  end
501

    
502
  # Returns the total number of hours spent on this issue and its descendants
503
  #
504
  # Example:
505
  #   spent_hours => 0.0
506
  #   spent_hours => 50.2
507
  def spent_hours
508
    @spent_hours ||= self_and_descendants.sum("#{TimeEntry.table_name}.hours", :include => :time_entries).to_f || 0.0
509
  end
510

    
511
  def relations
512
    @relations ||= (relations_from + relations_to).sort
513
  end
514

    
515
  # Preloads relations for a collection of issues
516
  def self.load_relations(issues)
517
    if issues.any?
518
      relations = IssueRelation.all(:conditions => ["issue_from_id IN (:ids) OR issue_to_id IN (:ids)", {:ids => issues.map(&:id)}])
519
      issues.each do |issue|
520
        issue.instance_variable_set "@relations", relations.select {|r| r.issue_from_id == issue.id || r.issue_to_id == issue.id}
521
      end
522
    end
523
  end
524

    
525
  # Finds an issue relation given its id.
526
  def find_relation(relation_id)
527
    IssueRelation.find(relation_id, :conditions => ["issue_to_id = ? OR issue_from_id = ?", id, id])
528
  end
529

    
530
  def all_dependent_issues(except=[])
531
    except << self
532
    dependencies = []
533
    relations_from.each do |relation|
534
      if relation.issue_to && !except.include?(relation.issue_to)
535
        dependencies << relation.issue_to
536
        dependencies += relation.issue_to.all_dependent_issues(except)
537
      end
538
    end
539
    dependencies
540
  end
541

    
542
  # Returns an array of issues that duplicate this one
543
  def duplicates
544
    relations_to.select {|r| r.relation_type == IssueRelation::TYPE_DUPLICATES}.collect {|r| r.issue_from}
545
  end
546

    
547
  # Returns the due date or the target due date if any
548
  # Used on gantt chart
549
  def due_before
550
    due_date || (fixed_version ? fixed_version.effective_date : nil)
551
  end
552

    
553
  # Returns the time scheduled for this issue.
554
  #
555
  # Example:
556
  #   Start Date: 2/26/09, End Date: 3/04/09
557
  #   duration => 6
558
  def duration
559
    (start_date && due_date) ? due_date - start_date : 0
560
  end
561

    
562
  def soonest_start
563
    @soonest_start ||= (
564
        relations_to.collect{|relation| relation.successor_soonest_start} +
565
        ancestors.collect(&:soonest_start)
566
      ).compact.max
567
  end
568

    
569
  def reschedule_after(date)
570
    return if date.nil?
571
    if leaf?
572
      if start_date.nil? || start_date < date
573
        self.start_date, self.due_date = date, date + duration
574
        save
575
      end
576
    else
577
      leaves.each do |leaf|
578
        leaf.reschedule_after(date)
579
      end
580
    end
581
  end
582

    
583
  def <=>(issue)
584
    if issue.nil?
585
      -1
586
    elsif root_id != issue.root_id
587
      (root_id || 0) <=> (issue.root_id || 0)
588
    else
589
      (lft || 0) <=> (issue.lft || 0)
590
    end
591
  end
592

    
593
  def to_s
594
    "#{tracker} ##{id}: #{subject}"
595
  end
596

    
597
  # Returns a string of css classes that apply to the issue
598
  def css_classes
599
    s = "issue status-#{status.position} "
600
    s << "priority-#{priority.position}"
601
    s << ' closed' if closed?
602
    s << ' overdue' if overdue?
603
    s << ' child' if child?
604
    s << ' parent' unless leaf?
605
    s << ' private' if is_private?
606
    s << ' created-by-me' if User.current.logged? && author_id == User.current.id
607
    s << ' assigned-to-me' if User.current.logged? && assigned_to_id == User.current.id
608
    s
609
  end
610

    
611
  # Saves an issue, time_entry, attachments, and a journal from the parameters
612
  # Returns false if save fails
613
  def save_issue_with_child_records(params, existing_time_entry=nil)
614
    Issue.transaction do
615
      if params[:time_entry] && (params[:time_entry][:hours].present? || params[:time_entry][:comments].present?) && User.current.allowed_to?(:log_time, project)
616
        @time_entry = existing_time_entry || TimeEntry.new
617
        @time_entry.project = project
618
        @time_entry.issue = self
619
        @time_entry.user = User.current
620
        @time_entry.spent_on = User.current.today
621
        @time_entry.attributes = params[:time_entry]
622
        self.time_entries << @time_entry
623
      end
624

    
625
      if valid?
626
        attachments = Attachment.attach_files(self, params[:attachments])
627
        # TODO: Rename hook
628
        Redmine::Hook.call_hook(:controller_issues_edit_before_save, { :params => params, :issue => self, :time_entry => @time_entry, :journal => @current_journal})
629
        begin
630
          if save
631
            # TODO: Rename hook
632
            Redmine::Hook.call_hook(:controller_issues_edit_after_save, { :params => params, :issue => self, :time_entry => @time_entry, :journal => @current_journal})
633
          else
634
            raise ActiveRecord::Rollback
635
          end
636
        rescue ActiveRecord::StaleObjectError
637
          attachments[:files].each(&:destroy)
638
          errors.add :base, l(:notice_locking_conflict)
639
          raise ActiveRecord::Rollback
640
        end
641
      end
642
    end
643
  end
644

    
645
  # Unassigns issues from +version+ if it's no longer shared with issue's project
646
  def self.update_versions_from_sharing_change(version)
647
    # Update issues assigned to the version
648
    update_versions(["#{Issue.table_name}.fixed_version_id = ?", version.id])
649
  end
650

    
651
  # Unassigns issues from versions that are no longer shared
652
  # after +project+ was moved
653
  def self.update_versions_from_hierarchy_change(project)
654
    moved_project_ids = project.self_and_descendants.reload.collect(&:id)
655
    # Update issues of the moved projects and issues assigned to a version of a moved project
656
    Issue.update_versions(["#{Version.table_name}.project_id IN (?) OR #{Issue.table_name}.project_id IN (?)", moved_project_ids, moved_project_ids])
657
  end
658

    
659
  def parent_issue_id=(arg)
660
    parent_issue_id = arg.blank? ? nil : arg.to_i
661
    if parent_issue_id && @parent_issue = Issue.find_by_id(parent_issue_id)
662
      @parent_issue.id
663
    else
664
      @parent_issue = nil
665
      nil
666
    end
667
  end
668

    
669
  def parent_issue_id
670
    if instance_variable_defined? :@parent_issue
671
      @parent_issue.nil? ? nil : @parent_issue.id
672
    else
673
      parent_id
674
    end
675
  end
676

    
677
  # Extracted from the ReportsController.
678
  def self.by_tracker(project)
679
    count_and_group_by(:project => project,
680
                       :field => 'tracker_id',
681
                       :joins => Tracker.table_name)
682
  end
683

    
684
  def self.by_version(project)
685
    count_and_group_by(:project => project,
686
                       :field => 'fixed_version_id',
687
                       :joins => Version.table_name)
688
  end
689

    
690
  def self.by_priority(project)
691
    count_and_group_by(:project => project,
692
                       :field => 'priority_id',
693
                       :joins => IssuePriority.table_name)
694
  end
695

    
696
  def self.by_category(project)
697
    count_and_group_by(:project => project,
698
                       :field => 'category_id',
699
                       :joins => IssueCategory.table_name)
700
  end
701

    
702
  def self.by_assigned_to(project)
703
    count_and_group_by(:project => project,
704
                       :field => 'assigned_to_id',
705
                       :joins => User.table_name)
706
  end
707

    
708
  def self.by_author(project)
709
    count_and_group_by(:project => project,
710
                       :field => 'author_id',
711
                       :joins => User.table_name)
712
  end
713

    
714
  def self.by_subproject(project)
715
    ActiveRecord::Base.connection.select_all("select    s.id as status_id, 
716
                                                s.is_closed as closed, 
717
                                                #{Issue.table_name}.project_id as project_id,
718
                                                count(#{Issue.table_name}.id) as total 
719
                                              from 
720
                                                #{Issue.table_name}, #{Project.table_name}, #{IssueStatus.table_name} s
721
                                              where 
722
                                                #{Issue.table_name}.status_id=s.id
723
                                                and #{Issue.table_name}.project_id = #{Project.table_name}.id
724
                                                and #{visible_condition(User.current, :project => project, :with_subprojects => true)}
725
                                                and #{Issue.table_name}.project_id <> #{project.id}
726
                                              group by s.id, s.is_closed, #{Issue.table_name}.project_id") if project.descendants.active.any?
727
  end
728
  # End ReportsController extraction
729

    
730
  # Returns an array of projects that current user can move issues to
731
  def self.allowed_target_projects_on_move
732
    projects = []
733
    if User.current.admin?
734
      # admin is allowed to move issues to any active (visible) project
735
      projects = Project.visible.all
736
    elsif User.current.logged?
737
      if Role.non_member.allowed_to?(:move_issues)
738
        projects = Project.visible.all
739
      else
740
        User.current.memberships.each {|m| projects << m.project if m.roles.detect {|r| r.allowed_to?(:move_issues)}}
741
      end
742
    end
743
    projects
744
  end
745

    
746
  private
747

    
748
  def update_nested_set_attributes
749
    if root_id.nil?
750
      # issue was just created
751
      self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id)
752
      set_default_left_and_right
753
      Issue.update_all("root_id = #{root_id}, lft = #{lft}, rgt = #{rgt}", ["id = ?", id])
754
      if @parent_issue
755
        move_to_child_of(@parent_issue)
756
      end
757
      reload
758
    elsif parent_issue_id != parent_id
759
      former_parent_id = parent_id
760
      # moving an existing issue
761
      if @parent_issue && @parent_issue.root_id == root_id
762
        # inside the same tree
763
        move_to_child_of(@parent_issue)
764
      else
765
        # to another tree
766
        unless root?
767
          move_to_right_of(root)
768
          reload
769
        end
770
        old_root_id = root_id
771
        self.root_id = (@parent_issue.nil? ? id : @parent_issue.root_id )
772
        target_maxright = nested_set_scope.maximum(right_column_name) || 0
773
        offset = target_maxright + 1 - lft
774
        Issue.update_all("root_id = #{root_id}, lft = lft + #{offset}, rgt = rgt + #{offset}",
775
                          ["root_id = ? AND lft >= ? AND rgt <= ? ", old_root_id, lft, rgt])
776
        self[left_column_name] = lft + offset
777
        self[right_column_name] = rgt + offset
778
        if @parent_issue
779
          move_to_child_of(@parent_issue)
780
        end
781
      end
782
      reload
783
      # delete invalid relations of all descendants
784
      self_and_descendants.each do |issue|
785
        issue.relations.each do |relation|
786
          relation.destroy unless relation.valid?
787
        end
788
      end
789
      # update former parent
790
      recalculate_attributes_for(former_parent_id) if former_parent_id
791
    end
792
    remove_instance_variable(:@parent_issue) if instance_variable_defined?(:@parent_issue)
793
  end
794

    
795
  def update_parent_attributes
796
    recalculate_attributes_for(parent_id) if parent_id
797
  end
798

    
799
  def recalculate_attributes_for(issue_id)
800
    if issue_id && p = Issue.find_by_id(issue_id)
801
      # priority = highest priority of children
802
      if priority_position = p.children.maximum("#{IssuePriority.table_name}.position", :include => :priority)
803
        p.priority = IssuePriority.find_by_position(priority_position)
804
      end
805

    
806
      # start/due dates = lowest/highest dates of children
807
      p.start_date = p.children.minimum(:start_date)
808
      p.due_date = p.children.maximum(:due_date)
809
      if p.start_date && p.due_date && p.due_date < p.start_date
810
        p.start_date, p.due_date = p.due_date, p.start_date
811
      end
812

    
813
      # done ratio = weighted average ratio of leaves
814
      unless Issue.use_status_for_done_ratio? && p.status && p.status.default_done_ratio
815
        leaves_count = p.leaves.count
816
        if leaves_count > 0
817
          average = p.leaves.average(:estimated_hours).to_f
818
          if average == 0
819
            average = 1
820
          end
821
          done = p.leaves.sum("COALESCE(estimated_hours, #{average}) * (CASE WHEN is_closed = #{connection.quoted_true} THEN 100 ELSE COALESCE(done_ratio, 0) END)", :include => :status).to_f
822
          progress = done / (average * leaves_count)
823
          p.done_ratio = progress.round
824
        end
825
      end
826

    
827
      # estimate = sum of leaves estimates
828
      p.estimated_hours = p.leaves.sum(:estimated_hours).to_f
829
      p.estimated_hours = nil if p.estimated_hours == 0.0
830

    
831
      # ancestors will be recursively updated
832
      p.save(false)
833
    end
834
  end
835

    
836
  # Update issues so their versions are not pointing to a
837
  # fixed_version that is not shared with the issue's project
838
  def self.update_versions(conditions=nil)
839
    # Only need to update issues with a fixed_version from
840
    # a different project and that is not systemwide shared
841
    Issue.all(:conditions => merge_conditions("#{Issue.table_name}.fixed_version_id IS NOT NULL" +
842
                                                " AND #{Issue.table_name}.project_id <> #{Version.table_name}.project_id" +
843
                                                " AND #{Version.table_name}.sharing <> 'system'",
844
                                                conditions),
845
              :include => [:project, :fixed_version]
846
              ).each do |issue|
847
      next if issue.project.nil? || issue.fixed_version.nil?
848
      unless issue.project.shared_versions.include?(issue.fixed_version)
849
        issue.init_journal(User.current)
850
        issue.fixed_version = nil
851
        issue.save
852
      end
853
    end
854
  end
855

    
856
  # Callback on attachment deletion
857
  def attachment_added(obj)
858
    if @current_journal && !obj.new_record?
859
      @current_journal.details << JournalDetail.new(:property => 'attachment', :prop_key => obj.id, :value => obj.filename)
860
    end
861
  end
862

    
863
  # Callback on attachment deletion
864
  def attachment_removed(obj)
865
    journal = init_journal(User.current)
866
    journal.details << JournalDetail.new(:property => 'attachment',
867
                                         :prop_key => obj.id,
868
                                         :old_value => obj.filename)
869
    journal.save
870
  end
871

    
872
  # Default assignment based on category
873
  def default_assign
874
    if assigned_to.nil? && category && category.assigned_to
875
      self.assigned_to = category.assigned_to
876
    end
877
  end
878

    
879
  # Updates start/due dates of following issues
880
  def reschedule_following_issues
881
    if start_date_changed? || due_date_changed?
882
      relations_from.each do |relation|
883
        relation.set_issue_to_dates
884
      end
885
    end
886
  end
887

    
888
  # Closes duplicates if the issue is being closed
889
  def close_duplicates
890
    if closing?
891
      duplicates.each do |duplicate|
892
        # Reload is need in case the duplicate was updated by a previous duplicate
893
        duplicate.reload
894
        # Don't re-close it if it's already closed
895
        next if duplicate.closed?
896
        # Same user and notes
897
        if @current_journal
898
          duplicate.init_journal(@current_journal.user, @current_journal.notes)
899
        end
900
        duplicate.update_attribute :status, self.status
901
      end
902
    end
903
  end
904

    
905
  # Saves the changes in a Journal
906
  # Called after_save
907
  def create_journal
908
    if @current_journal
909
      # attributes changes
910
      (Issue.column_names - %w(id root_id lft rgt lock_version created_on updated_on)).each {|c|
911
        before = @issue_before_change.send(c)
912
        after = send(c)
913
        next if before == after || (before.blank? && after.blank?)
914
        @current_journal.details << JournalDetail.new(:property => 'attr',
915
                                                      :prop_key => c,
916
                                                      :old_value => @issue_before_change.send(c),
917
                                                      :value => send(c))
918
      }
919
      # custom fields changes
920
      custom_values.each {|c|
921
        next if (@custom_values_before_change[c.custom_field_id]==c.value ||
922
                  (@custom_values_before_change[c.custom_field_id].blank? && c.value.blank?))
923
        @current_journal.details << JournalDetail.new(:property => 'cf',
924
                                                      :prop_key => c.custom_field_id,
925
                                                      :old_value => @custom_values_before_change[c.custom_field_id],
926
                                                      :value => c.value)
927
      }
928
      @current_journal.save
929
      # reset current journal
930
      init_journal @current_journal.user, @current_journal.notes
931
    end
932
  end
933

    
934
  # Query generator for selecting groups of issue counts for a project
935
  # based on specific criteria
936
  #
937
  # Options
938
  # * project - Project to search in.
939
  # * field - String. Issue field to key off of in the grouping.
940
  # * joins - String. The table name to join against.
941
  def self.count_and_group_by(options)
942
    project = options.delete(:project)
943
    select_field = options.delete(:field)
944
    joins = options.delete(:joins)
945

    
946
    where = "#{Issue.table_name}.#{select_field}=j.id"
947

    
948
    ActiveRecord::Base.connection.select_all("select    s.id as status_id, 
949
                                                s.is_closed as closed, 
950
                                                j.id as #{select_field},
951
                                                count(#{Issue.table_name}.id) as total 
952
                                              from 
953
                                                  #{Issue.table_name}, #{Project.table_name}, #{IssueStatus.table_name} s, #{joins} j
954
                                              where 
955
                                                #{Issue.table_name}.status_id=s.id 
956
                                                and #{where}
957
                                                and #{Issue.table_name}.project_id=#{Project.table_name}.id
958
                                                and #{visible_condition(User.current, :project => project)}
959
                                              group by s.id, s.is_closed, j.id")
960
  end
961
end