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

287 lines
7.4 KiB
Ruby
Raw Normal View History

2011-10-08 17:36:38 -04:00
class Note < ActiveRecord::Base
2016-05-10 18:41:46 -04:00
extend ActiveModel::Naming
include Gitlab::CurrentSettings
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
cache_markdown_field :note, pipeline: :note
# 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
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, touch: true
2012-09-27 02:20:36 -04:00
belongs_to :author, class_name: "User"
belongs_to :updated_by, class_name: "User"
2011-10-08 17:36:38 -04:00
2016-08-18 19:27:22 -04:00
# Only used by DiffNote, but defined here so that it can be used in `Note.includes`
belongs_to :resolved_by, class_name: "User"
2016-02-20 08:59:59 -05:00
has_many :todos, dependent: :destroy
2016-07-01 09:34:10 -04:00
has_many :events, as: :target, dependent: :destroy
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
2012-12-01 06:19:16 -05:00
validates :note, :project, presence: true
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
validate unless: [:for_commit?, :importing?] do |note|
unless note.noteable.try(:project) == note.project
errors.add(:invalid_project, 'Note and noteable project mismatch')
end
end
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]) }
2015-02-06 13:21:48 -05:00
scope :fresh, ->{ order(created_at: :asc, id: :asc) }
scope :inc_author_project, ->{ includes(:project, :author) }
scope :inc_author, ->{ includes(:author) }
2016-08-18 19:27:22 -04:00
scope :inc_relations_for_view, ->{ includes(:project, :author, :updated_by, :resolved_by, :award_emoji) }
2011-10-18 07:33:30 -04:00
2016-06-20 13:20:39 -04:00
scope :diff_notes, ->{ where(type: ['LegacyDiffNote', 'DiffNote']) }
2016-05-10 18:41:46 -04:00
scope :non_diff_notes, ->{ where(type: ['Note', nil]) }
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
2011-10-18 07:33:30 -04:00
after_initialize :ensure_discussion_id
before_validation :nullify_blank_type, :nullify_blank_line_code
before_validation :set_discussion_id
after_save :keep_around_commit
class << self
2016-05-10 18:41:46 -04:00
def model_name
ActiveModel::Name.new(self, nil, 'note')
end
2016-05-10 18:41:46 -04:00
def build_discussion_id(noteable_type, noteable_id)
[:discussion, noteable_type.try(:underscore), noteable_id].join("-")
end
2016-08-17 17:25:42 -04:00
def discussion_id(*args)
Digest::SHA1.hexdigest(build_discussion_id(*args))
end
2016-05-10 18:41:46 -04:00
def discussions
Discussion.for_notes(all)
end
def grouped_diff_discussions
2016-07-26 00:46:13 -04:00
active_notes = diff_notes.fresh.select(&:active?)
Discussion.for_diff_notes(active_notes).
map { |d| [d.line_code, d] }.to_h
end
2016-03-01 09:43:19 -05:00
# Searches for notes matching the given query.
#
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
#
2016-05-26 07:12:43 -04:00
# query - The search query as a String.
# as_user - Limit results to those viewable by a specific user
2016-03-01 09:43:19 -05:00
#
# Returns an ActiveRecord::Relation.
2016-05-26 07:12:43 -04:00
def search(query, as_user: nil)
table = arel_table
2016-03-01 09:43:19 -05:00
pattern = "%#{query}%"
Note.joins('LEFT JOIN issues ON issues.id = noteable_id').
where(table[:note].matches(pattern)).
merge(Issue.visible_to_user(as_user))
end
end
def cross_reference?
system && SystemNoteService.cross_reference?(note)
end
2016-05-10 18:41:46 -04:00
def diff_note?
false
end
2016-05-10 18:41:46 -04:00
def legacy_diff_note?
false
end
2016-06-20 13:20:39 -04:00
def new_diff_note?
false
end
def active?
2016-05-13 15:53:31 -04:00
true
end
def resolvable?
false
end
def resolved?
false
end
def to_be_resolved?
resolvable? && !resolved?
end
2016-05-10 18:41:46 -04:00
def max_attachment_size
current_application_settings.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
2012-10-13 10:23:12 -04:00
# override to return commits, which are not active record
def noteable
if for_commit?
2015-04-21 09:13:40 -04:00
project.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
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
# 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 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?
2016-06-01 05:23:09 -04:00
noteable.is_a?(Awardable)
end
def contains_emoji_only?
note =~ /\A#{Banzai::Filter::EmojiFilter.emoji_pattern}\s?\Z/
end
def award_emoji_name
note.match(Banzai::Filter::EmojiFilter.emoji_pattern)[1]
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 = Digest::SHA1.hexdigest(build_discussion_id)
end
def build_discussion_id
if for_merge_request?
2016-08-18 18:27:41 -04:00
# Notes on merge requests are always in a discussion of their own,
# so we generate a unique discussion ID.
[:discussion, :note, SecureRandom.hex].join("-")
else
self.class.build_discussion_id(noteable_type, noteable_id || commit_id)
end
end
2011-10-08 17:36:38 -04:00
end