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
|
2013-05-09 23:37:47 +00:00
|
|
|
|
2014-04-09 10:36:25 +00:00
|
|
|
default_value_for :system, false
|
|
|
|
|
2015-10-14 19:29:35 +00:00
|
|
|
attr_mentionable :note, cache: true, 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
|
2016-01-19 20:02:26 +00:00
|
|
|
belongs_to :noteable, polymorphic: true, touch: true
|
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"
|
2011-10-08 21:36:38 +00:00
|
|
|
|
2016-02-20 13:59:59 +00:00
|
|
|
has_many :todos, dependent: :destroy
|
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
|
|
|
|
2015-12-05 21:09:52 +00:00
|
|
|
before_validation :set_award!
|
|
|
|
|
2012-12-01 11:19:16 +00:00
|
|
|
validates :note, :project, presence: true
|
2015-11-19 16:12:17 +00:00
|
|
|
validates :note, uniqueness: { scope: [:author, :noteable_type, :noteable_id] }, if: ->(n) { n.is_award }
|
2015-12-05 21:09:52 +00:00
|
|
|
validates :note, inclusion: { in: Emoji.emojis_names }, if: ->(n) { n.is_award }
|
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-04-26 07:35:03 +00:00
|
|
|
validates :noteable_id, presence: true, unless: :for_commit?
|
|
|
|
validates :commit_id, presence: true, if: :for_commit?
|
2015-11-19 16:12:17 +00:00
|
|
|
validates :author, presence: true
|
2012-12-18 18:02:00 +00:00
|
|
|
|
2016-04-26 09:36:50 +00:00
|
|
|
validate unless: :for_commit? do |note|
|
2016-04-26 11:50:48 +00:00
|
|
|
unless note.noteable.try(:project) == note.project
|
2016-04-26 09:36:50 +00:00
|
|
|
errors.add(:invalid_project, 'Note and noteable project mismatch')
|
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
|
2015-11-18 22:59:07 +00:00
|
|
|
scope :awards, ->{ where(is_award: true) }
|
|
|
|
scope :nonawards, ->{ where(is_award: false) }
|
2013-01-05 11:11:15 +00:00
|
|
|
scope :for_commit_id, ->(commit_id) { where(noteable_type: "Commit", commit_id: commit_id) }
|
2014-10-06 12:07:36 +00:00
|
|
|
scope :system, ->{ where(system: true) }
|
2015-03-23 15:43:08 +00:00
|
|
|
scope :user, ->{ where(system: false) }
|
2013-07-16 21:14:03 +00:00
|
|
|
scope :common, ->{ where(noteable_type: ["", nil]) }
|
2015-02-06 18:21:48 +00:00
|
|
|
scope :fresh, ->{ order(created_at: :asc, id: :asc) }
|
2013-07-16 21:14:03 +00:00
|
|
|
scope :inc_author_project, ->{ includes(:project, :author) }
|
|
|
|
scope :inc_author, ->{ includes(:author) }
|
2011-10-18 11:33:30 +00:00
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
scope :legacy_diff_notes, ->{ where(type: 'LegacyDiffNote') }
|
|
|
|
scope :non_diff_notes, ->{ where(type: ['Note', nil]) }
|
|
|
|
|
2015-10-15 08:41:09 +00:00
|
|
|
scope :with_associations, -> do
|
2015-10-14 12:53:06 +00:00
|
|
|
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
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
before_validation :clear_blank_line_code!
|
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
|
|
|
|
|
|
|
|
def build_discussion_id(noteable_type, noteable_id)
|
|
|
|
[:discussion, noteable_type.try(:underscore), noteable_id].join("-")
|
|
|
|
end
|
2013-12-25 11:32:43 +00:00
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def discussions
|
|
|
|
all.group_by(&:discussion_id).values
|
2013-12-25 11:32:43 +00:00
|
|
|
end
|
2012-05-20 18:35:03 +00:00
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def grouped_diff_notes
|
|
|
|
legacy_diff_notes.select(&:active?).sort_by(&:created_at).group_by(&:line_code)
|
2014-06-06 20:15:54 +00:00
|
|
|
end
|
|
|
|
|
2016-03-01 14:43:19 +00:00
|
|
|
# Searches for notes matching the given query.
|
|
|
|
#
|
|
|
|
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
|
|
|
|
#
|
|
|
|
# query - The search query as a String.
|
|
|
|
#
|
|
|
|
# Returns an ActiveRecord::Relation.
|
2014-08-26 20:39:37 +00:00
|
|
|
def search(query)
|
2016-03-04 11:01:21 +00:00
|
|
|
table = arel_table
|
2016-03-01 14:43:19 +00:00
|
|
|
pattern = "%#{query}%"
|
|
|
|
|
|
|
|
where(table[:note].matches(pattern))
|
2014-08-26 20:39:37 +00:00
|
|
|
end
|
2015-11-11 13:12:51 +00:00
|
|
|
|
|
|
|
def grouped_awards
|
2015-12-24 17:46:35 +00:00
|
|
|
notes = {}
|
|
|
|
|
2015-11-19 16:12:17 +00:00
|
|
|
awards.select(:note).distinct.map do |note|
|
2015-12-24 17:46:35 +00:00
|
|
|
notes[note.note] = where(note: note.note)
|
2015-11-11 13:12:51 +00:00
|
|
|
end
|
2015-12-24 17:46:35 +00:00
|
|
|
|
|
|
|
notes["thumbsup"] ||= Note.none
|
|
|
|
notes["thumbsdown"] ||= Note.none
|
|
|
|
|
|
|
|
notes
|
2015-11-11 13:12:51 +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?
|
2015-05-09 22:19:41 +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
|
2013-08-04 17:43:49 +00:00
|
|
|
end
|
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def legacy_diff_note?
|
|
|
|
false
|
2014-09-08 18:54:52 +00:00
|
|
|
end
|
|
|
|
|
2016-05-13 19:53:31 +00:00
|
|
|
def active?
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
2016-05-10 22:41:46 +00:00
|
|
|
def discussion_id
|
|
|
|
@discussion_id ||=
|
|
|
|
if for_merge_request?
|
|
|
|
[:discussion, :note, id].join("-")
|
2014-09-08 13:27:12 +00:00
|
|
|
else
|
2016-05-10 22:41:46 +00:00
|
|
|
self.class.build_discussion_id(noteable_type, noteable_id || commit_id)
|
2014-09-08 13:27:12 +00:00
|
|
|
end
|
2016-01-22 00:43:06 +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
|
|
|
|
|
2012-10-13 14:23:12 +00:00
|
|
|
# override to return commits, which are not active record
|
|
|
|
def noteable
|
|
|
|
if for_commit?
|
2015-04-21 13:13:40 +00:00
|
|
|
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
|
|
|
|
|
|
|
# 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
|
2014-07-16 18:44:24 +00:00
|
|
|
Event.reset_event_cache_for(self)
|
2013-12-13 19:40:45 +00:00
|
|
|
end
|
2014-06-17 19:09:01 +00:00
|
|
|
|
2015-11-21 20:36:31 +00:00
|
|
|
def downvote?
|
2015-12-29 08:11:20 +00:00
|
|
|
is_award && note == "thumbsdown"
|
2015-11-21 20:36:31 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def upvote?
|
2015-12-29 08:11:20 +00:00
|
|
|
is_award && note == "thumbsup"
|
2015-11-21 20:36:31 +00:00
|
|
|
end
|
|
|
|
|
2014-08-29 12:19:35 +00:00
|
|
|
def editable?
|
2015-12-10 12:36:31 +00:00
|
|
|
!system? && !is_award
|
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)
|
|
|
|
cross_reference? && referenced_mentionables(user).empty?
|
|
|
|
end
|
|
|
|
|
2015-12-05 21:09:52 +00:00
|
|
|
# Checks if note is an award added as a comment
|
2015-12-02 07:48:21 +00:00
|
|
|
#
|
2015-12-05 21:09:52 +00:00
|
|
|
# If note is an award, this method sets is_award to true
|
|
|
|
# and changes content of the note to award name.
|
2015-12-02 07:48:21 +00:00
|
|
|
#
|
|
|
|
# Method is executed as a before_validation callback.
|
|
|
|
#
|
|
|
|
def set_award!
|
2015-12-05 21:09:52 +00:00
|
|
|
return unless awards_supported? && contains_emoji_only?
|
2016-02-18 09:26:10 +00:00
|
|
|
|
2015-12-02 07:48:21 +00:00
|
|
|
self.is_award = true
|
|
|
|
self.note = award_emoji_name
|
|
|
|
end
|
|
|
|
|
2015-12-03 12:03:50 +00:00
|
|
|
private
|
|
|
|
|
2016-03-11 22:46:50 +00:00
|
|
|
def clear_blank_line_code!
|
|
|
|
self.line_code = nil if self.line_code.blank?
|
|
|
|
end
|
|
|
|
|
2015-12-05 21:09:52 +00:00
|
|
|
def awards_supported?
|
2016-05-10 22:41:46 +00:00
|
|
|
(for_issue? || for_merge_request?) && !diff_note?
|
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
|
|
|
|
|
|
|
|
def award_emoji_name
|
2015-12-15 15:10:32 +00:00
|
|
|
original_name = note.match(Banzai::Filter::EmojiFilter.emoji_pattern)[1]
|
2015-12-11 11:10:00 +00:00
|
|
|
AwardEmoji.normilize_emoji_name(original_name)
|
2015-12-02 07:48:21 +00:00
|
|
|
end
|
2011-10-08 21:36:38 +00:00
|
|
|
end
|