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