BigW Consortium Gitlab

note.rb 9.53 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 committed
9 10
#  created_at    :datetime
#  updated_at    :datetime
11 12 13
#  project_id    :integer
#  attachment    :string(255)
#  line_code     :string(255)
14 15
#  commit_id     :string(255)
#  noteable_id   :integer
Dmitriy Zaporozhets committed
16
#  system        :boolean          default(FALSE), not null
Dmitriy Zaporozhets committed
17
#  st_diff       :text
Stan Hu committed
18
#  updated_by_id :integer
Stan Hu committed
19
#  is_award      :boolean          default(FALSE), not null
20 21
#

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 committed
35
  belongs_to :project
36
  belongs_to :noteable, polymorphic: true, touch: true
37
  belongs_to :author, class_name: "User"
38
  belongs_to :updated_by, class_name: "User"
gitlabhq committed
39

40
  has_many :todos, dependent: :destroy
41

42
  delegate :gfm_reference, :local_reference, to: :noteable
43 44
  delegate :name, to: :project, prefix: true
  delegate :name, :email, to: :author, prefix: true
45

46 47
  before_validation :set_award!

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

55 56
  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 committed
57
  validates :author, presence: true
58

59
  mount_uploader :attachment, AttachmentUploader
Andrey Kumanyaev committed
60 61

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

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

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

82 83 84 85 86 87 88 89 90
  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
91
        if !note.for_diff_line? && note.for_merge_request?
92 93 94 95 96 97 98 99 100 101 102
          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
103

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

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

    def grouped_awards
113 114
      notes = {}

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

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

      notes
Valery Sizov committed
123
    end
124
  end
125

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

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

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

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

144 145 146 147
  def hook_attrs
    attributes
  end

148 149 150
  def set_diff
    # First lets find notes with same diff
    # before iterating over all mr diffs
151
    diff = diff_for_line_code unless for_merge_request?
152 153 154 155 156 157 158 159 160
    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

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

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

173 174
    diffs = noteable.diffs(Commit.max_diff_options)
    notable_diff = diffs.find { |d| d.new_path == self.diff.new_path }
175

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

178 179 180
    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 }
181 182 183 184
  end

  def outdated?
    !active?
185 186
  end

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

  def diff_file_name
192
    diff.new_path if diff
193 194
  end

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

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

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

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

215
  def diff_line
216 217
    return @diff_line if @diff_line

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

    @diff_line
227 228
  end

229 230 231 232 233 234 235 236 237 238 239 240 241 242
  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

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

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

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

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

    prev_lines
262 263 264
  end

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

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

272
  def discussion_id
273
    @discussion_id ||= Note.build_discussion_id(noteable_type, noteable_id || commit_id, line_code)
274 275 276 277 278 279 280 281 282 283 284 285 286 287
  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 committed
288 289 290 291
  def for_issue?
    noteable_type == "Issue"
  end

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

  def for_merge_request_diff_line?
    for_merge_request? && for_diff_line?
298
  end
299

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

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

Andrew8xx8 committed
317
  # FIXME: Hack for polymorphic associations with STI
Steven Burgart committed
318
  #        For more information visit http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Polymorphic+Associations
319 320
  def noteable_type=(noteable_type)
    super(noteable_type.to_s.classify.constantize.base_class.to_s)
Andrew8xx8 committed
321
  end
322 323 324 325 326 327 328 329 330 331 332

  # 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
333
    Event.reset_event_cache_for(self)
334
  end
335

336
  def downvote?
337
    is_award && note == "thumbsdown"
338 339 340
  end

  def upvote?
341
    is_award && note == "thumbsup"
342 343
  end

344
  def editable?
345
    !system? && !is_award
346
  end
347

348 349 350 351
  def cross_reference_not_visible_for?(user)
    cross_reference? && referenced_mentionables(user).empty?
  end

352
  # Checks if note is an award added as a comment
353
  #
354 355
  # If note is an award, this method sets is_award to true
  #   and changes content of the note to award name.
356 357 358 359
  #
  # Method is executed as a before_validation callback.
  #
  def set_award!
360
    return unless awards_supported? && contains_emoji_only?
361

362 363 364 365
    self.is_award = true
    self.note = award_emoji_name
  end

366 367
  private

368
  def awards_supported?
369
    (for_issue? || for_merge_request?) && !for_diff_line?
370 371
  end

372
  def contains_emoji_only?
373
    note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
374 375 376
  end

  def award_emoji_name
377
    original_name = note.match(Banzai::Filter::EmojiFilter.emoji_pattern)[1]
Valery Sizov committed
378
    AwardEmoji.normilize_emoji_name(original_name)
379
  end
gitlabhq committed
380
end