2018-09-29 22:34:47 +00:00
# frozen_string_literal: true
2018-02-12 11:42:33 +00:00
module API
class ProjectImport < Grape :: API
include PaginationParams
2019-05-30 21:55:17 +00:00
helpers Helpers :: ProjectsHelpers
2018-02-12 11:42:33 +00:00
helpers do
def import_params
declared_params ( include_missing : false )
end
def file_is_valid?
2018-02-12 15:02:15 +00:00
import_params [ :file ] && import_params [ :file ] [ 'tempfile' ] . respond_to? ( :read )
2018-02-12 11:42:33 +00:00
end
2018-02-14 13:46:40 +00:00
def validate_file!
render_api_error! ( 'The file is invalid' , 400 ) unless file_is_valid?
end
2020-01-27 09:08:32 +00:00
def throttled? ( key , scope )
rate_limiter . throttled? ( key , scope : scope )
end
def rate_limiter
:: Gitlab :: ApplicationRateLimiter
end
2018-02-12 11:42:33 +00:00
end
before do
2018-02-13 14:18:52 +00:00
forbidden! unless Gitlab :: CurrentSettings . import_sources . include? ( 'gitlab_project' )
2018-02-12 11:42:33 +00:00
end
2018-11-08 12:18:17 +00:00
resource :projects , requirements : API :: NAMESPACE_OR_PROJECT_REQUIREMENTS do
2018-02-13 08:24:10 +00:00
params do
requires :path , type : String , desc : 'The new project path and name'
2019-09-18 14:02:45 +00:00
# TODO: remove rubocop disable - https://gitlab.com/gitlab-org/gitlab/issues/14960
2019-09-10 16:24:10 +00:00
requires :file , type : File , desc : 'The project export file to be imported' # rubocop:disable Scalability/FileUploads
2019-09-20 00:05:59 +00:00
optional :name , type : String , desc : 'The name of the project to be imported. Defaults to the path of the project if not provided.'
2018-02-16 13:37:26 +00:00
optional :namespace , type : String , desc : " The ID or name of the namespace that the project will be imported into. Defaults to the current user's namespace. "
2018-04-06 15:23:49 +00:00
optional :overwrite , type : Boolean , default : false , desc : 'If there is a project in the same namespace and with the same name overwrite it'
2018-03-29 11:57:21 +00:00
optional :override_params ,
type : Hash ,
desc : 'New project params to override values in the export' do
use :optional_project_params
end
2018-02-13 08:24:10 +00:00
end
2018-02-13 14:18:52 +00:00
desc 'Create a new project import' do
2018-02-14 13:46:40 +00:00
detail 'This feature was introduced in GitLab 10.6.'
2018-02-12 11:42:33 +00:00
success Entities :: ProjectImportStatus
end
post 'import' do
2020-01-27 09:08:32 +00:00
key = " project_import " . to_sym
if throttled? ( key , [ current_user , key ] )
rate_limiter . log_request ( request , " #{ key } _request_limit " . to_sym , current_user )
render_api_error! ( { error : _ ( 'This endpoint has been requested too many times. Try again later.' ) } , 429 )
end
2018-02-14 13:59:11 +00:00
validate_file!
2018-02-12 11:42:33 +00:00
2019-09-18 14:02:45 +00:00
Gitlab :: QueryLimiting . whitelist ( 'https://gitlab.com/gitlab-org/gitlab-foss/issues/42437' )
2018-02-13 14:18:52 +00:00
2018-02-14 13:46:40 +00:00
namespace = if import_params [ :namespace ]
find_namespace! ( import_params [ :namespace ] )
2018-02-12 11:42:33 +00:00
else
2018-02-14 13:46:40 +00:00
current_user . namespace
2018-02-12 11:42:33 +00:00
end
2018-02-16 17:03:34 +00:00
project_params = {
path : import_params [ :path ] ,
namespace_id : namespace . id ,
2019-09-20 00:05:59 +00:00
name : import_params [ :name ] ,
2018-04-06 15:23:49 +00:00
file : import_params [ :file ] [ 'tempfile' ] ,
overwrite : import_params [ :overwrite ]
2018-02-16 17:03:34 +00:00
}
2018-03-29 11:57:21 +00:00
override_params = import_params . delete ( :override_params )
2019-08-07 14:01:51 +00:00
filter_attributes_using_license! ( override_params ) if override_params
2018-03-29 11:57:21 +00:00
project = :: Projects :: GitlabProjectsImportService . new (
current_user , project_params , override_params
) . execute
2018-02-12 13:46:47 +00:00
2018-02-13 09:54:04 +00:00
render_api_error! ( project . errors . full_messages & . first , 400 ) unless project . saved?
2018-02-12 11:42:33 +00:00
present project , with : Entities :: ProjectImportStatus
end
2018-02-13 08:24:10 +00:00
params do
requires :id , type : String , desc : 'The ID of a project'
end
2018-02-13 14:18:52 +00:00
desc 'Get a project export status' do
2018-02-14 13:46:40 +00:00
detail 'This feature was introduced in GitLab 10.6.'
2018-02-13 08:24:10 +00:00
success Entities :: ProjectImportStatus
end
get ':id/import' do
present user_project , with : Entities :: ProjectImportStatus
end
2018-02-12 11:42:33 +00:00
end
end
end