debian-mirror-gitlab/app/models/snippet.rb

229 lines
5.8 KiB
Ruby
Raw Normal View History

2018-11-18 11:00:15 +05:30
# frozen_string_literal: true
2019-07-07 11:18:12 +05:30
class Snippet < ApplicationRecord
2015-04-26 12:48:37 +05:30
include Gitlab::VisibilityLevel
2018-11-18 11:00:15 +05:30
include Redactable
2016-11-03 12:29:30 +05:30
include CacheMarkdownField
2017-08-17 22:00:37 +05:30
include Noteable
2015-09-11 14:41:01 +05:30
include Participable
include Referable
include Sortable
2016-09-29 09:46:39 +05:30
include Awardable
2017-08-17 22:00:37 +05:30
include Mentionable
include Spammable
include Editable
2018-03-17 18:26:18 +05:30
include Gitlab::SQL::Pattern
2018-12-05 23:21:45 +05:30
include FromUnion
2014-09-02 18:07:02 +05:30
2016-11-03 12:29:30 +05:30
cache_markdown_field :title, pipeline: :single_line
2017-09-10 17:25:29 +05:30
cache_markdown_field :description
2016-11-03 12:29:30 +05:30
cache_markdown_field :content
2018-11-18 11:00:15 +05:30
redact_field :description
2017-08-17 22:00:37 +05:30
# 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-11-03 12:29:30 +05:30
# 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-03-17 18:26:18 +05:30
default_value_for(:visibility_level) { Gitlab::CurrentSettings.default_snippet_visibility }
2014-09-02 18:07:02 +05:30
2015-09-11 14:41:01 +05:30
belongs_to :author, class_name: 'User'
belongs_to :project
2014-09-02 18:07:02 +05:30
2017-09-10 17:25:29 +05:30
has_many :notes, as: :noteable, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
2014-09-02 18:07:02 +05:30
delegate :name, :email, to: :author, prefix: true, allow_nil: true
validates :author, presence: true
2017-08-17 22:00:37 +05:30
validates :title, presence: true, length: { maximum: 255 }
2015-04-26 12:48:37 +05:30
validates :file_name,
2017-09-10 17:25:29 +05:30
length: { maximum: 255 }
2016-08-24 12:49:21 +05:30
2014-09-02 18:07:02 +05:30
validates :content, presence: true
2015-04-26 12:48:37 +05:30
validates :visibility_level, inclusion: { in: Gitlab::VisibilityLevel.values }
2014-09-02 18:07:02 +05:30
# Scopes
2019-03-02 22:35:43 +05:30
scope :are_internal, -> { where(visibility_level: Snippet::INTERNAL) }
2015-04-26 12:48:37 +05:30
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]) }
2019-03-02 22:35:43 +05:30
scope :fresh, -> { order("created_at DESC") }
2018-11-18 11:00:15 +05:30
scope :inc_relations_for_view, -> { includes(author: :status) }
2014-09-02 18:07:02 +05:30
participant :author
participant :notes_with_associations
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
attr_spammable :title, spam_title: true
attr_spammable :content, spam_description: true
2018-12-13 13:39:08 +05:30
def self.with_optional_visibility(value = nil)
if value
where(visibility_level: value)
else
all
end
end
def self.only_global_snippets
where(project_id: nil)
end
def self.only_include_projects_visible_to(current_user = nil)
levels = Gitlab::VisibilityLevel.levels_for_user(current_user)
joins(:project).where('projects.visibility_level IN (?)', levels)
end
def self.only_include_projects_with_snippets_enabled(include_private: false)
column = ProjectFeature.access_level_attribute(:snippets)
levels = [ProjectFeature::ENABLED, ProjectFeature::PUBLIC]
levels << ProjectFeature::PRIVATE if include_private
joins(project: :project_feature)
.where(project_features: { column => levels })
end
def self.only_include_authorized_projects(current_user)
where(
'EXISTS (?)',
ProjectAuthorization
.select(1)
.where('project_id = snippets.project_id')
.where(user_id: current_user.id)
)
end
def self.for_project_with_user(project, user = nil)
return none unless project.snippets_visible?(user)
if user && project.team.member?(user)
project.snippets
else
project.snippets.public_to_user(user)
end
end
def self.visible_to_or_authored_by(user)
where(
'snippets.visibility_level IN (?) OR snippets.author_id = ?',
Gitlab::VisibilityLevel.levels_for_user(user),
user.id
)
end
2015-09-11 14:41:01 +05:30
def self.reference_prefix
'$'
end
# Pattern used to extract `$123` snippet references from text
#
# This pattern supports cross-project references.
def self.reference_pattern
2016-06-02 11:05:42 +05:30
@reference_pattern ||= %r{
2015-09-11 14:41:01 +05:30
(#{Project.reference_pattern})?
#{Regexp.escape(reference_prefix)}(?<snippet>\d+)
}x
end
2015-12-23 02:04:40 +05:30
def self.link_reference_pattern
2016-06-02 11:05:42 +05:30
@link_reference_pattern ||= super("snippets", /(?<snippet>\d+)/)
2015-12-23 02:04:40 +05:30
end
2018-03-17 18:26:18 +05:30
def to_reference(from = nil, full: false)
2015-09-11 14:41:01 +05:30
reference = "#{self.class.reference_prefix}#{id}"
2017-08-17 22:00:37 +05:30
if project.present?
2018-03-17 18:26:18 +05:30
"#{project.to_reference(from, full: full)}#{reference}"
2017-08-17 22:00:37 +05:30
else
reference
2015-09-11 14:41:01 +05:30
end
end
2014-09-02 18:07:02 +05:30
def self.content_types
[
".rb", ".py", ".pl", ".scala", ".c", ".cpp", ".java",
".haml", ".html", ".sass", ".scss", ".xml", ".php", ".erb",
".js", ".sh", ".coffee", ".yml", ".md"
]
end
2017-08-17 22:00:37 +05:30
def blob
@blob ||= Blob.decorate(SnippetBlob.new(self), nil)
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
def hook_attrs
attributes
end
2017-08-17 22:00:37 +05:30
def file_name
super.to_s
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
def sanitized_file_name
file_name.gsub(/[^a-zA-Z0-9_\-\.]+/, '')
end
2017-08-17 22:00:37 +05:30
def visibility_level_field
:visibility_level
2014-09-02 18:07:02 +05:30
end
2019-01-03 12:48:30 +05:30
def embeddable?
ability = project_id? ? :read_project_snippet : :read_personal_snippet
Ability.allowed?(nil, ability, self)
end
2017-08-17 22:00:37 +05:30
def notes_with_associations
notes.includes(:author)
2015-04-26 12:48:37 +05:30
end
2017-08-17 22:00:37 +05:30
def check_for_spam?
visibility_level_changed?(to: Snippet::PUBLIC) ||
(public? && (title_changed? || content_changed?))
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
def spammable_entity_type
'snippet'
end
2019-09-30 21:07:59 +05:30
def to_ability_name
model_name.singular
end
2015-04-26 12:48:37 +05:30
class << self
2016-06-02 11:05:42 +05:30
# 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.
2015-04-26 12:48:37 +05:30
def search(query)
2018-03-17 18:26:18 +05:30
fuzzy_search(query, [:title, :file_name])
2015-04-26 12:48:37 +05:30
end
2016-06-02 11:05:42 +05:30
# 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.
2015-04-26 12:48:37 +05:30
def search_code(query)
2018-03-17 18:26:18 +05:30
fuzzy_search(query, [:content])
2015-04-26 12:48:37 +05:30
end
2018-03-27 19:54:05 +05:30
def parent_class
::Project
end
2015-04-26 12:48:37 +05:30
end
2014-09-02 18:07:02 +05:30
end