BigW Consortium Gitlab

note.rb 10.1 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
  before_validation :set_award!
47
  before_validation :clear_blank_line_code!
48

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

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

60
  mount_uploader :attachment, AttachmentUploader
Andrey Kumanyaev committed
61 62

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

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

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

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

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

109 110 111 112 113 114 115
    # Searches for notes matching the given query.
    #
    # This method uses ILIKE on PostgreSQL and LIKE on MySQL.
    #
    # query - The search query as a String.
    #
    # Returns an ActiveRecord::Relation.
116
    def search(query)
117
      table   = arel_table
118 119 120
      pattern = "%#{query}%"

      where(table[:note].matches(pattern))
121
    end
Valery Sizov committed
122 123

    def grouped_awards
124 125
      notes = {}

Valery Sizov committed
126
      awards.select(:note).distinct.map do |note|
127
        notes[note.note] = where(note: note.note)
Valery Sizov committed
128
      end
129 130 131 132 133

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

      notes
Valery Sizov committed
134
    end
135
  end
136

137
  def cross_reference?
138
    system && SystemNoteService.cross_reference?(note)
139 140
  end

141 142 143 144
  def max_attachment_size
    current_application_settings.max_attachment_size.megabytes.to_i
  end

145
  def find_diff
146 147
    return nil unless noteable
    return @diff if defined?(@diff)
148

149 150
    # Don't use ||= because nil is a valid value for @diff
    @diff = noteable.diffs(Commit.max_diff_options).find do |d|
151
      Digest::SHA1.hexdigest(d.new_path) == diff_file_index if d.new_path
152
    end
153 154
  end

155 156 157 158
  def hook_attrs
    attributes
  end

159 160 161
  def set_diff
    # First lets find notes with same diff
    # before iterating over all mr diffs
162
    diff = diff_for_line_code unless for_merge_request?
163 164 165 166 167 168 169 170 171
    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

172 173 174 175
  def diff_for_line_code
    Note.where(noteable_id: noteable_id, noteable_type: noteable_type, line_code: line_code).last.try(:diff)
  end

176 177 178 179 180 181 182
  # Check if this note is part of an "active" discussion
  #
  # This will always return true for anything except MergeRequest noteables,
  # which have special logic.
  #
  # If the note's current diff cannot be matched in the MergeRequest's current
  # diff, it's considered inactive.
183
  def active?
184
    return true unless self.diff
185
    return false unless noteable
186
    return @active if defined?(@active)
187

188
    noteable_diff = find_noteable_diff
189

190 191
    if noteable_diff
      parsed_lines = Gitlab::Diff::Parser.new.parse(noteable_diff.diff.each_line)
192

193 194 195 196
      @active = parsed_lines.any? { |line_obj| line_obj.text == diff_line }
    else
      @active = false
    end
197

198
    @active
199 200
  end

201
  def diff_file_index
202
    line_code.split('_')[0] if line_code
203 204 205
  end

  def diff_file_name
206
    diff.new_path if diff
207 208
  end

209 210 211 212 213 214 215 216
  def file_path
    if diff.new_path.present?
      diff.new_path
    elsif diff.old_path.present?
      diff.old_path
    end
  end

217
  def diff_old_line
218
    line_code.split('_')[1].to_i if line_code
219 220 221
  end

  def diff_new_line
222
    line_code.split('_')[2].to_i if line_code
223 224
  end

225 226 227 228
  def generate_line_code(line)
    Gitlab::Diff::LineCode.generate(file_path, line.new_pos, line.old_pos)
  end

229
  def diff_line
230 231
    return @diff_line if @diff_line

232
    if diff
233
      diff_lines.each do |line|
234 235 236
        if generate_line_code(line) == self.line_code
          @diff_line = line.text
        end
237
      end
238
    end
239 240

    @diff_line
241 242
  end

243 244 245 246 247 248 249 250 251 252 253 254 255 256
  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

257 258 259 260 261
  def truncated_diff_lines
    max_number_of_lines = 16
    prev_match_line = nil
    prev_lines = []

262
    highlighted_diff_lines.each do |line|
263 264 265
      if line.type == "match"
        prev_lines.clear
        prev_match_line = line
266 267
      else
        prev_lines << line
268

269 270 271
        break if generate_line_code(line) == self.line_code

        prev_lines.shift if prev_lines.length >= max_number_of_lines
272 273
      end
    end
274 275

    prev_lines
276 277 278
  end

  def diff_lines
279
    @diff_lines ||= Gitlab::Diff::Parser.new.parse(diff.diff.each_line)
280 281 282 283
  end

  def highlighted_diff_lines
    Gitlab::Diff::Highlight.new(diff_lines).highlight
284 285
  end

286
  def discussion_id
287
    @discussion_id ||= Note.build_discussion_id(noteable_type, noteable_id || commit_id, line_code)
288 289 290 291 292 293 294 295 296 297 298 299 300 301
  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
302 303 304 305
  def for_issue?
    noteable_type == "Issue"
  end

306 307 308 309 310 311
  def for_merge_request?
    noteable_type == "MergeRequest"
  end

  def for_merge_request_diff_line?
    for_merge_request? && for_diff_line?
312
  end
313

314 315 316 317
  def for_project_snippet?
    noteable_type == "Snippet"
  end

318 319 320
  # override to return commits, which are not active record
  def noteable
    if for_commit?
321
      project.commit(commit_id)
322
    else
323
      super
324
    end
325 326
  # Temp fix to prevent app crash
  # if note commit id doesn't exist
327
  rescue
328
    nil
329
  end
330

Andrew8xx8 committed
331
  # FIXME: Hack for polymorphic associations with STI
Steven Burgart committed
332
  #        For more information visit http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Polymorphic+Associations
333 334
  def noteable_type=(noteable_type)
    super(noteable_type.to_s.classify.constantize.base_class.to_s)
Andrew8xx8 committed
335
  end
336 337 338 339 340 341 342 343 344 345 346

  # 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
347
    Event.reset_event_cache_for(self)
348
  end
349

350
  def downvote?
351
    is_award && note == "thumbsdown"
352 353 354
  end

  def upvote?
355
    is_award && note == "thumbsup"
356 357
  end

358
  def editable?
359
    !system? && !is_award
360
  end
361

362 363 364 365
  def cross_reference_not_visible_for?(user)
    cross_reference? && referenced_mentionables(user).empty?
  end

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

376 377 378 379
    self.is_award = true
    self.note = award_emoji_name
  end

380 381
  private

382 383 384 385
  def clear_blank_line_code!
    self.line_code = nil if self.line_code.blank?
  end

386 387 388 389 390 391
  # Find the diff on noteable that matches our own
  def find_noteable_diff
    diffs = noteable.diffs(Commit.max_diff_options)
    diffs.find { |d| d.new_path == self.diff.new_path }
  end

392
  def awards_supported?
393
    (for_issue? || for_merge_request?) && !for_diff_line?
394 395
  end

396
  def contains_emoji_only?
397
    note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
398 399 400
  end

  def award_emoji_name
401
    original_name = note.match(Banzai::Filter::EmojiFilter.emoji_pattern)[1]
Valery Sizov committed
402
    AwardEmoji.normilize_emoji_name(original_name)
403
  end
gitlabhq committed
404
end