note.rb 9.68 KB
Newer Older
1
2
3
4
5
6
7
8
# == Schema Information
#
# Table name: notes
#
#  id            :integer          not null, primary key
#  note          :text
#  noteable_type :string(255)
#  author_id     :integer
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
9
10
#  created_at    :datetime
#  updated_at    :datetime
11
12
13
#  project_id    :integer
#  attachment    :string(255)
#  line_code     :string(255)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
14
15
#  commit_id     :string(255)
#  noteable_id   :integer
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
16
#  system        :boolean          default(FALSE), not null
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
17
#  st_diff       :text
Stan Hu's avatar
Stan Hu committed
18
#  updated_by_id :integer
Stan Hu's avatar
Stan Hu committed
19
#  is_award      :boolean          default(FALSE), not null
20
21
#

gitlabhq's avatar
gitlabhq committed
22
23
24
25
require 'carrierwave/orm/activerecord'
require 'file_size_validator'

class Note < ActiveRecord::Base
26
  include Gitlab::CurrentSettings
27
  include Participable
28
  include Mentionable
29

30
31
  default_value_for :system, false

32
  attr_mentionable :note, cache: true, pipeline: :note
33
  participant :author
34

gitlabhq's avatar
gitlabhq committed
35
  belongs_to :project
36
  belongs_to :noteable, polymorphic: true, touch: true
Nihad Abbasov's avatar
Nihad Abbasov committed
37
  belongs_to :author, class_name: "User"
38
  belongs_to :updated_by, class_name: "User"
gitlabhq's avatar
gitlabhq committed
39

40
  has_many :todos, dependent: :destroy
41

Nihad Abbasov's avatar
Nihad Abbasov committed
42
43
  delegate :name, to: :project, prefix: true
  delegate :name, :email, to: :author, prefix: true
44

45
46
  before_validation :set_award!

Nihad Abbasov's avatar
Nihad Abbasov committed
47
  validates :note, :project, presence: true
Valery Sizov's avatar
Valery Sizov committed
48
  validates :note, uniqueness: { scope: [:author, :noteable_type, :noteable_id] }, if: ->(n) { n.is_award }
49
  validates :note, inclusion: { in: Emoji.emojis_names }, if: ->(n) { n.is_award }
Robert Speicher's avatar
Robert Speicher committed
50
  validates :line_code, line_code: true, allow_blank: true
51
52
  # Attachments are deprecated and are handled by Markdown uploader
  validates :attachment, file_size: { maximum: :max_attachment_size }
gitlabhq's avatar
gitlabhq committed
53

54
55
  validates :noteable_id, presence: true, if: ->(n) { n.noteable_type.present? && n.noteable_type != 'Commit' }
  validates :commit_id, presence: true, if: ->(n) { n.noteable_type == 'Commit' }
Valery Sizov's avatar
Valery Sizov committed
56
  validates :author, presence: true
57

Nihad Abbasov's avatar
Nihad Abbasov committed
58
  mount_uploader :attachment, AttachmentUploader
Andrey Kumanyaev's avatar
Andrey Kumanyaev committed
59
60

  # Scopes
Valery Sizov's avatar
Valery Sizov committed
61
62
  scope :awards, ->{ where(is_award: true) }
  scope :nonawards, ->{ where(is_award: false) }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
63
  scope :for_commit_id, ->(commit_id) { where(noteable_type: "Commit", commit_id: commit_id) }
64
65
  scope :inline, ->{ where("line_code IS NOT NULL") }
  scope :not_inline, ->{ where(line_code: [nil, '']) }
66
  scope :system, ->{ where(system: true) }
67
  scope :user, ->{ where(system: false) }
68
  scope :common, ->{ where(noteable_type: ["", nil]) }
69
  scope :fresh, ->{ order(created_at: :asc, id: :asc) }
70
71
  scope :inc_author_project, ->{ includes(:project, :author) }
  scope :inc_author, ->{ includes(:author) }
gitlabhq's avatar
gitlabhq committed
72

73
  scope :with_associations, -> do
74
    includes(:author, :noteable, :updated_by,
Yorick Peterse's avatar
Yorick Peterse committed
75
             project: [:project_members, { group: [:group_members] }])
76
  end
gitlabhq's avatar
gitlabhq committed
77

78
  serialize :st_diff
79
  before_create :set_diff, if: ->(n) { n.line_code.present? }
80

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
  class << self
    def discussions_from_notes(notes)
      discussion_ids = []
      discussions = []

      notes.each do |note|
        next if discussion_ids.include?(note.discussion_id)

        # don't group notes for the main target
        if !note.for_diff_line? && note.noteable_type == "MergeRequest"
          discussions << [note]
        else
          discussions << notes.select do |other_note|
            note.discussion_id == other_note.discussion_id
          end
          discussion_ids << note.discussion_id
        end
      end

      discussions
    end
102

103
104
105
106
    def build_discussion_id(type, id, line_code)
      [:discussion, type.try(:underscore), id, line_code].join("-").to_sym
    end

107
    def search(query)
108
      where("LOWER(note) like :query", query: "%#{query.downcase}%")
109
    end
Valery Sizov's avatar
Valery Sizov committed
110
111

    def grouped_awards
112
113
      notes = {}

Valery Sizov's avatar
Valery Sizov committed
114
      awards.select(:note).distinct.map do |note|
115
        notes[note.note] = where(note: note.note)
Valery Sizov's avatar
Valery Sizov committed
116
      end
117
118
119
120
121

      notes["thumbsup"] ||= Note.none
      notes["thumbsdown"] ||= Note.none

      notes
Valery Sizov's avatar
Valery Sizov committed
122
    end
123
  end
124

125
  def cross_reference?
126
    system && SystemNoteService.cross_reference?(note)
127
128
  end

129
130
131
132
  def max_attachment_size
    current_application_settings.max_attachment_size.megabytes.to_i
  end

133
  def find_diff
134
135
    return nil unless noteable
    return @diff if defined?(@diff)
136

137
138
    # Don't use ||= because nil is a valid value for @diff
    @diff = noteable.diffs(Commit.max_diff_options).find do |d|
139
      Digest::SHA1.hexdigest(d.new_path) == diff_file_index if d.new_path
140
    end
141
142
  end

143
144
145
146
  def hook_attrs
    attributes
  end

147
148
149
  def set_diff
    # First lets find notes with same diff
    # before iterating over all mr diffs
150
    diff = diff_for_line_code unless for_merge_request?
151
152
153
154
155
156
157
158
159
    diff ||= find_diff

    self.st_diff = diff.to_hash if diff
  end

  def diff
    @diff ||= Gitlab::Git::Diff.new(st_diff) if st_diff.respond_to?(:map)
  end

160
161
162
163
  def diff_for_line_code
    Note.where(noteable_id: noteable_id, noteable_type: noteable_type, line_code: line_code).last.try(:diff)
  end

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
164
165
166
  # Check if such line of code exists in merge request diff
  # If exists - its active discussion
  # If not - its outdated diff
167
  def active?
168
    return true unless self.diff
169
    return false unless noteable
170
    return @active if defined?(@active)
171

172
173
    diffs = noteable.diffs(Commit.max_diff_options)
    notable_diff = diffs.find { |d| d.new_path == self.diff.new_path }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
174

175
    return @active = false if notable_diff.nil?
176

177
178
179
    parsed_lines = Gitlab::Diff::Parser.new.parse(notable_diff.diff.each_line)
    # We cannot use ||= because @active may be false
    @active = parsed_lines.any? { |line_obj| line_obj.text == diff_line }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
180
181
182
183
  end

  def outdated?
    !active?
184
185
  end

186
  def diff_file_index
187
    line_code.split('_')[0] if line_code
188
189
190
  end

  def diff_file_name
191
    diff.new_path if diff
192
193
  end

194
195
196
197
198
199
200
201
  def file_path
    if diff.new_path.present?
      diff.new_path
    elsif diff.old_path.present?
      diff.old_path
    end
  end

202
  def diff_old_line
203
    line_code.split('_')[1].to_i if line_code
204
205
206
  end

  def diff_new_line
207
    line_code.split('_')[2].to_i if line_code
208
209
  end

210
211
212
213
  def generate_line_code(line)
    Gitlab::Diff::LineCode.generate(file_path, line.new_pos, line.old_pos)
  end

214
  def diff_line
215
216
    return @diff_line if @diff_line

217
    if diff
218
      diff_lines.each do |line|
219
220
221
        if generate_line_code(line) == self.line_code
          @diff_line = line.text
        end
222
      end
223
    end
224
225

    @diff_line
226
227
  end

228
229
230
231
232
233
234
235
236
237
238
239
240
241
  def diff_line_type
    return @diff_line_type if @diff_line_type

    if diff
      diff_lines.each do |line|
        if generate_line_code(line) == self.line_code
          @diff_line_type = line.type
        end
      end
    end

    @diff_line_type
  end

242
243
244
245
246
  def truncated_diff_lines
    max_number_of_lines = 16
    prev_match_line = nil
    prev_lines = []

247
    highlighted_diff_lines.each do |line|
248
249
250
      if line.type == "match"
        prev_lines.clear
        prev_match_line = line
251
252
      else
        prev_lines << line
253

254
255
256
        break if generate_line_code(line) == self.line_code

        prev_lines.shift if prev_lines.length >= max_number_of_lines
257
258
      end
    end
259
260

    prev_lines
261
262
263
  end

  def diff_lines
264
    @diff_lines ||= Gitlab::Diff::Parser.new.parse(diff.diff.each_line)
265
266
267
268
  end

  def highlighted_diff_lines
    Gitlab::Diff::Highlight.new(diff_lines).highlight
269
270
  end

271
  def discussion_id
272
    @discussion_id ||= Note.build_discussion_id(noteable_type, noteable_id || commit_id, line_code)
273
274
275
276
277
278
279
280
281
282
283
284
285
286
  end

  def for_commit?
    noteable_type == "Commit"
  end

  def for_commit_diff_line?
    for_commit? && for_diff_line?
  end

  def for_diff_line?
    line_code.present?
  end

Riyad Preukschas's avatar
Riyad Preukschas committed
287
288
289
290
  def for_issue?
    noteable_type == "Issue"
  end

291
292
293
294
295
296
  def for_merge_request?
    noteable_type == "MergeRequest"
  end

  def for_merge_request_diff_line?
    for_merge_request? && for_diff_line?
Cedric Gatay's avatar
Cedric Gatay committed
297
  end
298

299
300
301
302
  def for_project_snippet?
    noteable_type == "Snippet"
  end

Riyad Preukschas's avatar
Riyad Preukschas committed
303
304
305
  # override to return commits, which are not active record
  def noteable
    if for_commit?
306
      project.commit(commit_id)
307
    else
Riyad Preukschas's avatar
Riyad Preukschas committed
308
      super
309
    end
310
311
  # Temp fix to prevent app crash
  # if note commit id doesn't exist
312
  rescue
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
313
    nil
314
  end
315

316
  # Mentionable override.
317
318
  def gfm_reference(from_project = nil)
    noteable.gfm_reference(from_project)
319
320
321
322
323
324
325
  end

  # Mentionable override.
  def local_reference
    noteable
  end

Andrew8xx8's avatar
Andrew8xx8 committed
326
  # FIXME: Hack for polymorphic associations with STI
Steven Burgart's avatar
Steven Burgart committed
327
  #        For more information visit http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Polymorphic+Associations
328
329
  def noteable_type=(noteable_type)
    super(noteable_type.to_s.classify.constantize.base_class.to_s)
Andrew8xx8's avatar
Andrew8xx8 committed
330
  end
Drew Blessing's avatar
Drew Blessing committed
331
332
333
334
335
336
337
338
339
340
341

  # Reset notes events cache
  #
  # Since we do cache @event we need to reset cache in special cases:
  # * when a note is updated
  # * when a note is removed
  # Events cache stored like  events/23-20130109142513.
  # The cache key includes updated_at timestamp.
  # Thus it will automatically generate a new fragment
  # when the event is updated because the key changes.
  def reset_events_cache
342
    Event.reset_event_cache_for(self)
Drew Blessing's avatar
Drew Blessing committed
343
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
344

345
  def downvote?
346
    is_award && note == "thumbsdown"
347
348
349
  end

  def upvote?
350
    is_award && note == "thumbsup"
351
352
  end

353
  def editable?
354
    !system? && !is_award
355
  end
356

357
358
359
360
  def cross_reference_not_visible_for?(user)
    cross_reference? && referenced_mentionables(user).empty?
  end

361
  # Checks if note is an award added as a comment
362
  #
363
364
  # If note is an award, this method sets is_award to true
  #   and changes content of the note to award name.
365
366
367
368
  #
  # Method is executed as a before_validation callback.
  #
  def set_award!
369
    return unless awards_supported? && contains_emoji_only?
370

371
372
373
374
    self.is_award = true
    self.note = award_emoji_name
  end

375
376
  private

377
  def awards_supported?
378
    (noteable.kind_of?(Issue) || noteable.is_a?(MergeRequest)) && !for_diff_line?
379
380
  end

381
  def contains_emoji_only?
382
    note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
383
384
385
  end

  def award_emoji_name
386
    original_name = note.match(Banzai::Filter::EmojiFilter.emoji_pattern)[1]
Valery Sizov's avatar
Valery Sizov committed
387
    AwardEmoji.normilize_emoji_name(original_name)
388
  end
gitlabhq's avatar
gitlabhq committed
389
end