2021-01-03 14:25:43 +05:30
# frozen_string_literal: true
module API
class DebianProjectPackages < :: API :: Base
2021-10-27 15:23:28 +05:30
PACKAGE_FILE_REQUIREMENTS = {
id : API :: NO_SLASH_URL_PART_REGEX ,
distribution : :: Packages :: Debian :: DISTRIBUTION_REGEX ,
letter : :: Packages :: Debian :: LETTER_REGEX ,
package_name : API :: NO_SLASH_URL_PART_REGEX ,
package_version : API :: NO_SLASH_URL_PART_REGEX ,
file_name : API :: NO_SLASH_URL_PART_REGEX
} . freeze
FILE_NAME_REQUIREMENTS = {
file_name : API :: NO_SLASH_URL_PART_REGEX
} . freeze
2021-01-03 14:25:43 +05:30
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2021-10-27 15:23:28 +05:30
helpers do
def project_or_group
2023-03-17 16:20:25 +05:30
user_project ( action : :read_package )
2021-10-27 15:23:28 +05:30
end
2021-09-04 01:27:46 +05:30
end
after_validation do
2021-03-11 19:13:27 +05:30
require_packages_enabled!
2023-03-17 16:20:25 +05:30
not_found! unless :: Feature . enabled? ( :debian_packages , project_or_group )
2021-01-03 14:25:43 +05:30
2023-03-17 16:20:25 +05:30
authorize_read_package! ( project_or_group )
2021-01-03 14:25:43 +05:30
end
2021-10-27 15:23:28 +05:30
params do
2023-01-13 00:05:48 +05:30
requires :id , types : [ String , Integer ] , desc : 'The ID or URL-encoded path of the project'
2021-10-27 15:23:28 +05:30
end
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
namespace ':id/packages/debian' do
2021-09-04 01:27:46 +05:30
include :: API :: Concerns :: Packages :: DebianPackageEndpoints
2021-01-03 14:25:43 +05:30
2021-10-27 15:23:28 +05:30
# GET projects/:id/packages/debian/pool/:distribution/:letter/:package_name/:package_version/:file_name
params do
use :shared_package_file_params
end
2023-03-04 22:38:38 +05:30
desc 'Download Debian package' do
2021-10-27 15:23:28 +05:30
detail 'This feature was introduced in GitLab 14.2'
2023-03-04 22:38:38 +05:30
success code : 200
failure [
{ code : 401 , message : 'Unauthorized' } ,
{ code : 403 , message : 'Forbidden' } ,
{ code : 404 , message : 'Not Found' }
]
tags %w[ debian_packages ]
2021-10-27 15:23:28 +05:30
end
route_setting :authentication , authenticate_non_public : true
get 'pool/:distribution/:letter/:package_name/:package_version/:file_name' , requirements : PACKAGE_FILE_REQUIREMENTS do
2023-03-17 16:20:25 +05:30
present_distribution_package_file! ( project_or_group )
2021-10-27 15:23:28 +05:30
end
2021-01-03 14:25:43 +05:30
params do
2023-03-04 22:38:38 +05:30
requires :file_name , type : String , desc : 'The file name' , documentation : { example : 'example_1.0.0~alpha2_amd64.deb' }
2021-01-03 14:25:43 +05:30
end
2021-10-27 15:23:28 +05:30
namespace ':file_name' , requirements : FILE_NAME_REQUIREMENTS do
2021-09-04 01:27:46 +05:30
format :txt
2021-03-08 18:12:59 +05:30
content_type :json , Gitlab :: Workhorse :: INTERNAL_API_CONTENT_TYPE
2023-04-23 21:23:45 +05:30
# PUT {projects|groups}/:id/packages/debian/:file_name
2023-03-04 22:38:38 +05:30
desc 'Upload Debian package' do
detail 'This feature was introduced in GitLab 14.0'
success code : 201
failure [
{ code : 400 , message : 'Bad Request' } ,
{ code : 401 , message : 'Unauthorized' } ,
{ code : 403 , message : 'Forbidden' } ,
{ code : 404 , message : 'Not Found' }
]
tags %w[ debian_packages ]
end
2021-01-03 14:25:43 +05:30
params do
2023-01-13 00:05:48 +05:30
requires :file , type : :: API :: Validations :: Types :: WorkhorseFile , desc : 'The package file to be published (generated by Multipart middleware)' , documentation : { type : 'file' }
2023-04-23 21:23:45 +05:30
optional :distribution , type : String , desc : 'The Debian Codename or Suite' , regexp : Gitlab :: Regex . debian_distribution_regex
given :distribution do
requires :component , type : String , desc : 'The Debian Component' , regexp : Gitlab :: Regex . debian_component_regex
2023-05-27 22:25:52 +05:30
requires :file_name , type : String , desc : 'The filename' , regexp : { value : Gitlab :: Regex . debian_direct_upload_filename_regex , message : 'Only debs, udebs and ddebs can be directly added to a distribution' }
2023-04-23 21:23:45 +05:30
end
2021-01-03 14:25:43 +05:30
end
2021-03-11 19:13:27 +05:30
route_setting :authentication , deploy_token_allowed : true , basic_auth_personal_access_token : true , job_token_allowed : :basic_auth , authenticate_non_public : true
2021-01-03 14:25:43 +05:30
put do
authorize_upload! ( authorized_user_project )
bad_request! ( 'File is too large' ) if authorized_user_project . actual_limits . exceeded? ( :debian_max_file_size , params [ :file ] . size )
2021-09-04 01:27:46 +05:30
file_params = {
2022-08-27 11:52:29 +05:30
file : params [ 'file' ] ,
file_name : params [ 'file_name' ] ,
file_sha1 : params [ 'file.sha1' ] ,
2023-04-23 21:23:45 +05:30
file_md5 : params [ 'file.md5' ] ,
distribution : params [ 'distribution' ] ,
component : params [ 'component' ]
2021-09-04 01:27:46 +05:30
}
2023-04-23 21:23:45 +05:30
package = if params [ :distribution ] . present?
:: Packages :: CreateTemporaryPackageService . new (
authorized_user_project , current_user , declared_params . merge ( build : current_authenticated_job )
) . execute ( :debian , name : :: Packages :: Debian :: TEMPORARY_PACKAGE_NAME )
else
:: Packages :: Debian :: FindOrCreateIncomingService . new ( authorized_user_project , current_user ) . execute
end
2021-09-04 01:27:46 +05:30
2022-11-25 23:54:43 +05:30
:: Packages :: Debian :: CreatePackageFileService . new ( package : package , current_user : current_user , params : file_params ) . execute
2021-01-03 14:25:43 +05:30
2023-06-20 00:43:36 +05:30
track_debian_package_event 'push_package'
2021-01-03 14:25:43 +05:30
created!
rescue ObjectStorage :: RemoteStoreError = > e
Gitlab :: ErrorTracking . track_exception ( e , extra : { file_name : params [ :file_name ] , project_id : authorized_user_project . id } )
forbidden!
end
2021-03-11 19:13:27 +05:30
# PUT {projects|groups}/:id/packages/debian/:file_name/authorize
2023-03-04 22:38:38 +05:30
desc 'Authorize Debian package upload' do
detail 'This feature was introduced in GitLab 13.5'
success code : 200
failure [
2023-04-23 21:23:45 +05:30
{ code : 400 , message : 'Bad Request' } ,
2023-03-04 22:38:38 +05:30
{ code : 401 , message : 'Unauthorized' } ,
{ code : 403 , message : 'Forbidden' } ,
{ code : 404 , message : 'Not Found' }
]
tags %w[ debian_packages ]
end
2023-04-23 21:23:45 +05:30
params do
optional :distribution , type : String , desc : 'The Debian Codename or Suite' , regexp : Gitlab :: Regex . debian_distribution_regex
given :distribution do
requires :component , type : String , desc : 'The Debian Component' , regexp : Gitlab :: Regex . debian_component_regex
2023-05-27 22:25:52 +05:30
requires :file_name , type : String , desc : 'The filename' , regexp : { value : Gitlab :: Regex . debian_direct_upload_filename_regex , message : 'Only debs, udebs and ddebs can be directly added to a distribution' }
2023-04-23 21:23:45 +05:30
end
end
2021-03-11 19:13:27 +05:30
route_setting :authentication , deploy_token_allowed : true , basic_auth_personal_access_token : true , job_token_allowed : :basic_auth , authenticate_non_public : true
2021-03-08 18:12:59 +05:30
put 'authorize' do
2021-01-03 14:25:43 +05:30
authorize_workhorse! (
subject : authorized_user_project ,
maximum_size : authorized_user_project . actual_limits . debian_max_file_size
)
end
end
end
end
end
end