178 lines
4.8 KiB
Ruby
178 lines
4.8 KiB
Ruby
class Snippet < ActiveRecord::Base
|
|
include Gitlab::VisibilityLevel
|
|
include CacheMarkdownField
|
|
include Noteable
|
|
include Participable
|
|
include Referable
|
|
include Sortable
|
|
include Awardable
|
|
include Mentionable
|
|
include Spammable
|
|
include Editable
|
|
include Gitlab::SQL::Pattern
|
|
|
|
cache_markdown_field :title, pipeline: :single_line
|
|
cache_markdown_field :description
|
|
cache_markdown_field :content
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
default_value_for(:visibility_level) { Gitlab::CurrentSettings.default_snippet_visibility }
|
|
|
|
belongs_to :author, class_name: 'User'
|
|
belongs_to :project
|
|
|
|
has_many :notes, as: :noteable, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
|
|
|
|
delegate :name, :email, to: :author, prefix: true, allow_nil: true
|
|
|
|
validates :author, presence: true
|
|
validates :title, presence: true, length: { maximum: 255 }
|
|
validates :file_name,
|
|
length: { maximum: 255 }
|
|
|
|
validates :content, presence: true
|
|
validates :visibility_level, inclusion: { in: Gitlab::VisibilityLevel.values }
|
|
|
|
# Scopes
|
|
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]) }
|
|
scope :fresh, -> { order("created_at DESC") }
|
|
scope :inc_relations_for_view, -> { includes(author: :status) }
|
|
|
|
participant :author
|
|
participant :notes_with_associations
|
|
|
|
attr_spammable :title, spam_title: true
|
|
attr_spammable :content, spam_description: true
|
|
|
|
def self.reference_prefix
|
|
'$'
|
|
end
|
|
|
|
# Pattern used to extract `$123` snippet references from text
|
|
#
|
|
# This pattern supports cross-project references.
|
|
def self.reference_pattern
|
|
@reference_pattern ||= %r{
|
|
(#{Project.reference_pattern})?
|
|
#{Regexp.escape(reference_prefix)}(?<snippet>\d+)
|
|
}x
|
|
end
|
|
|
|
def self.link_reference_pattern
|
|
@link_reference_pattern ||= super("snippets", /(?<snippet>\d+)/)
|
|
end
|
|
|
|
# Returns a collection of snippets that are either public or visible to the
|
|
# logged in user.
|
|
#
|
|
# This method does not verify the user actually has the access to the project
|
|
# the snippet is in, so it should be only used on a relation that's already scoped
|
|
# for project access
|
|
def self.public_or_visible_to_user(user = nil)
|
|
if user
|
|
authorized = user
|
|
.project_authorizations
|
|
.select(1)
|
|
.where('project_authorizations.project_id = snippets.project_id')
|
|
|
|
levels = Gitlab::VisibilityLevel.levels_for_user(user)
|
|
|
|
where('EXISTS (?) OR snippets.visibility_level IN (?) or snippets.author_id = (?)', authorized, levels, user.id)
|
|
else
|
|
public_to_user
|
|
end
|
|
end
|
|
|
|
def to_reference(from = nil, full: false)
|
|
reference = "#{self.class.reference_prefix}#{id}"
|
|
|
|
if project.present?
|
|
"#{project.to_reference(from, full: full)}#{reference}"
|
|
else
|
|
reference
|
|
end
|
|
end
|
|
|
|
def self.content_types
|
|
[
|
|
".rb", ".py", ".pl", ".scala", ".c", ".cpp", ".java",
|
|
".haml", ".html", ".sass", ".scss", ".xml", ".php", ".erb",
|
|
".js", ".sh", ".coffee", ".yml", ".md"
|
|
]
|
|
end
|
|
|
|
def blob
|
|
@blob ||= Blob.decorate(SnippetBlob.new(self), nil)
|
|
end
|
|
|
|
def hook_attrs
|
|
attributes
|
|
end
|
|
|
|
def file_name
|
|
super.to_s
|
|
end
|
|
|
|
def sanitized_file_name
|
|
file_name.gsub(/[^a-zA-Z0-9_\-\.]+/, '')
|
|
end
|
|
|
|
def visibility_level_field
|
|
:visibility_level
|
|
end
|
|
|
|
def notes_with_associations
|
|
notes.includes(:author)
|
|
end
|
|
|
|
def check_for_spam?
|
|
visibility_level_changed?(to: Snippet::PUBLIC) ||
|
|
(public? && (title_changed? || content_changed?))
|
|
end
|
|
|
|
def spammable_entity_type
|
|
'snippet'
|
|
end
|
|
|
|
class << self
|
|
# 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.
|
|
def search(query)
|
|
fuzzy_search(query, [:title, :file_name])
|
|
end
|
|
|
|
# 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.
|
|
def search_code(query)
|
|
fuzzy_search(query, [:content])
|
|
end
|
|
|
|
def parent_class
|
|
::Project
|
|
end
|
|
end
|
|
end
|