debian-mirror-gitlab/app/models/packages/package.rb

371 lines
15 KiB
Ruby
Raw Normal View History

2020-07-28 23:09:34 +05:30
# frozen_string_literal: true
class Packages::Package < ApplicationRecord
2021-11-11 11:23:49 +05:30
include EachBatch
2020-07-28 23:09:34 +05:30
include Sortable
include Gitlab::SQL::Pattern
include UsageStatistics
2021-01-29 00:20:46 +05:30
include Gitlab::Utils::StrongMemoize
2020-07-28 23:09:34 +05:30
2021-04-29 21:17:54 +05:30
DISPLAYABLE_STATUSES = [:default, :error].freeze
2021-06-08 01:23:25 +05:30
INSTALLABLE_STATUSES = [:default].freeze
2021-04-29 21:17:54 +05:30
2021-09-04 01:27:46 +05:30
enum package_type: {
maven: 1,
npm: 2,
conan: 3,
nuget: 4,
pypi: 5,
composer: 6,
generic: 7,
golang: 8,
debian: 9,
rubygems: 10,
helm: 11,
terraform_module: 12
}
enum status: { default: 0, hidden: 1, processing: 2, error: 3 }
2020-07-28 23:09:34 +05:30
belongs_to :project
2020-11-24 15:15:51 +05:30
belongs_to :creator, class_name: 'User'
2020-07-28 23:09:34 +05:30
# package_files must be destroyed by ruby code in order to properly remove carrierwave uploads and update project statistics
has_many :package_files, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
has_many :dependency_links, inverse_of: :package, class_name: 'Packages::DependencyLink'
has_many :tags, inverse_of: :package, class_name: 'Packages::Tag'
has_one :conan_metadatum, inverse_of: :package, class_name: 'Packages::Conan::Metadatum'
has_one :pypi_metadatum, inverse_of: :package, class_name: 'Packages::Pypi::Metadatum'
has_one :maven_metadatum, inverse_of: :package, class_name: 'Packages::Maven::Metadatum'
has_one :nuget_metadatum, inverse_of: :package, class_name: 'Packages::Nuget::Metadatum'
has_one :composer_metadatum, inverse_of: :package, class_name: 'Packages::Composer::Metadatum'
2021-03-11 19:13:27 +05:30
has_one :rubygems_metadatum, inverse_of: :package, class_name: 'Packages::Rubygems::Metadatum'
2021-12-11 22:18:48 +05:30
has_one :npm_metadatum, inverse_of: :package, class_name: 'Packages::Npm::Metadatum'
2021-01-29 00:20:46 +05:30
has_many :build_infos, inverse_of: :package
2021-12-11 22:18:48 +05:30
has_many :pipelines, through: :build_infos, disable_joins: true
2021-03-11 19:13:27 +05:30
has_one :debian_publication, inverse_of: :package, class_name: 'Packages::Debian::Publication'
has_one :debian_distribution, through: :debian_publication, source: :distribution, inverse_of: :packages, class_name: 'Packages::Debian::ProjectDistribution'
2020-07-28 23:09:34 +05:30
accepts_nested_attributes_for :conan_metadatum
2021-03-11 19:13:27 +05:30
accepts_nested_attributes_for :debian_publication
2020-07-28 23:09:34 +05:30
accepts_nested_attributes_for :maven_metadatum
delegate :recipe, :recipe_path, to: :conan_metadatum, prefix: :conan
2021-03-11 19:13:27 +05:30
delegate :codename, :suite, to: :debian_distribution, prefix: :debian_distribution
2021-04-29 21:17:54 +05:30
delegate :target_sha, to: :composer_metadatum, prefix: :composer
2020-07-28 23:09:34 +05:30
validates :project, presence: true
validates :name, presence: true
2021-02-22 17:27:13 +05:30
validates :name, format: { with: Gitlab::Regex.package_name_regex }, unless: -> { conan? || generic? || debian? }
2020-07-28 23:09:34 +05:30
validates :name,
2021-03-11 19:13:27 +05:30
uniqueness: { scope: %i[project_id version package_type] }, unless: -> { conan? || debian_package? }
validate :unique_debian_package_name, if: :debian_package?
2020-07-28 23:09:34 +05:30
validate :valid_conan_package_recipe, if: :conan?
validate :valid_composer_global_name, if: :composer?
2021-10-27 15:23:28 +05:30
validate :npm_package_already_taken, if: :npm?
2020-07-28 23:09:34 +05:30
validates :name, format: { with: Gitlab::Regex.conan_recipe_component_regex }, if: :conan?
2021-01-03 14:25:43 +05:30
validates :name, format: { with: Gitlab::Regex.generic_package_name_regex }, if: :generic?
2021-06-08 01:23:25 +05:30
validates :name, format: { with: Gitlab::Regex.helm_package_regex }, if: :helm?
2021-04-17 20:07:23 +05:30
validates :name, format: { with: Gitlab::Regex.npm_package_name_regex }, if: :npm?
2020-11-05 12:06:23 +05:30
validates :name, format: { with: Gitlab::Regex.nuget_package_name_regex }, if: :nuget?
2021-06-08 01:23:25 +05:30
validates :name, format: { with: Gitlab::Regex.terraform_module_package_name_regex }, if: :terraform_module?
2021-02-22 17:27:13 +05:30
validates :name, format: { with: Gitlab::Regex.debian_package_name_regex }, if: :debian_package?
validates :name, inclusion: { in: %w[incoming] }, if: :debian_incoming?
2021-01-03 14:25:43 +05:30
validates :version, format: { with: Gitlab::Regex.nuget_version_regex }, if: :nuget?
2020-07-28 23:09:34 +05:30
validates :version, format: { with: Gitlab::Regex.conan_recipe_component_regex }, if: :conan?
validates :version, format: { with: Gitlab::Regex.maven_version_regex }, if: -> { version? && maven? }
2020-11-24 15:15:51 +05:30
validates :version, format: { with: Gitlab::Regex.pypi_version_regex }, if: :pypi?
2021-01-03 14:25:43 +05:30
validates :version, format: { with: Gitlab::Regex.prefixed_semver_regex }, if: :golang?
2021-09-04 01:27:46 +05:30
validates :version, format: { with: Gitlab::Regex.helm_version_regex }, if: :helm?
2021-06-08 01:23:25 +05:30
validates :version, format: { with: Gitlab::Regex.semver_regex }, if: -> { composer_tag_version? || npm? || terraform_module? }
2021-01-29 00:20:46 +05:30
2020-11-24 15:15:51 +05:30
validates :version,
presence: true,
format: { with: Gitlab::Regex.generic_package_version_regex },
if: :generic?
2021-02-22 17:27:13 +05:30
validates :version,
presence: true,
format: { with: Gitlab::Regex.debian_version_regex },
if: :debian_package?
validate :forbidden_debian_changes, if: :debian?
2020-07-28 23:09:34 +05:30
2021-06-08 01:23:25 +05:30
scope :for_projects, ->(project_ids) { where(project_id: project_ids) }
2020-07-28 23:09:34 +05:30
scope :with_name, ->(name) { where(name: name) }
scope :with_name_like, ->(name) { where(arel_table[:name].matches(name)) }
2021-01-03 14:25:43 +05:30
scope :with_normalized_pypi_name, ->(name) { where("LOWER(regexp_replace(name, '[-_.]+', '-', 'g')) = ?", name.downcase) }
2020-07-28 23:09:34 +05:30
scope :search_by_name, ->(query) { fuzzy_search(query, [:name], use_minimum_char_limit: false) }
scope :with_version, ->(version) { where(version: version) }
scope :without_version_like, -> (version) { where.not(arel_table[:version].matches(version)) }
scope :with_package_type, ->(package_type) { where(package_type: package_type) }
2021-06-08 01:23:25 +05:30
scope :without_package_type, ->(package_type) { where.not(package_type: package_type) }
2021-03-11 19:13:27 +05:30
scope :with_status, ->(status) { where(status: status) }
2021-04-29 21:17:54 +05:30
scope :displayable, -> { with_status(DISPLAYABLE_STATUSES) }
2021-06-08 01:23:25 +05:30
scope :installable, -> { with_status(INSTALLABLE_STATUSES) }
2020-11-24 15:15:51 +05:30
scope :including_project_route, -> { includes(project: { namespace: :route }) }
scope :including_tags, -> { includes(:tags) }
2021-11-11 11:23:49 +05:30
scope :including_dependency_links, -> { includes(dependency_links: :dependency) }
2020-07-28 23:09:34 +05:30
scope :with_conan_channel, ->(package_channel) do
joins(:conan_metadatum).where(packages_conan_metadata: { package_channel: package_channel })
end
scope :with_conan_username, ->(package_username) do
joins(:conan_metadatum).where(packages_conan_metadata: { package_username: package_username })
end
2021-04-17 20:07:23 +05:30
scope :with_debian_codename, -> (codename) do
debian
.joins(:debian_distribution)
.where(Packages::Debian::ProjectDistribution.table_name => { codename: codename })
end
scope :preload_debian_file_metadata, -> { preload(package_files: :debian_file_metadatum) }
2020-07-28 23:09:34 +05:30
scope :with_composer_target, -> (target) do
includes(:composer_metadatum)
.joins(:composer_metadatum)
.where(Packages::Composer::Metadatum.table_name => { target_sha: target })
end
scope :preload_composer, -> { preload(:composer_metadatum) }
2021-12-11 22:18:48 +05:30
scope :preload_npm_metadatum, -> { preload(:npm_metadatum) }
2020-07-28 23:09:34 +05:30
2021-04-17 20:07:23 +05:30
scope :without_nuget_temporary_name, -> { where.not(name: Packages::Nuget::TEMPORARY_PACKAGE_NAME) }
2020-07-28 23:09:34 +05:30
scope :has_version, -> { where.not(version: nil) }
scope :preload_files, -> { preload(:package_files) }
2021-12-11 22:18:48 +05:30
scope :preload_pipelines, -> { preload(pipelines: :user) }
2020-07-28 23:09:34 +05:30
scope :last_of_each_version, -> { where(id: all.select('MAX(id) AS id').group(:version)) }
scope :limit_recent, ->(limit) { order_created_desc.limit(limit) }
scope :select_distinct_name, -> { select(:name).distinct }
# Sorting
2021-06-08 01:23:25 +05:30
scope :order_created, -> { reorder(created_at: :asc) }
scope :order_created_desc, -> { reorder(created_at: :desc) }
scope :order_name, -> { reorder(name: :asc) }
scope :order_name_desc, -> { reorder(name: :desc) }
scope :order_version, -> { reorder(version: :asc) }
scope :order_version_desc, -> { reorder(version: :desc) }
scope :order_type, -> { reorder(package_type: :asc) }
scope :order_type_desc, -> { reorder(package_type: :desc) }
2020-07-28 23:09:34 +05:30
scope :order_project_name, -> { joins(:project).reorder('projects.name ASC') }
scope :order_project_name_desc, -> { joins(:project).reorder('projects.name DESC') }
2021-03-08 18:12:59 +05:30
scope :order_by_package_file, -> { joins(:package_files).order('packages_package_files.created_at ASC') }
2020-07-28 23:09:34 +05:30
2021-09-04 01:27:46 +05:30
scope :order_project_path, -> do
keyset_order = keyset_pagination_order(join_class: Project, column_name: :path, direction: :asc)
joins(:project).reorder(keyset_order)
end
scope :order_project_path_desc, -> do
keyset_order = keyset_pagination_order(join_class: Project, column_name: :path, direction: :desc)
joins(:project).reorder(keyset_order)
end
2021-04-29 21:17:54 +05:30
def self.only_maven_packages_with_path(path, use_cte: false)
2021-09-04 01:27:46 +05:30
if use_cte
2021-04-29 21:17:54 +05:30
# This is an optimization fence which assumes that looking up the Metadatum record by path (globally)
# and then filter down the packages (by project or by group and subgroups) will be cheaper than
# looking up all packages within a project or group and filter them by path.
inner_query = Packages::Maven::Metadatum.where(path: path).select(:id, :package_id)
cte = Gitlab::SQL::CTE.new(:maven_metadata_by_path, inner_query)
with(cte.to_arel)
.joins('INNER JOIN maven_metadata_by_path ON maven_metadata_by_path.package_id=packages_packages.id')
else
joins(:maven_metadatum).where(packages_maven_metadata: { path: path })
end
2020-07-28 23:09:34 +05:30
end
def self.by_name_and_file_name(name, file_name)
with_name(name)
.joins(:package_files)
.where(packages_package_files: { file_name: file_name }).last!
end
def self.by_file_name_and_sha256(file_name, sha256)
joins(:package_files)
.where(packages_package_files: { file_name: file_name, file_sha256: sha256 }).last!
end
2021-01-03 14:25:43 +05:30
def self.by_name_and_version!(name, version)
find_by!(name: name, version: version)
end
2020-07-28 23:09:34 +05:30
def self.pluck_names
pluck(:name)
end
def self.pluck_versions
pluck(:version)
end
def self.sort_by_attribute(method)
case method.to_s
when 'created_asc' then order_created
when 'created_at_asc' then order_created
when 'name_asc' then order_name
when 'name_desc' then order_name_desc
when 'version_asc' then order_version
when 'version_desc' then order_version_desc
when 'type_asc' then order_type
when 'type_desc' then order_type_desc
when 'project_name_asc' then order_project_name
when 'project_name_desc' then order_project_name_desc
when 'project_path_asc' then order_project_path
when 'project_path_desc' then order_project_path_desc
else
order_created_desc
end
end
2021-09-04 01:27:46 +05:30
def self.keyset_pagination_order(join_class:, column_name:, direction: :asc)
join_table = join_class.table_name
asc_order_expression = Gitlab::Database.nulls_last_order("#{join_table}.#{column_name}", :asc)
desc_order_expression = Gitlab::Database.nulls_first_order("#{join_table}.#{column_name}", :desc)
order_direction = direction == :asc ? asc_order_expression : desc_order_expression
reverse_order_direction = direction == :asc ? desc_order_expression : asc_order_expression
arel_order_classes = ::Gitlab::Pagination::Keyset::ColumnOrderDefinition::AREL_ORDER_CLASSES.invert
::Gitlab::Pagination::Keyset::Order.build([
::Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: "#{join_table}_#{column_name}",
column_expression: join_class.arel_table[column_name],
order_expression: order_direction,
reversed_order_expression: reverse_order_direction,
order_direction: direction,
distinct: false,
add_to_projections: true
),
::Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: 'id',
order_expression: arel_order_classes[direction].new(Packages::Package.arel_table[:id]),
add_to_projections: true
)
])
end
2020-07-28 23:09:34 +05:30
def versions
project.packages
2021-12-11 22:18:48 +05:30
.preload_pipelines
2020-11-24 15:15:51 +05:30
.including_tags
2020-07-28 23:09:34 +05:30
.with_name(name)
.where.not(version: version)
.with_package_type(package_type)
.order(:version)
end
2021-01-29 00:20:46 +05:30
# Technical debt: to be removed in https://gitlab.com/gitlab-org/gitlab/-/issues/281937
def original_build_info
strong_memoize(:original_build_info) do
build_infos.first
end
end
# Technical debt: to be removed in https://gitlab.com/gitlab-org/gitlab/-/issues/281937
2020-07-28 23:09:34 +05:30
def pipeline
2021-01-29 00:20:46 +05:30
original_build_info&.pipeline
2020-07-28 23:09:34 +05:30
end
def tag_names
tags.pluck(:name)
end
2021-09-04 01:27:46 +05:30
def infrastructure_package?
terraform_module?
end
2021-02-22 17:27:13 +05:30
def debian_incoming?
debian? && version.nil?
end
def debian_package?
debian? && !version.nil?
end
2021-03-08 18:12:59 +05:30
def package_settings
strong_memoize(:package_settings) do
project.namespace.package_settings
end
end
2021-04-17 20:07:23 +05:30
def sync_maven_metadata(user)
return unless maven? && version? && user
::Packages::Maven::Metadata::SyncWorker.perform_async(user.id, project.id, name)
end
2021-11-11 11:23:49 +05:30
def create_build_infos!(build)
return unless build&.pipeline
# TODO: use an upsert call when https://gitlab.com/gitlab-org/gitlab/-/issues/339093 is implemented
build_infos.find_or_create_by!(pipeline: build.pipeline)
end
2020-07-28 23:09:34 +05:30
private
2021-01-29 00:20:46 +05:30
def composer_tag_version?
composer? && !Gitlab::Regex.composer_dev_version_regex.match(version.to_s)
end
2020-07-28 23:09:34 +05:30
def valid_conan_package_recipe
recipe_exists = project.packages
.conan
.includes(:conan_metadatum)
.with_name(name)
.with_version(version)
.with_conan_channel(conan_metadatum.package_channel)
.with_conan_username(conan_metadatum.package_username)
.id_not_in(id)
.exists?
errors.add(:base, _('Package recipe already exists')) if recipe_exists
end
def valid_composer_global_name
# .default_scoped is required here due to a bug in rails that leaks
# the scope and adds `self` to the query incorrectly
# See https://github.com/rails/rails/pull/35186
if Packages::Package.default_scoped.composer.with_name(name).where.not(project_id: project_id).exists?
errors.add(:name, 'is already taken by another project')
end
end
2021-10-27 15:23:28 +05:30
def npm_package_already_taken
2020-07-28 23:09:34 +05:30
return unless project
2021-10-27 15:23:28 +05:30
return unless follows_npm_naming_convention?
2020-07-28 23:09:34 +05:30
2021-10-27 15:23:28 +05:30
if project.package_already_taken?(name, version, package_type: :npm)
2020-07-28 23:09:34 +05:30
errors.add(:base, _('Package already exists'))
end
end
2021-02-22 17:27:13 +05:30
2021-10-27 15:23:28 +05:30
# https://docs.gitlab.com/ee/user/packages/npm_registry/#package-naming-convention
def follows_npm_naming_convention?
return false unless project&.root_namespace&.path
project.root_namespace.path == ::Packages::Npm.scope_of(name)
end
2021-03-11 19:13:27 +05:30
def unique_debian_package_name
return unless debian_publication&.distribution
package_exists = debian_publication.distribution.packages
.with_name(name)
.with_version(version)
.id_not_in(id)
.exists?
errors.add(:base, _('Debian package already exists in Distribution')) if package_exists
end
2021-02-22 17:27:13 +05:30
def forbidden_debian_changes
return unless persisted?
# Debian incoming
if version_was.nil? || version.nil?
errors.add(:version, _('cannot be changed')) if version_changed?
end
end
2020-07-28 23:09:34 +05:30
end