2020-07-28 23:09:34 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
# PHP composer support (https://getcomposer.org/)
|
|
|
|
module API
|
2021-01-03 14:25:43 +05:30
|
|
|
class ComposerPackages < ::API::Base
|
2020-07-28 23:09:34 +05:30
|
|
|
helpers ::API::Helpers::PackagesManagerClientsHelpers
|
|
|
|
helpers ::API::Helpers::RelatedResourcesHelpers
|
|
|
|
helpers ::API::Helpers::Packages::BasicAuthHelpers
|
|
|
|
include ::API::Helpers::Packages::BasicAuthHelpers::Constants
|
|
|
|
include ::Gitlab::Utils::StrongMemoize
|
|
|
|
|
2021-01-29 00:20:46 +05:30
|
|
|
feature_category :package_registry
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
content_type :json, 'application/json'
|
|
|
|
default_format :json
|
|
|
|
|
|
|
|
COMPOSER_ENDPOINT_REQUIREMENTS = {
|
|
|
|
package_name: API::NO_SLASH_URL_PART_REGEX
|
|
|
|
}.freeze
|
|
|
|
|
|
|
|
default_format :json
|
|
|
|
|
|
|
|
rescue_from ArgumentError do |e|
|
|
|
|
render_api_error!(e.message, 400)
|
|
|
|
end
|
|
|
|
|
|
|
|
rescue_from ActiveRecord::RecordInvalid do |e|
|
|
|
|
render_api_error!(e.message, 400)
|
|
|
|
end
|
|
|
|
|
2021-01-03 14:25:43 +05:30
|
|
|
rescue_from Packages::Composer::ComposerJsonService::InvalidJson do |e|
|
|
|
|
render_api_error!(e.message, 422)
|
|
|
|
end
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
helpers do
|
|
|
|
def packages
|
|
|
|
strong_memoize(:packages) do
|
|
|
|
packages = ::Packages::Composer::PackagesFinder.new(current_user, user_group).execute
|
|
|
|
|
|
|
|
if params[:package_name].present?
|
2021-02-22 17:27:13 +05:30
|
|
|
params[:package_name], params[:sha] = params[:package_name].split('$')
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
packages = packages.with_name(params[:package_name])
|
|
|
|
end
|
|
|
|
|
|
|
|
packages
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2021-04-17 20:07:23 +05:30
|
|
|
def composer_v2?
|
|
|
|
headers['User-Agent'].to_s.include?('Composer/2')
|
|
|
|
end
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
def presenter
|
2021-04-17 20:07:23 +05:30
|
|
|
@presenter ||= ::Packages::Composer::PackagesPresenter.new(user_group, packages, composer_v2?)
|
2020-07-28 23:09:34 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
before do
|
|
|
|
require_packages_enabled!
|
|
|
|
end
|
|
|
|
|
|
|
|
params do
|
|
|
|
requires :id, type: String, desc: 'The ID of a group'
|
|
|
|
end
|
|
|
|
|
|
|
|
resource :group, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
|
|
before do
|
|
|
|
user_group
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Composer packages endpoint at group level'
|
2022-01-26 12:08:38 +05:30
|
|
|
route_setting :authentication, job_token_allowed: true, basic_auth_personal_access_token: true, deploy_token_allowed: true
|
2020-07-28 23:09:34 +05:30
|
|
|
get ':id/-/packages/composer/packages' do
|
|
|
|
presenter.root
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Composer packages endpoint at group level for packages list'
|
|
|
|
params do
|
|
|
|
requires :sha, type: String, desc: 'Shasum of current json'
|
|
|
|
end
|
2022-01-26 12:08:38 +05:30
|
|
|
route_setting :authentication, job_token_allowed: true, basic_auth_personal_access_token: true, deploy_token_allowed: true
|
2020-07-28 23:09:34 +05:30
|
|
|
get ':id/-/packages/composer/p/:sha' do
|
|
|
|
presenter.provider
|
|
|
|
end
|
|
|
|
|
2021-04-17 20:07:23 +05:30
|
|
|
desc 'Composer v2 packages p2 endpoint at group level for package versions metadata'
|
2020-07-28 23:09:34 +05:30
|
|
|
params do
|
|
|
|
requires :package_name, type: String, file_path: true, desc: 'The Composer package name'
|
|
|
|
end
|
2022-01-26 12:08:38 +05:30
|
|
|
route_setting :authentication, job_token_allowed: true, basic_auth_personal_access_token: true, deploy_token_allowed: true
|
2021-04-17 20:07:23 +05:30
|
|
|
get ':id/-/packages/composer/p2/*package_name', requirements: COMPOSER_ENDPOINT_REQUIREMENTS, file_path: true do
|
|
|
|
not_found! if packages.empty?
|
2020-07-28 23:09:34 +05:30
|
|
|
|
2021-04-17 20:07:23 +05:30
|
|
|
presenter.package_versions
|
|
|
|
end
|
|
|
|
|
|
|
|
desc 'Composer packages endpoint at group level for package versions metadata'
|
|
|
|
params do
|
|
|
|
requires :package_name, type: String, file_path: true, desc: 'The Composer package name'
|
|
|
|
end
|
2022-01-26 12:08:38 +05:30
|
|
|
route_setting :authentication, job_token_allowed: true, basic_auth_personal_access_token: true, deploy_token_allowed: true
|
2020-07-28 23:09:34 +05:30
|
|
|
get ':id/-/packages/composer/*package_name', requirements: COMPOSER_ENDPOINT_REQUIREMENTS, file_path: true do
|
|
|
|
not_found! if packages.empty?
|
2021-02-22 17:27:13 +05:30
|
|
|
not_found! if params[:sha].blank?
|
2020-07-28 23:09:34 +05:30
|
|
|
|
|
|
|
presenter.package_versions
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
params do
|
|
|
|
requires :id, type: Integer, desc: 'The ID of a project'
|
|
|
|
end
|
|
|
|
|
|
|
|
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
|
|
|
|
desc 'Composer packages endpoint for registering packages'
|
|
|
|
namespace ':id/packages/composer' do
|
2022-01-26 12:08:38 +05:30
|
|
|
route_setting :authentication, job_token_allowed: true, basic_auth_personal_access_token: true, deploy_token_allowed: true
|
2020-07-28 23:09:34 +05:30
|
|
|
|
|
|
|
params do
|
|
|
|
optional :branch, type: String, desc: 'The name of the branch'
|
|
|
|
optional :tag, type: String, desc: 'The name of the tag'
|
|
|
|
exactly_one_of :tag, :branch
|
|
|
|
end
|
|
|
|
post do
|
|
|
|
authorize_create_package!(authorized_user_project)
|
|
|
|
|
|
|
|
if params[:branch].present?
|
|
|
|
params[:branch] = find_branch!(params[:branch])
|
|
|
|
elsif params[:tag].present?
|
|
|
|
params[:tag] = find_tag!(params[:tag])
|
|
|
|
else
|
|
|
|
bad_request!
|
|
|
|
end
|
|
|
|
|
|
|
|
::Packages::Composer::CreatePackageService
|
2021-02-22 17:27:13 +05:30
|
|
|
.new(authorized_user_project, current_user, declared_params.merge(build: current_authenticated_job))
|
2020-07-28 23:09:34 +05:30
|
|
|
.execute
|
|
|
|
|
2021-11-18 22:05:49 +05:30
|
|
|
track_package_event('push_package', :composer, project: authorized_user_project, user: current_user, namespace: authorized_user_project.namespace)
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
created!
|
|
|
|
end
|
|
|
|
|
|
|
|
params do
|
|
|
|
requires :sha, type: String, desc: 'Shasum of current json'
|
|
|
|
requires :package_name, type: String, file_path: true, desc: 'The Composer package name'
|
|
|
|
end
|
2022-06-21 17:19:12 +05:30
|
|
|
route_setting :authentication, job_token_allowed: true, basic_auth_personal_access_token: true, deploy_token_allowed: true
|
2020-07-28 23:09:34 +05:30
|
|
|
get 'archives/*package_name' do
|
2022-06-21 17:19:12 +05:30
|
|
|
authorize_read_package!(authorized_user_project)
|
|
|
|
|
|
|
|
metadata = authorized_user_project
|
2020-07-28 23:09:34 +05:30
|
|
|
.packages
|
|
|
|
.composer
|
|
|
|
.with_name(params[:package_name])
|
|
|
|
.with_composer_target(params[:sha])
|
|
|
|
.first
|
|
|
|
&.composer_metadatum
|
|
|
|
|
|
|
|
not_found! unless metadata
|
|
|
|
|
2022-06-21 17:19:12 +05:30
|
|
|
track_package_event('pull_package', :composer, project: authorized_user_project, namespace: authorized_user_project.namespace)
|
2021-04-29 21:17:54 +05:30
|
|
|
|
2022-06-21 17:19:12 +05:30
|
|
|
send_git_archive authorized_user_project.repository, ref: metadata.target_sha, format: 'zip', append_sha: true
|
2020-07-28 23:09:34 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|