Read about our upcoming Code of Conduct on this issue

issue.rb 8.37 KB
Newer Older
1
2
require 'carrierwave/orm/activerecord'

gitlabhq's avatar
gitlabhq committed
3
class Issue < ActiveRecord::Base
4
  include InternalId
5
  include Issuable
6
  include Noteable
7
  include Referable
8
  include Sortable
9
  include Spammable
10
  include FasterCacheKeys
11
  include RelativePositioning
12
13
14
  include IgnorableColumn

  ignore_column :position
15

Rémy Coutable's avatar
Rémy Coutable committed
16
17
18
19
20
21
  DueDateStruct = Struct.new(:title, :name).freeze
  NoDueDate     = DueDateStruct.new('No Due Date', '0').freeze
  AnyDueDate    = DueDateStruct.new('Any Due Date', '').freeze
  Overdue       = DueDateStruct.new('Overdue', 'overdue').freeze
  DueThisWeek   = DueDateStruct.new('Due This Week', 'week').freeze
  DueThisMonth  = DueDateStruct.new('Due This Month', 'month').freeze
22

23
  belongs_to :project
24
25
  belongs_to :moved_to, class_name: 'Issue'

26
27
  has_many :events, as: :target, dependent: :destroy

28
  has_many :merge_requests_closing_issues, class_name: 'MergeRequestsClosingIssues'
29

30
31
32
  has_many :issue_assignees
  has_many :assignees, class_name: "User", through: :issue_assignees

33
34
  validates :project, presence: true

Valery Sizov's avatar
Valery Sizov committed
35
  scope :in_projects, ->(project_ids) { where(project_id: project_ids) }
36

37
38
39
40
  scope :assigned, -> { where('EXISTS (SELECT TRUE FROM issue_assignees WHERE issue_id = issues.id)') }
  scope :unassigned, -> { where('NOT EXISTS (SELECT TRUE FROM issue_assignees WHERE issue_id = issues.id)') }
  scope :assigned_to, ->(u) { where('EXISTS (SELECT TRUE FROM issue_assignees WHERE user_id = ? AND issue_id = issues.id)', u.id)}

41
42
43
44
  scope :without_due_date, -> { where(due_date: nil) }
  scope :due_before, ->(date) { where('issues.due_date < ?', date) }
  scope :due_between, ->(from_date, to_date) { where('issues.due_date >= ?', from_date).where('issues.due_date <= ?', to_date) }

45
46
47
  scope :order_due_date_asc, -> { reorder('issues.due_date IS NULL, issues.due_date ASC') }
  scope :order_due_date_desc, -> { reorder('issues.due_date IS NULL, issues.due_date DESC') }

48
49
  scope :created_after, -> (datetime) { where("created_at >= ?", datetime) }

Felipe Artur's avatar
Felipe Artur committed
50
  scope :preload_associations, -> { preload(:labels, project: :namespace) }
51

Regis Boudinot's avatar
Regis Boudinot committed
52
53
  after_save :expire_etag_cache

54
55
  attr_spammable :title, spam_title: true
  attr_spammable :description, spam_description: true
56

57
58
  participant :assignees

Andrew8xx8's avatar
Andrew8xx8 committed
59
  state_machine :state, initial: :opened do
Andrew8xx8's avatar
Andrew8xx8 committed
60
61
62
63
64
    event :close do
      transition [:reopened, :opened] => :closed
    end

    event :reopen do
Andrew8xx8's avatar
Andrew8xx8 committed
65
      transition closed: :reopened
Andrew8xx8's avatar
Andrew8xx8 committed
66
67
68
69
70
    end

    state :opened
    state :reopened
    state :closed
Felipe Artur's avatar
Felipe Artur committed
71
72
73
74

    before_transition any => :closed do |issue|
      issue.closed_at = Time.zone.now
    end
Andrew8xx8's avatar
Andrew8xx8 committed
75
  end
76

77
  def hook_attrs
78
79
    assignee_ids = self.assignee_ids

80
81
82
    attrs = {
      total_time_spent: total_time_spent,
      human_total_time_spent: human_total_time_spent,
83
84
85
      human_time_estimate: human_time_estimate,
      assignee_ids: assignee_ids,
      assignee_id: assignee_ids.first # This key is deprecated
86
87
88
    }

    attributes.merge!(attrs)
89
90
  end

91
92
93
94
  def self.reference_prefix
    '#'
  end

95
96
97
98
  # Pattern used to extract `#123` issue references from text
  #
  # This pattern supports cross-project references.
  def self.reference_pattern
99
    @reference_pattern ||= %r{
100
101
      (#{Project.reference_pattern})?
      #{Regexp.escape(reference_prefix)}(?<issue>\d+)
102
    }x
Kirill Zaitsev's avatar
Kirill Zaitsev committed
103
104
  end

105
  def self.link_reference_pattern
106
    @link_reference_pattern ||= super("issues", /(?<issue>\d+)/)
107
108
  end

109
110
111
112
  def self.reference_valid?(reference)
    reference.to_i > 0 && reference.to_i <= Gitlab::Database::MAX_INT_VALUE
  end

113
114
115
116
  def self.project_foreign_key
    'project_id'
  end

117
  def self.sort(method, excluded_labels: [])
118
119
    case method.to_s
    when 'due_date_asc' then order_due_date_asc
120
    when 'due_date_desc' then order_due_date_desc
121
122
123
124
125
    else
      super
    end
  end

126
  def self.order_by_position_and_priority
127
128
    order_labels_priority
      .reorder(Gitlab::Database.nulls_last_order('relative_position', 'ASC'),
129
130
131
132
              Gitlab::Database.nulls_last_order('highest_priority', 'ASC'),
              "id DESC")
  end

133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
  # Returns a Hash of attributes to be used for Twitter card metadata
  def card_attributes
    {
      'Author'   => author.try(:name),
      'Assignee' => assignee_list
    }
  end

  def assignee_or_author?(user)
    author_id == user.id || assignees.exists?(user.id)
  end

  def assignee_list
    assignees.map(&:name).to_sentence
  end

149
  # `from` argument can be a Namespace or Project.
150
  def to_reference(from = nil, full: false)
151
152
    reference = "#{self.class.reference_prefix}#{iid}"

153
    "#{project.to_reference(from, full: full)}#{reference}"
154
155
  end

156
  def referenced_merge_requests(current_user = nil)
Yorick Peterse's avatar
Yorick Peterse committed
157
158
159
160
    ext = all_references(current_user)

    notes_with_associations.each do |object|
      object.all_references(current_user, extractor: ext)
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
161
    end
Yorick Peterse's avatar
Yorick Peterse committed
162
163

    ext.merge_requests.sort_by(&:iid)
164
165
  end

166
  # All branches containing the current issue's ID, except for
167
  # those with a merge request open referencing the current issue.
168
169
  def related_branches(current_user)
    branches_with_iid = project.repository.branch_names.select do |branch|
170
      branch =~ /\A#{iid}-(?!\d+-stable)/i
171
    end
172
173
174
175

    branches_with_merge_request = self.referenced_merge_requests(current_user).map(&:source_branch)

    branches_with_iid - branches_with_merge_request
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
176
177
  end

178
179
  # Returns boolean if a related branch exists for the current issue
  # ignores merge requests branchs
180
  def has_related_branch?
181
182
183
184
185
    project.repository.branch_names.any? do |branch|
      /\A#{iid}-(?!\d+-stable)/i =~ branch
    end
  end

186
187
188
189
  # To allow polymorphism with MergeRequest.
  def source_project
    project
  end
190
191
192

  # From all notes on this issue, we'll select the system notes about linked
  # merge requests. Of those, the MRs closing `self` are returned.
193
  def closed_by_merge_requests(current_user = nil)
194
    return [] unless open?
195

Yorick Peterse's avatar
Yorick Peterse committed
196
197
198
199
200
201
    ext = all_references(current_user)

    notes.system.each do |note|
      note.all_references(current_user, extractor: ext)
    end

202
203
204
205
206
207
208
    merge_requests = ext.merge_requests.select(&:open?)
    if merge_requests.any?
      ids = MergeRequestsClosingIssues.where(merge_request_id: merge_requests.map(&:id), issue_id: id).pluck(:merge_request_id)
      merge_requests.select { |mr| mr.id.in?(ids) }
    else
      []
    end
209
  end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
210

211
212
213
214
215
216
217
218
219
  def moved?
    !moved_to.nil?
  end

  def can_move?(user, to_project = nil)
    if to_project
      return false unless user.can?(:admin_issue, to_project)
    end

220
221
    !moved? && persisted? &&
      user.can?(:admin_issue, self.project)
222
  end
223

Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
224
  def to_branch_name
225
    if self.confidential?
226
      "#{iid}-confidential-issue"
227
    else
228
      "#{iid}-#{title.parameterize}"
229
    end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
230
231
  end

232
  def can_be_worked_on?(current_user)
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
233
    !self.closed? &&
234
      !self.project.forked? &&
235
      self.related_branches(current_user).empty? &&
236
      self.closed_by_merge_requests(current_user).empty?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
237
  end
238

239
240
241
  # Returns `true` if the current issue can be viewed by either a logged in User
  # or an anonymous user.
  def visible_to_user?(user = nil)
242
    return false unless project && project.feature_available?(:issues, user)
243

244
    user ? readable_by?(user) : publicly_visible?
245
246
  end

247
  def overdue?
Rémy Coutable's avatar
Rémy Coutable committed
248
    due_date.try(:past?) || false
249
  end
250
251

  def check_for_spam?
252
    project.public? && (title_changed? || description_changed?)
253
  end
Phil Hughes's avatar
Phil Hughes committed
254
255
256

  def as_json(options = {})
    super(options).tap do |json|
257
      json[:subscribed] = subscribed?(options[:user], project) if options.key?(:user) && options[:user]
258

259
      if options.key?(:labels)
260
261
        json[:labels] = labels.as_json(
          project: project,
262
          only: [:id, :title, :description, :color, :priority],
263
264
265
          methods: [:text_color]
        )
      end
Phil Hughes's avatar
Phil Hughes committed
266
267
    end
  end
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

  private

  # Returns `true` if the given User can read the current Issue.
  #
  # This method duplicates the same check of issue_policy.rb
  # for performance reasons, check commit: 002ad215818450d2cbbc5fa065850a953dc7ada8
  # Make sure to sync this method with issue_policy.rb
  def readable_by?(user)
    if user.admin?
      true
    elsif project.owner == user
      true
    elsif confidential?
      author == user ||
283
        assignees.include?(user) ||
284
285
286
287
288
289
290
291
292
293
294
295
        project.team.member?(user, Gitlab::Access::REPORTER)
    else
      project.public? ||
        project.internal? && !user.external? ||
        project.team.member?(user)
    end
  end

  # Returns `true` if this Issue is visible to everybody.
  def publicly_visible?
    project.public? && !confidential?
  end
Regis Boudinot's avatar
Regis Boudinot committed
296
297

  def expire_etag_cache
298
    key = Gitlab::Routing.url_helpers.realtime_changes_project_issue_path(project, self)
Regis Boudinot's avatar
Regis Boudinot committed
299
300
    Gitlab::EtagCaching::Store.new.touch(key)
  end
gitlabhq's avatar
gitlabhq committed
301
end