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

508 lines
13 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
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 Mentionable
default_value_for :system, false
attr_mentionable :note
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"
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
2012-12-01 06:19:16 -05:00
validates :note, :project, presence: true
validates :line_code, format: { with: /\A[a-z0-9]+_\d+_\d+\Z/ }, allow_blank: true
validates :attachment, file_size: { maximum: 10.megabytes.to_i }
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' }
2012-12-01 06:19:16 -05:00
mount_uploader :attachment, AttachmentUploader
2012-10-08 20:10:04 -04:00
# Scopes
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 :common, ->{ where(noteable_type: ["", nil]) }
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
serialize :st_diff
before_create :set_diff, if: ->(n) { n.line_code.present? }
2014-06-17 15:09:01 -04:00
after_update :set_references
class << self
def create_status_change_note(noteable, project, author, status, source)
body = "_Status changed to #{status}#{' by ' + source.gfm_reference if source}_"
create(
noteable: noteable,
project: project,
author: author,
note: body,
system: true
)
end
# +noteable+ was referenced from +mentioner+, by including GFM in either
# +mentioner+'s description or an associated Note.
# Create a system Note associated with +noteable+ with a GFM back-reference
# to +mentioner+.
def create_cross_reference_note(noteable, mentioner, author, project)
gfm_reference = mentioner_gfm_ref(noteable, mentioner, project)
note_options = {
project: project,
author: author,
2014-10-19 10:24:22 -04:00
note: cross_reference_note_content(gfm_reference),
system: true
}
if noteable.kind_of?(Commit)
note_options.merge!(noteable_type: 'Commit', commit_id: noteable.id)
else
note_options.merge!(noteable: noteable)
end
create(note_options) unless cross_reference_disallowed?(noteable, mentioner)
end
def create_milestone_change_note(noteable, project, author, milestone)
body = if milestone.nil?
'_Milestone removed_'
else
"_Milestone changed to #{milestone.title}_"
end
create(
noteable: noteable,
project: project,
author: author,
note: body,
system: true
)
end
def create_assignee_change_note(noteable, project, author, assignee)
body = assignee.nil? ? '_Assignee removed_' : "_Reassigned to @#{assignee.username}_"
create({
noteable: noteable,
project: project,
author: author,
note: body,
system: true
})
end
def create_new_commits_note(noteable, project, author, commits)
commits_text = ActionController::Base.helpers.pluralize(commits.size, 'new commit')
body = "Added #{commits_text}:\n\n"
commits.each do |commit|
message = "* #{commit.short_id} - #{commit.title}"
body << message
body << "\n"
end
create(
noteable: noteable,
project: project,
author: author,
note: body,
system: true
)
end
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
# Determine if cross reference note should be created.
# eg. mentioning a commit in MR comments which exists inside a MR
# should not create "mentioned in" note.
def cross_reference_disallowed?(noteable, mentioner)
if mentioner.kind_of?(MergeRequest)
mentioner.commits.map(&:id).include? noteable.id
end
end
# Determine whether or not a cross-reference note already exists.
def cross_reference_exists?(noteable, mentioner)
gfm_reference = mentioner_gfm_ref(noteable, mentioner)
notes = if noteable.is_a?(Commit)
where(commit_id: noteable.id)
else
where(noteable_id: noteable.id)
end
2014-10-19 10:24:22 -04:00
notes.where('note like ?', cross_reference_note_content(gfm_reference)).
system.any?
end
def search(query)
where("note like :query", query: "%#{query}%")
end
2014-10-19 10:24:22 -04:00
def cross_reference_note_prefix
'_mentioned in '
end
private
2014-10-19 10:24:22 -04:00
def cross_reference_note_content(gfm_reference)
cross_reference_note_prefix + "#{gfm_reference}_"
end
# Prepend the mentioner's namespaced project path to the GFM reference for
# cross-project references. For same-project references, return the
# unmodified GFM reference.
def mentioner_gfm_ref(noteable, mentioner, project = nil)
if mentioner.is_a?(Commit)
if project.nil?
return mentioner.gfm_reference.sub('commit ', 'commit %')
else
mentioning_project = project
end
else
mentioning_project = mentioner.project
end
noteable_project_id = noteable_project_id(noteable, mentioning_project)
full_gfm_reference(mentioning_project, noteable_project_id, mentioner)
end
# Return the ID of the project that +noteable+ belongs to, or nil if
# +noteable+ is a commit and is not part of the project that owns
# +mentioner+.
def noteable_project_id(noteable, mentioning_project)
if noteable.is_a?(Commit)
if mentioning_project.repository.commit(noteable.id)
# The noteable commit belongs to the mentioner's project
mentioning_project.id
else
nil
end
else
noteable.project.id
end
end
# Return the +mentioner+ GFM reference. If the mentioner and noteable
# projects are not the same, add the mentioning project's path to the
# returned value.
def full_gfm_reference(mentioning_project, noteable_project_id, mentioner)
if mentioning_project.id == noteable_project_id
mentioner.gfm_reference
else
if mentioner.is_a?(Commit)
mentioner.gfm_reference.sub(
/(commit )/,
"\\1#{mentioning_project.path_with_namespace}@"
)
else
mentioner.gfm_reference.sub(
/(issue |merge request )/,
"\\1#{mentioning_project.path_with_namespace}"
)
end
end
end
end
2012-10-29 10:49:37 -04:00
def commit_author
@commit_author ||=
project.team.users.find_by(email: noteable.author_email) ||
project.team.users.find_by(name: noteable.author_name)
2012-10-29 10:49:37 -04:00
rescue
nil
2011-12-17 08:58:35 -05:00
end
2014-10-19 10:24:22 -04:00
def cross_reference?
note.start_with?(self.class.cross_reference_note_prefix)
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 set_diff
# First lets find notes with same diff
# before iterating over all mr diffs
diff = Note.where(noteable_id: self.noteable_id, noteable_type: self.noteable_type, line_code: self.line_code).last.try(:diff)
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
# 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
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 generate_line_code(line) != self.line_code
if line.type == "match"
prev_lines.clear
prev_match_line = line
else
prev_lines.push(line)
prev_lines.shift if prev_lines.length >= max_number_of_lines
end
else
prev_lines << line
return prev_lines
end
end
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
# Returns true if this is a downvote note,
# otherwise false is returned
def downvote?
2012-10-29 22:27:36 -04:00
votable? && (note.start_with?('-1') ||
note.start_with?(':-1:') ||
2014-03-20 08:31:43 -04:00
note.start_with?(':thumbsdown:') ||
note.start_with?(':thumbs_down_sign:')
)
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
2012-10-13 10:23:12 -04:00
# override to return commits, which are not active record
def noteable
if for_commit?
project.repository.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
2012-03-14 09:31:31 -04:00
# Returns true if this is an upvote note,
# otherwise false is returned
def upvote?
2012-10-29 22:27:36 -04:00
votable? && (note.start_with?('+1') ||
note.start_with?(':+1:') ||
2014-03-20 08:31:43 -04:00
note.start_with?(':thumbsup:') ||
note.start_with?(':thumbs_up_sign:')
)
2012-10-29 22:27:36 -04:00
end
def votable?
for_issue? || (for_merge_request? && !for_diff_line?)
2012-03-14 09:31:31 -04:00
end
# Mentionable override.
def gfm_reference
noteable.gfm_reference
end
# Mentionable override.
def local_reference
noteable
end
def noteable_type_name
if noteable_type.present?
noteable_type.downcase
end
end
2013-03-25 07:58:09 -04:00
# FIXME: Hack for polymorphic associations with STI
# For more information wisit http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Polymorphic+Associations
def noteable_type=(sType)
super(sType.to_s.classify.constantize.base_class.to_s)
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 set_references
notice_added_references(project, author)
end
def editable?
!read_attribute(:system)
end
2011-10-08 17:36:38 -04:00
end