cleanup_reset_service.rb

# frozen_string_literal: true

require 'pathname'

module Dor
  # Remove all traces of the object's data files from the workspace and export areas
  class CleanupResetService
    # @param [String] druid The identifier for the object whose reset data is to be removed
    # @return [void] remove copy of the reset data that was exported to preservation core
    def self.cleanup_by_reset_druid(druid)
      last_version = get_druid_last_version(druid)
      cleanup_reset_workspace_content(druid, last_version, Config.cleanup.local_workspace_root)
      cleanup_assembly_content(druid, Config.cleanup.local_assembly_root)
      cleanup_reset_export(druid, last_version)
    end

    def self.get_druid_last_version(druid)
      druid_obj = Dor.find(druid)
      last_version = druid_obj.current_version.to_i

      # if the current version is still open, avoid this versioned directory
      last_version -= 1 if Dor::Config.workflow.client.lifecycle('dor', druid, 'accessioned').nil?
      last_version
    end

    # @param [String] druid The identifier for the object whose reset data is to be removed
    # @param [String] base The base directory to delete from
    # @param [Integer] last_version The last version that the data should be removed until version 1
    # @return [void] remove all the object's reset data files from the workspace area equal to less than the last_version
    def self.cleanup_reset_workspace_content(druid, last_version, base)
      base_druid = DruidTools::Druid.new(druid, base)
      base_druid_tree = base_druid.pathname.to_s
      # if it is truncated tree /aa/111/aaa/1111/content,
      # we should follow the regular cleanup technique

      reset_directories = get_reset_dir_list(last_version, base_druid_tree)
      reset_directories.each do |path|
        FileUtils.rm_rf(path)
      end
      base_druid.prune_ancestors(base_druid.pathname.parent)
    end

    # @param [String] base_druid_tree The base directory to delete from
    # @param [Integer] last_version The last version that the data should be removed until version 1
    # @return [void] prepares a list of reset directories that should be removed
    def self.get_reset_dir_list(last_version, base_druid_tree)
      reset_directories = []
      (1..last_version).each do |i|
        reset_path = "#{base_druid_tree}_v#{i}"
        reset_directories.append(reset_path) if File.exist?(reset_path)
      end
      reset_directories
    end

    # @param [String] druid The identifier for the object whose reset bags data is to be removed
    # @return [void] remove copy of the reset data that was exported to preservation core
    def self.cleanup_reset_export(druid, last_version)
      id = druid.split(':').last
      base_bag_directory = File.join(Config.cleanup.local_export_home, id)

      bag_dir_list = get_reset_bag_dir_list(last_version, base_bag_directory)
      bag_dir_list.each do |bag_dir|
        Pathname(bag_dir).rmtree
      end

      bag_tar_list = get_reset_bag_tar_list(last_version, base_bag_directory)
      bag_tar_list.each do |bag_tar|
        Pathname(bag_tar).rmtree
      end
    end

    # @param [Integer] last_version The last version that the data should be removed until version 1
    # @param [String] base_bag_directory The base bag directory including the export home and druid id
    # @return [void] prepares a list of reset bag directories that should be removed
    def self.get_reset_bag_dir_list(last_version, base_bag_directory)
      reset_bags = []
      (1..last_version).each do |i|
        reset_path = "#{base_bag_directory}_v#{i}"
        reset_bags.append(reset_path) if File.exist?(reset_path)
      end
      reset_bags
    end

    # @param [String] base_bag_directory The base bag directory including the export home and druid id
    # @param [Integer] last_version The last version that the data should be removed until version 1
    # @return [void] prepares a list of reset bag tars that should be removed
    def self.get_reset_bag_tar_list(last_version, base_bag_directory)
      reset_bags = []
      (1..last_version).each do |i|
        reset_path = "#{base_bag_directory}_v#{i}.tar"
        reset_bags.append(reset_path) if File.exist?(reset_path)
      end
      reset_bags
    end

    # @param [String] druid The identifier for the object whose data is to be removed
    # @param [String] base The base directory to delete from
    # @return [void] remove the object's data files from the assembly area
    def self.cleanup_assembly_content(druid, base)
      DruidTools::Druid.new(druid, base).prune!
    end
  end
end