dor-services 5.10.4 → 5.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c643c1a3d63b56fd2e74475941e379a93a7220a
-  data.tar.gz: 7b7f607b5a01f5acf6b3e876e59f9954e4ae0782
+  metadata.gz: b43e614c997ae6368c5a7b14cc78ce07ae8cbfc8
+  data.tar.gz: aa9935c4a84262fcd5f6f8b18f3f8eead8530a5c
 SHA512:
-  metadata.gz: fb4b9b98f90f2b21061f5b563d1574434baa47894f3d8cc0abc2d7fef9e667633272c431198ed75c6d388be8262c6ca1d3274b06f96e31ea3c88fef30bbbed8c
-  data.tar.gz: 66b565537443097f8b2bc32538cad5bffbdc3bb97595dd28cca1cdd2801981c07e936ca73bde863fd8d9ef57a9f673dd877742e289d8bcd93fe40562470b398e
+  metadata.gz: cde8359eab91eaa96ff7773ec814b0bcfafa8a6e208c7179aa8b82bfb050b1bce9b853b7d705b38265e300482813c9f72cacf6e3e83e4de091e8c8b34bc7f412
+  data.tar.gz: 3cc30b9150f706c3f97858c6bf8109d6529f24f16b24d242f9bfa4cb38fddd287fc63c5893632a46cdab336633568ef5e168d8f8c0b11589ba10d5e25164a50c

data/lib/dor/models/identifiable.rb

@@ -205,6 +205,25 @@ module Dor
       desc_md_ds_title.present? ? desc_md_ds_title : default_title
     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
+
     private
 
     def solrize_related_obj_titles(solr_doc, relationships, title_hash, union_field_name, nonhydrus_field_name, hydrus_field_name)

data/lib/dor/models/publishable.rb

@@ -10,6 +10,59 @@ module Dor
     include Itemizable
     include Rightsable
 
+    # Compute the thumbnail for this object following the rules at https://consul.stanford.edu/display/chimera/The+Rules+of+Thumb
+    # @return [String] the computed thumb filename, with the druid prefix and a slash in front of it, e.g. oo000oo0001/filenamewith space.jp2
+    def thumb
+       return if contentMetadata.nil?
+       cm = contentMetadata.ng_xml
+       mime_type_finder = "@mimetype='image/jp2' or @mimeType='image/jp2'" # allow the mimetype attribute to be lower or camelcase when searching to make it more robust
+       thumb_image=nil
+
+       # these are the finders we will use to search for a thumb resource in contentMetadata, they will be searched in the order provided, stopping when one is reached
+       thumb_xpath_finders = [
+           {image_type: 'local', finder: "/contentMetadata/resource[@type='thumb' and @thumb='yes']/file[#{mime_type_finder}]"},      # first find a file of mimetype jp2 explicitly marked as a thumb in the resource type and with a thumb=yes attribute
+           {image_type: 'external', finder: "/contentMetadata/resource[@type='thumb' and @thumb='yes']/externalFile[#{mime_type_finder}]"}, # same thing for external files
+           {image_type: 'local', finder: "/contentMetadata/resource[(@type='page' or @type='image') and @thumb='yes']/file[#{mime_type_finder}]"},# next find any image or page resource types with the thumb=yes attribute of mimetype jp2
+           {image_type: 'external', finder: "/contentMetadata/resource[(@type='page' or @type='image') and @thumb='yes']/externalFile[#{mime_type_finder}]"},# same thing for external file
+           {image_type: 'local', finder: "/contentMetadata/resource[@type='thumb']/file[#{mime_type_finder}]"}, # next find a file of mimetype jp2 and resource type=thumb but not marked with the thumb directive
+           {image_type: 'external', finder: "/contentMetadata/resource[@type='thumb']/externalFile[#{mime_type_finder}]"}, # same thing for external file
+           {image_type: 'local', finder: "/contentMetadata/resource[@type='page' or @type='image']/file[#{mime_type_finder}]"}, # finally find the first page or image resource of mimetype jp2
+           {image_type: 'external', finder: "/contentMetadata/resource[@type='page' or @type='image']/externalFile[#{mime_type_finder}]"} # same thing for external file
+         ]
+              
+       thumb_xpath_finders.each do |search_path|
+         thumb_files = cm.xpath(search_path[:finder]) # look for a thumb  
+         if thumb_files.size > 0   # if we find one, return the filename based on whether it is a local file or external file
+           if search_path[:image_type] == 'local'
+             thumb_image="#{remove_druid_prefix}/#{thumb_files[0]['id']}"
+           else
+             thumb_image="#{remove_druid_prefix(thumb_files[0]['objectId'])}/#{thumb_files[0]['fileId']}"
+           end
+           break  # break out of the loop so we stop searching
+         end
+       end 
+              
+       thumb_image
+    end
+
+    # Return a URI encoded version of the thumb image for use by indexers (leaving the extension of the filename)
+    # @return [String] URI encoded version of the thumb with the druid prefix, e.g. oo000oo0001%2Ffilenamewith%20space.jp2
+    def encoded_thumb
+      thumb_image = thumb # store the result locally, so we don't have to compute each time we use it below
+      return unless thumb_image
+      thumb_druid=thumb_image.split('/').first # the druid (before the first slash)
+      thumb_filename=thumb_image.split(/#{pid_regex}[\/]/).last # everything after the druid
+      "#{thumb_druid}%2F#{URI.escape(thumb_filename)}"
+    end
+    
+    # Return a full qualified thumbnail image URL if the thumb is computable
+    # @return [String] fully qualified image URL for the computed thumbnail, e.g. https://stacks.stanford.edu/image/iiif/oo000oo0001%2Ffilenamewith%20space/full
+    def thumb_url
+      return unless encoded_thumb
+      thumb_basename=File.basename(encoded_thumb, File.extname(encoded_thumb)) # strip the extension for URL generation
+      "https://#{Dor::Config.stacks.host}/image/iiif/#{thumb_basename}/full/!400,400/0/default.jpg"
+    end
+    
     def public_relationships
       include_elements = ['fedora:isMemberOf', 'fedora:isMemberOfCollection', 'fedora:isConstituentOf']
       rels_doc = Nokogiri::XML(datastreams['RELS-EXT'].content)
@@ -41,9 +94,11 @@ module Dor
       rels = public_relationships.root
       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(generate_dublin_core.root.clone)
+      pub.add_child(Nokogiri::XML(generate_public_desc_md).root.clone) if metadata_format == 'mods'
       pub.add_child(Nokogiri(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.s
+      pub.add_child(Nokogiri("<thumb>#{thumb}</thumb>").root.clone) unless thumb.nil?
       new_pub = Nokogiri::XML(pub.to_xml) { |x| x.noblanks }
       new_pub.encoding = 'UTF-8'
       new_pub.to_xml

data/lib/dor/models/releaseable.rb

@@ -284,14 +284,6 @@ module Dor
       end
     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_prefix = 'druid:'
-      return id.split(druid_prefix)[1] if id.split(druid_prefix).size > 1
-      druid
-    end
-
     # Take the and create the entire purl url that will usable for the open method in open-uri, returns http
     # @return [String] the full url
     def form_purl_url

data/lib/dor/version.rb

@@ -1,3 +1,3 @@
 module Dor
-  VERSION = '5.10.4'.freeze
+  VERSION = '5.11.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services
 version: !ruby/object:Gem::Version
-  version: 5.10.4
+  version: 5.11.0
 platform: ruby
 authors:
 - Michael Klein
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora