dor-services 6.8.0 → 7.0.0

data/lib/dor/datastreams/workflow_definition_ds.rb

@@ -53,7 +53,7 @@ module Dor
       ng_xml.at_xpath('/workflow-def/@repository').to_s
     end
 
-    # Creates the xml used by Dor::WorkflowService#create_workflow
+    # Creates the xml used by Dor::Workflow::Client#create_workflow
     # @return [String] An object's initial workflow as defined by the <workflow-def> in content
     def initial_workflow
       doc = Nokogiri::XML('<workflow/>')

data/lib/dor/datastreams/workflow_ds.rb

@@ -3,9 +3,6 @@
 module Dor
   # TODO: class docs
   class WorkflowDs < ActiveFedora::OmDatastream
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
     before_save :build_location
     set_terminology do |t|
       t.root(path: 'workflows')
@@ -34,18 +31,6 @@ module Dor
       super.merge(mimeType: 'application/xml')
     end
 
-    def get_workflow(wf, repo = 'dor')
-      xml = Dor::Config.workflow.client.workflow_xml(repo, pid, wf)
-      xml = Nokogiri::XML(xml)
-      return nil if xml.xpath('workflow').length == 0
-
-      Workflow::Document.new(xml.to_s)
-    end
-    deprecation_deprecate get_workflow: 'This has been moved to Argo and will be discontinued'
-
-    alias [] get_workflow
-    deprecation_deprecate :[] => 'This has been moved to Argo and will be discontinued'
-
     def ng_xml
       @ng_xml ||= Nokogiri::XML::Document.parse(content)
     end

data/lib/dor/indexers/identifiable_indexer.rb

@@ -4,6 +4,11 @@ module Dor
   class IdentifiableIndexer
     include SolrDocHelper
 
+    INDEX_VERSION_FIELD = 'dor_services_version_ssi'
+    NS_HASH = { 'hydra' => 'http://projecthydra.org/ns/relations#',
+                'fedora' => 'info:fedora/fedora-system:def/relations-external#',
+                'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' }.freeze
+
     attr_reader :resource
     def initialize(resource:)
       @resource = resource
@@ -17,7 +22,7 @@ module Dor
     # @return [Hash] the partial solr document for identifiable concerns
     def to_solr
       solr_doc = {}
-      solr_doc[Dor::INDEX_VERSION_FIELD] = Dor::VERSION
+      solr_doc[INDEX_VERSION_FIELD] = Dor::VERSION
       solr_doc['indexed_at_dtsi'] = Time.now.utc.xmlschema
       resource.datastreams.values.each do |ds|
         add_solr_value(solr_doc, 'ds_specs', ds.datastream_spec_string, :string, [:symbol]) unless ds.new?
@@ -26,9 +31,8 @@ module Dor
       add_solr_value(solr_doc, 'title_sort', resource.label, :string, [:stored_sortable])
 
       rels_doc = Nokogiri::XML(resource.datastreams['RELS-EXT'].content)
-      ns_hash = { 'hydra' => 'http://projecthydra.org/ns/relations#', 'fedora' => 'info:fedora/fedora-system:def/relations-external#', 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' }
-      apos = rels_doc.search('//rdf:RDF/rdf:Description/hydra:isGovernedBy', ns_hash)
-      collections = rels_doc.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection', ns_hash)
+      apos = rels_doc.search('//rdf:RDF/rdf:Description/hydra:isGovernedBy', NS_HASH)
+      collections = rels_doc.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection', NS_HASH)
       solrize_related_obj_titles(solr_doc, apos, @@apo_hash, 'apo_title', 'nonhydrus_apo_title', 'hydrus_apo_title')
       solrize_related_obj_titles(solr_doc, collections, @@collection_hash, 'collection_title', 'nonhydrus_collection_title', 'hydrus_collection_title')
       solr_doc['public_dc_relation_tesim'] ||= solr_doc['collection_title_tesim'] if solr_doc['collection_title_tesim']

data/lib/dor/indexers/releasable_indexer.rb

@@ -15,7 +15,7 @@ module Dor
 
       # TODO: sort of worried about the performance impact in bulk reindex
       # situations, since released_for recurses all parent collections.  jmartin 2015-07-14
-      resource.released_for(true).each do |release_target, release_info|
+      released_for.each do |release_target, release_info|
         add_solr_value(solr_doc, 'released_to', release_target, :symbol, []) if release_info['release']
       end
 
@@ -24,5 +24,11 @@ module Dor
 
       solr_doc
     end
+
+    private
+
+    def released_for
+      ReleaseTagService.for(resource).released_for(skip_live_purl: true)
+    end
   end
 end

data/lib/dor/models/abstract.rb

@@ -2,19 +2,154 @@
 
 module Dor
   class Abstract < ::ActiveFedora::Base
-    include Identifiable
-    include Eventable
-    include Governable
-    include Rightsable
-    include Describable
-    include Versionable
-    include Processable
-    include Preservable
+    extend Deprecation
+    self.deprecation_horizon = '8.0'
+
+    has_metadata name: 'provenanceMetadata',
+                 type: ProvenanceMetadataDS,
+                 label: 'Provenance Metadata'
+    has_metadata name: 'workflows',
+                 type: WorkflowDs,
+                 label: 'Workflows',
+                 control_group: 'E',
+                 autocreate: true
+    has_metadata name: 'rightsMetadata',
+                 type: RightsMetadataDS,
+                 label: 'Rights metadata'
+    has_metadata name: 'events',
+                 type: EventsDS,
+                 label: 'Events'
+    has_metadata name: 'versionMetadata',
+                 type: VersionMetadataDS,
+                 label: 'Version Metadata',
+                 autocreate: true
+    has_metadata name: 'DC',
+                 type: SimpleDublinCoreDs,
+                 label: 'Dublin Core Record for self object'
+    has_metadata name: 'identityMetadata',
+                 type: Dor::IdentityMetadataDS,
+                 label: 'Identity Metadata'
+    has_metadata name: 'descMetadata',
+                 type: Dor::DescMetadataDS,
+                 label: 'Descriptive Metadata',
+                 control_group: 'M'
+
+    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'
 
     class_attribute :resource_indexer
+    class_attribute :object_type
+
+    def self.has_object_type(str)
+      self.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 self.assign_pid(_obj)
+      return Dor::SuriService.mint_id if Dor::Config.suri.mint_ids
 
+      super
+    end
+
+    # Overrides the method in ActiveFedora
     def to_solr
       resource_indexer.new(resource: self).to_solr
     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
+        begin
+          super
+        rescue ActiveFedora::ModelNotAsserted
+          adapt_to(Dor::Item)
+        end
+      end
+    end
+
+    # 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
+
+    # This is used by Argo and the MergeService
+    # @return [Boolean] true if the object is in a state that allows it to be modified.
+    #  States that will allow modification are: has not been submitted for accessioning, has an open version or has sdr-ingest set to hold
+    # @todo this could be a workflow service endpoint
+    def allows_modification?
+      client = Dor::Config.workflow.client
+      !client.lifecycle('dor', pid, 'submitted') ||
+        client.active_lifecycle('dor', pid, 'opened') ||
+        client.workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') == 'hold'
+    end
+
+    def current_version
+      versionMetadata.current_version_id
+    end
+
+    delegate :full_title, :stanford_mods, to: :descMetadata
+    delegate :rights, to: :rightsMetadata
+    delegate :catkey, :catkey=, :previous_catkeys, :tags, :content_type_tag, :source_id, :source_id=, to: :identityMetadata
+
+    def read_rights=(rights)
+      rightsMetadata.set_read_rights(rights)
+      unshelve_and_unpublish if rights == 'dark'
+    end
+    alias set_read_rights read_rights=
+    deprecation_deprecate set_read_rights: 'Use read_rights= instead'
+
+    def add_collection(collection_or_druid)
+      collection_manager.add(collection_or_druid)
+    end
+
+    def remove_collection(collection_or_druid)
+      collection_manager.remove(collection_or_druid)
+    end
+
+    # set the rights metadata datastream to the content of the APO's default object rights
+    def reapply_admin_policy_object_defaults
+      rightsMetadata.content = admin_policy_object.defaultObjectRights.content
+    end
+    alias reapplyAdminPolicyObjectDefaults reapply_admin_policy_object_defaults
+    deprecation_deprecate reapplyAdminPolicyObjectDefaults: 'Use reapply_admin_policy_object_defaults instead'
+
+    private
+
+    def unshelve_and_unpublish
+      contentMetadata.unshelve_and_unpublish if respond_to? :contentMetadata
+    end
+
+    def collection_manager
+      CollectionService.new(self)
+    end
   end
 end

data/lib/dor/models/admin_policy_object.rb

@@ -18,9 +18,6 @@ module Dor
       WorkflowsIndexer
     )
 
-    CREATIVE_COMMONS_USE_LICENSES = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('CREATIVE_COMMONS_USE_LICENSES', 'Dor::CreativeCommonsLicenseService')
-    OPEN_DATA_COMMONS_USE_LICENSES = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('OPEN_DATA_COMMONS_USE_LICENSES', 'Dor::OpenDataLicenseService')
-
     delegate :add_roleplayer, :purge_roles, :roles, to: :roleMetadata
     delegate :mods_title, :mods_title=, to: :descMetadata
     delegate :default_collections, :add_default_collection, :remove_default_collection,

data/lib/dor/models/collection.rb

@@ -2,8 +2,6 @@
 
 module Dor
   class Collection < Dor::Set
-    include Releaseable
-
     has_object_type 'collection'
 
     self.resource_indexer = CompositeIndexer.new(

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dor
+  # Time limits and processes for embargoed materials.
   module Embargoable
     extend ActiveSupport::Concern
 
@@ -8,59 +9,17 @@ module Dor
       has_metadata name: 'embargoMetadata', type: Dor::EmbargoMetadataDS, label: 'Embargo metadata'
     end
 
-    # These methods manipulate the object for embargo purposes
-    # They assume the object has embargoMetadata, rightsMetadata, and events datastreams
-
     # Manipulates datastreams in the object when embargo is lifted:
     # Sets embargo status to released in embargoMetadata
     # Modifies rightsMetadata to remove embargoReleaseDate and updates/adds access from embargoMetadata/releaseAccess
     # @param [String] release_agent name of the person, application or thing that released embargo
     # @note The caller should save the object to fedora to commit the changes
     def release_embargo(release_agent = 'unknown')
-      # Set status to released
-      embargo_md = datastreams['embargoMetadata']
-      embargo_md.status = 'released'
-
-      # Remove all read acces nodes
-      rights_md = datastreams['rightsMetadata']
-      rights_xml = rights_md.ng_xml
-      rights_md.ng_xml_will_change!
-      rights_xml.xpath("//rightsMetadata/access[@type='read']").each(&:remove)
-
-      # Replace rights <access> nodes with those from embargoMetadta
-      release_access = embargo_md.release_access_node
-      release_access.xpath('//releaseAccess/access').each do |new_access|
-        access_sibling = rights_xml.at_xpath('//rightsMetadata/access[last()]')
-        if access_sibling
-          access_sibling.add_next_sibling(new_access.clone)
-        else
-          rights_xml.root.add_child(new_access.clone)
-        end
-      end
-
-      events.add_event('embargo', release_agent, 'Embargo released')
+      embargo_service.release(release_agent)
     end
 
     def release_20_pct_vis_embargo(release_agent = 'unknown')
-      # Set status to released
-      embargo_md = datastreams['embargoMetadata']
-      embargo_md.twenty_pct_status = 'released'
-
-      # Remove all read acces nodes
-      rights_md = datastreams['rightsMetadata']
-      rights_xml = rights_md.ng_xml
-      rights_md.ng_xml_will_change!
-      rights_xml.xpath("//rightsMetadata/access[@type='read']").each(&:remove)
-
-      # Replace rights <access> nodes with 1 machine/world node
-      access_sibling = rights_xml.at_xpath('//rightsMetadata/access[last()]')
-      if access_sibling
-        access_sibling.add_next_sibling(world_doc.root.clone)
-      else
-        rights_xml.root.add_child(world_doc.root.clone)
-      end
-
-      events.add_event('embargo', release_agent, '20% Visibility Embargo released')
+      embargo_service.release_20_pct_vis(release_agent)
     end
 
     def embargoed?
@@ -68,23 +27,11 @@ module Dor
     end
 
     def update_embargo(new_date)
-      raise ArgumentError, 'You cannot change the embargo date of an item that is not embargoed.' if embargoMetadata.status != 'embargoed'
-      raise ArgumentError, 'You cannot set the embargo date to a past date.' if new_date.past?
-
-      updated = false
-      rightsMetadata.ng_xml.search('//embargoReleaseDate').each do |node|
-        node.content = new_date.beginning_of_day.utc.xmlschema
-        updated = true
-      end
-      rightsMetadata.ng_xml_will_change!
-      rightsMetadata.save
-      raise 'No release date in rights metadata, cannot proceed!' unless updated
+      embargo_service.update(new_date)
+    end
 
-      embargoMetadata.ng_xml.xpath('//releaseDate').each do |node|
-        node.content = new_date.beginning_of_day.utc.xmlschema
-      end
-      embargoMetadata.ng_xml_will_change!
-      embargoMetadata.save
+    def embargo_service
+      EmbargoService.new(self)
     end
   end
 end

data/lib/dor/models/etd.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Dor
+  class Etd < Abstract
+    include Dor::Embargoable
+
+    self.resource_indexer = CompositeIndexer.new(
+      DataIndexer
+    )
+
+    # This relationship was modeled incorrectly when first implemented.
+    # It should have been has_and_belongs_to_many so that the ETD is aware of
+    # its component parts.  Presently there is no way to discover which parts
+    # belong to the ETD without doing a Solr query.
+    has_many :parts, property: :is_part_of, class_name: 'Part'
+    has_many :supplemental_files, property: :is_constituent_of, class_name: 'Part'
+    has_many :permission_files, property: :is_dependent_of, class_name: 'Part'
+
+    has_metadata name: 'properties', type: ActiveFedora::SimpleDatastream, versionable: false do |m|
+      m.field 'name',  :string                    # PS:name
+      m.field 'prefix', :string                   # PS:prefix
+      m.field 'suffix', :string                   # PS:suffix
+      m.field 'major', :string                    # PS:plan
+      m.field 'degree', :string                   # PS:degree
+      m.field 'advisor', :string                  # one of the readers?
+      m.field 'etd_type', :string                 # PS:type
+      m.field 'title', :string                    # PS:title
+      m.field 'abstract', :text
+      m.field 'containscopyright', :string
+      m.field 'copyrightclearance', :string
+      m.field 'sulicense', :string
+      m.field 'cclicense', :string
+      m.field 'cclicensetype', :string
+      m.field 'embargo', :string
+      m.field 'external_visibility', :string
+
+      m.field 'term', :string
+      m.field 'sub', :string
+
+      m.field 'univid', :string                   # PS:univid
+      m.field 'sunetid', :string                  # PS:sunetid
+      m.field 'ps_career', :string                # PS:career
+      m.field 'ps_program', :string               # PS:program
+      m.field 'ps_plan', :string                  # PS:plan
+      m.field 'ps_subplan', :string               # PS:subplan
+      m.field 'dissertation_id', :string          # PS:dissertationid
+      m.field 'provost', :string                  # PS:vpname
+
+      # from latest ps revision
+      m.field 'degreeconfyr', :string
+      m.field 'schoolname', :string               # Display value derived from ps_career
+      m.field 'department', :string               # Display value derived from ps_program
+      m.field 'readerapproval', :string           # Possible Values: Not Submitted, Not Approved, Approved, Rejected, Reject with Modification
+      m.field 'readercomment', :string
+      m.field 'readeractiondttm', :string         # date?
+      m.field 'regapproval', :string              # Possible Values: Not Submitted, Not Approved, Approved, Rejected, Reject with Modification
+      m.field 'regcomment', :string
+      m.field 'regactiondttm', :string
+      m.field 'documentaccess', :string
+
+      m.field 'submit_date', :string
+      m.field 'symphonyStatus', :string
+    end
+
+    has_metadata name: 'workflow', type: ActiveFedora::SimpleDatastream, versionable: false do |m|
+      m.field 'citation_verified', :string
+      m.field 'abstract_provided', :string
+      m.field 'dissertation_uploaded', :string
+      m.field 'supplemental_files_uploaded', :string
+      m.field 'permissions_provided', :string
+      m.field 'permission_files_uploaded', :string
+      m.field 'rights_selected', :string
+      m.field 'cc_license_selected', :string
+      m.field 'submitted_to_registrar', :string
+    end
+
+    has_metadata name: 'DC', type: Dor::SimpleDublinCoreDs, versionable: false, label: 'DC', control_group: 'X'
+
+    def etd_embargo_date
+      regaction = properties.regactiondttm.first
+      embargo = properties.embargo.first
+      if properties.regapproval.first =~ /^approved$/i &&
+         !embargo.nil? && embargo != '' &&
+         !regaction.nil? && regaction != ''
+        embargo_months = case embargo
+                         when /6 months/i
+                           6
+                         when /1 year/i
+                           12
+                         when /2 years/i
+                           24
+                         else
+                           0
+                         end
+        return Time.strptime(regaction, '%m/%d/%Y %H:%M:%S') + embargo_months.months
+      end
+      nil
+    end
+  end
+end