dor-services 6.8.0 → 7.0.0

data/lib/dor/models/concerns/assembleable.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Assembleable
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    def initialize_workspace(source = nil)
-      druid = DruidTools::Druid.new(pid, Config.stacks.local_workspace_root)
-      if source.nil?
-        druid.mkdir
-      else
-        druid.mkdir_with_final_link(source)
-      end
-    end
-    deprecation_deprecate initialize_workspace: 'Use Dor::Services::Client.object(object_identifier).workspace.create(source:) instead'
-  end
-end

data/lib/dor/models/concerns/contentable.rb

@@ -1,185 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Contentable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    # add a file to a resource, not to be confused with add a resource to an object
-    def add_file(file, resource, file_name, mime_type = nil, publish = 'no', shelve = 'no', preserve = 'no')
-      xml = datastreams['contentMetadata'].ng_xml
-      # make sure the resource exists
-      raise 'resource doesnt exist.' if xml.search('//resource[@id=\'' + resource + '\']').length == 0
-
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
-      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
-      location = druid_tools.path(file_name)
-      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      md5  = Digest::MD5.file(file.path).hexdigest
-      sha1 = Digest::SHA1.file(file.path).hexdigest
-      size = File.size?(file.path)
-      # update contentmd
-      file_hash = { name: file_name, md5: md5, publish: publish, shelve: shelve, preserve: preserve, size: size.to_s, sha1: sha1, mime_type: mime_type }
-      begin
-        sftp.stat!(location.gsub(file_name, ''))
-        begin
-          sftp.stat!(location)
-          raise "The file #{file_name} already exists!"
-        rescue Net::SFTP::StatusException
-          sftp.upload!(file.path, location)
-          contentMetadata.add_file file_hash, resource
-        end
-      rescue Net::SFTP::StatusException
-        # directory layout doesn't match the new style, so use the old style.
-        begin
-          sftp.stat!(oldlocation)
-          raise "The file #{file_name} already exists!"
-        rescue Net::SFTP::StatusException
-          # file doesn't already exist, which is good. Add it
-          sftp.upload!(file.path, oldlocation)
-          contentMetadata.add_file file_hash, resource
-        end
-      end
-      # can only arrive at this point if a non status exception occurred.
-    end
-    deprecation_deprecate add_file: 'will be removed without replacement'
-
-    def replace_file(file, file_name)
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
-      item = Dor.find(pid)
-      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
-      location = druid_tools.path(file_name)
-      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      md5  = Digest::MD5.file(file.path).hexdigest
-      sha1 = Digest::SHA1.file(file.path).hexdigest
-      size = File.size?(file.path)
-      # update contentmd
-      file_hash = { name: file_name, md5: md5, size: size.to_s, sha1: sha1 }
-      begin
-        sftp.stat!(location)
-        sftp.upload!(file.path, location)
-        # this doesnt allow renaming files
-        item.contentMetadata.update_file(file_hash, file_name)
-      rescue StandardError
-        sftp.upload!(file.path, oldlocation)
-        item.contentMetadata.update_file(file_hash, file_name)
-      end
-    end
-    deprecation_deprecate replace_file: 'will be removed without replacement'
-
-    def get_preserved_file(file, version)
-      Sdr::Client.get_preserved_file_content(pid, file, version)
-    end
-    deprecation_deprecate get_preserved_file: 'Use Dor::Services::Client.object(object_identifier).files.preserved_content(filename:, version:) instead'
-
-    def get_file(file)
-      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
-      location = druid_tools.path(file)
-      oldlocation = location.gsub('/' + file, '').gsub('/' + pid.gsub('druid:', ''), '') + '/' + file
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
-      begin
-        data = sftp.download!(location)
-      rescue StandardError
-        data = sftp.download!(oldlocation)
-      end
-      data
-    end
-    deprecation_deprecate get_file: 'Use Dor::Services::Client.object(object_identifier).files.retrieve(filename:) instead'
-
-    # @param [String] filename
-    def remove_file(filename)
-      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
-      location = druid_tools.path(filename)
-      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
-      begin
-        sftp.remove!(location)
-      rescue StandardError
-        # if the file doesnt exist, that is ok, not all files will be present in the workspace
-        begin
-          sftp.remove!(oldlocation)
-        rescue Net::SFTP::StatusException
-        end
-      end
-      contentMetadata.remove_file filename
-    end
-    deprecation_deprecate remove_file: 'will be removed without replacement'
-
-    # @param [String] old_name
-    # @param [String] new_name
-    def rename_file(old_name, new_name)
-      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
-      location = druid_tools.path(old_name)
-      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
-      begin
-        sftp.rename!(location, location.gsub(old_name, new_name))
-      rescue StandardError
-        sftp.rename!(oldlocation, oldlocation.gsub(old_name, new_name))
-      end
-      contentMetadata.rename_file(old_name, new_name)
-    end
-    deprecation_deprecate rename_file: 'will be removed without replacement'
-
-    # @param [String] resource_name ID of the resource elememnt
-    def remove_resource(resource_name)
-      # run delete for all of the files in the resource
-      contentMetadata.ng_xml.search('//resource[@id=\'' + resource_name + '\']/file').each do |file|
-        remove_file(file['id'])
-      end
-      # remove the resource record from the metadata and renumber the resource sequence
-      contentMetadata.remove_resource resource_name
-    end
-    deprecation_deprecate remove_resource: 'will be removed without replacement'
-
-    # list files in the workspace
-    # @return [Array] workspace files
-    def list_files
-      filename = 'none'
-      files = []
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
-      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
-      location = druid_tools.path(filename).gsub(filename, '')
-      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      begin
-        sftp.dir.entries(location, '*') do |file|
-          files << file.name
-        end
-      rescue StandardError
-        begin
-          sftp.dir.glob(oldlocation, '*') do |file|
-            files << file.name
-          end
-        rescue Net::SFTP::StatusException
-          return files
-        end
-      end
-      files
-    end
-    deprecation_deprecate list_files: 'Use Dor::Services::Client.object(object_identifier).files.list instead'
-
-    # @param [String] filename
-    # @return [Boolean] whether the file in question is present in the object's workspace
-    def is_file_in_workspace?(filename)
-      druid_obj = DruidTools::Druid.new(pid, Dor::Config.stacks.local_workspace_root)
-      !druid_obj.find_content(filename).nil?
-    end
-    deprecation_deprecate is_file_in_workspace?: 'will be removed without replacement'
-
-    # 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)
-      DecommissionService.new(self).decommission(tag)
-    end
-    deprecation_deprecate decommission: 'Use DecommissionService#decommission instead'
-
-    # Adds a RELS-EXT constituent relationship to the given druid
-    # @param [String] druid the parent druid of the constituent relationship
-    #   e.g.: <fedora:isConstituentOf rdf:resource="info:fedora/druid:hj097bm8879" />
-    def add_constituent(druid)
-      add_relationship :is_constituent_of, ActiveFedora::Base.find(druid)
-    end
-    deprecation_deprecate add_constituent: 'Use add_relationship :is_constituent_of instead'
-  end
-end

data/lib/dor/models/concerns/describable.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Describable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    included do
-      has_metadata name: 'descMetadata', type: Dor::DescMetadataDS, label: 'Descriptive Metadata', control_group: 'M'
-    end
-
-    require 'stanford-mods'
-
-    # intended for read-access, "as SearchWorks would see it", mostly for to_solr()
-    # @param [Nokogiri::XML::Document] content Nokogiri descMetadata document (overriding internal data)
-    # @param [boolean] ns_aware namespace awareness toggle for from_nk_node()
-    def stanford_mods(content = nil, ns_aware = true)
-      @stanford_mods ||= begin
-        m = Stanford::Mods::Record.new
-        desc = content.nil? ? descMetadata.ng_xml : content
-        m.from_nk_node(desc.root, ns_aware)
-        m
-      end
-    end
-
-    def fetch_descMetadata_datastream
-      candidates = datastreams['identityMetadata'].otherId.collect(&:to_s)
-      metadata_id = Dor::MetadataService.resolvable(candidates).first
-      metadata_id.nil? ? nil : Dor::MetadataService.fetch(metadata_id.to_s)
-    end
-
-    def build_descMetadata_datastream(ds)
-      content = fetch_descMetadata_datastream
-      return nil if content.nil?
-
-      ds.dsLabel = 'Descriptive Metadata'
-      ds.ng_xml = Nokogiri::XML(content)
-      ds.ng_xml.normalize_text!
-      ds.content = ds.ng_xml.to_xml
-    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 generate_dublin_core(include_collection_as_related_item: true)
-      DublinCoreService.new(self, include_collection_as_related_item: include_collection_as_related_item).ng_xml
-    end
-    deprecation_deprecate generate_dublin_core: 'Use DublinCoreService#ng_xml instead'
-
-    # @return [String] Public descriptive medatada XML
-    def generate_public_desc_md(**options)
-      PublicDescMetadataService.new(self).to_xml(**options)
-    end
-    deprecation_deprecate generate_public_desc_md: 'Use PublicDescMetadataService#to_xml instead'
-
-    # @param [Boolean] force Overwrite existing XML
-    # @return [String] descMetadata.content XML
-    def set_desc_metadata_using_label(force = false)
-      raise 'Cannot proceed, there is already content in the descriptive metadata datastream: ' + descMetadata.content.to_s unless force || descMetadata.new?
-
-      label = self.label
-      builder = Nokogiri::XML::Builder.new do |xml|
-        xml.mods(Dor::DescMetadataDS::MODS_HEADER_CONFIG) do
-          xml.titleInfo do
-            xml.title label
-          end
-        end
-      end
-      descMetadata.content = builder.to_xml
-    end
-
-    def self.get_collection_title(obj)
-      obj.full_title
-    end
-
-    def full_title
-      stanford_mods.sw_title_display
-    end
-  end
-end

data/lib/dor/models/concerns/eventable.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Eventable
-    extend Deprecation
-    extend ActiveSupport::Concern
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    included do
-      has_metadata name: 'events', type: Dor::EventsDS, label: 'Events'
-    end
-
-    def add_event(*args)
-      datastreams['events'].add_event *args
-    end
-    deprecation_deprecate add_event: 'call item.events.add_event instead.'
-  end
-end

data/lib/dor/models/concerns/geoable.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Geoable
-    extend ActiveSupport::Concern
-
-    included do
-      has_metadata  name: 'geoMetadata',
-                    type: Dor::GeoMetadataDS,
-                    label: 'Geographic Information Metadata in ISO 19139',
-                    control_group: 'M'
-    end
-  end
-end

data/lib/dor/models/concerns/governable.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Governable
-    extend ActiveSupport::Concern
-
-    included do
-      belongs_to :admin_policy_object, property: :is_governed_by, class_name: 'Dor::AdminPolicyObject'
-      has_and_belongs_to_many :collections, property: :is_member_of_collection, class_name: 'Dor::Collection'
-      has_and_belongs_to_many :sets, property: :is_member_of, class_name: 'Dor::Collection'
-    end
-
-    def initiate_apo_workflow(name)
-      CreateWorkflowService.create_workflow(self, name: name, create_ds: !new_record?)
-    end
-    deprecation_deprecate initiate_apo_workflow: 'Use Dor::Services::Client.object(object_identifier).workflow.create(wf_name:) instead'
-
-    def reset_to_apo_default
-      rightsMetadata.content = admin_policy_object.rightsMetadata.ng_xml
-    end
-
-    def set_read_rights(rights)
-      rightsMetadata.set_read_rights(rights)
-      unshelve_and_unpublish if rights == 'dark'
-    end
-
-    def unshelve_and_unpublish
-      if respond_to? :contentMetadata
-        content_ds = datastreams['contentMetadata']
-        unless content_ds.nil?
-          content_ds.ng_xml.xpath('/contentMetadata/resource//file').each_with_index do |file_node, index|
-            content_ds.ng_xml_will_change! if index == 0
-            file_node['publish'] = 'no'
-            file_node['shelve'] = 'no'
-          end
-        end
-      end
-    end
-
-    def add_collection(collection_or_druid)
-      collection =
-        case collection_or_druid
-        when String
-          Dor::Collection.find(collection_or_druid)
-        when Dor::Collection
-          collection_or_druid
-        end
-      collections << collection
-      sets << collection
-    end
-
-    def remove_collection(collection_or_druid)
-      collection =
-        case collection_or_druid
-        when String
-          Dor::Collection.find(collection_or_druid)
-        when Dor::Collection
-          collection_or_druid
-        end
-
-      collections.delete(collection)
-      sets.delete(collection)
-    end
-
-    # set the rights metadata datastream to the content of the APO's default object rights
-    def reapplyAdminPolicyObjectDefaults
-      rightsMetadata.content = admin_policy_object.datastreams['defaultObjectRights'].content
-    end
-
-    def rights
-      return nil unless respond_to? :rightsMetadata
-      return nil if rightsMetadata.nil?
-
-      xml = rightsMetadata.ng_xml
-      return nil if xml.search('//rightsMetadata').length != 1 # ORLY?
-
-      if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1
-        'Stanford'
-      elsif xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length == 1
-        'World'
-      elsif xml.search('//rightsMetadata/access[@type=\'discover\']/machine/none').length == 1
-        'Dark'
-      else
-        'None'
-      end
-    end
-
-    delegate :can_manage_item?, :can_manage_desc_metadata?, :can_manage_system_metadata?,
-             :can_manage_content?, :can_manage_rights?, :can_manage_embargo?,
-             :can_view_content?, :can_view_metadata?, to: Dor::Ability
-
-    deprecation_deprecate can_manage_item?: 'Use Dor::Ability.can_manage_item? instead'
-    deprecation_deprecate can_manage_desc_metadata?: 'Use Dor::Ability.can_manage_desc_metadata? instead'
-    deprecation_deprecate can_manage_system_metadata?: 'Use Dor::Ability.can_manage_system_metadata? instead'
-    deprecation_deprecate can_manage_content?: 'Use Dor::Ability.can_manage_content? instead'
-    deprecation_deprecate can_manage_rights?: 'Use Dor::Ability.can_manage_rights? instead'
-    deprecation_deprecate can_manage_embargo?: 'Use Dor::Ability.can_manage_embargo? instead'
-    deprecation_deprecate can_view_content?: 'Use Dor::Ability.can_view_content? instead'
-    deprecation_deprecate can_view_metadata?: 'Use Dor::Ability.can_view_metadata? instead'
-  end
-end

data/lib/dor/models/concerns/identifiable.rb

@@ -1,172 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Identifiable
-    extend ActiveSupport::Concern
-
-    # ids for previous and current catkeys
-    CATKEY_TYPE_ID = 'catkey'
-    PREVIOUS_CATKEY_TYPE_ID = 'previous_catkey'
-
-    included do
-      has_metadata name: 'DC', type: SimpleDublinCoreDs, label: 'Dublin Core Record for self object'
-      has_metadata name: 'identityMetadata', type: Dor::IdentityMetadataDS, label: 'Identity Metadata'
-    end
-
-    module ClassMethods
-      attr_reader :object_type
-      def has_object_type(str)
-        @object_type = str
-        Dor.registered_classes[str] = self
-      end
-
-      # Overrides the method in ActiveFedora to mint a pid using SURI rather
-      # than the default Fedora sequence
-      def assign_pid(_obj)
-        return Dor::SuriService.mint_id if Dor::Config.suri.mint_ids
-
-        super
-      end
-    end
-
-    # helper method to get the tags as an array
-    def tags
-      identityMetadata.tag
-    end
-
-    # helper method to get just the content type tag
-    def content_type_tag
-      content_tag = tags.select { |tag| tag.include?('Process : Content Type') }
-      content_tag.size == 1 ? content_tag[0].split(':').last.strip : ''
-    end
-
-    # Convenience method
-    def source_id
-      identityMetadata.sourceId
-    end
-
-    # Convenience method
-    # @param  [String] source_id the new source identifier
-    # @return [String] same value, as per Ruby assignment convention
-    # @raise  [ArgumentError] see IdentityMetadataDS for logic
-    def source_id=(source_id)
-      identityMetadata.sourceId = source_id
-    end
-    alias set_source_id source_id=
-    deprecate set_source_id: 'Use source_id= instead'
-
-    # Convenience method to get the current catkey
-    # @return [String] current catkey value (or nil if none found)
-    def catkey
-      identityMetadata.otherId(CATKEY_TYPE_ID).first
-    end
-
-    # Convenience method to set the catkey
-    # @param  [String] val the new source identifier
-    # @return [String] same value, as per Ruby assignment convention
-    def catkey=(val)
-      # if there was already a catkey in the record, store that in the "previous" spot (assuming there is no change)
-      identityMetadata.add_otherId("#{PREVIOUS_CATKEY_TYPE_ID}:#{catkey}") if val != catkey && !catkey.blank?
-
-      if val.blank? # if we are setting the catkey to blank, remove the node from XML
-        remove_other_Id(CATKEY_TYPE_ID)
-      elsif catkey.blank? # if there is no current catkey, then add it
-        add_other_Id(CATKEY_TYPE_ID, val)
-      else # if there is a current catkey, update the current catkey to the new value
-        update_other_Id(CATKEY_TYPE_ID, val)
-      end
-
-      val
-    end
-
-    # Convenience method to get the previous catkeys (will be an array)
-    # @return [Array] previous catkey values (empty array if none found)
-    def previous_catkeys
-      identityMetadata.otherId(PREVIOUS_CATKEY_TYPE_ID)
-    end
-
-    def add_other_Id(type, val)
-      raise 'There is an existing entry for ' + type + ', consider using update_other_Id().' if identityMetadata.otherId(type).length > 0
-
-      identityMetadata.add_otherId(type + ':' + val)
-    end
-
-    def update_other_Id(type, new_val, val = nil)
-      identityMetadata.ng_xml.search('//otherId[@name=\'' + type + '\']')
-                      .select { |node| val.nil? || node.content == val }
-                      .each { identityMetadata.ng_xml_will_change! }
-                      .each { |node| node.content = new_val }
-                      .any?
-    end
-
-    def remove_other_Id(type, val = nil)
-      identityMetadata.ng_xml.search('//otherId[@name=\'' + type + '\']')
-                      .select { |node| val.nil? || node.content == val }
-                      .each { identityMetadata.ng_xml_will_change! }
-                      .each(&:remove)
-                      .any?
-    end
-
-    # Add an administrative tag to an item, you will need to seperately save the item to write it to fedora
-    # @param tag [string] The tag you wish to add
-    def add_tag(tag)
-      TagService.add(self, tag)
-    end
-    deprecation_deprecate add_tag: 'Call TagService.add instead'
-
-    def remove_tag(tag)
-      TagService.remove(self, tag)
-    end
-    deprecation_deprecate remove_tag: 'Call TagService.remove instead'
-
-    def update_tag(old_tag, new_tag)
-      TagService.update(self, old_tag, new_tag)
-    end
-    deprecation_deprecate update_tag: 'Call TagService.update instead'
-
-    # a regex that can be used to identify the last part of a druid (e.g. oo000oo0001)
-    # @return [Regex] a regular expression to identify the ID part of the druid
-    def pid_regex
-      /[a-zA-Z]{2}[0-9]{3}[a-zA-Z]{2}[0-9]{4}/
-    end
-
-    # a regex that can be used to identify a full druid with prefix (e.g. druid:oo000oo0001)
-    # @return [Regex] a regular expression to identify a full druid
-    def druid_regex
-      /druid:#{pid_regex}/
-    end
-
-    # Since purl does not use the druid: prefix but much of dor does, use this function to strip the druid: if needed
-    # @return [String] the druid sans the druid: or if there was no druid: prefix, the entire string you passed
-    def remove_druid_prefix(druid = id)
-      result = druid.match(/#{pid_regex}/)
-      result.nil? ? druid : result[0] # if no matches, return the string passed in, otherwise return the match
-    end
-
-    # Override ActiveFedora::Core#adapt_to_cmodel (used with associations, among other places) to
-    # preferentially use the objectType asserted in the identityMetadata.
-    def adapt_to_cmodel
-      object_type = identityMetadata.objectType.first
-      object_class = Dor.registered_classes[object_type]
-
-      if object_class
-        instance_of?(object_class) ? self : adapt_to(object_class)
-      else
-        if ActiveFedora::VERSION < '8'
-          result = super
-          if result.class == Dor::Abstract
-            adapt_to(Dor::Item)
-          else
-            result
-          end
-        else
-          begin
-            super
-          rescue ActiveFedora::ModelNotAsserted
-            adapt_to(Dor::Item)
-          end
-        end
-      end
-    end
-  end
-end