debian-mirror-gitlab/app/controllers/import/bulk_imports_controller.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

191 lines
4.9 KiB
Ruby
Raw Normal View History

2021-01-03 14:25:43 +05:30
# frozen_string_literal: true
class Import::BulkImportsController < ApplicationController
2021-03-08 18:12:59 +05:30
include ActionView::Helpers::SanitizeHelper
2021-01-03 14:25:43 +05:30
before_action :ensure_group_import_enabled
before_action :verify_blocked_uri, only: :status
feature_category :importers
2022-07-16 23:28:13 +05:30
urgency :low
2021-01-03 14:25:43 +05:30
2021-03-08 18:12:59 +05:30
POLLING_INTERVAL = 3_000
2021-09-30 23:02:18 +05:30
rescue_from BulkImports::Error, with: :bulk_import_connection_error
2021-01-03 14:25:43 +05:30
def configure
2021-01-29 00:20:46 +05:30
session[access_token_key] = configure_params[access_token_key]&.strip
session[url_key] = configure_params[url_key]
2021-01-03 14:25:43 +05:30
2022-08-13 15:12:31 +05:30
redirect_to status_import_bulk_imports_url(namespace_id: params[:namespace_id])
2021-01-03 14:25:43 +05:30
end
def status
respond_to do |format|
format.json do
2021-11-18 22:05:49 +05:30
data = ::BulkImports::GetImportableDataService.new(params, query_params, credentials).execute
2021-03-11 19:13:27 +05:30
pagination_headers.each do |header|
2021-11-18 22:05:49 +05:30
response.set_header(header, data[:response].headers[header])
2021-03-11 19:13:27 +05:30
end
2021-11-18 22:05:49 +05:30
json_response = { importable_data: serialized_data(data[:response].parsed_response) }
json_response[:version_validation] = data[:version_validation]
render json: json_response
2021-01-03 14:25:43 +05:30
end
2021-02-22 17:27:13 +05:30
format.html do
2022-08-13 15:12:31 +05:30
if params[:namespace_id]
@namespace = Namespace.find_by_id(params[:namespace_id])
render_404 unless current_user.can?(:create_subgroup, @namespace)
end
2021-02-22 17:27:13 +05:30
@source_url = session[url_key]
end
2021-01-03 14:25:43 +05:30
end
end
2021-01-29 00:20:46 +05:30
def create
2022-11-25 23:54:43 +05:30
return render json: { success: false }, status: :unprocessable_entity unless valid_create_params?
2022-08-27 11:52:29 +05:30
responses = create_params.map do |entry|
if entry[:destination_name]
entry[:destination_slug] ||= entry[:destination_name]
entry.delete(:destination_name)
end
::BulkImports::CreateService.new(current_user, entry, credentials).execute
end
2021-04-17 20:07:23 +05:30
2022-01-26 12:08:38 +05:30
render json: responses.map { |response| { success: response.success?, id: response.payload[:id], message: response.message } }
2021-01-29 00:20:46 +05:30
end
2021-03-08 18:12:59 +05:30
def realtime_changes
Gitlab::PollingInterval.set_header(response, interval: POLLING_INTERVAL)
render json: current_user_bulk_imports.to_json(only: [:id], methods: [:status_name])
end
2021-01-03 14:25:43 +05:30
private
2021-03-11 19:13:27 +05:30
def pagination_headers
%w[x-next-page x-page x-per-page x-prev-page x-total x-total-pages]
end
def serialized_data(data)
serializer.represent(data, {}, Import::BulkImportEntity)
2021-01-03 14:25:43 +05:30
end
def serializer
@serializer ||= BaseSerializer.new(current_user: current_user)
end
2021-03-08 18:12:59 +05:30
# Default query string params used to fetch groups from GitLab source instance
#
# top_level_only: fetch only top level groups (subgroups are fetched during import itself)
# min_access_level: fetch only groups user has maintainer or above permissions
# search: optional search param to search user's groups by a keyword
def query_params
query_params = {
top_level_only: true,
2021-09-04 01:27:46 +05:30
min_access_level: Gitlab::Access::OWNER
2021-03-08 18:12:59 +05:30
}
query_params[:search] = sanitized_filter_param if sanitized_filter_param
query_params
2021-01-03 14:25:43 +05:30
end
2021-01-29 00:20:46 +05:30
def configure_params
2021-01-03 14:25:43 +05:30
params.permit(access_token_key, url_key)
end
2021-01-29 00:20:46 +05:30
def create_params
2021-02-22 17:27:13 +05:30
params.permit(bulk_import: bulk_import_params)[:bulk_import]
2021-01-29 00:20:46 +05:30
end
2022-11-25 23:54:43 +05:30
def valid_create_params?
create_params.all? { _1[:source_type] == 'group_entity' }
end
2021-01-29 00:20:46 +05:30
def bulk_import_params
%i[
source_type
source_full_path
destination_name
2022-08-27 11:52:29 +05:30
destination_slug
2021-01-29 00:20:46 +05:30
destination_namespace
]
end
2021-01-03 14:25:43 +05:30
def ensure_group_import_enabled
2022-11-25 23:54:43 +05:30
render_404 unless ::BulkImports::Features.enabled?
2021-01-03 14:25:43 +05:30
end
def access_token_key
:bulk_import_gitlab_access_token
end
def url_key
:bulk_import_gitlab_url
end
def verify_blocked_uri
Gitlab::UrlBlocker.validate!(
session[url_key],
2021-02-22 17:27:13 +05:30
allow_localhost: allow_local_requests?,
allow_local_network: allow_local_requests?,
2023-03-04 22:38:38 +05:30
schemes: %w[http https]
2021-01-03 14:25:43 +05:30
)
rescue Gitlab::UrlBlocker::BlockedUrlError => e
clear_session_data
2021-04-17 20:07:23 +05:30
redirect_to new_group_path(anchor: 'import-group-pane'), alert: _('Specified URL cannot be used: "%{reason}"') % { reason: e.message }
2021-01-03 14:25:43 +05:30
end
def allow_local_requests?
Gitlab::CurrentSettings.allow_local_requests_from_web_hooks_and_services?
end
def bulk_import_connection_error(error)
clear_session_data
error_message = _("Unable to connect to server: %{error}") % { error: error }
flash[:alert] = error_message
respond_to do |format|
format.json do
render json: {
error: {
message: error_message,
redirect: new_group_path
}
}, status: :unprocessable_entity
end
format.html do
2021-04-17 20:07:23 +05:30
redirect_to new_group_path(anchor: 'import-group-pane')
2021-01-03 14:25:43 +05:30
end
end
end
def clear_session_data
session[url_key] = nil
session[access_token_key] = nil
end
2021-01-29 00:20:46 +05:30
def credentials
{
url: session[url_key],
2021-02-22 17:27:13 +05:30
access_token: session[access_token_key]
2021-01-29 00:20:46 +05:30
}
end
2021-03-08 18:12:59 +05:30
def sanitized_filter_param
@filter ||= sanitize(params[:filter])&.downcase
end
def current_user_bulk_imports
current_user.bulk_imports.gitlab
end
2021-01-03 14:25:43 +05:30
end