debian-mirror-gitlab/app/models/note.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

832 lines
24 KiB
Ruby
Raw Normal View History

2018-11-18 11:00:15 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
# A note on the root of an issue, merge request, commit, or snippet.
#
# A note of this type is never resolvable.
2019-07-07 11:18:12 +05:30
class Note < ApplicationRecord
2016-06-02 11:05:42 +05:30
extend ActiveModel::Naming
2021-10-27 15:23:28 +05:30
extend Gitlab::Utils::Override
2020-07-28 23:09:34 +05:30
include Gitlab::Utils::StrongMemoize
2015-09-11 14:41:01 +05:30
include Participable
2015-10-24 18:46:33 +05:30
include Mentionable
include Awardable
2016-06-22 15:30:34 +05:30
include Importable
2016-09-13 17:45:13 +05:30
include FasterCacheKeys
2018-11-18 11:00:15 +05:30
include Redactable
2016-11-03 12:29:30 +05:30
include CacheMarkdownField
2017-08-17 22:00:37 +05:30
include AfterCommitQueue
include ResolvableNote
include Editable
2018-03-17 18:26:18 +05:30
include Gitlab::SQL::Pattern
include ThrottledTouch
2018-12-05 23:21:45 +05:30
include FromUnion
2021-04-29 21:17:54 +05:30
include Sortable
2022-11-25 23:54:43 +05:30
include EachBatch
2018-03-17 18:26:18 +05:30
2022-08-27 11:52:29 +05:30
ISSUE_TASK_SYSTEM_NOTE_PATTERN = /\A.*marked\sthe\stask.+as\s(completed|incomplete).*\z/.freeze
2022-01-26 12:08:38 +05:30
cache_markdown_field :note, pipeline: :note, issuable_reference_expansion_enabled: true
2017-08-17 22:00:37 +05:30
2018-11-18 11:00:15 +05:30
redact_field :note
2022-04-04 11:22:00 +05:30
TYPES_RESTRICTED_BY_PROJECT_ABILITY = {
2019-12-04 20:38:33 +05:30
branch: :download_code
}.freeze
2022-04-04 11:22:00 +05:30
TYPES_RESTRICTED_BY_GROUP_ABILITY = {
contact: :read_crm_contact
}.freeze
2022-06-21 17:19:12 +05:30
NON_DIFF_NOTE_TYPES = ['Note', 'DiscussionNote', nil].freeze
2017-08-17 22:00:37 +05:30
# Aliases to make application_helper#edited_time_ago_with_tooltip helper work properly with notes.
2019-12-04 20:38:33 +05:30
# See https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/10392/diffs#note_28719102
2017-08-17 22:00:37 +05:30
alias_attribute :last_edited_by, :updated_by
2014-09-02 18:07:02 +05:30
2018-12-13 13:39:08 +05:30
# Attribute containing rendered and redacted Markdown as generated by
# Banzai::ObjectRenderer.
2016-11-03 12:29:30 +05:30
attr_accessor :redacted_note_html
2016-08-24 12:49:21 +05:30
2018-11-08 19:23:39 +05:30
# Total of all references as generated by Banzai::ObjectRenderer
attr_accessor :total_reference_count
2018-12-13 13:39:08 +05:30
# Number of user visible references as generated by Banzai::ObjectRenderer
2016-08-24 12:49:21 +05:30
attr_accessor :user_visible_reference_count
2018-03-17 18:26:18 +05:30
# Attribute used to store the attributes that have been changed by quick actions.
2022-02-27 12:50:16 +05:30
attr_writer :commands_changes
2017-08-17 22:00:37 +05:30
2021-11-11 11:23:49 +05:30
# Attribute used to determine whether keep_around_commits will be skipped for diff notes.
attr_accessor :skip_keep_around_commits
2023-01-13 00:05:48 +05:30
attribute :system, default: false
2014-09-02 18:07:02 +05:30
attr_mentionable :note, pipeline: :note
2015-10-24 18:46:33 +05:30
participant :author
2014-09-02 18:07:02 +05:30
belongs_to :project
2018-03-17 18:26:18 +05:30
belongs_to :noteable, polymorphic: true # rubocop:disable Cop/PolymorphicAssociations
2014-09-02 18:07:02 +05:30
belongs_to :author, class_name: "User"
2015-09-11 14:41:01 +05:30
belongs_to :updated_by, class_name: "User"
2017-08-17 22:00:37 +05:30
belongs_to :last_edited_by, class_name: 'User'
2020-06-23 00:09:42 +05:30
belongs_to :review, inverse_of: :notes
2016-09-13 17:45:13 +05:30
2018-03-17 18:26:18 +05:30
has_many :todos
2019-02-15 15:39:39 +05:30
# The delete_all definition is required here in order
# to generate the correct DELETE sql for
# suggestions.delete_all calls
has_many :suggestions, -> { order(:relative_order) },
inverse_of: :note, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
2019-12-04 20:38:33 +05:30
has_many :events, as: :target, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent
2017-08-17 22:00:37 +05:30
has_one :system_note_metadata
2018-11-08 19:23:39 +05:30
has_one :note_diff_file, inverse_of: :diff_note, foreign_key: :diff_note_id
2020-04-22 19:07:51 +05:30
has_many :diff_note_positions
2016-04-02 18:10:28 +05:30
2016-06-02 11:05:42 +05:30
delegate :gfm_reference, :local_reference, to: :noteable
2014-09-02 18:07:02 +05:30
delegate :name, to: :project, prefix: true
delegate :name, :email, to: :author, prefix: true
2016-06-02 11:05:42 +05:30
delegate :title, to: :noteable, allow_nil: true
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
validates :note, presence: true
2019-09-04 21:01:54 +05:30
validates :note, length: { maximum: Gitlab::Database::MAX_TEXT_SIZE_LIMIT }
2018-03-17 18:26:18 +05:30
validates :project, presence: true, if: :for_project_noteable?
2015-04-26 12:48:37 +05:30
# Attachments are deprecated and are handled by Markdown uploader
validates :attachment, file_size: { maximum: :max_attachment_size }
2014-09-02 18:07:02 +05:30
validates :noteable_type, presence: true
2016-06-22 15:30:34 +05:30
validates :noteable_id, presence: true, unless: [:for_commit?, :importing?]
validates :commit_id, presence: true, if: :for_commit?
2015-11-26 14:37:03 +05:30
validates :author, presence: true
2017-08-17 22:00:37 +05:30
validates :discussion_id, presence: true, format: { with: /\A\h{40}\z/ }
2014-09-02 18:07:02 +05:30
2022-06-21 17:19:12 +05:30
validate :ensure_confidentiality_discussion_compliance
validate :ensure_noteable_can_have_confidential_note
validate :ensure_note_type_can_be_confidential
validate :ensure_confidentiality_not_changed, on: :update
2018-03-27 19:54:05 +05:30
validate unless: [:for_commit?, :importing?, :skip_project_check?] do |note|
unless note.noteable.try(:project) == note.project
2017-08-17 22:00:37 +05:30
errors.add(:project, 'does not match noteable project')
end
end
2019-12-21 20:55:43 +05:30
validate :does_not_exceed_notes_limit?, on: :create, unless: [:system?, :importing?]
2022-08-13 15:12:31 +05:30
validate :validate_created_after
2019-12-21 20:55:43 +05:30
2021-09-04 01:27:46 +05:30
# @deprecated attachments are handled by the Upload model.
#
# https://gitlab.com/gitlab-org/gitlab/-/issues/20830
2014-09-02 18:07:02 +05:30
mount_uploader :attachment, AttachmentUploader
# Scopes
scope :for_commit_id, ->(commit_id) { where(noteable_type: "Commit", commit_id: commit_id) }
2018-03-17 18:26:18 +05:30
scope :system, -> { where(system: true) }
scope :user, -> { where(system: false) }
2023-03-17 16:20:25 +05:30
scope :not_internal, -> { where(internal: false) }
2018-03-17 18:26:18 +05:30
scope :common, -> { where(noteable_type: ["", nil]) }
2021-04-29 21:17:54 +05:30
scope :fresh, -> { order_created_asc.with_order_id_asc }
2018-03-17 18:26:18 +05:30
scope :updated_after, ->(time) { where('updated_at > ?', time) }
2021-12-11 22:18:48 +05:30
scope :with_discussion_ids, ->(discussion_ids) { where(discussion_id: discussion_ids) }
2021-06-08 01:23:25 +05:30
scope :with_suggestions, -> { joins(:suggestions) }
2018-03-17 18:26:18 +05:30
scope :inc_author, -> { includes(:author) }
2022-06-21 17:19:12 +05:30
scope :inc_note_diff_file, -> { includes(:note_diff_file) }
2021-04-29 21:17:54 +05:30
scope :with_api_entity_associations, -> { preload(:note_diff_file, :author) }
2023-03-17 16:20:25 +05:30
scope :inc_relations_for_view, ->(noteable = nil) do
relations = [{ project: :group }, { author: :status }, :updated_by, :resolved_by,
:award_emoji, { system_note_metadata: :description_version }, :suggestions]
if noteable.nil? || DiffNote.noteable_types.include?(noteable.class.name) ||
Feature.disabled?(:skip_notes_diff_include)
relations += [:note_diff_file, :diff_note_positions]
end
includes(relations)
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
2018-12-13 13:39:08 +05:30
scope :with_notes_filter, -> (notes_filter) do
case notes_filter
when UserPreference::NOTES_FILTERS[:only_comments]
user
when UserPreference::NOTES_FILTERS[:only_activity]
system
else
all
end
end
2018-03-17 18:26:18 +05:30
scope :diff_notes, -> { where(type: %w(LegacyDiffNote DiffNote)) }
scope :new_diff_notes, -> { where(type: 'DiffNote') }
2022-06-21 17:19:12 +05:30
scope :non_diff_notes, -> { where(type: NON_DIFF_NOTE_TYPES) }
2016-06-02 11:05:42 +05:30
2015-10-24 18:46:33 +05:30
scope :with_associations, -> do
2016-08-24 12:49:21 +05:30
# FYI noteable cannot be loaded for LegacyDiffNote for commits
2015-10-24 18:46:33 +05:30
includes(:author, :noteable, :updated_by,
2019-02-15 15:39:39 +05:30
project: [:project_members, :namespace, { group: [:group_members] }])
2015-10-24 18:46:33 +05:30
end
2018-03-17 18:26:18 +05:30
scope :with_metadata, -> { includes(:system_note_metadata) }
2021-04-29 21:17:54 +05:30
scope :with_web_entity_associations, -> { preload(:project, :author, :noteable) }
2015-10-24 18:46:33 +05:30
2019-12-21 20:55:43 +05:30
scope :for_note_or_capitalized_note, ->(text) { where(note: [text, text.capitalize]) }
scope :like_note_or_capitalized_note, ->(text) { where('(note LIKE ? OR note LIKE ?)', text, text.capitalize) }
2016-08-24 12:49:21 +05:30
before_validation :nullify_blank_type, :nullify_blank_line_code
2022-10-11 01:57:18 +05:30
# Syncs `confidential` with `internal` as we rename the column.
# https://gitlab.com/gitlab-org/gitlab/-/issues/367923
before_create :set_internal_flag
2023-03-04 22:38:38 +05:30
after_destroy :expire_etag_cache
2021-11-18 22:05:49 +05:30
after_save :keep_around_commit, if: :for_project_noteable?, unless: -> { importing? || skip_keep_around_commits }
2020-01-01 13:55:28 +05:30
after_save :expire_etag_cache, unless: :importing?
after_save :touch_noteable, unless: :importing?
2020-05-24 23:13:21 +05:30
after_commit :notify_after_create, on: :create
after_commit :notify_after_destroy, on: :destroy
2014-09-02 18:07:02 +05:30
class << self
2021-04-29 21:17:54 +05:30
extend Gitlab::Utils::Override
2016-06-02 11:05:42 +05:30
def model_name
ActiveModel::Name.new(self, nil, 'note')
end
2017-08-17 22:00:37 +05:30
def discussions(context_noteable = nil)
2017-09-10 17:25:29 +05:30
Discussion.build_collection(all.includes(:noteable).fresh, context_noteable)
2016-06-02 11:05:42 +05:30
end
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
# Note: Where possible consider using Discussion#lazy_find to return
# Discussions in order to benefit from having records batch loaded.
2017-08-17 22:00:37 +05:30
def find_discussion(discussion_id)
notes = where(discussion_id: discussion_id).fresh.to_a
2018-03-27 19:54:05 +05:30
2017-08-17 22:00:37 +05:30
return if notes.empty?
Discussion.build(notes)
2016-09-13 17:45:13 +05:30
end
2018-03-17 18:26:18 +05:30
# Group diff discussions by line code or file path.
# It is not needed to group by line code when comment is
# on an image.
2017-08-17 22:00:37 +05:30
def grouped_diff_discussions(diff_refs = nil)
groups = {}
diff_notes.fresh.discussions.each do |discussion|
2018-03-17 18:26:18 +05:30
group_key =
if discussion.on_image?
discussion.file_new_path
else
discussion.line_code_in_diffs(diff_refs)
end
if group_key
discussions = groups[group_key] ||= []
2017-09-10 17:25:29 +05:30
discussions << discussion
end
2017-08-17 22:00:37 +05:30
end
groups
2014-09-02 18:07:02 +05:30
end
2019-12-21 20:55:43 +05:30
def positions
where.not(position: nil)
.select(:id, :type, :position) # ActiveRecord needs id and type for typecasting.
.map(&:position)
end
2021-01-29 00:20:46 +05:30
def count_for_collection(ids, type, count_column = 'COUNT(*) as count')
user.select(:noteable_id, count_column)
2017-09-10 17:25:29 +05:30
.group(:noteable_id)
.where(noteable_type: type, noteable_id: ids)
2014-09-02 18:07:02 +05:30
end
2018-03-17 18:26:18 +05:30
def search(query)
fuzzy_search(query, [:note])
end
2021-04-29 21:17:54 +05:30
# Override the `Sortable` module's `.simple_sorts` to remove name sorting,
# as a `Note` does not have any property that correlates to a "name".
override :simple_sorts
def simple_sorts
super.except('name_asc', 'name_desc')
end
def cherry_picked_merge_requests(shas)
where(noteable_type: 'MergeRequest', commit_id: shas).select(:noteable_id)
end
2015-09-11 14:41:01 +05:30
end
2015-04-26 12:48:37 +05:30
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ServiceClass
2020-04-08 14:13:33 +05:30
def system_note_with_references?
2018-03-17 18:26:18 +05:30
return unless system?
if force_cross_reference_regex_check?
matches_cross_reference_regex?
else
2019-12-21 20:55:43 +05:30
::SystemNotes::IssuablesService.cross_reference?(note)
2018-03-17 18:26:18 +05:30
end
2015-04-26 12:48:37 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ServiceClass
2015-04-26 12:48:37 +05:30
2016-06-02 11:05:42 +05:30
def diff_note?
2014-09-02 18:07:02 +05:30
false
end
2016-06-02 11:05:42 +05:30
def active?
true
2015-04-26 12:48:37 +05:30
end
2016-06-02 11:05:42 +05:30
def max_attachment_size
2018-03-17 18:26:18 +05:30
Gitlab::CurrentSettings.max_attachment_size.megabytes.to_i
2015-04-26 12:48:37 +05:30
end
2016-06-02 11:05:42 +05:30
def hook_attrs
2018-11-18 11:00:15 +05:30
Gitlab::HookData::NoteBuilder.new(self).build
2014-09-02 18:07:02 +05:30
end
2019-02-15 15:39:39 +05:30
def supports_suggestion?
false
end
2014-09-02 18:07:02 +05:30
def for_commit?
noteable_type == "Commit"
end
def for_issue?
noteable_type == "Issue"
end
def for_merge_request?
noteable_type == "MergeRequest"
end
2016-06-02 11:05:42 +05:30
def for_snippet?
2015-04-26 12:48:37 +05:30
noteable_type == "Snippet"
end
2020-06-23 00:09:42 +05:30
def for_alert_mangement_alert?
noteable_type == 'AlertManagement::Alert'
end
2021-09-04 01:27:46 +05:30
def for_vulnerability?
noteable_type == "Vulnerability"
end
2021-03-11 19:13:27 +05:30
def for_project_snippet?
noteable.is_a?(ProjectSnippet)
end
2017-08-17 22:00:37 +05:30
def for_personal_snippet?
noteable.is_a?(PersonalSnippet)
end
2018-03-17 18:26:18 +05:30
def for_project_noteable?
!for_personal_snippet?
end
2020-05-24 23:13:21 +05:30
def for_design?
noteable_type == DesignManagement::Design.name
end
2018-11-18 11:00:15 +05:30
def for_issuable?
for_issue? || for_merge_request?
end
2017-08-17 22:00:37 +05:30
def skip_project_check?
2018-03-27 19:54:05 +05:30
!for_project_noteable?
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
def commit
@commit ||= project.commit(commit_id) if commit_id.present?
end
2020-04-08 14:13:33 +05:30
# Notes on merge requests and commits can be traced back to one or several
# MRs. This method returns a relation if the note is for one of these types,
# or nil if it is a note on some other object.
def merge_requests
if for_commit?
project.merge_requests.by_commit_sha(commit_id)
elsif for_merge_request?
MergeRequest.id_in(noteable_id)
else
nil
end
end
2014-09-02 18:07:02 +05:30
# override to return commits, which are not active record
def noteable
2018-03-17 18:26:18 +05:30
return commit if for_commit?
super
2021-06-08 01:23:25 +05:30
rescue StandardError
2018-03-17 18:26:18 +05:30
# Temp fix to prevent app crash
# if note commit id doesn't exist
2014-09-02 18:07:02 +05:30
nil
end
# FIXME: Hack for polymorphic associations with STI
2015-04-26 12:48:37 +05:30
# For more information visit http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#label-Polymorphic+Associations
2015-10-24 18:46:33 +05:30
def noteable_type=(noteable_type)
super(noteable_type.to_s.classify.constantize.base_class.to_s)
2014-09-02 18:07:02 +05:30
end
2020-11-24 15:15:51 +05:30
def contributor?
project&.team&.contributor?(self.author_id)
2018-03-17 18:26:18 +05:30
end
2020-11-24 15:15:51 +05:30
def noteable_author?(noteable)
noteable.author == self.author
end
2018-03-17 18:26:18 +05:30
2020-11-24 15:15:51 +05:30
def project_name
project&.name
2018-03-17 18:26:18 +05:30
end
2020-06-23 00:09:42 +05:30
def confidential?(include_noteable: false)
return true if confidential
include_noteable && noteable.try(:confidential?)
2018-04-05 14:03:07 +05:30
end
2015-04-26 12:48:37 +05:30
def editable?
!system?
2015-12-23 02:04:40 +05:30
end
2021-04-17 20:07:23 +05:30
# We used `last_edited_at` as an alias of `updated_at` before.
# This makes it compatible with the previous way without data migration.
def last_edited_at
super || updated_at
end
# Since we used `updated_at` as `last_edited_at`, it could be touched by transforming / resolving a note.
2019-07-07 11:18:12 +05:30
# This makes sure it is only marked as edited when the note body is updated.
def edited?
return false if updated_by.blank?
super
end
def award_emoji?
2016-08-24 12:49:21 +05:30
can_be_award_emoji? && contains_emoji_only?
2015-12-23 02:04:40 +05:30
end
def emoji_awardable?
!system?
end
2015-12-23 02:04:40 +05:30
2016-08-24 12:49:21 +05:30
def can_be_award_emoji?
2017-08-17 22:00:37 +05:30
noteable.is_a?(Awardable) && !part_of_discussion?
2015-12-23 02:04:40 +05:30
end
def contains_emoji_only?
note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
end
2019-10-31 01:37:42 +05:30
def noteable_ability_name
2020-06-23 00:09:42 +05:30
if for_snippet?
'snippet'
elsif for_alert_mangement_alert?
'alert_management_alert'
2021-09-04 01:27:46 +05:30
elsif for_vulnerability?
'security_resource'
2020-06-23 00:09:42 +05:30
else
noteable_type.demodulize.underscore
end
2017-08-17 22:00:37 +05:30
end
def can_be_discussion_note?
self.noteable.supports_discussions? && !part_of_discussion?
end
2018-03-27 19:54:05 +05:30
def can_create_todo?
2020-10-24 23:57:45 +05:30
# Skip system notes, and notes on snippets
2018-03-27 19:54:05 +05:30
!system? && !for_snippet?
end
2017-08-17 22:00:37 +05:30
def discussion_class(noteable = nil)
# When commit notes are rendered on an MR's Discussion page, they are
# displayed in one discussion instead of individually.
# See also `#discussion_id` and `Discussion.override_discussion_id`.
if noteable && noteable != self.noteable
OutOfContextDiscussion
else
IndividualNoteDiscussion
end
end
# See `Discussion.override_discussion_id` for details.
def discussion_id(noteable = nil)
2020-03-13 15:44:24 +05:30
discussion_class(noteable).override_discussion_id(self) || super() || ensure_discussion_id
2017-08-17 22:00:37 +05:30
end
# 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.
def to_discussion(noteable = nil)
Discussion.build([self], noteable)
end
# 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.
def discussion
2020-07-28 23:09:34 +05:30
strong_memoize(:discussion) do
2022-06-21 17:19:12 +05:30
full_discussion = self.noteable.notes.find_discussion(self.discussion_id) if self.noteable && part_of_discussion?
2020-07-28 23:09:34 +05:30
full_discussion || to_discussion
end
2017-08-17 22:00:37 +05:30
end
2020-01-01 13:55:28 +05:30
def start_of_discussion?
discussion.first_note == self
end
2017-08-17 22:00:37 +05:30
def part_of_discussion?
!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
2016-08-24 12:49:21 +05:30
end
2018-03-17 18:26:18 +05:30
def references
refs = [noteable]
if part_of_discussion?
refs += discussion.notes.take_while { |n| n.id < id }
end
refs
end
2021-09-30 23:02:18 +05:30
def bump_updated_at
# Instead of calling touch which is throttled via ThrottledTouch concern,
# we bump the updated_at column directly. This also prevents executing
# after_commit callbacks that we don't need.
2022-06-21 17:19:12 +05:30
attributes_to_update = { updated_at: Time.current }
# Notes that were edited before the `last_edited_at` column was added, fall back to `updated_at` for the edit time.
# We copy this over to the correct column so we don't erroneously change the edit timestamp.
if updated_by_id.present? && read_attribute(:last_edited_at).blank?
attributes_to_update[:last_edited_at] = updated_at
end
update_columns(attributes_to_update)
2021-09-30 23:02:18 +05:30
end
2018-03-17 18:26:18 +05:30
def expire_etag_cache
2018-11-20 20:47:30 +05:30
noteable&.expire_note_etag_cache
2018-03-17 18:26:18 +05:30
end
2021-06-08 01:23:25 +05:30
def touch(*args, **kwargs)
2018-03-17 18:26:18 +05:30
# We're not using an explicit transaction here because this would in all
# cases result in all future queries going to the primary, even if no writes
# are performed.
#
# We touch the noteable first so its SELECT query can run before our writes,
# ensuring it runs on a secondary (if no prior write took place).
touch_noteable
super
end
# By default Rails will issue an "SELECT *" for the relation, which is
# overkill for just updating the timestamps. To work around this we manually
# touch the data so we can SELECT only the columns we need.
def touch_noteable
# Commits are not stored in the DB so we can't touch them.
return if for_commit?
assoc = association(:noteable)
noteable_object =
if assoc.loaded?
noteable
else
# If the object is not loaded (e.g. when notes are loaded async) we
# _only_ want the data we actually need.
assoc.scope.select(:id, :updated_at).take
end
noteable_object&.touch
2019-09-30 21:07:59 +05:30
# We return the noteable object so we can re-use it in EE for Elasticsearch.
2018-03-17 18:26:18 +05:30
noteable_object
end
2020-05-24 23:13:21 +05:30
def notify_after_create
noteable&.after_note_created(self)
end
def notify_after_destroy
noteable&.after_note_destroyed(self)
end
2018-03-17 18:26:18 +05:30
def banzai_render_context(field)
2020-06-23 00:09:42 +05:30
super.merge(noteable: noteable, system_note: system?, label_url_method: noteable_label_url_method)
2018-03-17 18:26:18 +05:30
end
2018-11-08 19:23:39 +05:30
def retrieve_upload(_identifier, paths)
Upload.find_by(model: self, path: paths)
end
2019-12-21 20:55:43 +05:30
def resource_parent
2019-02-15 15:39:39 +05:30
project
end
2020-01-01 13:55:28 +05:30
def user_mentions
2020-03-13 15:44:24 +05:30
return Note.none unless noteable.present?
2020-01-01 13:55:28 +05:30
noteable.user_mentions.where(note: self)
end
2022-04-04 11:22:00 +05:30
def system_note_visible_for?(user)
2020-11-24 15:15:51 +05:30
return true unless system?
2022-04-04 11:22:00 +05:30
system_note_viewable_by?(user) && all_referenced_mentionables_allowed?(user)
2020-04-08 14:13:33 +05:30
end
2020-10-24 23:57:45 +05:30
def parent_user
noteable.author if for_personal_snippet?
end
2020-11-24 15:15:51 +05:30
def skip_notification?
2021-04-17 20:07:23 +05:30
review.present? || !author.can_trigger_notifications?
2020-11-24 15:15:51 +05:30
end
2021-10-27 15:23:28 +05:30
def post_processed_cache_key
2021-11-11 11:23:49 +05:30
cache_key_items = [cache_key, author&.cache_key]
cache_key_items << project.team.human_max_access(author&.id) if author.present?
2021-10-27 15:23:28 +05:30
cache_key_items << Digest::SHA1.hexdigest(redacted_note_html) if redacted_note_html.present?
cache_key_items.join(':')
end
override :user_mention_class
def user_mention_class
return if noteable.blank?
noteable.user_mention_class
end
override :user_mention_identifier
def user_mention_identifier
return if noteable.blank?
noteable.user_mention_identifier.merge({
note_id: id
})
end
2022-01-26 12:08:38 +05:30
def show_outdated_changes?
return false unless for_merge_request?
return false unless system?
return false unless change_position&.line_range
change_position.line_range["end"] || change_position.line_range["start"]
end
2022-02-27 12:50:16 +05:30
def commands_changes
@commands_changes&.slice(
:due_date,
:label_ids,
:remove_label_ids,
:add_label_ids,
:canonical_issue_id,
:clone_with_notes,
:confidential,
:create_merge_request,
:add_contacts,
:remove_contacts,
:assignee_ids,
:milestone_id,
:time_estimate,
:spend_time,
:discussion_locked,
:merge,
:rebase,
:wip_event,
:target_branch,
:reviewer_ids,
:health_status,
:promote_to_epic,
:weight,
:emoji_award,
:todo_event,
:subscription_event,
:state_event,
:title,
:tag_message,
:tag_name
)
end
2022-08-13 15:12:31 +05:30
def mentioned_users(current_user = nil)
users = super
return users unless confidential?
Ability.users_that_can_read_internal_notes(users, resource_parent)
end
def mentioned_filtered_user_ids_for(references)
return super unless confidential?
user_ids = references.mentioned_user_ids.presence
return [] if user_ids.blank?
users = User.where(id: user_ids)
Ability.users_that_can_read_internal_notes(users, resource_parent).pluck(:id)
end
2022-08-27 11:52:29 +05:30
# Method necesary while we transition into the new format for task system notes
# TODO: https://gitlab.com/gitlab-org/gitlab/-/issues/369923
def note
2022-11-25 23:54:43 +05:30
return super unless system? && for_issue? && super&.match?(ISSUE_TASK_SYSTEM_NOTE_PATTERN)
2022-08-27 11:52:29 +05:30
super.sub!('task', 'checklist item')
end
# Method necesary while we transition into the new format for task system notes
# TODO: https://gitlab.com/gitlab-org/gitlab/-/issues/369923
def note_html
2022-11-25 23:54:43 +05:30
return super unless system? && for_issue? && super&.match?(ISSUE_TASK_SYSTEM_NOTE_PATTERN)
2022-08-27 11:52:29 +05:30
super.sub!('task', 'checklist item')
end
2022-11-25 23:54:43 +05:30
def issuable_ability_name
confidential? ? :read_internal_note : :read_note
end
2016-08-24 12:49:21 +05:30
private
2019-12-04 20:38:33 +05:30
def system_note_viewable_by?(user)
return true unless system_note_metadata
2022-04-04 11:22:00 +05:30
system_note_viewable_by_project_ability?(user) && system_note_viewable_by_group_ability?(user)
end
2019-12-04 20:38:33 +05:30
2022-04-04 11:22:00 +05:30
def system_note_viewable_by_project_ability?(user)
project_restriction = TYPES_RESTRICTED_BY_PROJECT_ABILITY[system_note_metadata.action.to_sym]
!project_restriction || Ability.allowed?(user, project_restriction, project)
end
def system_note_viewable_by_group_ability?(user)
group_restriction = TYPES_RESTRICTED_BY_GROUP_ABILITY[system_note_metadata.action.to_sym]
!group_restriction || Ability.allowed?(user, group_restriction, project&.group)
2019-12-04 20:38:33 +05:30
end
2016-08-24 12:49:21 +05:30
def keep_around_commit
project.repository.keep_around(self.commit_id)
end
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?
2015-04-26 12:48:37 +05:30
end
2016-09-13 17:45:13 +05:30
def ensure_discussion_id
2020-03-13 15:44:24 +05:30
return if self.attribute_present?(:discussion_id)
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
self.discussion_id = derive_discussion_id
2016-09-13 17:45:13 +05:30
end
2020-03-13 15:44:24 +05:30
def derive_discussion_id
discussion_class.discussion_id(self)
2016-09-13 17:45:13 +05:30
end
2018-11-08 19:23:39 +05:30
def all_referenced_mentionables_allowed?(user)
2022-04-04 11:22:00 +05:30
return true unless system_note_with_references?
2018-11-08 19:23:39 +05:30
if user_visible_reference_count.present? && total_reference_count.present?
# if they are not equal, then there are private/confidential references as well
2023-01-13 00:05:48 +05:30
total_reference_count == 0 ||
user_visible_reference_count > 0 && user_visible_reference_count == total_reference_count
2018-11-08 19:23:39 +05:30
else
2020-02-01 01:16:34 +05:30
refs = all_references(user)
2021-11-11 11:23:49 +05:30
refs.all.any? && refs.all_visible?
2018-11-08 19:23:39 +05:30
end
end
2018-03-17 18:26:18 +05:30
def force_cross_reference_regex_check?
return unless system?
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
system_note_metadata&.cross_reference_types&.include?(system_note_metadata&.action)
2016-09-13 17:45:13 +05:30
end
2019-12-21 20:55:43 +05:30
def does_not_exceed_notes_limit?
return unless noteable
errors.add(:base, _('Maximum number of comments exceeded')) if noteable.notes.count >= Noteable::MAX_NOTES_LIMIT
end
2020-06-23 00:09:42 +05:30
2022-08-13 15:12:31 +05:30
def validate_created_after
return unless created_at
return if created_at >= '1970-01-01'
errors.add(:created_at, s_('Note|The created date provided is too far in the past.'))
end
2020-06-23 00:09:42 +05:30
def noteable_label_url_method
for_merge_request? ? :project_merge_requests_url : :project_issues_url
end
2022-06-21 17:19:12 +05:30
def ensure_confidentiality_not_changed
return unless will_save_change_to_attribute?(:confidential)
return unless attribute_change_to_be_saved(:confidential).include?(true)
errors.add(:confidential, _('can not be changed for existing notes'))
end
def ensure_confidentiality_discussion_compliance
return if start_of_discussion?
if discussion.first_note.confidential? != confidential?
errors.add(:confidential, _('reply should have same confidentiality as top-level note'))
end
ensure
clear_memoization(:discussion)
end
def ensure_noteable_can_have_confidential_note
return unless confidential?
return if noteable_can_have_confidential_note?
errors.add(:confidential, _('can not be set for this resource'))
end
def ensure_note_type_can_be_confidential
return unless confidential?
return if NON_DIFF_NOTE_TYPES.include?(type)
errors.add(:confidential, _('can not be set for this type of note'))
end
def noteable_can_have_confidential_note?
for_issue?
end
2022-10-11 01:57:18 +05:30
def set_internal_flag
self.internal = confidential if confidential
end
2014-09-02 18:07:02 +05:30
end
2019-12-04 20:38:33 +05:30
2021-06-08 01:23:25 +05:30
Note.prepend_mod_with('Note')