gitlab-org--gitlab-foss/app/models/note.rb

384 lines
9.3 KiB
Ruby
Raw Normal View History

2012-11-19 13:24:05 -05:00
# == Schema Information
#
# Table name: notes
#
# id :integer not null, primary key
# note :text
# noteable_type :string(255)
# author_id :integer
# created_at :datetime
# updated_at :datetime
2012-11-19 13:24:05 -05:00
# project_id :integer
# attachment :string(255)
# line_code :string(255)
2013-01-03 14:09:18 -05:00
# commit_id :string(255)
# noteable_id :integer
2013-10-01 08:15:28 -04:00
# system :boolean default(FALSE), not null
# st_diff :text
2015-09-06 10:48:48 -04:00
# updated_by_id :integer
2015-12-09 00:00:01 -05:00
# is_award :boolean default(FALSE), not null
2012-11-19 13:24:05 -05:00
#
2011-10-08 17:36:38 -04:00
require 'carrierwave/orm/activerecord'
require 'file_size_validator'
class Note < ActiveRecord::Base
include Gitlab::CurrentSettings
include Participable
include Mentionable
default_value_for :system, false
attr_mentionable :note, cache: true, pipeline: :note
participant :author
2011-10-08 17:36:38 -04:00
belongs_to :project
belongs_to :noteable, polymorphic: true
2012-09-27 02:20:36 -04:00
belongs_to :author, class_name: "User"
belongs_to :updated_by, class_name: "User"
2011-10-08 17:36:38 -04:00
2012-09-27 02:20:36 -04:00
delegate :name, to: :project, prefix: true
delegate :name, :email, to: :author, prefix: true
before_validation :set_award!
2012-12-01 06:19:16 -05:00
validates :note, :project, presence: true
2015-11-19 11:12:17 -05:00
validates :note, uniqueness: { scope: [:author, :noteable_type, :noteable_id] }, if: ->(n) { n.is_award }
validates :note, inclusion: { in: Emoji.emojis_names }, if: ->(n) { n.is_award }
2015-12-01 19:30:01 -05:00
validates :line_code, line_code: true, allow_blank: true
# Attachments are deprecated and are handled by Markdown uploader
validates :attachment, file_size: { maximum: :max_attachment_size }
2011-10-08 17:36:38 -04:00
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' }
2015-11-19 11:12:17 -05:00
validates :author, presence: true
2012-12-01 06:19:16 -05:00
mount_uploader :attachment, AttachmentUploader
2012-10-08 20:10:04 -04:00
# Scopes
2015-11-18 17:59:07 -05:00
scope :awards, ->{ where(is_award: true) }
scope :nonawards, ->{ where(is_award: false) }
2013-01-05 06:11:15 -05:00
scope :for_commit_id, ->(commit_id) { where(noteable_type: "Commit", commit_id: commit_id) }
scope :inline, ->{ where("line_code IS NOT NULL") }
scope :not_inline, ->{ where(line_code: [nil, '']) }
scope :system, ->{ where(system: true) }
scope :user, ->{ where(system: false) }
scope :common, ->{ where(noteable_type: ["", nil]) }
2015-02-06 13:21:48 -05:00
scope :fresh, ->{ order(created_at: :asc, id: :asc) }
scope :inc_author_project, ->{ includes(:project, :author) }
scope :inc_author, ->{ includes(:author) }
2011-10-18 07:33:30 -04:00
scope :with_associations, -> do
includes(:author, :noteable, :updated_by,
2015-10-15 04:42:48 -04:00
project: [:project_members, { group: [:group_members] }])
end
2011-10-18 07:33:30 -04:00
serialize :st_diff
before_create :set_diff, if: ->(n) { n.line_code.present? }
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
def build_discussion_id(type, id, line_code)
[:discussion, type.try(:underscore), id, line_code].join("-").to_sym
end
def search(query)
where("LOWER(note) like :query", query: "%#{query.downcase}%")
end
2015-11-11 08:12:51 -05:00
def grouped_awards
2015-11-19 11:12:17 -05:00
awards.select(:note).distinct.map do |note|
2015-11-11 08:12:51 -05:00
[ note.note, where(note: note.note) ]
end
end
end
def cross_reference?
system && SystemNoteService.cross_reference?(note)
end
def max_attachment_size
current_application_settings.max_attachment_size.megabytes.to_i
end
def find_diff
return nil unless noteable && noteable.diffs.present?
@diff ||= noteable.diffs.find do |d|
Digest::SHA1.hexdigest(d.new_path) == diff_file_index if d.new_path
2013-01-15 04:12:17 -05:00
end
2012-10-29 10:49:37 -04:00
end
def hook_attrs
attributes
end
def set_diff
# First lets find notes with same diff
# before iterating over all mr diffs
diff = diff_for_line_code unless for_merge_request?
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
def diff_for_line_code
Note.where(noteable_id: noteable_id, noteable_type: noteable_type, line_code: line_code).last.try(:diff)
end
# Check if such line of code exists in merge request diff
# If exists - its active discussion
# If not - its outdated diff
def active?
return true unless self.diff
return false unless noteable
noteable.diffs.each do |mr_diff|
next unless mr_diff.new_path == self.diff.new_path
lines = Gitlab::Diff::Parser.new.parse(mr_diff.diff.lines.to_a)
lines.each do |line|
if line.text == diff_line
return true
end
end
end
false
end
def outdated?
!active?
end
2012-10-29 10:49:37 -04:00
def diff_file_index
2014-06-27 10:48:30 -04:00
line_code.split('_')[0] if line_code
2012-10-29 10:49:37 -04:00
end
def diff_file_name
diff.new_path if diff
2012-10-29 10:49:37 -04:00
end
def file_path
if diff.new_path.present?
diff.new_path
elsif diff.old_path.present?
diff.old_path
end
end
def diff_old_line
2014-06-27 10:48:30 -04:00
line_code.split('_')[1].to_i if line_code
2012-10-29 10:49:37 -04:00
end
def diff_new_line
2014-06-27 10:48:30 -04:00
line_code.split('_')[2].to_i if line_code
2012-10-29 10:49:37 -04:00
end
def generate_line_code(line)
Gitlab::Diff::LineCode.generate(file_path, line.new_pos, line.old_pos)
end
def diff_line
return @diff_line if @diff_line
if diff
diff_lines.each do |line|
if generate_line_code(line) == self.line_code
@diff_line = line.text
end
end
end
@diff_line
end
2014-06-27 10:48:30 -04:00
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
def truncated_diff_lines
max_number_of_lines = 16
prev_match_line = nil
prev_lines = []
diff_lines.each do |line|
if line.type == "match"
prev_lines.clear
prev_match_line = line
else
prev_lines << line
break if generate_line_code(line) == self.line_code
prev_lines.shift if prev_lines.length >= max_number_of_lines
end
end
prev_lines
end
def diff_lines
@diff_lines ||= Gitlab::Diff::Parser.new.parse(diff.diff.lines.to_a)
end
2012-10-29 10:49:37 -04:00
def discussion_id
@discussion_id ||= Note.build_discussion_id(noteable_type, noteable_id || commit_id, line_code)
2012-10-29 10:49:37 -04:00
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
2012-10-29 22:27:36 -04:00
def for_issue?
noteable_type == "Issue"
end
2012-10-29 10:49:37 -04:00
def for_merge_request?
noteable_type == "MergeRequest"
end
def for_merge_request_diff_line?
for_merge_request? && for_diff_line?
end
2012-01-04 15:19:41 -05:00
def for_project_snippet?
noteable_type == "Snippet"
end
2012-10-13 10:23:12 -04:00
# override to return commits, which are not active record
def noteable
if for_commit?
2015-04-21 09:13:40 -04:00
project.commit(commit_id)
2012-03-14 09:31:31 -04:00
else
2012-10-13 10:23:12 -04:00
super
2012-01-04 15:19:41 -05:00
end
# Temp fix to prevent app crash
# if note commit id doesn't exist
2012-03-14 09:31:31 -04:00
rescue
2012-01-20 02:51:48 -05:00
nil
2012-01-04 15:19:41 -05:00
end
2012-02-09 21:59:39 -05:00
# Mentionable override.
2015-05-26 16:30:07 -04:00
def gfm_reference(from_project = nil)
noteable.gfm_reference(from_project)
end
# Mentionable override.
def local_reference
noteable
end
def noteable_type_name
noteable_type.downcase if noteable_type.present?
end
2013-03-25 07:58:09 -04:00
# FIXME: Hack for polymorphic associations with STI
# For more information visit http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Polymorphic+Associations
def noteable_type=(noteable_type)
super(noteable_type.to_s.classify.constantize.base_class.to_s)
2013-03-25 07:58:09 -04:00
end
2013-12-13 14:40:45 -05:00
# 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
Event.reset_event_cache_for(self)
2013-12-13 14:40:45 -05:00
end
2014-06-17 15:09:01 -04:00
def system?
read_attribute(:system)
end
# Deprecated. Still exists to preserve API compatibility.
def downvote?
false
end
# Deprecated. Still exists to preserve API compatibility.
def upvote?
false
end
def editable?
!system? && !is_award
end
# Checks if note is an award added as a comment
#
# If note is an award, this method sets is_award to true
# and changes content of the note to award name.
#
# Method is executed as a before_validation callback.
#
def set_award!
return unless awards_supported? && contains_emoji_only?
self.is_award = true
self.note = award_emoji_name
end
private
def awards_supported?
noteable.kind_of?(Issue) || noteable.is_a?(MergeRequest)
end
def contains_emoji_only?
note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
end
def award_emoji_name
original_name = note.match(Banzai::Filter::EmojiFilter.emoji_pattern)[1]
2015-12-11 06:10:00 -05:00
AwardEmoji.normilize_emoji_name(original_name)
end
2011-10-08 17:36:38 -04:00
end