hyrax 5.1.0 → 5.3.0

data/app/models/hyrax/riiif/file_resolver.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+if defined?(Riiif::Image)
+  module Hyrax
+    module Riiif
+      # Adds file locking to Riiif::File
+      # @see Riiif::FileResolver
+      class FileResolver
+        include ActiveSupport::Benchmarkable
+
+        # @param [String] id from iiif manifest
+        # @return [Riiif::File]
+        def find(id)
+          path = nil
+          file_locks[id].with_write_lock do
+            path = build_path(id)
+            path = build_path(id, force: true) unless ::File.exist?(path) # Ensures the file is locally available
+          end
+          Hyrax::Riiif::File.new(path, id: id)
+        end
+
+        # tracks individual file locks
+        # @see Hyrax::Riiif::File
+        # @return [Concurrent::Map<Concurrent::ReadWriteLock>]
+        def file_locks
+          @file_locks ||= Concurrent::Map.new do |k, v|
+            k.compute_if_absent(v) { Concurrent::ReadWriteLock.new }
+          end
+        end
+
+        private
+
+        def build_path(id, force: false)
+          ::Riiif::Image.cache.fetch("riiif:" + Digest::MD5.hexdigest("path:#{id}"),
+                                   expires_in: ::Riiif::Image.expires_in,
+                                   force: force) do
+            load_file(id)
+          end
+        end
+
+        def load_file(id)
+          benchmark "Hyrax::Riiif::FileResolver loaded #{id}", level: :debug do
+            fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
+            file_set = Hyrax.query_service.find_by(id: fs_id)
+            file_metadata = Hyrax.custom_queries.find_original_file(file_set: file_set)
+            file_metadata.file.disk_path.to_s # Stores a local copy in tmpdir
+          end
+        end
+
+        def logger
+          Hyrax.logger
+        end
+      end
+    end
+  end
+else
+  module Hyrax
+    module Riiif
+      class FileResolver
+        def initialize(*)
+          raise 'Riiif not available'
+        end
+      end
+    end
+  end
+end

data/app/models/hyrax/uploaded_file.rb

@@ -14,6 +14,8 @@ module Hyrax
              dependent: :destroy
     belongs_to :user, class_name: '::User'
 
+    validate :virus_scan
+
     ##
     # Associate a {FileSet} with this uploaded file.
     #
@@ -28,5 +30,12 @@ module Hyrax
             end
       update!(file_set_uri: uri)
     end
+
+    private
+
+    def virus_scan
+      errors.add(:file, I18n.t('hyrax.virus_scanner.virus_detected', filename: file.path)) if
+        file.path && Hyrax::VirusScanner.infected?(file.path)
+    end
   end
 end

data/app/models/hyrax/virus_scanner.rb

@@ -38,10 +38,25 @@ module Hyrax
     #
     # @return [Boolean]
     def infected?
-      defined?(ClamAV) ? clam_av_scanner : null_scanner
+      if defined?(Clamby)
+        clamby_scanner
+      elsif defined?(ClamAV)
+        clam_av_scanner
+      else
+        null_scanner
+      end
+    end
+
+    private
+
+    def clamby_scanner
+      scan_result = Clamby.virus?(file)
+      warning("A virus was found in #{file}") if scan_result
+      scan_result
     end
 
     def clam_av_scanner
+      Deprecation.warn("ClamAV support has been deprecated. Please use Clamby instead.")
       scan_result = ClamAV.instance.method(:scanfile).call(file)
       return false if scan_result.zero?
       warning "A virus was found in #{file}: #{scan_result}"
@@ -58,8 +73,6 @@ module Hyrax
       false
     end
 
-    private
-
     def warning(msg)
       Hyrax.logger&.warn(msg)
     end

data/app/models/hyrax/work.rb

@@ -94,7 +94,10 @@ module Hyrax
   # @see https://wiki.lyrasis.org/display/samvera/Hydra::Works+Shared+Modeling
   #   for a historical perspective.
   class Work < Hyrax::Resource
-    include Hyrax::Schema(:core_metadata)
+    include Hyrax::Schema(:core_metadata) if Hyrax.config.work_default_metadata
+    # See documentation/redirects.md for the redirects feature.
+    include Hyrax::Schema(:redirects) if Hyrax.config.work_default_metadata && Hyrax.config.redirects_enabled?
+    include Hyrax::RedirectsNormalization if Hyrax.config.redirects_enabled?
 
     attribute :admin_set_id,             Valkyrie::Types::ID
     attribute :member_ids,               Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)

data/app/models/job_io_wrapper.rb

@@ -25,6 +25,8 @@ class JobIoWrapper < ApplicationRecord
   after_initialize :static_defaults
   delegate :read, to: :file
 
+  attr_accessor :use_valkyrie
+
   # Responsible for creating a JobIoWrapper from the given parameters, with a
   # focus on sniffing out attributes from the given :file.
   #
@@ -34,8 +36,8 @@ class JobIoWrapper < ApplicationRecord
   # @param [FileSet] file_set - The associated file set
   # @return [JobIoWrapper]
   # @raise ActiveRecord::RecordInvalid - if the instance is not valid
-  def self.create_with_varied_file_handling!(user:, file:, relation:, file_set:)
-    args = { user: user, relation: relation.to_s, file_set_id: file_set.id }
+  def self.create_with_varied_file_handling!(user:, file:, relation:, file_set:, use_valkyrie: nil)
+    args = { user: user, relation: relation.to_s, file_set_id: file_set.id, use_valkyrie: use_valkyrie }
     if file.is_a?(Hyrax::UploadedFile)
       args[:uploaded_file] = file
       args[:path] = file.uploader.path
@@ -49,6 +51,12 @@ class JobIoWrapper < ApplicationRecord
     create!(args)
   end
 
+  def initialize(attributes = {})
+    @use_valkyrie = attributes&.delete(:use_valkyrie)
+    @use_valkyrie = Hyrax.config.use_valkyrie? if @use_valkyrie.nil?
+    super(attributes)
+  end
+
   def original_name
     super || extracted_original_name
   end
@@ -63,7 +71,8 @@ class JobIoWrapper < ApplicationRecord
     nil # unable to determine
   end
 
-  def file_set(use_valkyrie: Hyrax.config.query_index_from_valkyrie)
+  def file_set(use_valkyrie: nil)
+    use_valkyrie ||= @use_valkyrie
     return FileSet.find(file_set_id) unless use_valkyrie
     Hyrax.query_service.find_by(id: Valkyrie::ID.new(file_set_id))
   end

data/app/models/user_mailbox.rb

@@ -49,7 +49,9 @@ class UserMailbox
   end
 
   def preferred_locale
-    user.preferred_locale || I18n.default_locale
+    return I18n.default_locale unless I18n.locale_available?(user.preferred_locale)
+
+    user.preferred_locale
   end
 
   def empty_trash(user)

data/app/presenters/hyrax/admin_set_presenter.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 module Hyrax
   class AdminSetPresenter < CollectionPresenter
+    delegate :contexts, to: :solr_document
+
+    def self.terms
+      base = super
+      if Hyrax.config.flexible? && Hyrax.config.admin_set_class.new.respond_to?(:contexts)
+        base | [:contexts]
+      else
+        base
+      end
+    end
+
     ##
     # @return [Boolean] true if there are items
     def any_items?

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