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

474 lines
13 KiB
Ruby
Raw Normal View History

# A note on the root of an issue, merge request, commit, or snippet.
#
# A note of this type is never resolvable.
2011-10-08 17:36:38 -04:00
class Note < ActiveRecord::Base
2016-05-10 18:41:46 -04:00
extend ActiveModel::Naming
include Participable
include Mentionable
2016-05-25 15:07:36 -04:00
include Awardable
include Importable
include FasterCacheKeys
2016-10-06 17:52:44 -04:00
include CacheMarkdownField
include AfterCommitQueue
include ResolvableNote
include IgnorableColumn
include Editable
include Gitlab::SQL::Pattern
include ThrottledTouch
module SpecialRole
FIRST_TIME_CONTRIBUTOR = :first_time_contributor
class << self
def values
constants.map {|const| self.const_get(const)}
end
end
end
ignore_column :original_discussion_id
2016-10-06 17:52:44 -04:00
cache_markdown_field :note, pipeline: :note, issuable_state_filter_enabled: true
2017-05-03 07:16:36 -04: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 07:11:19 -04:00
alias_attribute :last_edited_at, :updated_at
alias_attribute :last_edited_by, :updated_by
# Attribute containing rendered and redacted Markdown as generated by
# Banzai::ObjectRenderer.
2016-10-06 17:52:44 -04:00
attr_accessor :redacted_note_html
# An Array containing the number of visible references as generated by
# Banzai::ObjectRenderer
attr_accessor :user_visible_reference_count
# Attribute used to store the attributes that have been changed by quick actions.
2016-11-24 01:32:32 -05:00
attr_accessor :commands_changes
# A special role that may be displayed on issuable's discussions
attr_accessor :special_role
default_value_for :system, false
attr_mentionable :note, pipeline: :note
participant :author
2011-10-08 17:36:38 -04:00
belongs_to :project
belongs_to :noteable, polymorphic: true # rubocop:disable Cop/PolymorphicAssociations
2012-09-27 02:20:36 -04:00
belongs_to :author, class_name: "User"
belongs_to :updated_by, class_name: "User"
belongs_to :last_edited_by, class_name: 'User'
2011-10-08 17:36:38 -04:00
has_many :todos
has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
has_one :system_note_metadata
delegate :gfm_reference, :local_reference, to: :noteable
2012-09-27 02:20:36 -04:00
delegate :name, to: :project, prefix: true
delegate :name, :email, to: :author, prefix: true
delegate :title, to: :noteable, allow_nil: true
2017-01-05 08:36:06 -05:00
validates :note, presence: true
2017-11-01 13:35:14 -04:00
validates :project, presence: true, if: :for_project_noteable?
2016-06-01 05:23:09 -04:00
# 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_type, presence: true
validates :noteable_id, presence: true, unless: [:for_commit?, :importing?]
validates :commit_id, presence: true, if: :for_commit?
2015-11-19 11:12:17 -05:00
validates :author, presence: true
2017-03-30 21:33:45 -04:00
validates :discussion_id, presence: true, format: { with: /\A\h{40}\z/ }
validate unless: [:for_commit?, :importing?, :skip_project_check?] do |note|
unless note.noteable.try(:project) == note.project
2017-03-17 15:25:52 -04:00
errors.add(:project, 'does not match noteable project')
end
end
2018-01-29 12:57:34 -05:00
# @deprecated attachments are handler by the MarkdownUploader
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 :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 09:18:44 -04:00
scope :inc_relations_for_view, -> do
includes(:project, :author, :updated_by, :resolved_by, :award_emoji, :system_note_metadata)
end
2011-10-18 07:33:30 -04: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 18:41:46 -04:00
scope :with_associations, -> do
# FYI noteable cannot be loaded for LegacyDiffNote for commits
includes(:author, :noteable, :updated_by,
2015-10-15 04:42:48 -04:00
project: [:project_members, { group: [:group_members] }])
end
scope :with_metadata, -> { includes(:system_note_metadata) }
2011-10-18 07:33:30 -04:00
2017-03-30 21:33:45 -04:00
after_initialize :ensure_discussion_id
before_validation :nullify_blank_type, :nullify_blank_line_code
2017-03-30 21:33:45 -04:00
before_validation :set_discussion_id, on: :create
2017-11-01 13:35:14 -04:00
after_save :keep_around_commit, if: :for_project_noteable?
after_save :expire_etag_cache
after_save :touch_noteable
after_destroy :expire_etag_cache
class << self
2016-05-10 18:41:46 -04:00
def model_name
ActiveModel::Name.new(self, nil, 'note')
end
def discussions(context_noteable = nil)
2017-05-31 15:00:30 -04:00
Discussion.build_collection(all.includes(:noteable).fresh, context_noteable)
end
def find_discussion(discussion_id)
notes = where(discussion_id: discussion_id).fresh.to_a
return if notes.empty?
Discussion.build(notes)
end
2017-10-07 00:25:17 -04:00
# Group diff discussions by line code or file path.
# It is not needed to group by line code when comment is
# on an image.
def grouped_diff_discussions(diff_refs = nil)
2017-05-22 16:56:20 -04:00
groups = {}
diff_notes.fresh.discussions.each do |discussion|
2017-10-07 00:25:17 -04:00
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-05-22 16:56:20 -04:00
discussions << discussion
end
end
groups
end
def count_for_collection(ids, type)
2017-06-21 09:48:12 -04:00
user.select('noteable_id', 'COUNT(*) as count')
.group(:noteable_id)
.where(noteable_type: type, noteable_id: ids)
end
2017-08-02 10:06:28 -04:00
def has_special_role?(role, note)
note.special_role == role
end
def search(query)
fuzzy_search(query, [:note])
end
end
def cross_reference?
2017-11-16 09:23:32 -05:00
return unless system?
if force_cross_reference_regex_check?
matches_cross_reference_regex?
else
SystemNoteService.cross_reference?(note)
end
end
2016-05-10 18:41:46 -04:00
def diff_note?
false
end
def active?
2016-05-13 15:53:31 -04:00
true
end
2016-05-10 18:41:46 -04:00
def max_attachment_size
Gitlab::CurrentSettings.max_attachment_size.megabytes.to_i
end
2016-05-10 18:41:46 -04:00
def hook_attrs
attributes
2012-10-29 10:49:37 -04:00
end
def for_commit?
noteable_type == "Commit"
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_snippet?
noteable_type == "Snippet"
end
2017-01-05 08:36:06 -05:00
def for_personal_snippet?
2017-01-20 05:28:40 -05:00
noteable.is_a?(PersonalSnippet)
end
2017-11-01 13:35:14 -04:00
def for_project_noteable?
!for_personal_snippet?
end
2017-01-20 05:28:40 -05:00
def skip_project_check?
!for_project_noteable?
2017-01-05 08:36:06 -05:00
end
def commit
2017-12-06 10:57:10 -05:00
@commit ||= project.commit(commit_id) if commit_id.present?
end
2012-10-13 10:23:12 -04:00
# override to return commits, which are not active record
def noteable
2017-12-06 10:57:10 -05:00
return commit if for_commit?
super
2012-03-14 09:31:31 -04:00
rescue
2017-12-06 10:57:10 -05:00
# Temp fix to prevent app crash
# if note commit id doesn't exist
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
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
def special_role=(role)
2017-08-02 10:06:28 -04:00
raise "Role is undefined, #{role} not found in #{SpecialRole.values}" unless SpecialRole.values.include?(role)
@special_role = role
end
def has_special_role?(role)
2017-08-02 10:06:28 -04:00
self.class.has_special_role?(role, self)
end
def specialize_for_first_contribution!(noteable)
return unless noteable.author_id == self.author_id
self.special_role = Note::SpecialRole::FIRST_TIME_CONTRIBUTOR
end
def confidential?
noteable.try(:confidential?)
end
def editable?
2016-04-16 15:09:08 -04:00
!system?
end
def cross_reference_not_visible_for?(user)
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
end
2016-04-16 15:09:08 -04:00
def award_emoji?
can_be_award_emoji? && contains_emoji_only?
end
def emoji_awardable?
!system?
end
def can_be_award_emoji?
noteable.is_a?(Awardable) && !part_of_discussion?
end
def contains_emoji_only?
note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
end
2017-01-20 05:28:40 -05:00
def to_ability_name
for_personal_snippet? ? 'personal_snippet' : noteable_type.underscore
end
def can_be_discussion_note?
self.noteable.supports_discussions? && !part_of_discussion?
end
def can_create_todo?
# Skip system notes, and notes on project snippet
!system? && !for_snippet?
end
def can_create_notification?
true
end
def discussion_class(noteable = nil)
# When commit notes are rendered on an MR's Discussion page, they are
2017-04-04 18:27:23 -04:00
# displayed in one discussion instead of individually.
# See also `#discussion_id` and `Discussion.override_discussion_id`.
2017-03-17 15:25:52 -04:00
if noteable && noteable != self.noteable
OutOfContextDiscussion
else
IndividualNoteDiscussion
end
end
2017-04-04 18:27:23 -04:00
# See `Discussion.override_discussion_id` for details.
def discussion_id(noteable = nil)
discussion_class(noteable).override_discussion_id(self) || super()
end
2017-03-30 23:06:09 -04: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.
def to_discussion(noteable = nil)
Discussion.build([self], noteable)
end
2017-03-30 23:06:09 -04: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.
def discussion
2017-03-30 23:06:09 -04:00
full_discussion = self.noteable.notes.find_discussion(self.discussion_id) if part_of_discussion?
full_discussion || to_discussion
end
def part_of_discussion?
2017-03-17 15:25:52 -04: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
end
def references
refs = [noteable]
if part_of_discussion?
refs += discussion.notes.take_while { |n| n.id < id }
end
refs
end
def expire_etag_cache
2017-08-30 04:43:10 -04:00
return unless noteable&.discussions_rendered_on_frontend?
2018-04-03 12:03:00 -04:00
Gitlab::EtagCaching::Store.new.touch(etag_key)
end
def etag_key
Gitlab::Routing.url_helpers.project_noteable_notes_path(
2017-08-17 13:26:45 -04:00
project,
target_type: noteable_type.underscore,
2017-08-17 13:26:45 -04:00
target_id: noteable_id
)
end
def touch(*args)
# 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
# We return the noteable object so we can re-use it in EE for ElasticSearch.
noteable_object
end
def banzai_render_context(field)
super.merge(noteable: noteable)
end
private
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?
end
def ensure_discussion_id
return unless self.persisted?
# Needed in case the SELECT statement doesn't ask for `discussion_id`
return unless self.has_attribute?(:discussion_id)
return if self.discussion_id
set_discussion_id
update_column(:discussion_id, self.discussion_id)
end
def set_discussion_id
self.discussion_id ||= discussion_class.discussion_id(self)
end
2017-11-16 09:23:32 -05:00
def force_cross_reference_regex_check?
return unless system?
SystemNoteMetadata::TYPES_WITH_CROSS_REFERENCES.include?(system_note_metadata&.action)
end
2011-10-08 17:36:38 -04:00
end