2011-10-16 21:07:10 +00:00
|
|
|
class Snippet < ActiveRecord::Base
|
2014-10-08 13:44:25 +00:00
|
|
|
include Gitlab::VisibilityLevel
|
2016-10-06 21:17:11 +00:00
|
|
|
include CacheMarkdownField
|
2017-03-10 01:29:11 +00:00
|
|
|
include Noteable
|
2015-04-21 13:23:20 +00:00
|
|
|
include Participable
|
2015-05-03 03:11:21 +00:00
|
|
|
include Referable
|
|
|
|
include Sortable
|
2016-06-03 09:44:04 +00:00
|
|
|
include Awardable
|
2016-11-17 20:46:31 +00:00
|
|
|
include Mentionable
|
2017-02-01 18:15:59 +00:00
|
|
|
include Spammable
|
2017-05-18 12:24:34 +00:00
|
|
|
include Editable
|
2017-11-24 10:45:19 +00:00
|
|
|
include Gitlab::SQL::Pattern
|
2011-10-20 19:00:00 +00:00
|
|
|
|
2016-10-06 21:17:11 +00:00
|
|
|
cache_markdown_field :title, pipeline: :single_line
|
2017-05-03 15:26:49 +00:00
|
|
|
cache_markdown_field :description
|
2016-10-06 21:17:11 +00:00
|
|
|
cache_markdown_field :content
|
|
|
|
|
2017-05-04 03:54:25 +00:00
|
|
|
# Aliases to make application_helper#edited_time_ago_with_tooltip helper work properly with snippets.
|
|
|
|
# See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10392/diffs#note_28719102
|
|
|
|
alias_attribute :last_edited_at, :updated_at
|
|
|
|
alias_attribute :last_edited_by, :updated_by
|
|
|
|
|
2016-10-06 21:17:11 +00:00
|
|
|
# If file_name changes, it invalidates content
|
|
|
|
alias_method :default_content_html_invalidator, :content_html_invalidated?
|
|
|
|
def content_html_invalidated?
|
|
|
|
default_content_html_invalidator || file_name_changed?
|
|
|
|
end
|
|
|
|
|
2018-02-02 18:39:55 +00:00
|
|
|
default_value_for(:visibility_level) { Gitlab::CurrentSettings.default_snippet_visibility }
|
2014-03-17 13:50:16 +00:00
|
|
|
|
2015-05-03 03:14:31 +00:00
|
|
|
belongs_to :author, class_name: 'User'
|
|
|
|
belongs_to :project
|
2013-03-25 11:58:09 +00:00
|
|
|
|
2017-06-08 15:16:27 +00:00
|
|
|
has_many :notes, as: :noteable, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
2011-10-16 21:07:10 +00:00
|
|
|
|
2012-12-14 05:34:05 +00:00
|
|
|
delegate :name, :email, to: :author, prefix: true, allow_nil: true
|
2011-10-16 21:07:10 +00:00
|
|
|
|
2012-10-09 00:10:04 +00:00
|
|
|
validates :author, presence: true
|
2016-12-02 12:54:57 +00:00
|
|
|
validates :title, presence: true, length: { maximum: 255 }
|
2015-02-03 05:15:44 +00:00
|
|
|
validates :file_name,
|
2017-07-05 16:01:38 +00:00
|
|
|
length: { maximum: 255 }
|
2016-06-16 18:55:04 +00:00
|
|
|
|
2013-01-22 15:10:00 +00:00
|
|
|
validates :content, presence: true
|
2014-10-08 13:44:25 +00:00
|
|
|
validates :visibility_level, inclusion: { in: Gitlab::VisibilityLevel.values }
|
2011-10-16 21:07:10 +00:00
|
|
|
|
2012-10-09 00:10:04 +00:00
|
|
|
# Scopes
|
2014-10-08 13:44:25 +00:00
|
|
|
scope :are_internal, -> { where(visibility_level: Snippet::INTERNAL) }
|
|
|
|
scope :are_private, -> { where(visibility_level: Snippet::PRIVATE) }
|
|
|
|
scope :are_public, -> { where(visibility_level: Snippet::PUBLIC) }
|
|
|
|
scope :public_and_internal, -> { where(visibility_level: [Snippet::PUBLIC, Snippet::INTERNAL]) }
|
2013-03-24 20:23:12 +00:00
|
|
|
scope :fresh, -> { order("created_at DESC") }
|
2011-10-27 07:14:50 +00:00
|
|
|
|
2016-05-26 11:38:28 +00:00
|
|
|
participant :author
|
|
|
|
participant :notes_with_associations
|
2015-04-21 13:23:20 +00:00
|
|
|
|
2017-02-01 18:15:59 +00:00
|
|
|
attr_spammable :title, spam_title: true
|
|
|
|
attr_spammable :content, spam_description: true
|
|
|
|
|
2015-05-03 03:11:21 +00:00
|
|
|
def self.reference_prefix
|
|
|
|
'$'
|
|
|
|
end
|
|
|
|
|
2015-05-14 20:59:39 +00:00
|
|
|
# Pattern used to extract `$123` snippet references from text
|
|
|
|
#
|
|
|
|
# This pattern supports cross-project references.
|
|
|
|
def self.reference_pattern
|
2016-03-24 15:41:48 +00:00
|
|
|
@reference_pattern ||= %r{
|
2015-12-01 14:51:27 +00:00
|
|
|
(#{Project.reference_pattern})?
|
|
|
|
#{Regexp.escape(reference_prefix)}(?<snippet>\d+)
|
2015-05-14 20:59:39 +00:00
|
|
|
}x
|
|
|
|
end
|
|
|
|
|
2015-11-30 20:14:46 +00:00
|
|
|
def self.link_reference_pattern
|
2016-03-24 15:41:48 +00:00
|
|
|
@link_reference_pattern ||= super("snippets", /(?<snippet>\d+)/)
|
2015-11-30 20:14:46 +00:00
|
|
|
end
|
|
|
|
|
2017-11-22 13:20:35 +00:00
|
|
|
def to_reference(from = nil, full: false)
|
2015-05-03 03:11:21 +00:00
|
|
|
reference = "#{self.class.reference_prefix}#{id}"
|
|
|
|
|
2016-11-02 23:49:13 +00:00
|
|
|
if project.present?
|
2017-11-22 13:20:35 +00:00
|
|
|
"#{project.to_reference(from, full: full)}#{reference}"
|
2016-11-02 23:49:13 +00:00
|
|
|
else
|
|
|
|
reference
|
2015-05-03 03:11:21 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-10-16 21:07:10 +00:00
|
|
|
def self.content_types
|
2011-10-26 13:46:25 +00:00
|
|
|
[
|
2011-10-16 21:07:10 +00:00
|
|
|
".rb", ".py", ".pl", ".scala", ".c", ".cpp", ".java",
|
|
|
|
".haml", ".html", ".sass", ".scss", ".xml", ".php", ".erb",
|
|
|
|
".js", ".sh", ".coffee", ".yml", ".md"
|
|
|
|
]
|
|
|
|
end
|
2011-10-20 19:00:00 +00:00
|
|
|
|
2017-04-13 16:47:28 +00:00
|
|
|
def blob
|
|
|
|
@blob ||= Blob.decorate(SnippetBlob.new(self), nil)
|
2012-04-20 22:26:22 +00:00
|
|
|
end
|
|
|
|
|
2015-03-05 18:38:23 +00:00
|
|
|
def hook_attrs
|
|
|
|
attributes
|
|
|
|
end
|
|
|
|
|
2016-12-02 12:54:57 +00:00
|
|
|
def file_name
|
|
|
|
super.to_s
|
|
|
|
end
|
|
|
|
|
2014-12-12 11:28:48 +00:00
|
|
|
def sanitized_file_name
|
|
|
|
file_name.gsub(/[^a-zA-Z0-9_\-\.]+/, '')
|
|
|
|
end
|
|
|
|
|
2014-10-08 13:44:25 +00:00
|
|
|
def visibility_level_field
|
2017-03-01 20:23:00 +00:00
|
|
|
:visibility_level
|
2014-12-12 11:15:42 +00:00
|
|
|
end
|
2014-10-08 13:44:25 +00:00
|
|
|
|
2016-05-26 11:38:28 +00:00
|
|
|
def notes_with_associations
|
2016-06-03 18:47:09 +00:00
|
|
|
notes.includes(:author)
|
2016-05-26 11:38:28 +00:00
|
|
|
end
|
|
|
|
|
2017-02-01 18:15:59 +00:00
|
|
|
def check_for_spam?
|
2017-03-21 02:37:29 +00:00
|
|
|
visibility_level_changed?(to: Snippet::PUBLIC) ||
|
|
|
|
(public? && (title_changed? || content_changed?))
|
2017-02-01 18:15:59 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def spammable_entity_type
|
|
|
|
'snippet'
|
|
|
|
end
|
|
|
|
|
2014-08-29 19:22:45 +00:00
|
|
|
class << self
|
2016-03-01 11:51:01 +00:00
|
|
|
# Searches for snippets with a matching title or file name.
|
|
|
|
#
|
|
|
|
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
|
|
|
|
#
|
|
|
|
# query - The search query as a String.
|
|
|
|
#
|
|
|
|
# Returns an ActiveRecord::Relation.
|
2014-08-29 19:22:45 +00:00
|
|
|
def search(query)
|
2017-11-24 11:24:24 +00:00
|
|
|
fuzzy_search(query, [:title, :file_name])
|
2014-08-29 19:22:45 +00:00
|
|
|
end
|
|
|
|
|
2016-03-01 11:51:01 +00:00
|
|
|
# Searches for snippets with matching content.
|
|
|
|
#
|
|
|
|
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
|
|
|
|
#
|
|
|
|
# query - The search query as a String.
|
|
|
|
#
|
|
|
|
# Returns an ActiveRecord::Relation.
|
2014-08-29 19:22:45 +00:00
|
|
|
def search_code(query)
|
2017-11-24 11:24:24 +00:00
|
|
|
fuzzy_search(query, [:content])
|
2014-08-29 19:22:45 +00:00
|
|
|
end
|
|
|
|
end
|
2011-10-16 21:07:10 +00:00
|
|
|
end
|