dor-services 6.8.0 → 7.0.0

data/lib/dor/services/ability.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  class Ability
-    class << self
-      def can_manage_item?(roles)
-        intersect roles, groups_which_manage_item
-      end
-
-      def can_manage_desc_metadata?(roles)
-        intersect roles, groups_which_manage_desc_metadata
-      end
-
-      def can_manage_system_metadata?(roles)
-        intersect roles, groups_which_manage_system_metadata
-      end
-
-      def can_manage_content?(roles)
-        intersect roles, groups_which_manage_content
-      end
-
-      def can_manage_rights?(roles)
-        intersect roles, groups_which_manage_rights
-      end
-
-      def can_manage_embargo?(roles)
-        intersect roles, groups_which_manage_embargo
-      end
-
-      def can_view_content?(roles)
-        intersect roles, groups_which_view_content
-      end
-
-      def can_view_metadata?(roles)
-        intersect roles, groups_which_view_metadata
-      end
-
-      private
-
-      def groups_which_manage_item
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor']
-      end
-
-      def groups_which_manage_desc_metadata
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor', 'dor-apo-metadata']
-      end
-
-      def groups_which_manage_system_metadata
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor']
-      end
-
-      def groups_which_manage_content
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor']
-      end
-
-      def groups_which_manage_rights
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor']
-      end
-
-      def groups_which_manage_embargo
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor']
-      end
-
-      def groups_which_view_content
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor', 'dor-viewer', 'sdr-viewer']
-      end
-
-      def groups_which_view_metadata
-        ['dor-administrator', 'sdr-administrator', 'dor-apo-manager', 'dor-apo-depositor', 'dor-viewer', 'sdr-viewer']
-      end
-
-      def intersect(arr1, arr2)
-        (arr1 & arr2).length > 0
-      end
-    end
-  end
-end

data/lib/dor/services/cleanup_reset_service.rb

@@ -1,103 +0,0 @@
-# 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

data/lib/dor/services/datastream_builder.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  # The ContentMetadata and DescMetadata robot are allowed to build the
-  # datastream by reading a file from the /dor/workspace that matches the
-  # datastream name. This allows assembly or pre-assembly to prebuild the
-  # datastreams from templates or using other means
-  # (like the assembly-objectfile gem) and then have those datastreams picked
-  # up and added to the object during accessionWF.
-  #
-  # This class builds that datastream using the content of a file if such a file
-  # exists and is newer than the object's current datastream (see above); otherwise,
-  # builds the datastream by calling build_fooMetadata_datastream.
-  class DatastreamBuilder
-    # @param [ActiveFedora::Base] object The object that contains the datastream
-    # @param [ActiveFedora::Datastream] datastream The datastream object
-    # @param [Boolean] force Should we overwrite existing datastream?
-    # @param [Boolean] required If set to true, raise an error if we can't build the datastream
-    # @return [ActiveFedora::Datastream]
-    def initialize(object:, datastream:, force: false, required: false)
-      @object = object
-      @datastream = datastream
-      @force = force
-      @required = required
-      raise 'Datastream required, but none provided' if required && !datastream
-    end
-
-    def build
-      return unless datastream
-
-      # See if datastream exists as a file and if the file's timestamp is newer than datastream's timestamp.
-      if file_newer_than_datastream?
-        create_from_file(filename)
-      elsif force || empty_datastream?
-        create_default
-      end
-      # Check for success.
-      raise "Required datastream #{datastream_name} could not be populated!" if required && empty_datastream?
-    end
-
-    private
-
-    attr_reader :datastream, :force, :object, :required
-
-    def filename
-      @filename ||= find_metadata_file
-    end
-
-    # @return [String] datastream name (dsid)
-    def datastream_name
-      datastream.dsid
-    end
-
-    def file_newer_than_datastream?
-      filename && (!datastream_date || file_date > datastream_date)
-    end
-
-    def file_date
-      File.mtime(filename)
-    end
-
-    def datastream_date
-      datastream.createDate
-    end
-
-    def create_from_file(filename)
-      content = File.read(filename)
-      datastream.content = content
-      datastream.ng_xml = Nokogiri::XML(content) if datastream.respond_to?(:ng_xml)
-      datastream.save unless datastream.digital_object.new?
-    end
-
-    def create_default
-      meth = "build_#{datastream_name}_datastream".to_sym
-      return unless object.respond_to?(meth)
-
-      object.public_send(meth, datastream)
-      datastream.save unless datastream.digital_object.new?
-    end
-
-    # Tries to find a file for the datastream.
-    # @return [String, nil] path to datastream or nil
-    def find_metadata_file
-      druid = DruidTools::Druid.new(object.pid, Dor::Config.stacks.local_workspace_root)
-      druid.find_metadata("#{datastream_name}.xml")
-    end
-
-    def empty_datastream?
-      return true if datastream.new?
-
-      return datastream.content.to_s.empty? unless datastream.class.respond_to?(:xml_template)
-
-      datastream.content.to_s.empty? || EquivalentXml.equivalent?(datastream.content, datastream.class.xml_template)
-    end
-  end
-end

data/lib/dor/services/decommission_service.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  # Responsible for decommissioning objects
-  class DecommissionService
-    # @param [Dor::Item] object
-    def initialize(object)
-      @object = object
-    end
-
-    attr_reader :object
-
-    # Clears RELS-EXT relationships, sets the isGovernedBy relationship to the SDR Graveyard APO
-    # @param [String] tag optional String of text that is concatenated to the identityMetadata/tag "Decommissioned : "
-    def decommission(tag)
-      # remove isMemberOf and isMemberOfCollection relationships
-      object.clear_relationship :is_member_of
-      object.clear_relationship :is_member_of_collection
-      # remove isGovernedBy relationship
-      object.clear_relationship :is_governed_by
-      # add isGovernedBy to graveyard APO druid:sw909tc7852
-      # SEARCH BY dc title for 'SDR Graveyard'
-      object.add_relationship :is_governed_by, ActiveFedora::Base.find(Dor::SearchService.sdr_graveyard_apo_druid)
-      # eliminate contentMetadata. set it to <contentMetadata/> ?
-      object.contentMetadata.content = '<contentMetadata/>'
-      # eliminate rightsMetadata. set it to <rightsMetadata/> ?
-      object.rightsMetadata.content = '<rightsMetadata/>'
-      TagService.add object, "Decommissioned : #{tag}"
-    end
-  end
-end

data/lib/dor/services/digital_stacks_service.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/ssh'
-require 'net/sftp'
-
-module Dor
-  class DigitalStacksService
-    # Delete files from stacks that have change type 'deleted', 'copydeleted', or 'modified'
-    # @param [Pathname] stacks_object_pathname the stacks location of the digital object
-    # @param [Moab::FileGroupDifference] content_diff the content file version differences report
-    def self.remove_from_stacks(stacks_object_pathname, content_diff)
-      %i[deleted copydeleted modified].each do |change_type|
-        subset = content_diff.subset(change_type) # {Moab::FileGroupDifferenceSubset}
-        subset.files.each do |moab_file| # {Moab::FileInstanceDifference}
-          moab_signature = moab_file.signatures.first # {Moab::FileSignature}
-          file_pathname = stacks_object_pathname.join(moab_file.basis_path)
-          delete_file(file_pathname, moab_signature)
-        end
-      end
-    end
-
-    # Delete a file, but only if it exists and matches the expected signature
-    # @param [Pathname] file_pathname The location of the file to be deleted
-    # @param [Moab::FileSignature] moab_signature The fixity values of the file
-    # @return [Boolean] true if file deleted, false otherwise
-    def self.delete_file(file_pathname, moab_signature)
-      if file_pathname.exist? && (file_pathname.size == moab_signature.size)
-        file_signature = Moab::FileSignature.new.signature_from_file(file_pathname)
-        if file_signature == moab_signature
-          file_pathname.delete
-          return true
-        end
-      end
-      false
-    end
-
-    # Rename files from stacks that have change type 'renamed' using an intermediate temp filename.
-    # The 2-step renaming allows chained or cyclic renames to occur without file collisions.
-    # @param [Pathname] stacks_object_pathname the stacks location of the digital object
-    # @param [Moab::FileGroupDifference] content_diff the content file version differences report
-    def self.rename_in_stacks(stacks_object_pathname, content_diff)
-      subset = content_diff.subset(:renamed) # {Moab::FileGroupDifferenceSubset
-
-      # 1st Pass - rename files from original name to checksum-based name
-      subset.files.each do |moab_file| # {Moab::FileInstanceDifference}
-        moab_signature = moab_file.signatures.first # {Moab::FileSignature}
-        original_pathname = stacks_object_pathname.join(moab_file.basis_path)
-        temp_pathname = stacks_object_pathname.join(moab_signature.checksums.values.last)
-        rename_file(original_pathname, temp_pathname, moab_signature)
-      end
-
-      # 2nd Pass - rename files from checksum-based name to new name
-      subset.files.each do |moab_file| # {Moab::FileInstanceDifference}
-        moab_signature = moab_file.signatures.first # {Moab::FileSignature}
-        temp_pathname = stacks_object_pathname.join(moab_signature.checksums.values.last)
-        new_pathname = stacks_object_pathname.join(moab_file.other_path)
-        rename_file(temp_pathname, new_pathname, moab_signature)
-      end
-    end
-
-    # Rename a file, but only if it exists and has the expected signature
-    # @param [Pathname] old_pathname The original location/name of the file being renamed
-    # @param [Pathname] new_pathname The new location/name of the file
-    # @param [Moab::FileSignature] moab_signature The fixity values of the file
-    # @return [Boolean] true if file renamed, false otherwise
-    def self.rename_file(old_pathname, new_pathname, moab_signature)
-      if old_pathname.exist? && (old_pathname.size == moab_signature.size)
-        file_signature = Moab::FileSignature.new.signature_from_file(old_pathname)
-        if file_signature == moab_signature
-          new_pathname.parent.mkpath
-          old_pathname.rename(new_pathname)
-          return true
-        end
-      end
-      false
-    end
-
-    # Add files to stacks that have change type 'added', 'copyadded' or 'modified'.
-    # @param [Pathname] workspace_content_pathname The dor workspace location of the digital object's content fies
-    # @param [Pathname] stacks_object_pathname the stacks location of the digital object's shelved files
-    # @param [Moab::FileGroupDifference] content_diff the content file version differences report
-    def self.shelve_to_stacks(workspace_content_pathname, stacks_object_pathname, content_diff)
-      return false if workspace_content_pathname.nil?
-
-      %i[added copyadded modified].each do |change_type|
-        subset = content_diff.subset(change_type) # {Moab::FileGroupDifferenceSubset
-        subset.files.each do |moab_file| # {Moab::FileInstanceDifference}
-          moab_signature = moab_file.signatures.last # {Moab::FileSignature}
-          filename = change_type == :modified ? moab_file.basis_path : moab_file.other_path
-          workspace_pathname = workspace_content_pathname.join(filename)
-          stacks_pathname = stacks_object_pathname.join(filename)
-          copy_file(workspace_pathname, stacks_pathname, moab_signature)
-        end
-      end
-      true
-    end
-
-    # Copy a file to stacks, but only if it does not yet exist with the expected signature
-    # @param [Pathname] workspace_pathname The location of the file in the DOR workspace
-    # @param [Pathname] stacks_pathname The location of the file in the stacks
-    # @param [Moab::FileSignature] moab_signature The fixity values of the file
-    # @return [Boolean] true if file copied, false otherwise
-    def self.copy_file(workspace_pathname, stacks_pathname, moab_signature)
-      if stacks_pathname.exist?
-        file_signature = Moab::FileSignature.new.signature_from_file(stacks_pathname)
-        stacks_pathname.delete if file_signature != moab_signature
-      end
-      unless stacks_pathname.exist?
-        stacks_pathname.parent.mkpath
-        FileUtils.cp workspace_pathname.to_s, stacks_pathname.to_s
-        # Change permissions
-        FileUtils.chmod 'u=rw,go=r', stacks_pathname.to_s
-        return true
-      end
-      false
-    end
-
-    # Assumes the digital stacks storage root is mounted to the local file system
-    # TODO: since this is delegating to the Druid, this method may not be necessary
-    def self.prune_stacks_dir(id)
-      stacks_druid_tree = DruidTools::StacksDruid.new(id, Config.stacks.local_stacks_root)
-      stacks_druid_tree.prune!
-    end
-  end
-end

data/lib/dor/services/dublin_core_service.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  class DublinCoreService
-    MODS_TO_DC_XSLT = Nokogiri::XSLT(File.new(File.expand_path(File.dirname(__FILE__) + '/mods2dc.xslt')))
-    XMLNS_OAI_DC = 'http://www.openarchives.org/OAI/2.0/oai_dc/'
-    class CrosswalkError < RuntimeError; end
-
-    def initialize(work, include_collection_as_related_item: true)
-      @work = work
-      @include_collection = include_collection_as_related_item
-    end
-
-    # Generates Dublin Core from the MODS in the descMetadata datastream using the LoC mods2dc stylesheet
-    #    Should not be used for the Fedora DC datastream
-    # @raise [CrosswalkError] Raises an Exception if the generated DC is empty or has no children
-    # @return [Nokogiri::XML::Document] the DublinCore XML document object
-    def ng_xml
-      dc_doc = MODS_TO_DC_XSLT.transform(desc_md)
-      dc_doc.xpath('/oai_dc:dc/*[count(text()) = 0]', oai_dc: XMLNS_OAI_DC).remove # Remove empty nodes
-      raise CrosswalkError, "Dor::Item#generate_dublin_core produced incorrect xml (no root):\n#{dc_doc.to_xml}" if dc_doc.root.nil?
-      raise CrosswalkError, "Dor::Item#generate_dublin_core produced incorrect xml (no children):\n#{dc_doc.to_xml}" if dc_doc.root.children.size == 0
-
-      dc_doc
-    end
-
-    # @return [String] the DublinCore XML document object
-    def to_xml
-      ng_xml.to_xml
-    end
-
-    private
-
-    def desc_md
-      return PublicDescMetadataService.new(work).ng_xml(include_access_conditions: false) if include_collection?
-
-      work.descMetadata.ng_xml
-    end
-
-    def include_collection?
-      @include_collection
-    end
-    attr_reader :work
-  end
-end