File: generate_csv_service.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (71 lines) | stat: -rw-r--r-- 2,132 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# frozen_string_literal: true

module Import
  module SourceUsers
    # This class generates CSV data for `Import::SourceUser` records associated
    # with a namespace. This spreadsheet is filled in and re-uploaded to
    # facilitate the user mapping flow.
    class GenerateCsvService
      HEADERS = [
        'Source host',
        'Import type',
        'Source user identifier',
        'Source user name',
        'Source username',
        'GitLab username',
        'GitLab public email'
      ].freeze

      # @param namespace [Namespace, Group] The namespace where the import source users are associated
      # @param current_user [User] The user performing the CSV export
      def initialize(namespace, current_user:)
        @namespace = namespace
        @current_user = current_user
      end

      def execute
        # We use :owner_access here because it's shared between GroupPolicy and
        # NamespacePolicy.
        return error_invalid_permissions unless current_user.can?(:owner_access, namespace)

        ServiceResponse.success(payload: csv_data)
      end

      private

      attr_reader :namespace, :current_user

      def csv_data
        CSV.generate do |csv|
          csv << HEADERS

          import_source_users.each_batch(of: 1000) do |batch|
            batch.each do |source_user|
              csv << [
                source_user.source_hostname,
                source_user.import_type,
                source_user.source_user_identifier,
                source_user.source_name,
                source_user.source_username,
                '',
                ''
              ]
            end
          end
        end
      end

      def import_source_users
        statuses = Import::SourceUser::STATUSES.slice(*Import::SourceUser::REASSIGNABLE_STATUSES).values
        namespace.import_source_users.by_statuses(statuses)
      end

      def error_invalid_permissions
        ServiceResponse.error(
          message: s_('Import|You do not have permission to view import source users for this namespace'),
          reason: :forbidden
        )
      end
    end
  end
end