zammad/lib/auto_wizard.rb

# Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/

module AutoWizard

=begin

check if auto wizard is enabled

  AutoWizard.enabled?

returns

  true | false

=end

  def self.enabled?
    auto_wizard_file_location = file_location
    return false if !File.file?(auto_wizard_file_location)

    true
  end

=begin

get auto wizard data

  AutoWizard.data

returns

  content of auto wizard file as object

=end

  def self.data
    auto_wizard_file_location = file_location
    raise "The required file #{auto_wizard_file_location} was not found." if !File.file?(auto_wizard_file_location)

    JSON.parse(File.read(auto_wizard_file_location))
  end

=begin

creates or updates Users, EmailAddresses and sets Settings based on the 'auto_wizard.json' file placed in the root directory.

there is an example file 'contrib/auto_wizard_example.json'

  AutoWizard.setup

returns

  the first created User if a 'auto_wizard.json' file was found and processed, containing at least one entry in Users

  the User with id 1 (NULL) if a 'auto_wizard.json' file was found and processed, containing no Users

  nil if no 'auto_wizard.json' file was found

=end

  def self.setup
    raise AutoWizardDisabledError if !enabled?

    ttl = 60.minutes.to_i * 60.seconds.to_i * 1000
    Service::ExecuteLockedBlock.new('Zammad::System::Setup', ttl).execute { run }
  end

  def self.run
    auto_wizard_file_location = file_location

    auto_wizard_hash = data

    admin_user = User.find(1)

    UserInfo.current_user_id = admin_user.id

    # set default calendar
    if auto_wizard_hash['CalendarSetup'] && auto_wizard_hash['CalendarSetup']['Ip']
      Calendar.init_setup(auto_wizard_hash['CalendarSetup']['Ip'])
    end

    # load text modules
    if auto_wizard_hash['TextModuleLocale'] && auto_wizard_hash['TextModuleLocale']['Locale']
      begin
        TextModule.load(auto_wizard_hash['TextModuleLocale']['Locale'])
      rescue => e
        Rails.logger.error "Unable to load text modules #{auto_wizard_hash['TextModuleLocale']['Locale']}: #{e.message}"
      end
    end

    # set Settings
    auto_wizard_hash['Settings']&.each do |setting_data|
      Setting.set(setting_data['name'], setting_data['value'])
    end

    # create Permissions/Organization
    model_map = {
      'Permissions'   => 'Permission',
      'Organizations' => 'Organization',
    }
    model_map.each do |map_name, model|
      next if !auto_wizard_hash[map_name]

      auto_wizard_hash[map_name].each do |data|
        data.symbolize_keys!
        model.constantize.create_or_update_with_ref(data)
      end
    end

    # create Users
    auto_wizard_hash['Users']&.each do |user_data|
      user_data.symbolize_keys!

      if admin_user.id == 1
        if !user_data[:roles] && !user_data[:role_ids]
          user_data[:roles] = Role.where(name: %w[Agent Admin])
        end
        if !user_data[:groups] && !user_data[:group_ids]
          user_data[:groups] = Group.all
        end
      end

      created_user = User.create_or_update_with_ref(user_data)

      # use first created user as admin
      next if admin_user.id != 1

      admin_user = created_user
      UserInfo.current_user_id = admin_user.id

      # fetch org logo
      if admin_user.email.present?
        Service::Image.organization_suggest(admin_user.email)
      end
    end

    # create EmailAddresses/Channels/Signatures
    model_map = {
      'Channels'       => 'Channel',
      'EmailAddresses' => 'EmailAddress',
      'Signatures'     => 'Signature',
      'Groups'         => 'Group',
    }
    model_map.each do |map_name, model|
      next if !auto_wizard_hash[map_name]

      auto_wizard_hash[map_name].each do |data|
        data.symbolize_keys!
        model.constantize.create_or_update_with_ref(data)
      end
    end

    # reset primary key sequences
    DbHelper.import_post

    # remove auto wizard file
    begin
      FileUtils.rm auto_wizard_file_location
    rescue
      # Tolerate deletion errors, e.g. on read-only file systems.
    end

    admin_user
  end

  def self.file_location
    Rails.root.join(ENV['AUTOWIZARD_RELATIVE_PATH'].presence || 'auto_wizard.json')
  end
  private_class_method :file_location

  class AutoWizardDisabledError < StandardError
    def initialize
      super(__('AutoWizard is disabled'))
    end
  end
end