2017-04-06 15:05:57 +00:00
|
|
|
# A note on the root of an issue, merge request, commit, or snippet.
|
|
|
|
#
|
|
|
|
# A note of this type is never resolvable.
|
2011-10-08 21:36:38 +00:00
|
|
|
class Note < ActiveRecord::Base
|
2016-05-10 22:41:46 +00:00
|
|
|
extend ActiveModel::Naming
|
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
|
2016-05-25 19:07:36 +00:00
|
|
|
include Awardable
|
2016-06-13 11:34:36 +00:00
|
|
|
include Importable
|
2016-08-08 14:18:13 +00:00
|
|
|
include FasterCacheKeys
|
2016-10-06 21:52:44 +00:00
|
|
|
include CacheMarkdownField
|
2016-10-13 15:26:44 +00:00
|
|
|
include AfterCommitQueue
|
2017-03-10 01:29:11 +00:00
|
|
|
include ResolvableNote
|
2017-04-04 22:41:04 +00:00
|
|
|
include IgnorableColumn
|
2017-05-18 12:24:34 +00:00
|
|
|
include Editable
|
2017-04-04 22:41:04 +00:00
|
|
|
|
|
|
|
ignore_column :original_discussion_id
|
2016-10-06 21:52:44 +00:00
|
|
|
|
2017-04-19 14:38:46 +00:00
|
|
|
cache_markdown_field :note, pipeline: :note, issuable_state_filter_enabled: true
|
2013-05-09 23:37:47 +00:00
|
|
|
|
2017-05-03 11:16:36 +00:00
|
|
|
# Aliases to make application_helper#edited_time_ago_with_tooltip helper work properly with notes.
|
|
|
|
# See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10392/diffs#note_28719102
|
2017-05-03 11:11:19 +00:00
|
|
|
alias_attribute :last_edited_at, :updated_at
|
|
|
|
alias_attribute :last_edited_by, :updated_by
|
|
|
|
|
2016-06-21 11:35:09 +00:00
|
|
|
# Attribute containing rendered and redacted Markdown as generated by
|
|
|
|
# Banzai::ObjectRenderer.
|
2016-10-06 21:52:44 +00:00
|
|
|
attr_accessor :redacted_note_html
|
2016-06-21 11:35:09 +00:00
|
|
|
|
2016-07-04 05:31:43 +00:00
|
|
|
# An Array containing the number of visible references as generated by
|
|
|
|
# Banzai::ObjectRenderer
|
|
|
|
attr_accessor :user_visible_reference_count
|
|
|
|
|
2017-05-31 05:50:53 +00:00
|
|
|
# Attribute used to store the attributes that have ben changed by quick actions.
|
2016-11-24 06:32:32 +00:00
|
|
|
attr_accessor :commands_changes
|
|
|
|
|
2014-04-09 10:36:25 +00:00
|
|
|
default_value_for :system, false
|
|
|
|
|
2016-05-26 11:38:28 +00:00
|
|
|
attr_mentionable :note, 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
|
2017-06-02 12:29:30 +00:00
|
|
|
belongs_to :noteable, polymorphic: true, touch: true # rubocop:disable Cop/PolymorphicAssociations
|
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"
|
2017-05-03 05:32:21 +00:00
|
|
|
belongs_to :last_edited_by, class_name: 'User'
|
2011-10-08 21:36:38 +00:00
|
|
|
|
2017-06-08 15:16:27 +00:00
|
|
|
has_many :todos, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
|
|
|
has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
2017-03-15 13:19:45 +00:00
|
|
|
has_one :system_note_metadata
|
2016-02-17 19:45:32 +00:00
|
|
|
|
2016-03-06 01:43:12 +00:00
|
|
|
delegate :gfm_reference, :local_reference, to: :noteable
|
2012-09-27 06:20:36 +00:00
|
|
|
delegate :name, to: :project, prefix: true
|
|
|
|
delegate :name, :email, to: :author, prefix: true
|
2016-05-08 18:05:45 +00:00
|
|
|
delegate :title, to: :noteable, allow_nil: true
|
2011-11-03 10:56:26 +00:00
|
|
|
|
2017-01-05 13:36:06 +00:00
|
|
|
validates :note, presence: true
|
|
|
|
validates :project, presence: true, unless: :for_personal_snippet?
|
2016-06-01 09:23:09 +00:00
|
|
|
|
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
|
|
|
|
2016-04-29 10:16:18 +00:00
|
|
|
validates :noteable_type, presence: true
|
2016-06-13 11:34:36 +00:00
|
|
|
validates :noteable_id, presence: true, unless: [:for_commit?, :importing?]
|
2016-04-26 07:35:03 +00:00
|
|
|
validates :commit_id, presence: true, if: :for_commit?
|
2015-11-19 16:12:17 +00:00
|
|
|
validates :author, presence: true
|
2017-03-31 01:33:45 +00:00
|
|
|
validates :discussion_id, presence: true, format: { with: /\A\h{40}\z/ }
|
2012-12-18 18:02:00 +00:00
|
|
|
|
2017-01-05 13:36:06 +00:00
|
|
|
validate unless: [:for_commit?, :importing?, :for_personal_snippet?] do |note|
|
2016-04-26 11:50:48 +00:00
|
|
|
unless note.noteable.try(:project) == note.project
|
2017-03-17 19:25:52 +00:00
|
|
|
errors.add(:project, 'does not match noteable project')
|
2016-04-25 12:28:23 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
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) }
|
2017-08-09 09:52:22 +00:00
|
|
|
scope :system, -> { where(system: true) }
|
|
|
|
scope :user, -> { where(system: false) }
|
|
|
|
scope :common, -> { where(noteable_type: ["", nil]) }
|
|
|
|
scope :fresh, -> { order(created_at: :asc, id: :asc) }
|
|
|
|
scope :updated_after, ->(time) { where('updated_at > ?', time) }
|
|
|
|
scope :inc_author_project, -> { includes(:project, :author) }
|
|
|
|
scope :inc_author, -> { includes(:author) }
|
2017-03-15 13:18:44 +00:00
|
|
|
scope :inc_relations_for_view, -> do
|
|
|
|
includes(:project, :author, :updated_by, :resolved_by, :award_emoji, :system_note_metadata)
|
|
|
|
end
|
2011-10-18 11:33:30 +00:00
|
|
|
|
2017-08-09 09:52:22 +00:00
|
|
|
scope :diff_notes, -> { where(type: %w(LegacyDiffNote DiffNote)) }
|
|
|
|
scope :new_diff_notes, -> { where(type: 'DiffNote') }
|
|
|
|
scope :non_diff_notes, -> { where(type: ['Note', 'DiscussionNote', nil]) }
|
2016-05-10 22:41:46 +00:00
|
|
|
|
2015-10-15 08:41:09 +00:00
|
|
|
scope :with_associations, -> do
|
2016-06-21 05:26:43 +00:00
|
|
|
# FYI noteable cannot be loaded for LegacyDiffNote for commits
|
|
|
|
includes(:author, :noteable, :updated_by,
|
2015-10-15 08:42:48 +00:00
|
|
|
project: [:project_members, { group: [:group_members] }])
|
2015-10-14 10:44:10 +00:00
|
|
|
end
|
2011-10-18 11:33:30 +00:00
|
|
|
|
2017-03-31 01:33:45 +00:00
|
|
|
after_initialize :ensure_discussion_id
|
2016-07-22 22:26:33 +00:00
|
|
|
before_validation :nullify_blank_type, :nullify_blank_line_code
|
2017-03-31 01:33:45 +00:00
|
|
|
before_validation :set_discussion_id, on: :create
|
2017-01-05 13:36:06 +00:00
|
|
|
after_save :keep_around_commit, unless: :for_personal_snippet?
|
2017-02-08 17:04:16 +00:00
|
|
|
after_save :expire_etag_cache
|
2017-04-11 12:20:25 +00:00
|
|
|
after_destroy :expire_etag_cache
|
2013-08-04 16:01:57 +00:00
|
|
|
|
2013-12-25 11:32:43 +00:00
|
|
|
class << self
|
2016-05-10 22:41:46 +00:00
|
|
|
def model_name
|
|
|
|
ActiveModel::Name.new(self, nil, 'note')
|
|
|
|
end
|
2013-12-25 11:32:43 +00:00
|
|
|
|
2017-04-07 16:29:29 +00:00
|
|
|
def discussions(context_noteable = nil)
|
2017-05-31 19:00:30 +00:00
|
|
|
Discussion.build_collection(all.includes(:noteable).fresh, context_noteable)
|
2013-12-25 11:32:43 +00:00
|
|
|
end
|
2012-05-20 18:35:03 +00:00
|
|
|
|
2017-03-10 01:29:11 +00:00
|
|
|
def find_discussion(discussion_id)
|
|
|
|
notes = where(discussion_id: discussion_id).fresh.to_a
|
|
|
|
return if notes.empty?
|
|
|
|
|
|
|
|
Discussion.build(notes)
|
2013-12-25 11:32:43 +00:00
|
|
|
end
|
2012-05-20 18:35:03 +00:00
|
|
|
|
2017-03-31 23:39:14 +00:00
|
|
|
def grouped_diff_discussions(diff_refs = nil)
|
2017-05-22 20:56:20 +00:00
|
|
|
groups = {}
|
2017-04-30 20:32:09 +00:00
|
|
|
|
|
|
|
diff_notes.fresh.discussions.each do |discussion|
|
2017-05-24 15:10:10 +00:00
|
|
|
line_code = discussion.line_code_in_diffs(diff_refs)
|
2017-05-21 20:38:33 +00:00
|
|
|
|
2017-05-22 20:56:20 +00:00
|
|
|
if line_code
|
|
|
|
discussions = groups[line_code] ||= []
|
|
|
|
discussions << discussion
|
|
|
|
end
|
2017-04-30 20:32:09 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
groups
|
2014-06-06 20:15:54 +00:00
|
|
|
end
|
2017-01-23 20:40:25 +00:00
|
|
|
|
|
|
|
def count_for_collection(ids, type)
|
2017-06-21 13:48:12 +00:00
|
|
|
user.select('noteable_id', 'COUNT(*) as count')
|
|
|
|
.group(:noteable_id)
|
|
|
|
.where(noteable_type: type, noteable_id: ids)
|
2017-01-23 20:40:25 +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?
|
2017-03-10 01:29:11 +00:00
|
|
|
system? && SystemNoteService.cross_reference?(note)
|
2013-05-30 23:16:49 +00:00
|
|
|
end
|
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def diff_note?
|
|
|
|
false
|
2015-03-20 12:11:12 +00:00
|
|
|
end
|
|
|
|
|
2013-08-04 17:43:49 +00:00
|
|
|
def active?
|
2016-05-13 19:53:31 +00:00
|
|
|
true
|
2014-09-08 18:54:52 +00:00
|
|
|
end
|
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def max_attachment_size
|
|
|
|
current_application_settings.max_attachment_size.megabytes.to_i
|
2014-09-08 13:27:12 +00:00
|
|
|
end
|
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def hook_attrs
|
|
|
|
attributes
|
2012-10-29 14:49:37 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def for_commit?
|
|
|
|
noteable_type == "Commit"
|
|
|
|
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
|
|
|
|
|
2016-03-31 07:20:27 +00:00
|
|
|
def for_snippet?
|
2015-03-05 18:38:23 +00:00
|
|
|
noteable_type == "Snippet"
|
|
|
|
end
|
|
|
|
|
2017-01-05 13:36:06 +00:00
|
|
|
def for_personal_snippet?
|
2017-01-20 10:28:40 +00:00
|
|
|
noteable.is_a?(PersonalSnippet)
|
|
|
|
end
|
|
|
|
|
|
|
|
def skip_project_check?
|
|
|
|
for_personal_snippet?
|
2017-01-05 13:36:06 +00:00
|
|
|
end
|
|
|
|
|
2012-10-13 14:23:12 +00:00
|
|
|
# override to return commits, which are not active record
|
|
|
|
def noteable
|
|
|
|
if for_commit?
|
2017-07-17 19:26:41 +00:00
|
|
|
@commit ||= 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
|
|
|
|
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
|
2015-10-12 12:30:44 +00:00
|
|
|
def noteable_type=(noteable_type)
|
|
|
|
super(noteable_type.to_s.classify.constantize.base_class.to_s)
|
2013-03-25 11:58:09 +00:00
|
|
|
end
|
2013-12-13 19:40:45 +00:00
|
|
|
|
2014-08-29 12:19:35 +00:00
|
|
|
def editable?
|
2016-04-16 19:09:08 +00:00
|
|
|
!system?
|
2014-08-29 12:19:35 +00:00
|
|
|
end
|
2015-12-02 07:48:21 +00:00
|
|
|
|
2016-01-13 15:37:17 +00:00
|
|
|
def cross_reference_not_visible_for?(user)
|
2016-07-04 05:31:43 +00:00
|
|
|
cross_reference? && !has_referenced_mentionables?(user)
|
|
|
|
end
|
|
|
|
|
|
|
|
def has_referenced_mentionables?(user)
|
|
|
|
if user_visible_reference_count.present?
|
|
|
|
user_visible_reference_count > 0
|
|
|
|
else
|
|
|
|
referenced_mentionables(user).any?
|
|
|
|
end
|
2016-01-13 15:37:17 +00:00
|
|
|
end
|
|
|
|
|
2016-04-16 19:09:08 +00:00
|
|
|
def award_emoji?
|
2016-06-20 17:15:44 +00:00
|
|
|
can_be_award_emoji? && contains_emoji_only?
|
2015-12-02 07:48:21 +00:00
|
|
|
end
|
|
|
|
|
2016-06-15 10:29:57 +00:00
|
|
|
def emoji_awardable?
|
|
|
|
!system?
|
|
|
|
end
|
|
|
|
|
2016-06-20 17:15:44 +00:00
|
|
|
def can_be_award_emoji?
|
2017-03-10 01:29:11 +00:00
|
|
|
noteable.is_a?(Awardable) && !part_of_discussion?
|
2015-12-05 21:09:52 +00:00
|
|
|
end
|
|
|
|
|
2015-12-02 07:48:21 +00:00
|
|
|
def contains_emoji_only?
|
2015-12-15 15:10:32 +00:00
|
|
|
note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
|
2015-12-02 07:48:21 +00:00
|
|
|
end
|
|
|
|
|
2017-01-20 10:28:40 +00:00
|
|
|
def to_ability_name
|
|
|
|
for_personal_snippet? ? 'personal_snippet' : noteable_type.underscore
|
|
|
|
end
|
|
|
|
|
2017-03-10 01:29:11 +00:00
|
|
|
def can_be_discussion_note?
|
2017-04-06 15:05:57 +00:00
|
|
|
self.noteable.supports_discussions? && !part_of_discussion?
|
2017-04-05 23:42:07 +00:00
|
|
|
end
|
|
|
|
|
2017-03-10 01:29:11 +00:00
|
|
|
def discussion_class(noteable = nil)
|
|
|
|
# When commit notes are rendered on an MR's Discussion page, they are
|
2017-04-04 22:27:23 +00:00
|
|
|
# displayed in one discussion instead of individually.
|
|
|
|
# See also `#discussion_id` and `Discussion.override_discussion_id`.
|
2017-03-17 19:25:52 +00:00
|
|
|
if noteable && noteable != self.noteable
|
|
|
|
OutOfContextDiscussion
|
2017-03-10 01:29:11 +00:00
|
|
|
else
|
|
|
|
IndividualNoteDiscussion
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-04-04 22:27:23 +00:00
|
|
|
# See `Discussion.override_discussion_id` for details.
|
2017-03-10 01:29:11 +00:00
|
|
|
def discussion_id(noteable = nil)
|
|
|
|
discussion_class(noteable).override_discussion_id(self) || super()
|
|
|
|
end
|
|
|
|
|
2017-03-31 03:06:09 +00:00
|
|
|
# Returns a discussion containing just this note.
|
|
|
|
# This method exists as an alternative to `#discussion` to use when the methods
|
|
|
|
# we intend to call on the Discussion object don't require it to have all of its notes,
|
|
|
|
# and just depend on the first note or the type of discussion. This saves us a DB query.
|
2017-03-10 01:29:11 +00:00
|
|
|
def to_discussion(noteable = nil)
|
|
|
|
Discussion.build([self], noteable)
|
|
|
|
end
|
|
|
|
|
2017-03-31 03:06:09 +00:00
|
|
|
# Returns the entire discussion this note is part of.
|
|
|
|
# Consider using `#to_discussion` if we do not need to render the discussion
|
|
|
|
# and all its notes and if we don't care about the discussion's resolvability status.
|
2017-03-10 01:29:11 +00:00
|
|
|
def discussion
|
2017-03-31 03:06:09 +00:00
|
|
|
full_discussion = self.noteable.notes.find_discussion(self.discussion_id) if part_of_discussion?
|
|
|
|
full_discussion || to_discussion
|
2017-03-10 01:29:11 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def part_of_discussion?
|
2017-03-17 19:25:52 +00:00
|
|
|
!to_discussion.individual_note?
|
|
|
|
end
|
|
|
|
|
|
|
|
def in_reply_to?(other)
|
|
|
|
case other
|
|
|
|
when Note
|
|
|
|
if part_of_discussion?
|
|
|
|
in_reply_to?(other.noteable) && in_reply_to?(other.to_discussion)
|
|
|
|
else
|
|
|
|
in_reply_to?(other.noteable)
|
|
|
|
end
|
|
|
|
when Discussion
|
|
|
|
self.discussion_id == other.id
|
|
|
|
when Noteable
|
|
|
|
self.noteable == other
|
|
|
|
else
|
|
|
|
false
|
|
|
|
end
|
2017-03-10 01:29:11 +00:00
|
|
|
end
|
|
|
|
|
2017-07-17 18:36:29 +00:00
|
|
|
def expire_etag_cache
|
2017-08-30 08:43:10 +00:00
|
|
|
return unless noteable&.discussions_rendered_on_frontend?
|
2017-07-17 18:36:29 +00:00
|
|
|
|
|
|
|
key = Gitlab::Routing.url_helpers.project_noteable_notes_path(
|
2017-08-17 17:26:45 +00:00
|
|
|
project,
|
2017-07-17 18:36:29 +00:00
|
|
|
target_type: noteable_type.underscore,
|
2017-08-17 17:26:45 +00:00
|
|
|
target_id: noteable_id
|
2017-07-17 18:36:29 +00:00
|
|
|
)
|
|
|
|
Gitlab::EtagCaching::Store.new.touch(key)
|
|
|
|
end
|
|
|
|
|
2016-07-03 23:58:58 +00:00
|
|
|
private
|
|
|
|
|
|
|
|
def keep_around_commit
|
|
|
|
project.repository.keep_around(self.commit_id)
|
|
|
|
end
|
2016-07-22 22:26:33 +00:00
|
|
|
|
|
|
|
def nullify_blank_type
|
|
|
|
self.type = nil if self.type.blank?
|
|
|
|
end
|
|
|
|
|
|
|
|
def nullify_blank_line_code
|
|
|
|
self.line_code = nil if self.line_code.blank?
|
|
|
|
end
|
2016-08-17 17:14:44 +00:00
|
|
|
|
|
|
|
def ensure_discussion_id
|
|
|
|
return unless self.persisted?
|
2016-08-20 16:18:06 +00:00
|
|
|
# Needed in case the SELECT statement doesn't ask for `discussion_id`
|
|
|
|
return unless self.has_attribute?(:discussion_id)
|
2016-08-17 17:14:44 +00:00
|
|
|
return if self.discussion_id
|
|
|
|
|
|
|
|
set_discussion_id
|
|
|
|
update_column(:discussion_id, self.discussion_id)
|
|
|
|
end
|
|
|
|
|
|
|
|
def set_discussion_id
|
2017-03-10 01:29:11 +00:00
|
|
|
self.discussion_id ||= discussion_class.discussion_id(self)
|
2016-08-17 17:14:44 +00:00
|
|
|
end
|
2011-10-08 21:36:38 +00:00
|
|
|
end
|