hyrax 5.2.0 → 5.3.0

data/app/models/hyrax/embargo.rb

@@ -14,8 +14,10 @@ module Hyrax
     attribute :embargo_release_date,      Valkyrie::Types::DateTime
     attribute :embargo_history,           Valkyrie::Types::Array
 
+    # Fix releasing embargos on the day they are expired - this solves a 1 second bug around how
+    # midnights are calculated, which causes day of embargos to incorrectly set the permissions to private
     def active?
-      (embargo_release_date.present? && Hyrax::TimeService.time_in_utc < embargo_release_date)
+      (embargo_release_date.present? && Date.yesterday.end_of_day < embargo_release_date)
     end
   end
 end

data/app/models/hyrax/file_set.rb

@@ -49,8 +49,10 @@ module Hyrax
   # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
-    include Hyrax::Schema(:core_metadata)
-    include Hyrax::Schema(:file_set_metadata)
+    if Hyrax.config.file_set_include_metadata?
+      include Hyrax::Schema(:core_metadata)
+      include Hyrax::Schema(:file_set_metadata)
+    end
 
     def self.model_name(name_class: Hyrax::Name)
       @_model_name ||= name_class.new(self, nil, 'FileSet')

data/app/models/hyrax/flexible_schema.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+# rubocop:disable Metrics/ClassLength
+class Hyrax::FlexibleSchema < ApplicationRecord
+  serialize :profile, coder: YAML
+  serialize :contexts, coder: YAML
+
+  validate :validate_profile
+  validate :validate_property_name_conflicts
+
+  before_save :update_contexts
+
+  def warnings
+    @warnings ||= ActiveModel::Errors.new(self)
+  end
+
+  def self.current_version
+    order("created_at asc").last&.profile
+  end
+
+  def self.current_schema_id
+    order("created_at asc").last&.id
+  end
+
+  def self.create_default_schema
+    m3_profile_path = Hyrax::Schema.m3_schema_loader.config_paths&.first
+    raise ArgumentError, "No M3 profile found, check the Hyrax.config.schema_loader_config_search_paths" unless m3_profile_path
+    schema = Hyrax::FlexibleSchema.first
+    return if schema
+    schema = Hyrax::FlexibleSchema.new(profile: YAML.safe_load_file(m3_profile_path))
+    schema.save(validate: false)
+    schema
+  end
+
+  # Retrieve the properties for the model / work type
+  # This is a class method called by the model at class load
+  #   meaning AdminSet is not available and we cannot get the
+  #   contextual dynamic_schema
+  # Instead we use the default (contextless) dynamic_schema
+  #   which will add all properties available for that class
+  # @return [Array] property#to_sym
+  def self.default_properties
+    current_version['properties'].symbolize_keys!.keys
+  rescue StandardError
+    []
+  end
+
+  # Retrieve the required data to use for mappings
+  def self.mappings_data_for(mapping = 'simple_dc_pmh')
+    # for OAI-PMH we need the mappings and indexing info
+    # for properties with the specified mapping
+    return {} unless current_version
+    current_version['properties'].each_with_object({}) do |(key, values), obj|
+      next unless values['mappings'] && values['mappings'][mapping]
+      obj[key] = {
+        'indexing' => values['indexing'],
+        'mappings' => { mapping => values['mappings'][mapping] }
+      }
+    end
+  end
+
+  def update_contexts
+    self.contexts = profile['contexts']
+  end
+
+  def title
+    "#{profile['profile']['responsibility_statement']} - version #{id}"
+  end
+
+  def attributes_for(class_name)
+    class_names[class_name]
+  end
+
+  def schema_version
+    profile['m3_version']
+  end
+
+  def context_select
+    contexts&.map { |k, v| [v&.[]('display_label'), k] }
+  end
+
+  def metadata_profile_type
+    profile['profile']['type']
+  end
+
+  def version
+    id
+  end
+
+  def profile_created_at
+    created_at.strftime("%b %d, %Y")
+  end
+
+  private
+
+  def validate_profile
+    validation_service = Hyrax::FlexibleSchemaValidatorService.new(profile:)
+    validation_service.validate!
+
+    validation_service.errors.each do |e|
+      errors.add(:profile, e.to_s)
+    end
+
+    validation_service.warnings.each do |w|
+      warnings.add(:profile, "Warning: #{w.to_s}")
+    end
+  end
+
+  def validate_property_name_conflicts
+    return unless profile&.dig('properties')
+
+    # Group properties by their resolved name
+    properties_by_name = profile['properties'].each_with_object({}) do |(key, config), hash|
+      property_name = config['name'] || key
+      hash[property_name] ||= []
+      hash[property_name] << { key: key, config: config }
+    end
+
+    # Check for conflicts (same name with overlapping class/context)
+    properties_by_name.each do |property_name, properties|
+      next if properties.length == 1
+
+      # Check all pairs for conflicts
+      properties.combination(2).each do |prop1, prop2|
+        if properties_conflict?(prop1[:config], prop2[:config])
+          errors.add(:profile, "Property name '#{property_name}' conflicts between '#{prop1[:key]}' and '#{prop2[:key]}' - they have overlapping classes and contexts")
+        end
+      end
+    end
+  end
+
+  def properties_conflict?(config1, config2)
+    classes1 = Array(config1.dig('available_on', 'class'))
+    classes2 = Array(config2.dig('available_on', 'class'))
+
+    contexts1 = Array(config1.dig('available_on', 'context'))
+    contexts2 = Array(config2.dig('available_on', 'context'))
+
+    # If no contexts specified, consider as universal context
+    contexts1 = [nil] if contexts1.empty?
+    contexts2 = [nil] if contexts2.empty?
+
+    # Conflict if there's any overlap in both classes AND contexts
+    class_overlap = (classes1 & classes2).any?
+    context_overlap = !(contexts1 & contexts2).empty?
+
+    class_overlap && context_overlap
+  end
+
+  def class_names
+    return @class_names if @class_names
+    @class_names = {}
+    profile['classes'].keys.each do |class_name|
+      @class_names[class_name] = {}
+    end
+    profile['properties'].each do |key, values|
+      property_name = values['name'] || key
+      values['available_on']['class'].each do |property_class|
+        # map some m3 items to what Hyrax expects
+        values = values_map(values)
+        @class_names[property_class][property_name] = values
+      end
+    end
+    @class_names
+  end
+
+  def values_map(values)
+    values['type'] = lookup_type(values['range'])
+    values['predicate'] = values['property_uri']
+    values['index_keys'] = values['indexing']
+    values['context'] = values.dig('available_on', 'context')
+    values['multiple'] = determine_multiplicity(values)
+
+    normalize_form_attributes(values)
+
+    values
+  end
+
+  def determine_multiplicity(values)
+    return values['data_type'] == 'array' if values.key?('data_type')
+    return values['multi_value'] if values.key?('multi_value')
+
+    if (card = values['cardinality'])
+      max = card['maximum']
+      return max.nil? || max.to_i > 1
+    end
+
+    false
+  end
+
+  def normalize_form_attributes(values)
+    return unless values['form']
+
+    # Rename `multi_value` key to `multiple` (legacy support)
+    values['form']['multiple'] = values['form'].delete('multi_value') if values['form'].key?('multi_value')
+
+    values['form']['multiple'] = values['form'].delete('data_type') == 'array' if values['form'].key?('data_type')
+
+    assign_required_flag(values)
+  end
+
+  def assign_required_flag(values)
+    return unless (card = values['cardinality']) && card['minimum']
+
+    return if values['form'].key?('required')
+
+    required_flag = card['minimum'].to_i.positive?
+    values['form']['required'] = required_flag
+  end
+
+  def lookup_type(range)
+    case range
+    when "http://www.w3.org/2001/XMLSchema#dateTime"
+      'date_time'
+    else
+      range.split('#').last.underscore
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/app/models/hyrax/lease.rb

@@ -14,8 +14,10 @@ module Hyrax
     attribute :lease_expiration_date,   Valkyrie::Types::DateTime
     attribute :lease_history,           Valkyrie::Types::Array
 
+    # Fix releasing leases on the day they are expired - this solves a 1 second bug around how
+    # midnights are calculated, which causes day of leases to incorrectly set the permissions to private
     def active?
-      (lease_expiration_date.present? && Hyrax::TimeService.time_in_utc < lease_expiration_date)
+      (lease_expiration_date.present? && Time.zone.today.end_of_day < lease_expiration_date)
     end
   end
 end

data/app/models/hyrax/pcdm_collection.rb

@@ -40,7 +40,10 @@ module Hyrax
   # @see Hyrax::CustomQueries::Navigators::CollectionMembers#find_members_of
   #
   class PcdmCollection < Hyrax::Resource
-    include Hyrax::Schema(:core_metadata)
+    include Hyrax::Schema(:core_metadata) if Hyrax.config.collection_include_metadata?
+    # See documentation/redirects.md for the redirects feature.
+    include Hyrax::Schema(:redirects) if Hyrax.config.collection_include_metadata? && Hyrax.config.redirects_enabled?
+    include Hyrax::RedirectsNormalization if Hyrax.config.redirects_enabled?
 
     attribute :collection_type_gid, Valkyrie::Types::String
     attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)

data/app/models/hyrax/redirect.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Wraps a single redirect entry for use in form views, providing `.path`
+  # and `.is_display_url` readers over the underlying persisted hash.
+  #
+  # Redirects are persisted as plain hashes on the parent work or
+  # collection. Form-render code calls `Hyrax::Redirect.wrap(entry)` to
+  # get a value object the view can call methods on. Other code (the
+  # validator, indexer, sync step) reads the persisted hash directly.
+  #
+  # @example
+  #   Hyrax::Redirect.new(path: '/handle/12345/678', is_display_url: false)
+  #   Hyrax::Redirect.wrap('path' => '/foo', 'is_display_url' => true)
+  class Redirect
+    attr_reader :path, :is_display_url
+
+    ##
+    # Accept nil values so the view can build an empty trailing row.
+    def initialize(path: nil, is_display_url: false)
+      @path = path
+      @is_display_url = is_display_url
+    end
+
+    ##
+    # Build a presenter from a hash. If passed a presenter, returns it
+    # unchanged. Returns nil for nil input. Accepts string or symbol keys.
+    #
+    # @param input [Hyrax::Redirect, Hash, nil]
+    # @return [Hyrax::Redirect, nil]
+    def self.wrap(input)
+      return nil if input.nil?
+      return input if input.is_a?(Hyrax::Redirect)
+      raise ArgumentError, "cannot wrap #{input.class} as Hyrax::Redirect" unless input.respond_to?(:to_h)
+
+      h = input.to_h.transform_keys(&:to_s)
+      new(path: h['path'], is_display_url: h.fetch('is_display_url', false))
+    end
+
+    ##
+    # @return [Hash{String => Object}] string-keyed hash matching the persisted shape.
+    def to_h
+      { 'path' => path, 'is_display_url' => is_display_url }
+    end
+
+    def as_json(*)
+      to_h
+    end
+
+    ##
+    # Equality on attribute values, so `Array#uniq` works as expected.
+    def ==(other)
+      other.is_a?(Hyrax::Redirect) &&
+        other.path == path &&
+        other.is_display_url == is_display_url
+    end
+    alias eql? ==
+
+    def hash
+      [path, is_display_url].hash
+    end
+  end
+end

data/app/models/hyrax/redirect_path.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # ActiveRecord-backed redirects table for global path uniqueness.
+  #
+  # Maintained by Hyrax::Transactions::Steps::SyncRedirectPaths and
+  # Hyrax::Transactions::Steps::RemoveRedirectPaths; queried by
+  # Hyrax::RedirectsLookup. The unique index on `from_path` is the source
+  # of truth for "no two records share a redirect alias"; this class just
+  # exposes it.
+  class RedirectPath < ActiveRecord::Base
+    self.table_name = 'hyrax_redirect_paths'
+  end
+end

data/app/models/hyrax/resource.rb

@@ -30,9 +30,11 @@ module Hyrax
   #   `Hyrax::VisibilityWriter` (which provide their underlying
   #   implementations).
   #
-  class Resource < Valkyrie::Resource
+  class Resource < Valkyrie::Resource # disable:rubocop Metrics/ClassLength
     include Hyrax::Naming
     include Hyrax::WithEvents
+    include Hyrax::WithEmbargoesAndLeases
+    include Hyrax::Suppressible
 
     attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
     attribute :embargo_id,    Valkyrie::Types::Params::ID
@@ -44,6 +46,21 @@ module Hyrax
              :read_users,  :read_users=, to: :permission_manager
 
     class << self
+      def inherited(subclass)
+        super
+        subclass.acts_as_flexible_resource if Hyrax.config.flexible_classes.include?(subclass.name)
+      end
+
+      def acts_as_flexible_resource
+        include Hyrax::Flexibility
+        include Hyrax::Schema(name, schema_loader: Hyrax::Schema.m3_schema_loader)
+        Hyrax.config.flexible_classes << name unless Hyrax.config.flexible_classes.include?(name)
+      end
+
+      def flexible?
+        defined?(super) ? super : false
+      end
+
       ##
       # @return [String] a human readable name for the model
       def human_readable_type
@@ -105,6 +122,10 @@ module Hyrax
       end
     end
 
+    def flexible?
+      self.class.flexible?
+    end
+
     ##
     # @return [Boolean]
     def collection?
@@ -170,30 +191,6 @@ module Hyrax
       visibility_reader.read
     end
 
-    def embargo=(value)
-      raise TypeError "can't convert #{value.class} into Hyrax::Embargo" unless value.is_a? Hyrax::Embargo
-
-      @embargo = value
-      self.embargo_id = @embargo.id
-    end
-
-    def embargo
-      return @embargo if @embargo
-      @embargo = Hyrax.query_service.find_by(id: embargo_id) if embargo_id.present?
-    end
-
-    def lease=(value)
-      raise TypeError "can't convert #{value.class} into Hyrax::Lease" unless value.is_a? Hyrax::Lease
-
-      @lease = value
-      self.lease_id = @lease.id
-    end
-
-    def lease
-      return @lease if @lease
-      @lease = Hyrax.query_service.find_by(id: lease_id) if lease_id.present?
-    end
-
     protected
 
     def visibility_writer

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+if defined?(::Riiif::File)
+  module Hyrax
+    module Riiif
+      class File < ::Riiif::File
+        include ActiveSupport::Benchmarkable
+
+        attr_reader :id
+
+        def initialize(input_path, tempfile = nil, id:)
+          super(input_path, tempfile)
+          raise(ArgumentError, "must specify id") if id.blank?
+          @id = id
+        end
+
+        # Wrap extract in a read lock and benchmark it
+        def extract(transformation, image_info = nil)
+          ::Riiif::Image.file_resolver.file_locks[id].with_read_lock do
+            benchmark "Hyrax::Riiif::File extracted #{path} with #{transformation.to_params}", level: :debug do
+              super
+            end
+          end
+        end
+
+        private
+
+        def logger
+          Hyrax.logger
+        end
+      end
+    end
+  end
+else
+  module Hyrax
+    module Riiif
+      class File
+        def initialize(*)
+          raise 'Riiif not available'
+        end
+      end
+    end
+  end
+end

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?