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 IssueRelation < ActiveRecord::Base
19 belongs_to :issue_from, :class_name => 'Issue', :foreign_key => 'issue_from_id'
20 belongs_to :issue_to, :class_name => 'Issue', :foreign_key => 'issue_to_id'
21
22 TYPE_RELATES = "relates"
23 TYPE_DUPLICATES = "duplicates"
24 TYPE_DUPLICATED = "duplicated"
25 TYPE_BLOCKS = "blocks"
26 TYPE_BLOCKED = "blocked"
27 TYPE_PRECEDES = "precedes"
28 TYPE_FOLLOWS = "follows"
29
30 TYPES = { TYPE_RELATES => { :name => :label_relates_to, :sym_name => :label_relates_to, :order => 1, :sym => TYPE_RELATES },
31 TYPE_DUPLICATES => { :name => :label_duplicates, :sym_name => :label_duplicated_by, :order => 2, :sym => TYPE_DUPLICATED },
32 TYPE_DUPLICATED => { :name => :label_duplicated_by, :sym_name => :label_duplicates, :order => 3, :sym => TYPE_DUPLICATES, :reverse => TYPE_DUPLICATES },
33 TYPE_BLOCKS => { :name => :label_blocks, :sym_name => :label_blocked_by, :order => 4, :sym => TYPE_BLOCKED },
34 TYPE_BLOCKED => { :name => :label_blocked_by, :sym_name => :label_blocks, :order => 5, :sym => TYPE_BLOCKS, :reverse => TYPE_BLOCKS },
35 TYPE_PRECEDES => { :name => :label_precedes, :sym_name => :label_follows, :order => 6, :sym => TYPE_FOLLOWS },
36 TYPE_FOLLOWS => { :name => :label_follows, :sym_name => :label_precedes, :order => 7, :sym => TYPE_PRECEDES, :reverse => TYPE_PRECEDES }
37 }.freeze
38
39 validates_presence_of :issue_from, :issue_to, :relation_type
40 validates_inclusion_of :relation_type, :in => TYPES.keys
41 validates_numericality_of :delay, :allow_nil => true
42 validates_uniqueness_of :issue_to_id, :scope => :issue_from_id
43
44 validate :validate_issue_relation
45
46 attr_protected :issue_from_id, :issue_to_id
47
48 before_save :handle_issue_order
49
50 def visible?(user=User.current)
51 (issue_from.nil? || issue_from.visible?(user)) && (issue_to.nil? || issue_to.visible?(user))
52 end
53
54 def deletable?(user=User.current)
55 visible?(user) &&
56 ((issue_from.nil? || user.allowed_to?(:manage_issue_relations, issue_from.project)) ||
57 (issue_to.nil? || user.allowed_to?(:manage_issue_relations, issue_to.project)))
58 end
59
60 def initialize(attributes=nil, *args)
61 super
62 if new_record?
63 if relation_type.blank?
64 self.relation_type = IssueRelation::TYPE_RELATES
65 end
66 end
67 end
68
69 def validate_issue_relation
70 if issue_from && issue_to
71 errors.add :issue_to_id, :invalid if issue_from_id == issue_to_id
72 errors.add :issue_to_id, :not_same_project unless issue_from.project_id == issue_to.project_id || Setting.cross_project_issue_relations?
73 #detect circular dependencies depending wether the relation should be reversed
74 if TYPES.has_key?(relation_type) && TYPES[relation_type][:reverse]
75 errors.add :base, :circular_dependency if issue_from.all_dependent_issues.include? issue_to
76 else
77 errors.add :base, :circular_dependency if issue_to.all_dependent_issues.include? issue_from
78 end
79 errors.add :base, :cant_link_an_issue_with_a_descendant if issue_from.is_descendant_of?(issue_to) || issue_from.is_ancestor_of?(issue_to)
80 end
81 end
82
83 def other_issue(issue)
84 (self.issue_from_id == issue.id) ? issue_to : issue_from
85 end
86
87 # Returns the relation type for +issue+
88 def relation_type_for(issue)
89 if TYPES[relation_type]
90 if self.issue_from_id == issue.id
91 relation_type
92 else
93 TYPES[relation_type][:sym]
94 end
95 end
96 end
97
98 def label_for(issue)
99 TYPES[relation_type] ? TYPES[relation_type][(self.issue_from_id == issue.id) ? :name : :sym_name] : :unknow
100 end
101
102 def handle_issue_order
103 reverse_if_needed
104
105 if TYPE_PRECEDES == relation_type
106 self.delay ||= 0
107 else
108 self.delay = nil
109 end
110 set_issue_to_dates
111 end
112
113 def set_issue_to_dates
114 soonest_start = self.successor_soonest_start
115 if soonest_start && issue_to
116 issue_to.reschedule_after(soonest_start)
117 end
118 end
119
120 def successor_soonest_start
121 if (TYPE_PRECEDES == self.relation_type) && delay && issue_from && (issue_from.start_date || issue_from.due_date)
122 (issue_from.due_date || issue_from.start_date) + 1 + delay
123 end
124 end
125
126 def <=>(relation)
127 TYPES[self.relation_type][:order] <=> TYPES[relation.relation_type][:order]
128 end
129
130 private
131
132 # Reverses the relation if needed so that it gets stored in the proper way
133 # Should not be reversed before validation so that it can be displayed back
134 # as entered on new relation form
135 def reverse_if_needed
136 if TYPES.has_key?(relation_type) && TYPES[relation_type][:reverse]
137 issue_tmp = issue_to
138 self.issue_to = issue_from
139 self.issue_from = issue_tmp
140 self.relation_type = TYPES[relation_type][:reverse]
141 end
142 end
143 end