dor-services 5.1.0 → 5.1.1

data/lib/dor/models/presentable.rb

@@ -6,7 +6,7 @@ module Dor
     DC_NS = {"dc"=>"http://purl.org/dc/elements/1.1/", "oai_dc"=>"http://www.openarchives.org/OAI/2.0/oai_dc/"}
 
     def iiif_presentation_manifest_needed? pub_obj_doc
-      if(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="image"]/resource[@type="image"]'))
+      if(pub_obj_doc.at_xpath('/publicObject/contentMetadata[contains(@type,"image") or contains(@type,"map")]/resource[@type="image"]'))
         return true
       elsif(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]/resource[@type="page"]'))
         return true
@@ -32,6 +32,14 @@ module Dor
         '@id'   => "#{purl_base_uri}/iiif/manifest.json",
         'label' => lbl,
         'attribution' => 'Provided by the Stanford University Libraries',
+        'logo' => { 
+          '@id' => "http://stacks.stanford.edu/image/iiif/wy534zh7137%2FSULAIR_rosette/full/400,/0/default.jpg", 
+          'service' => { 
+            '@context' => "http://iiif.io/api/image/2/context.json", 
+            '@id' => "http://stacks.stanford.edu/image/iiif/wy534zh7137%2FSULAIR_rosette", 
+            'profile' => "http://iiif.io/api/image/2/level1.json" 
+            } 
+          },
         'seeAlso' => {
           '@id' => "#{purl_base_uri}.mods",
           'format' => 'application/mods+xml'
@@ -80,7 +88,12 @@ module Dor
 
         canv = IIIF::Presentation::Canvas.new
         canv['@id'] = "#{purl_base_uri}/canvas/canvas-#{count}"
-        canv.label = res_node.at_xpath('label').text
+        label_node = res_node.at_xpath('label')
+        if label_node
+          canv.label = label_node.text
+        else
+          canv.label = "image"
+        end
         canv.height = height
         canv.width = width
 

data/lib/dor/models/processable.rb

@@ -106,6 +106,7 @@ module Dor
       Dor::WorkflowService.get_milestones('dor',self.pid)
     end
 
+    # @return [Hash] including :current_version, :status_code and :status_time
     def status_info()
       current_version = '1'
       begin
@@ -139,8 +140,10 @@ module Dor
       return {:current_version => current_version, :status_code => status_code, :status_time => status_time}
     end
 
+    # @param [Boolean] include_time
+    # @return [String] single composed status from status_info
     def status(include_time=false)
-      status_info_hash = status_info
+      status_info_hash = status_info()
       current_version, status_code, status_time = status_info_hash[:current_version], status_info_hash[:status_code], status_info_hash[:status_time]
 
       #use the translation table to get the appropriate verbage for the latest step
@@ -149,6 +152,13 @@ module Dor
       return result
     end
 
+    # return the text translation of the status code, minus any trailing parenthetical explanation
+    # e.g. 'In accessioning (described)' and 'In accessioning (described, published)' both come back
+    # as 'In accessioning'
+    def simplified_status_code_disp_txt(status_code)
+      return STATUS_CODE_DISP_TXT[status_code].gsub(/\(.*\)$/, '').strip
+    end
+
     def to_solr(solr_doc=Hash.new, *args)
       super(solr_doc, *args)
       sortable_milestones = {}
@@ -171,38 +181,34 @@ module Dor
         timestamp = milestone[:at].utc.xmlschema
         sortable_milestones[milestone[:milestone]] ||= []
         sortable_milestones[milestone[:milestone]] << timestamp
-        add_solr_value(solr_doc, 'lifecycle', milestone[:milestone], :string, [:searchable, :facetable])
-        unless milestone[:version]
-          milestone[:version]=current_version
-        end
-        add_solr_value(solr_doc, 'lifecycle', "#{milestone[:milestone]}:#{timestamp};#{milestone[:version]}", :string, [:displayable])
+        milestone[:version] ||= current_version
+        solr_doc['lifecycle_ssim'] ||= []
+        solr_doc['lifecycle_ssim'] << milestone[:milestone]
+        add_solr_value(solr_doc, 'lifecycle', "#{milestone[:milestone]}:#{timestamp};#{milestone[:version]}", :symbol)
       end
 
       sortable_milestones.each do |milestone, unordered_dates|
         dates = unordered_dates.sort
-        #create the published_dt and published_day fields and the like
-        add_solr_value(solr_doc, milestone+'_day', DateTime.parse(dates.last).beginning_of_day.utc.xmlschema.split('T').first, :string, [:stored_searchable, :facetable])
-        add_solr_value(solr_doc, milestone, dates.first, :date, [:stored_searchable, :facetable])
-
-        #fields for OAI havester to sort on
-        add_solr_value(solr_doc, "#{milestone}_earliest_dt", dates.first, :date, [:sortable])
-        add_solr_value(solr_doc, "#{milestone}_latest_dt",   dates.last,  :date, [:sortable])
-
-        #for future faceting
-        add_solr_value(solr_doc, "#{milestone}_earliest", dates.first, :date, [:searchable, :facetable])
-        add_solr_value(solr_doc, "#{milestone}_latest",   dates.last,  :date, [:searchable, :facetable])
+        #create the published_dttsi and published_day fields and the like
+        dates.each do |date|
+          solr_doc["#{milestone}_dttsim"] ||= []
+          solr_doc["#{milestone}_dttsim"] << date unless solr_doc["#{milestone}_dttsim"].include?(date)
+        end
+        #fields for OAI havester to sort on: _dttsi is trie date +stored +indexed (single valued, i.e. sortable)
+        solr_doc["#{milestone}_earliest_dttsi"] = dates.first
+        solr_doc["#{milestone}_latest_dttsi"  ] = dates.last
       end
-      add_solr_value(solr_doc,"status",status,:string, [:displayable])
+      solr_doc["status_ssi"] = status # status is singular (i.e. the current one)
+      solr_doc["current_version_isi"] = current_version.to_i
+      solr_doc["modified_latest_dttsi"] = self.modified_date.to_datetime.utc.strftime('%FT%TZ')
+      add_solr_value(solr_doc, "rights", rights, :string, [:symbol]) if self.respond_to? :rights
 
-      if sortable_milestones['opened']
-        #add a facetable field for the date when the open version was opened
-        opened_date=sortable_milestones['opened'].sort.last
-        add_solr_value(solr_doc, "version_opened", DateTime.parse(opened_date).beginning_of_day.utc.xmlschema.split('T').first, :string, [ :searchable, :facetable])
-      end
-      add_solr_value(solr_doc, "current_version", current_version.to_s, :string, [ :displayable , :facetable])
-      add_solr_value(solr_doc, "last_modified_day", self.modified_date.to_s.split('T').first, :string, [ :facetable ])
-      add_solr_value(solr_doc, "rights", rights, :string, [:facetable]) if self.respond_to? :rights
-      solr_doc
+      status_info_hash = status_info()
+      status_code = status_info_hash[:status_code]
+      add_solr_value(solr_doc, 'processing_status_text', simplified_status_code_disp_txt(status_code), :string, [:stored_sortable])
+      solr_doc['processing_status_code_isi'] = status_code # no _isi in Solrizer's default descriptors
+
+      return solr_doc
     end
 
     # Initilizes workflow for the object in the workflow service
@@ -213,13 +219,11 @@ module Dor
     # @param [Integer] priority the workflow's priority level
     def initialize_workflow(name, create_ds=true, priority=0)
       priority = workflows.current_priority if priority == 0
-      opts = { :create_ds => create_ds }
+      opts = { :create_ds => create_ds, :lane_id => default_workflow_lane }
       opts[:priority] = priority if(priority > 0)
-      opts[:lane_id] = default_workflow_lane
       Dor::WorkflowService.create_workflow(Dor::WorkflowObject.initial_repo(name), self.pid, name, Dor::WorkflowObject.initial_workflow(name), opts)
     end
 
-
     private
     #handles formating utc date/time to human readable
     # XXX: bad form to hardcode TZ here.  Code smell abounds.

data/lib/dor/models/publishable.rb

@@ -8,17 +8,7 @@ module Dor
     include Describable
     include Itemizable
     include Presentable
-
-    included do
-      has_metadata :name => "rightsMetadata", :type => ActiveFedora::OmDatastream, :label => 'Rights Metadata'
-    end
-
-    def build_rightsMetadata_datastream(ds)
-      content_ds = self.admin_policy_object.datastreams['defaultObjectRights']
-      ds.dsLabel = 'Rights Metadata'
-      ds.ng_xml = content_ds.ng_xml.clone
-      ds.content = ds.ng_xml.to_xml
-    end
+    include Rightsable
 
     def public_relationships
       include_elements = ['fedora:isMemberOf','fedora:isMemberOfCollection']
@@ -43,7 +33,7 @@ module Dor
 
       im=self.datastreams['identityMetadata'].ng_xml.clone
       im.search('//release').each {|node| node.remove} # remove any <release> tags from public xml which have full history
-      im.root.add_child(release_xml)  # now add in final <release> tag  #TODO:  Adding this breaks tests, rework these
+      im.root.add_child(release_xml) 
 
       pub.add_child(im.root) # add in modified identityMetadata datastream
       pub.add_child(self.datastreams['contentMetadata'].public_xml.root.clone)
@@ -53,7 +43,8 @@ module Dor
       pub.add_child(rels.clone) unless rels.nil? # TODO: Should never be nil in practice; working around an ActiveFedora quirk for testing
       pub.add_child(self.generate_dublin_core.root.clone)
       @public_xml_doc = pub # save this for possible IIIF Presentation manifest
-      pub.add_child(Nokogiri(self.generate_release_xml).root.clone)  #TODO:  Adding this breaks tests, rework these
+      pub.add_child(Nokogiri(self.generate_release_xml).root.clone) unless release_xml.children.size == 0 #If there are no release_tags, this prevents an empty <releaseData/> from being added
+      #Note we cannot base this on if an individual object has release tags or not, because the collection may cause one to be generated for an item, so we need to calculate it and then look at the final result
       new_pub = Nokogiri::XML(pub.to_xml) { |x| x.noblanks }
       new_pub.encoding = 'UTF-8'
       new_pub.to_xml
@@ -89,4 +80,4 @@ module Dor
     end
   end
 
-end
+end

data/lib/dor/models/{releasable.rb → releaseable.rb}

@@ -2,21 +2,43 @@ require 'open-uri'
 require 'retries'
 
 module Dor
-  module Releasable
+  module Releaseable
     extend ActiveSupport::Concern
     include Itemizable
+        
+    #Add release tags to an item and initialize the item release workflow
+    #
+    #@params release_tags [Hash or Array] Either a hash of a single release tag.  Each tag should be in the form of {:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket', :release=>true/false}
+    #
+    #@raise [ArgumentError] Raised if the tags are improperly supplied
+    #
+    #
+    def add_release_nodes_and_start_releaseWF(release_tags)
+      release_tags = [release_tags] unless release_tags.class == Array
+      
+      #Add in each tag
+      release_tags.each do |r_tag|
+        self.add_release_node(r_tag[:release],r_tag)
+      end
+      
+      #Save the item to dor so the robots work with the latest data
+      self.save 
+      
+      #Intialize the release workflow
+      self.initialize_workflow('releaseWF') 
+    end
 
-    #Generate XML structure for inclusion to Purl 
+    #Generate XML structure for inclusion to Purl
     #
     #@return [String] The XML release node as a string, with ReleaseDigest as the root document
     def generate_release_xml
       builder = Nokogiri::XML::Builder.new do |xml|
-        xml.ReleaseData {
+        xml.releaseData {
           self.released_for.each do |project,released_value|
             xml.release(released_value["release"],:to=>project)
           end  
-        }        
-      end
+        }
+        end
       return builder.to_xml
     end
     
@@ -91,7 +113,7 @@ module Dor
     #@return [Hash] the combined hash with uniquiness enforced 
     def combine_two_release_tag_hashes(hash_one, hash_two)
       hash_two.keys.each do |key|
-        hash_one[key] = hash_two[key] if hash_one[key].nil?
+        hash_one[key] = hash_two[key] if hash_one[key] == nil
         hash_one[key] = (hash_one[key] + hash_two[key]).uniq if hash_one[key] != nil
       end
       return hash_one
@@ -161,9 +183,9 @@ module Dor
     #@return [Boolean] true or false if it applies (not true or false if it is released, that is the release_tag data)
     def does_release_tag_apply(release_tag, admin_tags=false)
       #Is the tag global or restricted 
-      return true if release_tag['tag'].nil?  #there is no specific tag specificied, so that means this tag is global to all members of the collection, it applies, return true
+      return true if release_tag['tag'] == nil  #there is no specific tag specificied, so that means this tag is global to all members of the collection, it applies, return true
         
-      admin_tags = self.tags unless admin_tags #We use false instead of [], since an item can have no admin_tags that which point we'd be passing down this variable as [] and would not an attempt to retrieve it
+      admin_tags = self.tags if ! admin_tags #We use false instead of [], since an item can have no admin_tags that which point we'd be passing down this variable as [] and would not an attempt to retrieve it
       return admin_tags.include?(release_tag['tag'])
     end
     
@@ -256,17 +278,24 @@ module Dor
     #
     #@return [Nokogiri::XML::Element] the tag added if successful 
     #
-    #@raise [RuntimeError] Raised if attributes are improperly supplied
+    #@raise [ArgumentError] Raised if attributes are improperly supplied
     #
     #@params tag [Boolean] True or false for the release node
     #@params attrs [hash]  A hash of any attributes to be placed onto the tag 
+    #Timestamp will be calculated by the function, if no displayType is passed in, it will default to file
+    #
     #@example
-    #  item.add_tag(true,:release,{:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket'})
+    #  item.add_tag(true,:release,{:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket', :displayType='filmstrip'})
     def add_release_node(release, attrs={})
       identity_metadata_ds = self.identityMetadata
-      attrs[:when] = Time.now.utc.iso8601 if attrs[:when] == nil#add the timestamp
+      attrs[:when] = Time.now.utc.iso8601 if attrs[:when].nil? #add the timestamp
+      attrs[:displayType] = 'file' if attrs[:displayType].nil? #default to file is no display type is passed
       valid_release_attributes(release, attrs)
   
+      #Remove the old displayType and then add the one for this tag
+      remove_displayTypes
+      identity_metadata_ds.add_value(:displayType, attrs[:displayType], {})
+      
       return identity_metadata_ds.add_value(:release, release.to_s, attrs)
     end
 
@@ -282,15 +311,15 @@ module Dor
       [:who, :to, :what].each do |check_attr|
         raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
       end
-  
+
       what_correct = false
       ['self', 'collection'].each do |allowed_what_value|
         what_correct = true if attrs[:what] == allowed_what_value
       end
       raise ArgumentError, ":what must be self or collection" if ! what_correct
-  
       raise ArgumentError, "the value set for this tag is not a boolean" if !!tag != tag
-      #identity_metadata_ds = self.identityMetadata
+      raise ArgumentError, ":displayType must be passed in as a String" unless attrs[:displayType].class == String
+      
       validate_tag_format(attrs[:tag]) if attrs[:tag] != nil #Will Raise exception if invalid tag
       return true
     end
@@ -387,10 +416,25 @@ module Dor
       tags_currently_in_purl = self.get_release_tags_from_purl
       missing_tags = tags_currently_in_purl.map(&:downcase) - new_tags.keys.map(&:downcase) 
       missing_tags.each do |missing_tag|
-        new_tags[missing_tag.capitalize] = false
+        new_tags[missing_tag.capitalize] = {"release"=>false}
       end
       return new_tags
     end
 
+    def to_solr(solr_doc=Hash.new, *args)
+      super(solr_doc, *args)
+
+      #TODO: sort of worried about the performance impact in bulk reindex 
+      # situations, since released_for recurses all parent collections.  jmartin 2015-07-14
+      released_for().each { |key, val|
+        add_solr_value(solr_doc, "released_to", key, :symbol, []) if val
+      }
+
+      #TODO: need to solrize whether item is released to purl?  does released_for 
+      # return that?  logic is:  "True when there is a published lifecycle and Access 
+      # Rights is anything but Dark"
+
+      return solr_doc
+    end
   end
 end

data/lib/dor/models/rightsable.rb

@@ -0,0 +1,25 @@
+module Dor
+  module Rightsable
+    extend ActiveSupport::Concern
+
+    included do
+      has_metadata :name => 'rightsMetadata', :type => Dor::RightsMetadataDS, :label => 'Rights metadata'
+    end
+
+    def build_rightsMetadata_datastream(ds)
+      content_ds = self.admin_policy_object.datastreams['defaultObjectRights']
+      ds.dsLabel = 'Rights Metadata'
+      ds.ng_xml = content_ds.ng_xml.clone
+      ds.content = ds.ng_xml.to_xml
+    end
+
+    def world_doc
+      return Nokogiri::XML::Builder.new do |xml|
+        xml.access(:type => 'read') {
+          xml.machine { xml.world }
+        }
+      end.doc
+    end
+
+  end
+end

data/lib/dor/models/versionable.rb

@@ -1,8 +1,9 @@
+require 'dor/utils/sdr_client'
+
 module Dor
   module Versionable
     extend ActiveSupport::Concern
-    include Processable
-    include Upgradable
+    include Processable # implies Upgradable
 
     included do
       has_metadata :name => 'versionMetadata', :type => Dor::VersionMetadataDS, :label => 'Version Metadata', :autocreate => true
@@ -24,8 +25,10 @@ module Dor
       raise Dor::Exception, 'Object already opened for versioning' if(new_version_open?)
       raise Dor::Exception, 'Object currently being accessioned' if(Dor::WorkflowService.get_active_lifecycle('dor', pid, 'submitted'))
 
+      sdr_version = Sdr::Client.current_version pid
+
       vmd_ds = datastreams['versionMetadata']
-      vmd_ds.increment_version
+      vmd_ds.sync_then_increment_version sdr_version
       vmd_ds.content = vmd_ds.ng_xml.to_s
       vmd_ds.save unless self.new_object?
 

data/lib/dor/models/workflow_object.rb

@@ -12,7 +12,7 @@ module Dor
     has_metadata :name => "workflowDefinition", :type => Dor::WorkflowDefinitionDs, :label => 'Workflow Definition'
 
     def self.find_by_name(name, opts={})
-      Dor.find_all(%{#{Solrizer.solr_name "objectType", :facetable}:"#{self.object_type}" #{Solrizer.solr_name "workflow_name", :symbol}:"#{name}"}, opts).first
+      Dor.find_all(%{#{Solrizer.solr_name "objectType", :symbol}:"#{self.object_type}" #{Solrizer.solr_name "workflow_name", :symbol}:"#{name}"}, opts).first
     end
 
     # Searches for the workflow definition object in DOR, then
@@ -51,7 +51,7 @@ module Dor
       client = Dor::WorkflowService.workflow_resource
       xml = client["workflow_archive?repository=#{definition.repo}&workflow=#{definition.name}&count-only=true"].get
       count = Nokogiri::XML(xml).at_xpath('/objects/@count').value
-      add_solr_value(solr_doc,"#{definition.name}_archived",count,:integer,[:displayable])
+      solr_doc["#{definition.name}_archived_isi"] = count
       solr_doc
     end
 
@@ -62,7 +62,7 @@ module Dor
     alias_method :generate_intial_workflow, :generate_initial_workflow
 
     # Searches DOR for the workflow definition object.  It then caches the workflow repository and xml
-    # @param [String] naem the name of the workflow
+    # @param [String] name the name of the workflow
     def self.find_and_cache_workflow_xml_and_repo name
       wobj = self.find_by_name(name)
       wf_xml = wobj.generate_initial_workflow
@@ -71,4 +71,4 @@ module Dor
     end
 
   end
-end
+end

data/lib/dor/services/cleanup_reset_service.rb

@@ -43,8 +43,7 @@ module Dor
     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 [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)

data/lib/dor/services/cleanup_service.rb

@@ -61,7 +61,7 @@ module Dor
     end
 
     def self.cleanup_stacks(druid)
-      DruidTools::StacksDruid.new(druid, Config.stacks.local_storage_root).prune!
+      DruidTools::StacksDruid.new(druid, Config.stacks.local_stacks_root).prune!
     end
 
     def self.cleanup_purl_doc_cache(druid)

data/lib/dor/services/registration_service.rb

@@ -1,7 +1,6 @@
 require 'uuidtools'
 
 module Dor
-
   class RegistrationService
 
     class << self
@@ -173,7 +172,5 @@ module Dor
         end
       end
     end
-
   end
-
 end