project_import.rb 2.77 KB
Newer Older
1 2
# frozen_string_literal: true

James Lopez's avatar
James Lopez committed
3 4 5
module API
  class ProjectImport < Grape::API
    include PaginationParams
6 7

    helpers Helpers::ProjectsHelpers
James Lopez's avatar
James Lopez committed
8 9 10 11 12 13 14

    helpers do
      def import_params
        declared_params(include_missing: false)
      end

      def file_is_valid?
James Lopez's avatar
James Lopez committed
15
        import_params[:file] && import_params[:file]['tempfile'].respond_to?(:read)
James Lopez's avatar
James Lopez committed
16
      end
17 18 19 20

      def validate_file!
        render_api_error!('The file is invalid', 400) unless file_is_valid?
      end
James Lopez's avatar
James Lopez committed
21 22 23
    end

    before do
James Lopez's avatar
James Lopez committed
24
      forbidden! unless Gitlab::CurrentSettings.import_sources.include?('gitlab_project')
James Lopez's avatar
James Lopez committed
25 26
    end

27
    resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
James Lopez's avatar
James Lopez committed
28 29 30
      params do
        requires :path, type: String, desc: 'The new project path and name'
        requires :file, type: File, desc: 'The project export file to be imported'
James Lopez's avatar
James Lopez committed
31
        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."
32
        optional :overwrite, type: Boolean, default: false, desc: 'If there is a project in the same namespace and with the same name overwrite it'
33 34 35 36 37
        optional :override_params,
                 type: Hash,
                 desc: 'New project params to override values in the export' do
          use :optional_project_params
        end
James Lopez's avatar
James Lopez committed
38
      end
James Lopez's avatar
James Lopez committed
39
      desc 'Create a new project import' do
40
        detail 'This feature was introduced in GitLab 10.6.'
James Lopez's avatar
James Lopez committed
41 42 43
        success Entities::ProjectImportStatus
      end
      post 'import' do
44
        validate_file!
James Lopez's avatar
James Lopez committed
45

James Lopez's avatar
James Lopez committed
46 47
        Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42437')

48 49
        namespace = if import_params[:namespace]
                      find_namespace!(import_params[:namespace])
James Lopez's avatar
James Lopez committed
50
                    else
51
                      current_user.namespace
James Lopez's avatar
James Lopez committed
52 53
                    end

54 55 56
        project_params = {
            path: import_params[:path],
            namespace_id: namespace.id,
57 58
            file: import_params[:file]['tempfile'],
            overwrite: import_params[:overwrite]
59 60
        }

61 62 63 64 65
        override_params = import_params.delete(:override_params)

        project = ::Projects::GitlabProjectsImportService.new(
          current_user, project_params, override_params
        ).execute
James Lopez's avatar
James Lopez committed
66

James Lopez's avatar
James Lopez committed
67
        render_api_error!(project.errors.full_messages&.first, 400) unless project.saved?
James Lopez's avatar
James Lopez committed
68 69 70

        present project, with: Entities::ProjectImportStatus
      end
James Lopez's avatar
James Lopez committed
71 72 73 74

      params do
        requires :id, type: String, desc: 'The ID of a project'
      end
James Lopez's avatar
James Lopez committed
75
      desc 'Get a project export status' do
76
        detail 'This feature was introduced in GitLab 10.6.'
James Lopez's avatar
James Lopez committed
77 78 79 80 81
        success Entities::ProjectImportStatus
      end
      get ':id/import' do
        present user_project, with: Entities::ProjectImportStatus
      end
James Lopez's avatar
James Lopez committed
82 83 84
    end
  end
end