dor-services 2.2.4 → 4.4.10

data/lib/dor/models/discoverable.rb

@@ -0,0 +1,66 @@
+module Dor
+  module Discoverable
+    extend ActiveSupport::Concern
+    #index gryphondor fields
+    require 'stanford-mods'
+		def to_solr(solr_doc=Hash.new, *args)
+			super solr_doc, *args
+    
+      if self.descMetadata and not self.descMetadata.new?
+        stanford_mods_record=Stanford::Mods::Record.new
+        stanford_mods_record.from_str(self.descMetadata.ng_xml.to_s)
+        doc_hash = { 
+          :sw_format_facet => stanford_mods_record.format,
+          # title fields
+          :sw_title_245a_search_facet_facet => stanford_mods_record.sw_short_title,
+          :sw_title_245_search_facet_facet => stanford_mods_record.sw_full_title,
+          :sw_title_variant_search_facet_facet => stanford_mods_record.sw_addl_titles,
+          :sw_title_sort_facet => stanford_mods_record.sw_sort_title,
+          :sw_title_245a_display_facet => stanford_mods_record.sw_short_title,
+          :sw_title_display_facet => stanford_mods_record.sw_full_title,
+          :sw_title_full_display_facet => stanford_mods_record.sw_full_title,
+      
+          # author fields
+          :sw_author_1xx_search_facet_facet => stanford_mods_record.sw_main_author,
+          :sw_author_7xx_search_facet_facet => stanford_mods_record.sw_addl_authors,
+          :sw_author_person_facet_facet => stanford_mods_record.sw_person_authors,
+          :sw_author_other_facet_facet => stanford_mods_record.sw_impersonal_authors,
+          #:sw_author_sort_facet => stanford_mods_record.sw_sort_author,
+          :sw_author_corp_display_facet => stanford_mods_record.sw_corporate_authors,
+          :sw_author_meeting_display_facet => stanford_mods_record.sw_meeting_authors,
+          :sw_author_person_display_facet => stanford_mods_record.sw_person_authors,
+          :sw_author_person_full_display_facet => stanford_mods_record.sw_person_authors,
+      
+          # subject search fields
+           :sw_topic_search_facet_facet => stanford_mods_record.topic_search, 
+           :sw_geographic_search_facet_facet => stanford_mods_record.geographic_search,
+           :sw_subject_other_search_facet_facet => stanford_mods_record.subject_other_search, 
+           :sw_subject_other_subvy_search_facet_facet => stanford_mods_record.subject_other_subvy_search,
+           :sw_subject_all_search_facet_facet => stanford_mods_record.subject_all_search, 
+           :sw_topic_facet_facet => stanford_mods_record.topic_facet,
+           :sw_geographic_facet_facet => stanford_mods_record.geographic_facet,
+           :sw_era_facet_facet => stanford_mods_record.era_facet,
+
+          :sw_language_facet => stanford_mods_record.sw_language_facet,
+          #:sw_physical =>  stanford_mods_record.term_values([:sw_physical_description, :sw_extent]),
+          #:sw_summary_search_facet_facet => stanford_mods_record.term_values(:sw_abstract),
+          #:sw_toc_search_facet_facet => stanford_mods_record.term_values(:sw_tableOfContents),
+          #:sw_url_suppl => stanford_mods_record.term_values([:sw_related_item, :sw_location, :sw_url]),
+
+          #publish date fields
+          :sw_pub_search_facet_facet => stanford_mods_record.place,
+          :sw_pub_date_sort_facet => stanford_mods_record.pub_date_sort,
+          :sw_pub_date_group_facet_facet => stanford_mods_record.pub_date_groups(stanford_mods_record.pub_date), 
+          :sw_pub_date_facet =>stanford_mods_record.pub_date_facet,
+          :sw_pub_date_display_facet => stanford_mods_record.pub_date_display,
+          :sw_all_search_facet_facet => stanford_mods_record.text
+      
+        }
+        if doc_hash
+          solr_doc = solr_doc.merge(doc_hash)
+        end
+      end
+      solr_doc
+    end
+  end
+end

data/lib/dor/models/editable.rb

@@ -0,0 +1,267 @@
+module Dor  
+  module Editable
+    extend ActiveSupport::Concern
+    include ActiveFedora::Relationships
+
+    included do
+      belongs_to 'agreement_object', :property => :referencesAgreement, :class_name => "Dor::Item"
+    end
+    
+    def to_solr(solr_doc=Hash.new, *args)
+      super(solr_doc, *args)
+      add_solr_value(solr_doc, "default_rights", default_rights, :string, [:facetable])
+      add_solr_value(solr_doc, "agreement", agreement, :string, [:facetable]) if agreement_object
+      solr_doc
+    end
+    #Adds a person or group to a role in the APO role metadata datastream
+    #
+    #@param role [String] the role the group or person will be filed under, ex. dor-apo-manager
+    #@param entity [String] the name of the person or group, ex dlss:developers or sunetid:someone
+    #@param type [Symbol] :workgroup for a group or :person for a person
+    def add_roleplayer role, entity, type=:workgroup
+      xml=self.roleMetadata.ng_xml
+      group='person'
+      if type == :workgroup
+        group='group'
+      end
+      nodes = xml.search('/roleMetadata/role[@type=\''+role+'\']')
+      if nodes.length > 0
+        group_node=Nokogiri::XML::Node.new(group, xml)
+        id_node=Nokogiri::XML::Node.new('identifier', xml)
+        group_node.add_child(id_node)
+        id_node.content=entity
+        id_node['type']=type.to_s
+        nodes.first.add_child(group_node)
+      else
+        node=Nokogiri::XML::Node.new('role', xml)
+        node['type']=role
+        group_node=Nokogiri::XML::Node.new(group, xml)
+        node.add_child group_node
+        id_node=Nokogiri::XML::Node.new('identifier', xml)
+        group_node.add_child(id_node)
+        id_node.content=entity
+        id_node['type']=type.to_s
+        xml.search('/roleMetadata').first.add_child(node)
+      end
+      self.roleMetadata.content=xml.to_s
+    end
+    #remove all people groups and roles from the APO role metadata datastream
+    def purge_roles 
+      xml=self.roleMetadata.ng_xml
+      nodes = xml.search('/roleMetadata/role')
+      nodes.each do |node|
+        node.remove
+      end
+    end
+
+    def mods_title
+      return self.descMetadata.term_values(:title_info, :main_title).first
+    end
+    def mods_title=(val)
+      self.descMetadata.update_values({[:title_info, :main_title] => val})
+    end
+    #get all collections listed for this APO, used during registration
+    #@return [Array] array of pids
+    def default_collections 
+      return administrativeMetadata.term_values(:registration, :default_collection)
+    end
+    #Add a collection to the listing of collections for items governed by this apo. 
+    #@param val [String] pid of the collection, ex. druid:ab123cd4567
+    def add_default_collection val
+      ds=self.administrativeMetadata
+      xml=ds.ng_xml
+      reg=xml.search('//administrativeMetadata/registration').first
+      if not reg
+        reg=Nokogiri::XML::Node.new('registration',xml)
+        xml.search('/administrativeMetadata').first.add_child(reg)
+      end
+      node=Nokogiri::XML::Node.new('collection',xml)
+      node['id']=val
+      reg.add_child(node)
+      self.administrativeMetadata.content=xml.to_s
+    end
+    
+    def remove_default_collection val
+      ds=self.administrativeMetadata
+      xml=ds.ng_xml
+      xml.search('//administrativeMetadata/registration/collection[@id=\''+val+'\']').remove
+      self.administrativeMetadata.content=xml.to_s
+    end
+    #Get all roles defined in the role metadata, and the people or groups in those roles. Groups are prefixed with 'workgroup:'
+    #@return [Hash] role => ['person','group'] ex. {"dor-apo-manager" => ["workgroup:dlss:developers", "sunetid:lmcrae"]
+    def roles
+      roles={}
+      self.roleMetadata.ng_xml.search('/roleMetadata/role').each do |role|
+        roles[role['type']]=[]
+        role.search('identifier').each do |entity|
+          roles[role['type']] << entity['type'] + ':' + entity.text()
+        end
+      end
+      roles
+    end
+    def metadata_source 
+      self.administrativeMetadata.metadata_source.first
+    end
+    def metadata_source=(val)
+      if self.administrativeMetadata.descMetadata == nil
+        self.administrativeMetadata.add_child_node(self.administrativeMetadata, :descMetadata)
+      end
+      self.administrativeMetadata.update_values({[:descMetadata, :source] => val})
+    end
+    def use_statement
+      self.defaultObjectRights.use_statement.first
+    end
+    def use_statement=(val)
+      self.defaultObjectRights.update_values({[:use_statement] => val})
+    end
+    def copyright_statement
+      self.defaultObjectRights.copyright.first
+    end
+    def copyright_statement=(val)
+      self.defaultObjectRights.update_values({[:copyright] => val})
+    end
+    def creative_commons_license
+      self.defaultObjectRights.creative_commons.first
+    end
+    def creative_commons_license_human
+      self.defaultObjectRights.creative_commons_human.first
+    end
+    def creative_commons_license=(val)
+      (machine, human)=val
+      if creative_commons_license == nil
+        self.defaultObjectRights.add_child_node(self.defaultObjectRights.ng_xml.root, :creative_commons)
+      end
+      self.defaultObjectRights.update_values({[:creative_commons] => val})
+    end
+    def creative_commons_license_human=(val)
+      if creative_commons_license_human == nil
+        #add the nodes
+       self.defaultObjectRights.add_child_node(self.defaultObjectRights.ng_xml.root, :creative_commons)
+      end
+      self.defaultObjectRights.update_values({[:creative_commons_human] => val})
+      
+    end
+    #@return [String] A description of the rights defined in the default object rights datastream. Can be 'Stanford', 'World', 'Dark' or 'None'
+    def default_rights
+      xml=self.defaultObjectRights.ng_xml
+      if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1
+        'Stanford'
+      else
+        if xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length ==1
+          'World'
+        else
+          if xml.search('//rightsMetadata/access[@type=\'discover\']/machine/none').length == 1
+            'Dark'
+          else
+            'None'
+          end
+        end
+      end
+    end
+    #Set the rights in default object rights
+    #@param rights [String] Stanford, World, Dark, or None
+    def default_rights=(rights)
+      rights=rights.downcase
+      ds = self.defaultObjectRights
+      rights_xml=ds.ng_xml
+      rights_xml.search('//rightsMetadata/access[@type=\'discover\']/machine').each do |node|
+        node.children.remove
+        if rights=='dark'
+            world_node=Nokogiri::XML::Node.new('none',rights_xml)
+            node.add_child(world_node)
+        else
+            world_node=Nokogiri::XML::Node.new('world',rights_xml)
+          node.add_child(world_node)
+        end
+      end
+      rights_xml.search('//rightsMetadata/access[@type=\'read\']').each do |node|
+        node.children.remove
+        machine_node=Nokogiri::XML::Node.new('machine',rights_xml)
+        if(rights=='world')
+          world_node=Nokogiri::XML::Node.new(rights,rights_xml)
+          node.add_child(machine_node)
+          machine_node.add_child(world_node)
+        end
+        if rights=='stanford'
+          world_node=Nokogiri::XML::Node.new(rights,rights_xml)
+          node.add_child(machine_node)
+          group_node=Nokogiri::XML::Node.new('group',rights_xml)
+          group_node.content="Stanford"
+          node.add_child(machine_node)
+          machine_node.add_child(group_node)
+        end
+        if rights=='none' || rights == 'dark'
+          none_node=Nokogiri::XML::Node.new('none',rights_xml)
+          node.add_child(machine_node)
+          machine_node.add_child(none_node)
+        end
+      end
+    end
+    
+    def desc_metadata_format
+      self.administrativeMetadata.metadata_format.first
+    end
+    def desc_metadata_format=(format)
+      #create the node if it isnt there already
+      if not self.administrativeMetadata.metadata_format.first
+        self.administrativeMetadata.add_child_node(self.administrativeMetadata.ng_xml.root, :metadata_format)
+      end
+      self.administrativeMetadata.update_values({[:metadata_format] => format})
+    end
+    def desc_metadata_source
+      self.administrativeMetadata.metadata_source.first
+    end
+    def desc_metadata_source=(source)
+      #create the node if it isnt there already
+      if not self.administrativeMetadata.metadata_source.first
+        self.administrativeMetadata.add_child_node(self.administrativeMetadata.ng_xml.root, :metadata_source)
+      end
+      self.administrativeMetadata.update_values({[:metadata_source] => format})
+    end
+    #List of default workflows, used to provide choices at registration
+    #@return [Array] and array of pids, ex ['druid:ab123cd4567']
+    def default_workflows
+      xml=self.administrativeMetadata.ng_xml
+      nodes=self.administrativeMetadata.term_values(:registration, :workflow_id)
+      if nodes.length > 0
+        wfs=[]
+        nodes.each do |node|
+          wfs << node
+        end
+        wfs
+      else
+        []
+      end      
+    end
+    #set a single default workflow
+    #@param wf [String] the name of the workflow, ex. 'digitizationWF'
+    def default_workflow=(wf)
+      ds=self.administrativeMetadata
+      xml=ds.ng_xml
+      nodes=xml.search('//registration/workflow')
+      if nodes.first
+        nodes.first['id']=wf
+      else
+        nodes=xml.search('//registration')
+        if not nodes.first
+          self.administrativeMetadata.add_child_node(self.administrativeMetadata.ng_xml.root, :registration)
+        end
+        nodes=xml.search('//registration')
+        wf_node=Nokogiri::XML::Node.new('workflow',xml)
+        wf_node['id']=wf
+        nodes.first.add_child(wf_node)
+      end
+    end
+    def agreement
+      if agreement_object and agreement_object.first
+        agreement_object.first.pid
+      else
+        ''
+      end
+    end
+    def agreement=(val)
+      self.agreement_object = Dor::Item.find val.to_s, :cast => true
+    end
+  end
+
+end

data/lib/dor/models/embargoable.rb

@@ -0,0 +1,97 @@
+module Dor
+  module Embargoable
+    extend ActiveSupport::Concern
+    include Dor::Publishable
+
+    included do
+      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_xml = datastreams['rightsMetadata'].ng_xml
+      rights_xml.xpath("//rightsMetadata/access[@type='read']").each { |n| n.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
+
+      datastreams['events'].add_event("embargo", release_agent, "Embargo released")
+    end
+
+    def world_doc
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.access(:type => 'read') {
+          xml.machine {
+            xml.world
+          }
+        }
+      end
+      return builder.doc
+    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_xml = datastreams['rightsMetadata'].ng_xml
+      rights_xml.xpath("//rightsMetadata/access[@type='read']").each { |n| n.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
+
+      datastreams['rightsMetadata'].content_will_change!
+      datastreams['events'].add_event("embargo", release_agent, "20% Visibility Embargo released")
+    end
+
+		def update_embargo(new_date)
+			if not embargoMetadata.status == 'embargoed'
+				raise 'You cannot change the embargo date of an item thant isnt embargoed.'
+			end
+			if new_date.past?
+			  raise 'You cannot set the embargo date to a past date.'
+			end
+			updated=false
+			self.rightsMetadata.ng_xml.search('//embargoReleaseDate').each do |node|
+				node.content=new_date.beginning_of_day.utc.xmlschema
+				updated=true
+			end
+			self.rightsMetadata.content=self.rightsMetadata.ng_xml.to_s
+			self.rightsMetadata.save
+			if not updated
+				raise 'No release date in rights metadata, cannot proceed!'
+			end
+			self.embargoMetadata.ng_xml.xpath('//releaseDate').each do |node|
+				node.content=new_date.beginning_of_day.utc.xmlschema
+			end
+			self.embargoMetadata.content=self.embargoMetadata.ng_xml.to_s
+			self.embargoMetadata.save
+		end
+  end
+end

data/lib/dor/models/eventable.rb

@@ -0,0 +1,12 @@
+module Dor
+  module Eventable
+    extend ActiveSupport::Concern
+    included do
+      has_metadata :name => 'events', :type => Dor::EventsDS, :label => 'Events'
+    end
+    
+    def add_event *args
+      self.datastreams['events'].add_event *args
+    end
+  end
+end

data/lib/dor/models/governable.rb

@@ -0,0 +1,162 @@
+module Dor  
+  module Governable
+    extend ActiveSupport::Concern
+    include ActiveFedora::Relationships
+
+    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)
+      self.initialize_workflow(name, 'dor', !self.new_object?)
+    end
+
+    def reset_to_apo_default()
+      rights_metadata_ds = self.rightsMetadata
+      #get the apo for this object
+      apo_druid=obj.identityMetadata.adminPolicy.first
+      apo_obj=Dor::Item.find(apo_druid, :lightweight => true)
+      rights_metadata_ds.content=apo_obj.rightsMetadata.ng_xml
+    end
+
+    def set_read_rights(rights)
+      return if not ['world','stanford','none', 'dark'].include? rights
+      rights_metadata_ds = self.rightsMetadata
+      rights_xml=rights_metadata_ds.ng_xml
+      if(rights_xml.search('//rightsMetadata/access[@type=\'read\']').length==0)
+        raise ('The rights metadata stream doesnt contain an entry for machine read permissions. Consider populating it from the APO before trying to change it.')
+      end
+      rights_xml.search('//rightsMetadata/access[@type=\'discover\']/machine').each do |node|
+        node.children.remove
+        if rights=='dark'
+            world_node=Nokogiri::XML::Node.new('none',rights_xml)
+            node.add_child(world_node)
+        else
+            world_node=Nokogiri::XML::Node.new('world',rights_xml)
+          node.add_child(world_node)
+        end
+      end
+      rights_xml.search('//rightsMetadata/access[@type=\'read\']').each do |node|
+        node.children.remove
+        machine_node=Nokogiri::XML::Node.new('machine',rights_xml)
+        if(rights=='world')
+          world_node=Nokogiri::XML::Node.new(rights,rights_xml)
+          node.add_child(machine_node)
+          machine_node.add_child(world_node)
+        end
+        if rights=='stanford'
+          world_node=Nokogiri::XML::Node.new(rights,rights_xml)
+          node.add_child(machine_node)
+          group_node=Nokogiri::XML::Node.new('group',rights_xml)
+          group_node.content="Stanford"
+          node.add_child(machine_node)
+          machine_node.add_child(group_node)
+        end
+        if rights=='none' or rights == 'dark'
+          none_node=Nokogiri::XML::Node.new('none',rights_xml)
+          node.add_child(machine_node)
+          machine_node.add_child(none_node)
+        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
+      self.collections << collection
+      self.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
+
+      self.collections.delete(collection)
+      self.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 self.respond_to? :rightsMetadata
+        xml=self.rightsMetadata.ng_xml
+        return nil if xml.search('//rightsMetadata').length != 1
+        if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1
+          'Stanford'
+        else
+          if xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length ==1
+            'World'
+          else
+            if xml.search('//rightsMetadata/access[@type=\'discover\']/machine/none').length == 1
+              'Dark'
+            else
+              'None'
+            end
+          end
+      end
+    end
+    def groups_which_manage_item
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor']
+    end
+    def groups_which_manage_desc_metadata
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor', 'dor-apo-metadata']
+    end
+    def groups_which_manage_system_metadata
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor']
+    end
+    def groups_which_manage_content
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor']    
+    end
+    def groups_which_manage_rights
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor']
+    end
+    def groups_which_manage_embargo
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor']    
+    end
+    def groups_which_view_content
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor', 'dor-viewer']    
+    end
+    def groups_which_view_metadata
+      ['dor-administrator','dor-apo-manager', 'dor-apo-depositor', 'dor-viewer']    
+    end
+    def intersect arr1, arr2
+      return (arr1 & arr2).length > 0
+    end
+    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
+  end
+end