dor-services 5.1.0 → 5.1.1

data/lib/dor/datastreams/default_object_rights_ds.rb

@@ -1,20 +1,18 @@
 module Dor
-  class DefaultObjectRightsDS < ActiveFedora::OmDatastream 
+  class DefaultObjectRightsDS < ActiveFedora::OmDatastream
 
     set_terminology do |t|
       t.root :path => 'rightsMetadata', :index_as => [:not_searchable]
-      t.copyright :path => 'copyright/human', :index_as => [:facetable]
-      t.use_statement :path => '/use/human[@type=\'useAndReproduction\']', :index_as => [:facetable]
-      
+      t.copyright :path => 'copyright/human', :index_as => [:symbol]
+      t.use_statement :path => '/use/human[@type=\'useAndReproduction\']', :index_as => [:symbol]
+
       t.use do
         t.machine
         t.human
       end
-        
+
       t.creative_commons :path => '/use/machine', :type => 'creativeCommons'
       t.creative_commons_human :path => '/use/human[@type=\'creativeCommons\']'
-      
-      
     end
 
     define_template :creative_commons do |xml|
@@ -23,6 +21,7 @@ module Dor
         xml.machine(:type => "creativeCommons")
       }
     end
+
     def self.xml_template
       Nokogiri::XML::Builder.new do |xml|
         xml.rightsMetadata{
@@ -30,7 +29,7 @@ module Dor
             xml.machine{
               xml.world
             }
-          } 
+          }
           xml.access(:type => 'read'){
             xml.machine{
               xml.world
@@ -44,9 +43,8 @@ module Dor
           xml.copyright{
             xml.human
           }
-        
-      }
-    end.doc
+        }
+      end.doc
+    end
   end
 end
-end

data/lib/dor/datastreams/desc_metadata_ds.rb

@@ -4,7 +4,7 @@ class DescMetadataDS < ActiveFedora::OmDatastream
   MODS_NS = 'http://www.loc.gov/mods/v3'
   set_terminology do |t|
     t.root :path => 'mods', :xmlns => MODS_NS, :index_as => [:not_searchable]
-    t.originInfo :index_as => [:not_searchable] do
+    t.originInfo  :index_as => [:not_searchable] do
       t.publisher :index_as => [:stored_searchable]
       t.date_created :path => 'dateCreated', :index_as => [:stored_searchable]
       t.place :index_as => [:not_searchable] do
@@ -31,9 +31,9 @@ class DescMetadataDS < ActiveFedora::OmDatastream
   def self.xml_template
     Nokogiri::XML::Builder.new do |xml|
       xml.mods( 'xmlns' => 'http://www.loc.gov/mods/v3', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',:version => '3.3', "xsi:schemaLocation" => 'http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd'){
-         xml.titleInfo{
-           xml.title
-         }
+        xml.titleInfo{
+          xml.title
+        }
       }
     end.doc
   end

data/lib/dor/datastreams/events_ds.rb

@@ -3,12 +3,12 @@ class EventsDS < ActiveFedora::OmDatastream
   before_create :ensure_non_versionable
   
   set_terminology do |t|
-    t.root(:path => "events")
+    t.root(:path => 'events')
     t.event do
-      t.who :path => { :attribute => "who" }, :index_as => [:displayable, :not_searchable]
-      t.type_ :path => { :attribute => "type" }, :index_as => [:displayable, :not_searchable]
-      t.when :path => { :attribute => "when" }, :index_as => [:displayable, :not_searchable], :data_type => :date
-      t.message :path => "text()", :index_as => [:displayable, :not_searchable]
+      t.who     :path => { :attribute => 'who'  }, :index_as => [:displayable, :not_searchable]
+      t.type_   :path => { :attribute => 'type' }, :index_as => [:displayable, :not_searchable]
+      t.when    :path => { :attribute => 'when' }, :index_as => [:displayable, :not_searchable], :data_type => :date
+      t.message :path => 'text()', :index_as => [:displayable, :not_searchable]
     end
   end
   
@@ -21,7 +21,7 @@ class EventsDS < ActiveFedora::OmDatastream
   end
   
   def ensure_non_versionable
-    self.versionable = "false"
+    self.versionable = 'false'
   end
   
   # Adds an event to the datastream
@@ -29,7 +29,7 @@ class EventsDS < ActiveFedora::OmDatastream
   # @param [String] who who is responsible for this event. Sets the who attribute for the event
   # @param [String] message what happened. Sets the content of the event with this message
   def add_event(type, who, message)
-    ev = ng_xml.create_element "event", message, 
+    ev = ng_xml.create_element 'event', message, 
       :type => type, :who => who, :when => Time.now.xmlschema
     ng_xml.root.add_child(ev)
     ng_xml_will_change!
@@ -60,4 +60,4 @@ class EventsDS < ActiveFedora::OmDatastream
   end
   
 end
-end
+end

data/lib/dor/datastreams/identity_metadata_ds.rb

@@ -4,18 +4,18 @@ class IdentityMetadataDS < ActiveFedora::OmDatastream
   
   set_terminology do |t|
     t.root(:path=>"identityMetadata")
-    t.objectId :index_as => [:symbol, :searchable]
-    t.objectType :index_as => [:symbol, :searchable, :facetable]
+    t.objectId :index_as => [:symbol]
+    t.objectType :index_as => [:symbol]
     t.objectLabel
     t.citationCreator
     t.sourceId
     t.otherId(:path => 'otherId') do
       t.name_(:path => { :attribute => 'name' })
     end
-    t.agreementId :index_as => [:searchable, :facetable]
-    t.tag :index_as => [:symbol, :searchable, :facetable]
+    t.agreementId :index_as => [:stored_searchable, :symbol]
+    t.tag :index_as => [:symbol]
     t.citationTitle
-    t.objectCreator :index_as => [:searchable, :facetable]
+    t.objectCreator :index_as => [:stored_searchable, :symbol]
     t.adminPolicy :index_as => [:not_searchable]
   end
   
@@ -82,35 +82,52 @@ class IdentityMetadataDS < ActiveFedora::OmDatastream
   
   def to_solr(solr_doc=Hash.new, *args)
     super(solr_doc, *args)
+
     if digital_object.respond_to?(:profile)
-      digital_object.profile.each_pair do |property,value|
-        if property =~ /Date/
-          add_solr_value(solr_doc, property.underscore,  Time.parse(value).utc.xmlschema, :date, [:stored_searchable])
-        else
-          add_solr_value(solr_doc, property.underscore, value, :string, [:stored_searchable])
-        end
+      digital_object.profile.each_pair do |property, value|
+        add_solr_value(solr_doc, property.underscore, value, (property =~ /Date/ ? :date : :symbol), [:stored_searchable])
       end
     end
+
     if sourceId.present?
-      (name,id) = sourceId.split(/:/,2)
-      add_solr_value(solr_doc, "dor_id", id, :string, [:searchable, :facetable])
-      add_solr_value(solr_doc, "identifier", sourceId, :string, [:searchable, :facetable, :symbol])
-      add_solr_value(solr_doc, "source_id", sourceId, :string, [:symbol, :searchable, :facetable])
+      (name, id) = sourceId.split(/:/, 2)
+      add_solr_value(solr_doc, "dor_id", id, :symbol, [:stored_searchable])
+      add_solr_value(solr_doc, "identifier", sourceId, :symbol, [:stored_searchable])
+      add_solr_value(solr_doc, "source_id", sourceId, :symbol, [])
     end
     otherId.compact.each { |qid|
-      (name,id) = qid.split(/:/,2)
-      add_solr_value(solr_doc, "dor_id", id, :string, [:searchable, :facetable])
-      add_solr_value(solr_doc, "identifier", qid, :string, [:searchable, :facetable, :symbol])
-      add_solr_value(solr_doc, "#{name}_id", id, :string, [:symbol, :searchable, :facetable])
+      # this section will solrize barcode and catkey, which live in otherId
+      (name, id) = qid.split(/:/, 2)
+      add_solr_value(solr_doc, "dor_id", id, :symbol, [:stored_searchable])
+      add_solr_value(solr_doc, "identifier", qid, :symbol, [:stored_searchable])
+      add_solr_value(solr_doc, "#{name}_id", id, :symbol, [])
     }
-        
+    
+    # do some stuff to make tags in general and project tags specifically more easily searchable and facetable
     self.find_by_terms(:tag).each { |tag|
-      (top,rest) = tag.text.split(/:/,2)
+      (prefix, rest) = tag.text.split(/:/, 2)
+      prefix = prefix.downcase.strip.gsub(/\s/,'_')
       unless rest.nil?
-        add_solr_value(solr_doc, "#{top.downcase.strip.gsub(/\s/,'_')}_tag", rest.strip, :string, [:symbol, :searchable, :facetable])
+        # this part will index a value in a field specific to the tag, e.g. registered_by_tag_*, 
+        # book_tag_*, project_tag_*, remediated_by_tag_*, etc.  project_tag_* and registered_by_tag_*
+        # definitley get used, but most don't.  we can limit the prefixes that get solrized if things 
+        # get out of hand.
+        add_solr_value(solr_doc, "#{prefix}_tag", rest.strip, :symbol, [])
+      end
+
+      # solrize each possible prefix for the tag, inclusive of the full tag.
+      # e.g., for a tag such as "A : B : C", this will solrize to an _ssim field 
+      # that contains ["A",  "A : B",  "A : B : C"].
+      tag_parts = tag.text.split(/:/)
+      progressive_tag_prefix = ''
+      tag_parts.each_with_index do |part, index|
+        progressive_tag_prefix += " : " if index > 0
+        progressive_tag_prefix += part.strip
+        add_solr_value(solr_doc, "exploded_tag", progressive_tag_prefix, :symbol, [])
       end
     }
-    solr_doc
+
+    return solr_doc
   end
 end #class
 end

data/lib/dor/datastreams/rights_metadata_ds.rb

@@ -0,0 +1,109 @@
+module Dor
+  class RightsMetadataDS < ActiveFedora::OmDatastream
+    require 'dor/rights_auth'
+
+    attr_writer :dra_object
+
+    # This is separate from default_object_rights because
+    # (1) we cannot default to such a permissive state
+    # (2) this is real, not default
+    #
+    # Ultimately, default_object_rights should go away and APOs also use an instantation of this class
+
+    set_terminology do |t|
+      t.root :path => 'rightsMetadata', :index_as => [:not_searchable]
+      t.copyright :path => 'copyright/human', :index_as => [:symbol]
+      t.use_statement :path => '/use/human[@type=\'useAndReproduction\']', :index_as => [:symbol]
+
+      t.use do
+        t.machine
+        t.human
+      end
+
+      t.creative_commons :path => '/use/machine', :type => 'creativeCommons'
+      t.creative_commons_human :path => '/use/human[@type=\'creativeCommons\']'
+    end
+
+    define_template :creative_commons do |xml|
+      xml.use {
+        xml.human(:type => "creativeCommons")
+        xml.machine(:type => "creativeCommons")
+      }
+    end
+
+    def self.xml_template
+      Nokogiri::XML::Builder.new do |xml|
+        xml.rightsMetadata{
+          xml.access(:type => 'discover'){
+            xml.machine{ xml.none }
+          }
+          xml.access(:type => 'read'){
+            xml.machine{ xml.none }   # dark default
+          }
+          xml.use{
+            xml.human(:type => 'useAndReproduction')
+            xml.human(:type => "creativeCommons")
+            xml.machine(:type => "creativeCommons")
+          }
+          xml.copyright{ xml.human }
+        }
+      end.doc
+    end
+
+    # just a wrapper to invalidate @dra_object
+    def content=(xml)
+      @dra_object = nil
+      super
+    end
+
+    def dra_object
+      @dra_object ||= Dor::RightsAuth.parse(self.ng_xml, true)
+    end
+
+    # @param rights [string] archetypical rights to assign: 'world', 'stanford', 'none' or 'dark'
+    # Moved from Governable
+    # slight misnomer: also sets discover rights!
+    # TODO: convert xpath reads to dra_object calls
+    def set_read_rights(rights)
+      raise(ArgumentError, "Argument '#{rights}' is not a recognized value") unless ['world','stanford','none','dark'].include? rights
+      rights_xml = self.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
+      label = rights=='dark' ? 'none' : 'world'
+      @dra_object = nil # until TODO complete, we'll expect to have to reparse after modification
+      rights_xml.search('//rightsMetadata/access[@type=\'discover\']/machine').each do |node|
+        node.children.remove
+        node.add_child Nokogiri::XML::Node.new(label,rights_xml)
+      end
+      rights_xml.search('//rightsMetadata/access[@type=\'read\']').each do |node|
+        node.children.remove
+        machine_node = Nokogiri::XML::Node.new('machine',rights_xml)
+        node.add_child(machine_node)
+        if rights == 'world'
+          machine_node.add_child Nokogiri::XML::Node.new(rights,rights_xml)
+        elsif rights == 'stanford'
+          group_node = Nokogiri::XML::Node.new('group',rights_xml)
+          group_node.content = "Stanford"
+          machine_node.add_child(group_node)
+        else  # we know it is none or dark by the argument filter (first line)
+          machine_node.add_child Nokogiri::XML::Node.new('none',rights_xml)
+        end
+      end
+    end
+
+    def to_solr(solr_doc=Hash.new, *args)
+      super(solr_doc, *args)
+      dra = self.dra_object
+      solr_doc['rights_primary_ssi'] = dra.index_elements[:primary]
+      solr_doc['rights_errors_ssim'] = dra.index_elements[:errors] if dra.index_elements[:errors].size > 0
+      solr_doc['rights_characteristics_ssim'] = dra.index_elements[:terms] if dra.index_elements[:terms].size > 0
+      # suppress empties
+      %w[use_statement_ssim copyright_ssim].each do |key|
+        solr_doc[key] = solr_doc[key].reject{ |val| val.nil? || val == '' }.flatten unless solr_doc[key].nil?
+      end
+      solr_doc
+    end
+
+  end #class
+end

data/lib/dor/datastreams/role_metadata_ds.rb

@@ -37,11 +37,11 @@ class RoleMetadataDS < ActiveFedora::OmDatastream
   def to_solr(solr_doc=Hash.new, *args)
     self.find_by_xpath('/roleMetadata/role/*').each do |actor|
       role_type = actor.parent['type']
-      val = [actor.at_xpath('identifier/@type'),actor.at_xpath('identifier/text()')].join ':'
-      add_solr_value(solr_doc, "apo_role_#{actor.name}_#{role_type}", val, :string, [:searchable, :facetable, :symbol])
-      add_solr_value(solr_doc, "apo_role_#{role_type}", val, :string, [:searchable, :facetable, :symbol])
+      val = [actor.at_xpath('identifier/@type'), actor.at_xpath('identifier/text()')].join ':'
+      add_solr_value(solr_doc, "apo_role_#{actor.name}_#{role_type}", val, :string, [:symbol])
+      add_solr_value(solr_doc, "apo_role_#{role_type}", val, :string, [:symbol])
       if ['dor-apo-manager','dor-apo-depositor'].include? role_type
-        add_solr_value(solr_doc, "apo_register_permissions", val, :string, [:searchable, :facetable, :symbol])
+        add_solr_value(solr_doc, "apo_register_permissions", val, :string, [:symbol, :stored_searchable])
       end
     end
     solr_doc

data/lib/dor/datastreams/simple_dublin_core_ds.rb

@@ -3,9 +3,9 @@ class SimpleDublinCoreDs < ActiveFedora::OmDatastream
 
   set_terminology do |t|
     t.root(:path=>"dc", :xmlns=>"http://www.openarchives.org/OAI/2.0/oai_dc/", :schema=>"http://cosimo.stanford.edu/standards/oai_dc/v2/oai_dc.xsd", :namespace_prefix => 'oai_dc', :index_as => [:not_searchable])
-    t.title(     :index_as=>[:displayable, :facetable, :stored_searchable], :xmlns => "http://purl.org/dc/elements/1.1/", :namespace_prefix => 'dc')
-    t.creator(   :index_as=>[:displayable, :facetable, :stored_searchable], :xmlns => "http://purl.org/dc/elements/1.1/", :namespace_prefix => 'dc')
-    t.identifier(:index_as=>[:displayable, :stored_searchable],             :xmlns => "http://purl.org/dc/elements/1.1/", :namespace_prefix => 'dc')
+    t.title(     :index_as=>[:stored_sortable, :stored_searchable], :xmlns => "http://purl.org/dc/elements/1.1/", :namespace_prefix => 'dc')
+    t.creator(   :index_as=>[:stored_sortable, :stored_searchable], :xmlns => "http://purl.org/dc/elements/1.1/", :namespace_prefix => 'dc')
+    t.identifier(:index_as=>[:symbol, :stored_searchable],          :xmlns => "http://purl.org/dc/elements/1.1/", :namespace_prefix => 'dc')
   end
 
   def self.xml_template
@@ -27,15 +27,15 @@ class SimpleDublinCoreDs < ActiveFedora::OmDatastream
     begin
       doc = super solr_doc, *args
 
-      add_solr_value(doc, 'dc_title',   self.title.first,   :string, [:sortable])
-      add_solr_value(doc, 'dc_creator', self.creator.first, :string, [:sortable])
+      add_solr_value(doc, 'dc_title',   self.title.first,   :string, [:stored_sortable, :stored_searchable])
+      add_solr_value(doc, 'dc_creator', self.creator.first, :string, [:stored_sortable, :stored_searchable])
 
       identifiers = {}
 
       self.identifier.each { |i| ns, val = i.split(":"); identifiers[ns] ||= val }
 
       identifiers.each do |ns, val|
-        add_solr_value(doc, "dc_identifier_#{ns}", val, :string, [:sortable])
+        add_solr_value(doc, "dc_identifier_#{ns}", val, :string, [:stored_sortable, :stored_searchable])
       end
 
       return doc

data/lib/dor/datastreams/version_metadata_ds.rb

@@ -107,7 +107,7 @@ module Dor
       end
     end
 
-    # @return [Fixnum] value of the most current versionId
+    # @return [String] value of the most current versionId
     def current_version_id
       current_version=current_version_node
       if current_version.nil?
@@ -151,11 +151,6 @@ module Dor
       self.content = ng_xml.to_s
     end
 
-    # @return [String] The value of the greatest versionId
-    def current_version_id
-      current_version_node[:versionId].to_s
-    end
-
     # @return [Boolean] returns true if the current version has a tag and a description, false otherwise
     def current_version_closeable?
       current = current_version_node
@@ -168,9 +163,9 @@ module Dor
 
     # @return [String] The tag for the newest version
     def current_tag
-      current_version_node[:tag].to_s  
+      current_version_node[:tag].to_s
     end
-    
+
     def tag_for_version(versionId)
       nodes=self.ng_xml.search('//version[@versionId=\''+versionId+'\']')
       if nodes.length == 1
@@ -179,6 +174,7 @@ module Dor
         ''
       end
     end
+
     # @return [String] The description for the specified version, or empty string if there is no description
     def description_for_version(versionId)
       nodes=self.ng_xml.search('//version[@versionId=\''+versionId+'\']')
@@ -188,7 +184,7 @@ module Dor
         ''
       end
     end
-    
+
     # @return [String] The description for the current version
     def current_description
       desc_node=current_version_node.at_xpath('description')
@@ -197,7 +193,29 @@ module Dor
       end
       ''
     end
-    
+
+    # Compares the current_version with the passed in known_version (usually SDRs version)
+    #   If the known_version is greater than the current version, then all version nodes greater than the known_version are removed,
+    #   then the current_version is incremented.  This repairs the case where a previous call to open a new verison
+    #   updates the versionMetadata datastream, but versioningWF is not initiated.  Prevents the versions from getting
+    #   out of synch with SDR
+    #
+    # @param [Integer] known_version object version you wish to synch to, usually SDR's version
+    # @param [Hash] opts optional parameters
+    # @option opts [String] :description describes the version change
+    # @option opts [Symbol] :significance which part of the version tag to increment
+    def sync_then_increment_version known_version, opts = {}
+      cv = current_version_id.to_i
+      raise Dor::Exception.new("Cannot sync to a version greater than current: #{cv}, requested #{known_version}") if cv < known_version
+
+      while cv != known_version &&
+        current_version_node.remove
+        cv = current_version_id.to_i
+      end
+
+      increment_version(opts[:description], opts[:significance])
+    end
+
     private
 
     # @return [Nokogiri::XML::Node] Node representing the current version
@@ -210,5 +228,6 @@ module Dor
       tags = find_by_terms(:version, :tag)
       tags.map{|t| VersionTag.parse(t.value)}.max
     end
+
   end
 end