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

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

15
  ignore_column :assignee_id, :branch_name, :deleted_at
16

Rémy Coutable's avatar
Rémy Coutable committed
17
18
19
20
21
22
  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
23

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

27
  has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
28

29
30
31
32
33
34
  has_many :merge_requests_closing_issues,
    class_name: 'MergeRequestsClosingIssues',
    dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent

  has_many :issue_assignees
  has_many :assignees, class_name: "User", through: :issue_assignees
35

36
37
  validates :project, presence: true

38
  alias_attribute :parent_ids, :project_id
39

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

42
43
44
45
  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)}

46
47
48
49
  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) }

50
51
52
  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') }

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

55
56
  scope :public_only, -> { where(confidential: false) }

Regis Boudinot's avatar
Regis Boudinot committed
57
58
  after_save :expire_etag_cache

59
60
  attr_spammable :title, spam_title: true
  attr_spammable :description, spam_description: true
61

62
63
  participant :assignees

Andrew8xx8's avatar
Andrew8xx8 committed
64
  state_machine :state, initial: :opened do
Andrew8xx8's avatar
Andrew8xx8 committed
65
    event :close do
66
      transition [:opened] => :closed
Andrew8xx8's avatar
Andrew8xx8 committed
67
68
69
    end

    event :reopen do
70
      transition closed: :opened
Andrew8xx8's avatar
Andrew8xx8 committed
71
72
73
74
    end

    state :opened
    state :closed
Felipe Artur's avatar
Felipe Artur committed
75
76
77
78

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

81
82
83
84
  class << self
    alias_method :in_parents, :in_projects
  end

85
86
87
88
  def self.reference_prefix
    '#'
  end

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

99
  def self.link_reference_pattern
100
    @link_reference_pattern ||= super("issues", /(?<issue>\d+)/)
101
102
  end

103
104
105
106
  def self.reference_valid?(reference)
    reference.to_i > 0 && reference.to_i <= Gitlab::Database::MAX_INT_VALUE
  end

107
108
109
110
  def self.project_foreign_key
    'project_id'
  end

111
  def self.sort(method, excluded_labels: [])
112
    case method.to_s
113
114
    when 'due_date'      then order_due_date_asc
    when 'due_date_asc'  then order_due_date_asc
115
    when 'due_date_desc' then order_due_date_desc
116
117
118
119
120
    else
      super
    end
  end

121
  def self.order_by_position_and_priority
122
123
    order_labels_priority
      .reorder(Gitlab::Database.nulls_last_order('relative_position', 'ASC'),
124
125
126
127
              Gitlab::Database.nulls_last_order('highest_priority', 'ASC'),
              "id DESC")
  end

128
  def hook_attrs
129
    Gitlab::HookData::IssueBuilder.new(self).build
130
131
  end

132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
  # 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

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

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

155
  def referenced_merge_requests(current_user = nil)
Yorick Peterse's avatar
Yorick Peterse committed
156
157
158
159
    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
160
    end
Yorick Peterse's avatar
Yorick Peterse committed
161

162
163
164
165
166
167
168
169
170
171
172
173
    merge_requests = ext.merge_requests.sort_by(&:iid)

    cross_project_filter = -> (merge_requests) do
      merge_requests.select { |mr| mr.target_project == project }
    end

    Ability.merge_requests_readable_by_user(
      merge_requests, current_user,
      filters: {
        read_cross_project: cross_project_filter
      }
    )
174
175
  end

176
  # All branches containing the current issue's ID, except for
177
  # those with a merge request open referencing the current issue.
178
179
  def related_branches(current_user)
    branches_with_iid = project.repository.branch_names.select do |branch|
180
      branch =~ /\A#{iid}-(?!\d+-stable)/i
181
    end
182
183
184
185

    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
186
187
  end

188
189
  # Returns boolean if a related branch exists for the current issue
  # ignores merge requests branchs
190
  def has_related_branch?
191
192
193
194
195
    project.repository.branch_names.any? do |branch|
      /\A#{iid}-(?!\d+-stable)/i =~ branch
    end
  end

196
197
198
199
  # To allow polymorphism with MergeRequest.
  def source_project
    project
  end
200
201
202

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

Yorick Peterse's avatar
Yorick Peterse committed
206
207
208
209
210
211
    ext = all_references(current_user)

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

212
213
214
215
216
217
218
    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
219
  end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
220

221
222
223
224
225
226
227
228
229
  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

230
231
    !moved? && persisted? &&
      user.can?(:admin_issue, self.project)
232
  end
233

Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
234
  def to_branch_name
235
    if self.confidential?
236
      "#{iid}-confidential-issue"
237
    else
238
      "#{iid}-#{title.parameterize}"
239
    end
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
240
241
  end

242
  def can_be_worked_on?(current_user)
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
243
    !self.closed? &&
244
      !self.project.forked? &&
245
      self.related_branches(current_user).empty? &&
246
      self.closed_by_merge_requests(current_user).empty?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg committed
247
  end
248

249
250
251
  # 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)
252
    return false unless project && project.feature_available?(:issues, user)
253

254
    user ? readable_by?(user) : publicly_visible?
255
256
  end

257
  def overdue?
Rémy Coutable's avatar
Rémy Coutable committed
258
    due_date.try(:past?) || false
259
  end
260
261

  def check_for_spam?
262
    project.public? && (title_changed? || description_changed?)
263
  end
Phil Hughes's avatar
Phil Hughes committed
264
265
266

  def as_json(options = {})
    super(options).tap do |json|
267
268
269
270
271
272
      if options.key?(:sidebar_endpoints) && project
        url_helper = Gitlab::Routing.url_helpers

        json.merge!(issue_sidebar_endpoint: url_helper.project_issue_path(project, self, format: :json, serializer: 'sidebar'),
                    toggle_subscription_endpoint: url_helper.toggle_subscription_project_issue_path(project, self))
      end
273

274
      if options.key?(:labels)
275
276
        json[:labels] = labels.as_json(
          project: project,
277
          only: [:id, :title, :description, :color, :priority],
278
279
280
          methods: [:text_color]
        )
      end
Phil Hughes's avatar
Phil Hughes committed
281
282
    end
  end
283

Douwe Maan's avatar
Douwe Maan committed
284
285
286
287
  def discussions_rendered_on_frontend?
    true
  end

288
289
290
291
  def update_project_counter_caches
    Projects::OpenIssuesCountService.new(project).refresh_cache
  end

292
293
  private

294
295
296
297
298
  def ensure_metrics
    super
    metrics.record!
  end

299
300
301
302
303
304
305
306
307
308
309
310
  # 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 ||
311
        assignees.include?(user) ||
312
313
314
315
316
317
318
319
320
321
322
323
        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
324
325

  def expire_etag_cache
326
    key = Gitlab::Routing.url_helpers.realtime_changes_project_issue_path(project, self)
Regis Boudinot's avatar
Regis Boudinot committed
327
328
    Gitlab::EtagCaching::Store.new.touch(key)
  end
gitlabhq's avatar
gitlabhq committed
329
end