hyrax 5.2.0 → 5.3.0

data/app/presenters/hyrax/annotates_content.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module AnnotatesContent
+    extend ActiveSupport::Concern
+
+    include DisplaysTranscripts
+
+    def annotation_content
+      transcription_content if video? || audio?
+    end
+
+    private
+
+    def transcription_content
+      transcripts.map do |doc|
+        options = {
+          type: 'Text',
+          motivation: 'supplementing',
+          body_id: transcript_url(doc, host: hostname, file_ext: file_ext(doc.mime_type)),
+          format: doc.mime_type,
+          label: doc.title_or_label
+        }
+        options[:language] = language_code(doc.language) if language_code(doc.language)
+        IIIFManifest::V3::AnnotationContent.new(**options)
+      end
+    end
+
+    # If you change the accepted mime types in Hyrax::TranscriptsBehavior,
+    # you may also want to override this method
+    def file_ext(_mime_type)
+      "vtt"
+    end
+  end
+end

data/app/presenters/hyrax/collection_presenter.rb

@@ -25,7 +25,7 @@ module Hyrax
 
     # CurationConcern methods
     delegate :stringify_keys, :human_readable_type, :collection?, :representative_id,
-             :to_s, to: :solr_document
+             :to_s, :schema_version, to: :solr_document
 
     delegate(*Hyrax::CollectionType.settings_attributes, to: :collection_type, prefix: :collection_type_is)
     alias nestable? collection_type_is_nestable?
@@ -129,6 +129,10 @@ module Hyrax
       current_ability.can?(:deposit, solr_document)
     end
 
+    def editor?
+      current_ability.can?(:edit, self)
+    end
+
     def user_can_create_new_nest_collection?
       current_ability.can?(:create_collection_of_type, collection_type)
     end

data/app/presenters/hyrax/displays_content.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # rubocop:disable Metrics/ModuleLength
+  module DisplaysContent
+    extend ActiveSupport::Concern
+    # Creates a display content only where FileSet is an image, audio, or video.
+    #
+    # @return [IIIFManifest::V3::DisplayContent] the display content required by the manifest builder.
+    def display_content
+      return nil unless ability.can?(:read, object)
+
+      return image_content if image?
+      return video_content if video? && Flipflop.iiif_av?
+      return audio_content if audio? && Flipflop.iiif_av?
+      return pdf_content if pdf? && Flipflop.iiif_pdf?
+    end
+
+    private
+
+    def content_supported?
+      video? || audio? || image? || pdf?
+    end
+
+    def image_content
+      return nil unless latest_file_id
+      # Only provide v3 content when using v3 factory
+      # Otherwise let display_image handle v2
+      return nil unless Hyrax.config.iiif_manifest_factory == ::IIIFManifest::V3::ManifestFactory
+
+      url = Hyrax.config.iiif_image_url_builder.call(
+        latest_file_id,
+        hostname,
+        Hyrax.config.iiif_image_size_default,
+        image_format(alpha_channels)
+      )
+
+      image_content_v3(url)
+    end
+
+    def image_content_v3(url)
+      # @see https://github.com/samvera-labs/iiif_manifest
+      IIIFManifest::V3::DisplayContent.new(
+        url,
+        format: image_format(alpha_channels),
+        width: width,
+        height: height,
+        type: 'Image',
+        iiif_endpoint: iiif_endpoint(latest_file_id)
+      )
+    end
+
+    def video_content
+      # @see https://github.com/samvera-labs/iiif_manifest
+      IIIFManifest::V3::DisplayContent.new(
+        download_path('mp4'),
+        label: 'mp4',
+        width: Array(width).first.try(:to_i),
+        height: Array(height).first.try(:to_i),
+        duration: conformed_duration,
+        type: 'Video',
+        format: mime_type,
+        thumbnail: thumbnail
+      )
+    end
+
+    def audio_content
+      IIIFManifest::V3::DisplayContent.new(
+        download_path('mp3'),
+        label: 'mp3',
+        duration: conformed_duration,
+        type: 'Sound',
+        # I think UV has a bug where if it's 'audio/mpeg' then it would load, so adding this
+        # workaround to use 'audio/mp3' (which isn't even an official MIME type).
+        format: Hyrax.config.iiif_av_viewer == :universal_viewer ? 'audio/mp3' : mime_type,
+        thumbnail: [{
+          id: "#{hostname}/assets/audio.png",
+          type: 'Image',
+          format: 'image/png'
+        }]
+      )
+    end
+
+    def pdf_content
+      IIIFManifest::V3::DisplayContent.new(
+        download_path('pdf'),
+        label: 'pdf',
+        type: 'Text',
+        format: mime_type,
+        thumbnail: thumbnail
+      )
+    end
+
+    def download_path(extension)
+      Hyrax::Engine.routes.url_helpers.download_url(object, file: extension, host: hostname)
+    end
+
+    def thumbnail
+      [{
+        id: download_path('thumbnail'),
+        type: 'Image',
+        format: 'image/jpeg'
+      }]
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def conformed_duration
+      duration_string = Array(object.duration).first
+      return nil if duration_string.blank?
+
+      # Handle values with explicit seconds unit (e.g., "25 s")
+      return duration_string.to_f if duration_string.match?(/\A[\d.]+\s*s\z/)
+      # Handle plain millisecond values (e.g., "120000")
+      return duration_string.to_f / 1000.0 unless duration_string.include?(':')
+
+      # Parse time-formatted strings
+      parts = duration_string.split(':').map(&:to_i)
+
+      case parts.length
+      when 2 # MM:SS
+        parts[0] * 60.0 + parts[1]
+      when 3 # H:MM:SS
+        parts[0] * 3600.0 + parts[1] * 60.0 + parts[2]
+      when 4 # H:MM:SS:mmm (milliseconds)
+        parts[0] * 3600.0 + parts[1] * 60.0 + parts[2] + (parts[3] / 1000.0)
+      else
+        duration_string.to_f # fallback
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+  # rubocop:enable Metrics/ModuleLength
+end

data/app/presenters/hyrax/displays_image.rb

@@ -15,7 +15,7 @@ module Hyrax
       return nil unless latest_file_id
 
       # @see https://github.com/samvera-labs/iiif_manifest
-      IIIFManifest::DisplayImage.new(display_image_url(request.base_url),
+      IIIFManifest::DisplayImage.new(display_image_url,
                                      format: image_format(alpha_channels),
                                      width: width,
                                      height: height,
@@ -24,7 +24,12 @@ module Hyrax
 
     private
 
-    def display_image_url(base_url)
+    def base_url_for_iiif
+      respond_to?(:request) && request ? request.base_url : hostname
+    end
+
+    def display_image_url(base_url = nil)
+      base_url ||= base_url_for_iiif
       Hyrax.config.iiif_image_url_builder.call(
         latest_file_id,
         base_url,
@@ -33,8 +38,10 @@ module Hyrax
       )
     end
 
-    def iiif_endpoint(file_id, base_url: request.base_url)
+    def iiif_endpoint(file_id, base_url: nil)
       return unless Hyrax.config.iiif_image_server?
+      base_url ||= base_url_for_iiif
+
       IIIFManifest::IIIFEndpoint.new(
         Hyrax.config.iiif_info_url_builder.call(file_id, base_url),
         profile: Hyrax.config.iiif_image_compliance_level_uri
@@ -42,7 +49,7 @@ module Hyrax
     end
 
     def image_format(channels)
-      channels&.include?('rgba') ? 'png' : 'jpg'
+      channels&.include?('rgba') ? 'image/png' : 'image/jpeg'
     end
 
     ##

data/app/presenters/hyrax/displays_transcripts.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module Hyrax
+  module DisplaysTranscripts
+    extend ActiveSupport::Concern
+
+    # @return [Array<SolrDocument>] the solr documents represented by
+    # the audio/video file set's transcript_ids
+    def transcripts
+      return [] if transcript_ids.blank?
+      @transcripts ||= begin
+                          results = Hyrax::SolrQueryService.new
+                                                           .accessible_by(
+                                                             ability: (try(:current_ability) || ability),
+                                                             action: :read
+                                                           )
+                                                           .with_ids(ids: transcript_ids)
+                                                           .solr_documents
+                          sort_transcripts_by_language(results)
+                        end
+    end
+
+    def transcript_url(document, host: request.base_url, file_ext: "vtt")
+      Hyrax::Engine.routes.url_helpers.transcript_url(document.id, host: host, file_ext: file_ext)
+    end
+
+    # Try our best to convert language field to an ISO 639-1 code for use in the IIIF manifest.
+    # @param [Array<String>] - a solr document's language field. Parseable values include an ISO 639-1 code,
+    #                          an ISO 639-3 code, or the English name for a language
+    #                          Examples: https://github.com/scsmith/language_list#examples
+    # @return [String or NilClass] - the 2-letter code, or nil if no value or value is unparseable
+    def language_code(language)
+      return if language.empty?
+      value = language.first
+      if URI.parse(value).scheme
+        # This is probably a Library of Congress languages URI
+        # like http://id.loc.gov/vocabulary/iso639-3/eng, which can
+        # be configured with the Questioning Authority gem.
+        # Try to extract the code from the URI.
+        LanguageList::LanguageInfo.find(value.split("/").last).try(:iso_639_1)
+      else
+        # Otherwise, assume it is a language code or name and try
+        # to convert it to a 2-letter code
+        LanguageList::LanguageInfo.find(value).try(:iso_639_1)
+      end
+    end
+
+    private
+
+    def sort_transcripts_by_language(results)
+      current_locale = I18n.locale.to_s
+
+      # Sort alphabetically by language code
+      sorted = results.sort_by { |doc| language_code(doc.language) || '' }
+
+      # Move current locale to front
+      sorted.partition { |doc| language_code(doc.language) == current_locale }.flatten
+    end
+  end
+end

data/app/presenters/hyrax/file_set_presenter.rb

@@ -6,6 +6,8 @@ module Hyrax
     include CharacterizationBehavior
     include WithEvents
     include DisplaysImage
+    include MissingMethodBehavior
+    include DisplaysTranscripts
 
     attr_accessor :solr_document, :current_ability, :request
 
@@ -18,29 +20,17 @@ module Hyrax
       @request = request
     end
 
-    # CurationConcern methods
-    delegate :stringify_keys, :human_readable_type, :collection?, :image?, :video?,
-             :audio?, :pdf?, :office_document?, :representative_id, :to_s,
-             :extensions_and_mime_types, to: :solr_document
-
-    # Methods used by blacklight helpers
-    delegate :has?, :first, :fetch, to: :solr_document
-
-    # Metadata Methods
-    delegate :title, :label, :description, :creator, :contributor, :subject,
-             :publisher, :language, :date_uploaded,
-             :embargo_release_date, :lease_expiration_date,
-             :depositor, :keyword, :title_or_label, :keyword,
-             :date_created, :date_modified, :itemtype,
-             :original_file_id,
-             to: :solr_document
-
+    delegate :to_s, to: :solr_document
     delegate :member_of_collection_ids, to: :parent
 
     def workflow
       nil
     end
 
+    def model
+      solr_document.to_model
+    end
+
     def single_use_links
       @single_use_links ||= SingleUseLink.where(item_id: id).map { |link| link_presenter_class.new(link) }
     end
@@ -109,7 +99,7 @@ module Hyrax
     ##
     # @return [Array<String>]
     def show_partials
-      ['show_details']
+      %w[show_details metadata]
     end
 
     private

data/app/presenters/hyrax/google_scholar_presenter.rb

@@ -82,5 +82,44 @@ module Hyrax
     def title
       Array(object.try(:title)).sort.first || ""
     end
+
+    ##
+    # @return [String] a string representing the degree granting institution(s)
+    #   as a semicolon delimited list
+    def degree_grantor
+      Array(object.try(:degree_grantor)).join('; ')
+    end
+
+    ##
+    # @return [String] a string representing the journal title
+    def journal_title
+      Array(object.try(:journal_title)).first || ''
+    end
+
+    ##
+    # @return [String] a string representing the journal volume
+    def volume
+      Array(object.try(:journal_volume)).first || ''
+    end
+
+    ##
+    # @return [String] a string representing the journal issue
+    def issue
+      Array(object.try(:journal_issue)).first || ''
+    end
+
+    ##
+    # @return [String] a string representing the first page
+    def first_page
+      Array(object.try(:page_start)).first || ''
+    end
+    alias firstpage first_page
+
+    ##
+    # @return [String] a string representing the last page
+    def last_page
+      Array(object.try(:page_end)).first || ''
+    end
+    alias lastpage last_page
   end
 end

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -63,7 +63,7 @@ module Hyrax
     ##
     # @return [Array<DisplayImagePresenter>]
     def file_set_presenters
-      member_presenters.select(&:file_set?)
+      member_presenters.select { |p| p.file_set? && (p.display_image || p.display_content) }
     end
 
     ##
@@ -119,14 +119,29 @@ module Hyrax
     ##
     # @return [Array<Hash{String => String}>]
     def sequence_rendering
-      Array(try(:rendering_ids)).map do |file_set_id|
-        rendering = file_set_presenters.find { |p| p.id == file_set_id }
+      Array(try(:rendering_ids)).filter_map do |file_set_id|
+        rendering = member_presenters.find { |p| p.file_set? && p.id == file_set_id }
         next unless rendering
 
         { '@id' => Hyrax::Engine.routes.url_helpers.download_url(rendering.id, host: hostname),
           'format' => rendering.mime_type.presence || I18n.t("hyrax.manifest.unknown_mime_text"),
           'label' => I18n.t("hyrax.manifest.download_text") + (rendering.label || '') }
-      end.flatten
+      end
+    end
+
+    ##
+    # Provides a link to the work page as the homepage for the object
+    # represented by the IIIF manifest (see
+    # https://iiif.io/api/cookbook/recipe/0047-homepage/).
+    # This can be helpful if the IIIF manifest is reused on an external site.
+    # @return [Array<Hash{String => String}>]
+    def homepage
+      [{
+        'id' => Rails.application.routes.url_helpers.polymorphic_url(model, host: hostname),
+        'type' => 'Text',
+        'format' => 'text/html',
+        'label' => { 'none' => [Array(title).first || ''] }
+      }]
     end
 
     ##
@@ -188,6 +203,8 @@ module Hyrax
       delegate_all
 
       include Hyrax::DisplaysImage
+      include Hyrax::DisplaysContent
+      include Hyrax::AnnotatesContent
 
       ##
       # @!attribute [w] ability
@@ -201,6 +218,7 @@ module Hyrax
       #
       # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
       def display_image
+        return nil if Hyrax.config.iiif_manifest_factory == ::IIIFManifest::V3::ManifestFactory
         return nil unless model.image?
         return nil unless latest_file_id
 

data/app/presenters/hyrax/missing_method_behavior.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Hyrax
+  module MissingMethodBehavior
+    private
+
+    def method_missing(method_name, *args, &block)
+      return solr_document.public_send(method_name, *args, &block) if solr_document.respond_to?(method_name)
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      solr_document.respond_to?(method_name, include_private) || super
+    end
+  end
+end

data/app/presenters/hyrax/pcdm_member_presenter_factory.rb

@@ -108,12 +108,10 @@ module Hyrax
 
     def query_docs(generic_type: nil, ids: object.member_ids)
       query = "{!terms f=id}#{ids.join(',')}"
-      query += "{!term f=generic_type_si}#{generic_type}" if generic_type
-      # works created via ActiveFedora use the _sim field
-      query += "{!term f=generic_type_sim}#{generic_type}" if generic_type
+      query = "(generic_type_si:#{generic_type} OR generic_type_sim:#{generic_type}) AND #{query}" if generic_type
 
       Hyrax::SolrService
-        .post(q: query, rows: 10_000)
+        .post(query, rows: 10_000)
         .fetch('response')
         .fetch('docs')
     end

data/app/presenters/hyrax/work_show_presenter.rb

@@ -3,6 +3,7 @@ module Hyrax
   class WorkShowPresenter
     include ModelProxy
     include PresentsAttributes
+    include MissingMethodBehavior
 
     ##
     # @!attribute [w] member_presenter_factory
@@ -24,12 +25,45 @@ module Hyrax
       @solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(solr_document)
       @current_ability = current_ability
       @request = request
+      define_dynamic_methods if @solr_document.flexible?
     end
 
+    def define_dynamic_methods # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      Hyrax::FlexibleSchema.default_properties.each do |prop|
+        method_name = prop.to_s
+        property_details = Hyrax::FlexibleSchema.current_version["properties"][method_name]
+        next unless property_details
+
+        index_keys = property_details["indexing"]
+        next unless index_keys
+
+        multi_value = property_details['multiple'] || (property_details['data_type'] == 'array')
+
+        next if self.class.method_defined?(method_name) && solr_document.respond_to?(method_name)
+        # Define the method on the SolrDocument class
+        Hyrax::SolrDocument::OrderedMembers.send(:define_method, method_name) do |*_args|
+          index_keys.each do |index_key|
+            value = self[index_key]
+            return (multi_value ? Array.wrap(value) : value) if value.present?
+          end
+          multi_value ? [] : ""
+        end
+
+        # Define the method on the Presenter class
+        self.class.send(:define_method, method_name) do |*args|
+          @solr_document.send(method_name, *args)
+        end
+      end
+    end # rubocop:enable Metrics/MethodLength
+
     # We cannot rely on the method missing to catch this delegation.  Because
     # most all objects implicitly implicitly implement #to_s
     delegate :to_s, to: :solr_document
 
+    def schema_version
+      solr_document[:schema_version_ssi]
+    end
+
     def page_title
       "#{human_readable_type} | #{title.first} | ID: #{id} | #{I18n.t('hyrax.product_name')}"
     end
@@ -50,11 +84,9 @@ module Hyrax
 
     # @return [Boolean] render a IIIF viewer
     def iiif_viewer?
-      Hyrax.config.iiif_image_server? &&
-        representative_id.present? &&
+      representative_id.present? &&
         representative_presenter.present? &&
-        representative_presenter.image? &&
-        members_include_viewable_image?
+        (av_viewable? || image_viewable? || pdf_viewable?)
     end
 
     alias universal_viewer? iiif_viewer?
@@ -74,7 +106,11 @@ module Hyrax
     #   <h3>My IIIF Viewer!</h3>
     #   <a href=<%= main_app.polymorphic_url([main_app, :manifest, presenter], { locale: nil }) %>>Manifest</a>
     def iiif_viewer
-      :universal_viewer
+      if representative_presenter.present? && av_viewable?
+        Hyrax.config.iiif_av_viewer
+      else
+        :universal_viewer
+      end
     end
 
     # @return FileSetPresenter presenter for the representative FileSets
@@ -246,15 +282,6 @@ module Hyrax
 
     private
 
-    def method_missing(method_name, *args, &block)
-      return solr_document.public_send(method_name, *args, &block) if solr_document.respond_to?(method_name)
-      super
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      solr_document.respond_to?(method_name, include_private) || super
-    end
-
     # list of item ids to display is based on ordered_ids
     def authorized_item_ids(filter_unreadable: Flipflop.hide_private_items?)
       @member_item_list_ids ||=
@@ -320,5 +347,20 @@ module Hyrax
     def members_include_viewable_image?
       file_set_presenters.any? { |presenter| presenter.image? && current_ability.can?(:read, presenter.id) }
     end
+
+    def av_viewable?
+      return false unless Flipflop.iiif_av?
+      representative_presenter.video? || representative_presenter.audio?
+    end
+
+    def image_viewable?
+      return false unless Hyrax.config.iiif_image_server?
+      representative_presenter.image? && members_include_viewable_image?
+    end
+
+    def pdf_viewable?
+      return false unless Flipflop.iiif_pdf?
+      representative_presenter.pdf?
+    end
   end
 end

data/app/renderers/hyrax/renderers/attribute_renderer.rb

@@ -27,7 +27,7 @@ module Hyrax
 
       # Draw the table row for the attribute
       def render
-        return '' if values.blank? && !options[:include_empty]
+        return '' if blank_values? && !options[:include_empty]
 
         markup = %(<tr><th>#{label}</th>\n<td><ul class='tabular'>)
 
@@ -47,7 +47,7 @@ module Hyrax
 
       # Draw the dl row for the attribute
       def render_dl_row
-        return '' if values.blank? && !options[:include_empty]
+        return '' if blank_values? && !options[:include_empty]
 
         markup = %(<dt>#{label}</dt>\n<dd><ul class='tabular'>)
 
@@ -107,6 +107,10 @@ module Hyrax
       def work_type_label_key
         options[:work_type] ? options[:work_type].underscore : nil
       end
+
+      def blank_values?
+        Array(values).all?(&:blank?)
+      end
     end
   end
 end

data/app/renderers/hyrax/renderers/license_attribute_renderer.rb

@@ -7,18 +7,18 @@ module Hyrax
       private
 
       ##
-      # Special treatment for license/rights.  A URL from the Hyrax gem's config/hyrax.rb is stored in the descMetadata of the
-      # curation_concern.  If that URL is valid in form, then it is used as a link.  If it is not valid, it is used as plain text.
+      # Special treatment for license/rights. A URL from the Hyrax gem's
+      # `config/hyrax.rb` is stored in the descMetadata of the
+      # curation_concern. If the stored value is an absolute http/https URI,
+      # render it as a link with the authority's label; otherwise render the
+      # value as plain text to avoid emitting unsafe href values (e.g.
+      # `javascript:`) or broken links for free-text values.
       def attribute_value_to_html(value)
-        begin
-          parsed_uri = URI.parse(value)
-        rescue URI::InvalidURIError
-          nil
-        end
-        if parsed_uri.nil?
-          ERB::Util.h(value)
+        if Hyrax::AuthorityRenderingHelper.linkable_uri?(value)
+          label = Hyrax.config.license_service_class.new.label(value) { value }
+          %(<a href="#{ERB::Util.h(value)}" target="_blank" rel="noopener noreferrer">#{ERB::Util.h(label)}</a>)
         else
-          %(<a href=#{ERB::Util.h(value)} target="_blank">#{Hyrax.config.license_service_class.new.label(value)}</a>)
+          ERB::Util.h(value)
         end
       end
     end

data/app/renderers/hyrax/renderers/redirects_label_attribute_renderer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Renderers
+    # Renders each redirect path as a clickable link. The link text is the full
+    # absolute URL (host + path); the href is the path alone, which the browser
+    # resolves against the current document's host. Used on show pages via the
+    # `redirects` schema's `render_as: redirects_label` view option.
+    class RedirectsLabelAttributeRenderer < AttributeRenderer
+      private
+
+      def li_value(value)
+        path = value.to_s
+        return ERB::Util.h(path) if path.blank?
+
+        display = base_url.present? ? "#{base_url}#{path}" : path
+        link_to(ERB::Util.h(display), path)
+      end
+
+      def base_url
+        options[:base_url].to_s.sub(%r{/+\z}, '')
+      end
+    end
+  end
+end