hyrax 4.0.0 → 5.0.0.rc1

data/app/services/hyrax/embargo_manager.rb

@@ -17,6 +17,7 @@ module Hyrax
   #    - "Enforced" means the object's visibility matches the pre-release
   #      visibility of the embargo; i.e. the embargo has been applied,
   #      but not released.
+  #    - "Deactivate" means that the existing embargo will be removed
   #
   # Note that an resource may be `#under_embargo?` even if the embargo is not
   # be `#enforced?` (in this case, the application should seek to apply the
@@ -74,7 +75,7 @@ module Hyrax
   #   resource.visibility # => 'open'
   #   manager.enforced? => false
   #
-  class EmbargoManager
+  class EmbargoManager # rubocop:disable Metrics/ClassLength
     ##
     # @!attribute [rw] resource
     #   @return [Hyrax::Resource]
@@ -117,6 +118,51 @@ module Hyrax
         new(resource: resource, query_service: query_service)
           .release!
       end
+
+      # Creates or updates an existing embargo on a member to match the embargo on the parent work
+      # @param [Array<Valkyrie::Resource>] members
+      # @param [Hyrax::Work] work
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def create_or_update_embargo_on_members(members, work)
+        # TODO: account for all members and levels, not just file sets. ref: #6131
+
+        members.each do |member|
+          member_embargo_needs_updating = work.embargo.updated_at > member.embargo&.updated_at if member.embargo
+
+          if member.embargo && member_embargo_needs_updating
+            member.embargo.embargo_release_date = work.embargo['embargo_release_date']
+            member.embargo.visibility_during_embargo = work.embargo['visibility_during_embargo']
+            member.embargo.visibility_after_embargo = work.embargo['visibility_after_embargo']
+            member.embargo = Hyrax.persister.save(resource: member.embargo)
+          else
+            work_embargo_manager = Hyrax::EmbargoManager.new(resource: work)
+            work_embargo_manager.copy_embargo_to(target: member)
+            member = Hyrax.persister.save(resource: member)
+          end
+
+          user ||= ::User.find_by_user_key(member.depositor)
+          # the line below works in that it indexes the file set with the necessary lease properties
+          # I do not know however if this is the best event_id to pass
+          Hyrax.publisher.publish('object.metadata.updated', object: member, user: user)
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    end
+
+    # Deactivates the embargo and logs a message to the embargo_history property
+    def deactivate!
+      embargo_state = embargo.active? ? 'active' : 'expired'
+      embargo_record = embargo_history_message(
+        embargo_state,
+        Time.zone.today,
+        embargo.embargo_release_date,
+        embargo.visibility_during_embargo,
+        embargo.visibility_after_embargo
+      )
+
+      release(force: true)
+      nullify(force: true)
+      embargo.embargo_history += [embargo_record]
     end
 
     ##
@@ -128,7 +174,7 @@ module Hyrax
     def copy_embargo_to(target:)
       return false unless under_embargo?
 
-      target.embargo = Embargo.new(clone_attributes)
+      target.embargo = Hyrax.persister.save(resource: Embargo.new(clone_attributes))
       self.class.apply_embargo_for(resource: target)
     end
 
@@ -152,7 +198,8 @@ module Hyrax
     ##
     # @return [Boolean]
     def enforced?
-      embargo.visibility_during_embargo.to_s == resource.visibility
+      embargo.embargo_release_date.present? &&
+        (embargo.visibility_during_embargo.to_s == resource.visibility)
     end
 
     ##
@@ -162,21 +209,28 @@ module Hyrax
     end
 
     ##
-    # Drop the embargo by setting its release date to `nil`.
+    # Drop the embargo by setting its release date and visibility settings to `nil`.
+    #
+    # @param force [boolean] force the nullify even when the embargo period is current
     #
     # @return [void]
-    def nullify
-      return unless under_embargo?
+    def nullify(force: false)
+      return false if !force && under_embargo?
+
       embargo.embargo_release_date = nil
+      embargo.visibility_during_embargo = nil
+      embargo.visibility_after_embargo = nil
     end
 
     ##
-    # Sets the visibility of the resource to the embargo's visibility condition.
-    # no-op if the embargo period is current.
+    # Sets the visibility of the resource to the embargo's after embargo visibility.
+    # no-op if the embargo period is current and the force flag is false.
+    #
+    # @param force [boolean] force the release even when the embargo period is current
     #
     # @return [Boolean] truthy if the embargo has been applied
-    def release
-      return false if under_embargo?
+    def release(force: false)
+      return false if !force && under_embargo?
       return true if embargo.visibility_after_embargo.nil?
 
       resource.visibility = embargo.visibility_after_embargo
@@ -209,5 +263,17 @@ module Hyrax
     def core_attribute_keys
       [:visibility_after_embargo, :visibility_during_embargo, :embargo_release_date]
     end
+
+    protected
+
+    # Create the log message used when deactivating an embargo
+    def embargo_history_message(state, deactivate_date, release_date, visibility_during, visibility_after)
+      I18n.t 'hydra.embargo.history_message',
+              state: state,
+              deactivate_date: deactivate_date,
+              release_date: release_date,
+              visibility_during: visibility_during,
+              visibility_after: visibility_after
+    end
   end
 end

data/app/services/hyrax/file_set_derivatives_service.rb

@@ -75,7 +75,7 @@ module Hyrax
                                                   url: derivative_url('thumbnail'),
                                                   layer: 0
                                                 }])
-      extract_full_text(filename, uri)
+      extract_full_text(filename, derivative_url('extracted_text'))
     end
 
     def create_office_document_derivatives(filename)
@@ -86,7 +86,7 @@ module Hyrax
                                                        url: derivative_url('thumbnail'),
                                                        layer: 0
                                                      }])
-      extract_full_text(filename, uri)
+      extract_full_text(filename, derivative_url('extracted_text'))
     end
 
     def create_audio_derivatives(filename)
@@ -122,6 +122,7 @@ module Hyrax
     # @param [String] uri to the file set (deligated to file_set)
     def extract_full_text(filename, uri)
       return unless Hyrax.config.extract_full_text?
+
       Hydra::Derivatives::FullTextExtract.create(filename,
                                                  outputs: [{ url: uri, container: "extracted_text" }])
     end

data/app/services/hyrax/lease_manager.rb

@@ -4,7 +4,22 @@ module Hyrax
   ##
   # Provides utilities for managing the lifecycle of an `Hyrax::Lease` on a
   # `Hyrax::Resource`.
-  class LeaseManager
+  #
+  # The lease terminology used here is as follows:
+  #
+  #    - "Expiration Date" is the day a lease is scheduled to expire.
+  #    - "Under Lease" means the lease is "active"; i.e. that its expiration
+  #       date is today or later.
+  #    - "Applied" means the lease's pre-expiration visibility has been set on
+  #      the resource.
+  #    - "Released" means the lease's post-expiration visibility has been set on
+  #      the resource.
+  #    - "Enforced" means the object's visibility matches the pre-expiration
+  #      visibility of the lease; i.e. the lease has been applied,
+  #      but not released.
+  #    - "Deactivate" means that the existing lease will be removed
+  #
+  class LeaseManager # rubocop:disable Metrics/ClassLength
     ##
     # @!attribute [rw] resource
     #   @return [Hyrax::Resource]
@@ -47,6 +62,51 @@ module Hyrax
         new(resource: resource, query_service: query_service)
           .release!
       end
+
+      # Creates or updates an existing lease on a member to match the lease on the parent work
+      # @param [Array<Valkyrie::Resource>] members
+      # @param [Hyrax::Work] work
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def create_or_update_lease_on_members(members, work)
+        # TODO: account for all members and levels, not just file sets. ref: #6131
+
+        members.each do |member|
+          member_lease_needs_updating = work.lease.updated_at > member.lease&.updated_at if member.lease
+
+          if member.lease && member_lease_needs_updating
+            member.lease.lease_expiration_date = work.lease['lease_expiration_date']
+            member.lease.visibility_during_lease = work.lease['visibility_during_lease']
+            member.lease.visibility_after_lease = work.lease['visibility_after_lease']
+            member.lease = Hyrax.persister.save(resource: member.lease)
+          else
+            work_lease_manager = Hyrax::LeaseManager.new(resource: work)
+            work_lease_manager.copy_lease_to(target: member)
+            member = Hyrax.persister.save(resource: member)
+          end
+
+          user ||= ::User.find_by_user_key(member.depositor)
+          # the line below works in that it indexes the file set with the necessary lease properties
+          # I do not know however if this is the best event_id to pass
+          Hyrax.publisher.publish('object.metadata.updated', object: member, user: user)
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    end
+
+    # Deactivates the lease and logs a message to the lease_history property
+    def deactivate!
+      lease_state = lease.active? ? 'active' : 'expired'
+      lease_record = lease_history_message(
+        lease_state,
+        Time.zone.today,
+        lease.lease_expiration_date,
+        lease.visibility_during_lease,
+        lease.visibility_after_lease
+      )
+
+      release(force: true)
+      nullify(force: true)
+      lease.lease_history += [lease_record]
     end
 
     ##
@@ -58,7 +118,7 @@ module Hyrax
     def copy_lease_to(target:)
       return false unless under_lease?
 
-      target.lease = Lease.new(clone_attributes)
+      target.lease = Hyrax.persister.save(resource: Lease.new(clone_attributes))
       self.class.apply_lease_for(resource: target)
     end
 
@@ -80,7 +140,8 @@ module Hyrax
     ##
     # @return [Boolean]
     def enforced?
-      lease.visibility_during_lease.to_s == resource.visibility
+      lease.lease_expiration_date.present? &&
+        lease.visibility_during_lease.to_s == resource.visibility
     end
 
     ##
@@ -90,18 +151,27 @@ module Hyrax
     end
 
     ##
-    # Drop the lease by setting its release date to `nil`.
+    # Drop the lease by setting its release date and visibility settings to `nil`.
     #
+    # @param force [boolean] force the nullify even when the lease period is current
     # @return [void]
-    def nullify
-      return unless under_lease?
+    def nullify(force: false)
+      return false if !force && under_lease?
+
       lease.lease_expiration_date = nil
+      lease.visibility_during_lease = nil
+      lease.visibility_after_lease = nil
     end
 
     ##
+    # Sets the visibility of the resource to the lease's after lease visibility.
+    # no-op if the lease period is current and the force flag is false.
+    #
+    # @param force [boolean] force the release even when the lease period is current
+    #
     # @return [Boolean]
-    def release
-      return false if under_lease?
+    def release(force: false)
+      return false if !force && under_lease?
       return true if lease.visibility_after_lease.nil?
 
       resource.visibility = lease.visibility_after_lease
@@ -131,5 +201,15 @@ module Hyrax
     def core_attribute_keys
       [:visibility_after_lease, :visibility_during_lease, :lease_expiration_date]
     end
+
+    # Create the log message used when deactivating a lease
+    def lease_history_message(state, deactivate_date, expiration_date, visibility_during, visibility_after)
+      I18n.t 'hydra.lease.history_message',
+              state: state,
+              deactivate_date: deactivate_date,
+              expiration_date: expiration_date,
+              visibility_during: visibility_during,
+              visibility_after: visibility_after
+    end
   end
 end

data/app/services/hyrax/listeners/file_metadata_listener.rb

@@ -35,10 +35,10 @@ module Hyrax
       end
 
       ##
-      # Called when 'object.file.uploaded' event is published
+      # Called when 'file.uploaded' event is published
       # @param [Dry::Events::Event] event
       # @return [void]
-      def on_object_file_uploaded(event)
+      def on_file_uploaded(event)
         # Run characterization
         Hyrax.config
              .characterization_service

data/app/services/hyrax/listeners/workflow_listener.rb

@@ -7,17 +7,14 @@ module Hyrax
     # manages workflow accordingly.
     class WorkflowListener
       ##
-      # @note respects class attribute configuration at
-      #   {Hyrax::Actors::InitializeWorkflowActor.workflow_factory}, but falls
-      #   back on {Hyrax::Workflow::WorkflowFactory} to prepare for removal of
-      #   Actors
-      # @return [#create] default: {Hyrax::Workflow::WorkflowFactory}
-      def factory
-        if defined?(Hyrax::Actors::InitializeWorkflowActor)
-          Hyrax::Actors::InitializeWorkflowActor.workflow_factory
-        else
-          Hyrax::Workflow::WorkflowFactory
-        end
+      # @!attribute [rw] factory
+      #   @return [#create]
+      attr_accessor :factory
+
+      ##
+      # @param [#create] factory
+      def initialize(factory: Hyrax::Workflow::WorkflowFactory)
+        @factory = factory
       end
 
       ##

data/app/services/hyrax/persist_directly_contained_output_file_service.rb

@@ -24,11 +24,33 @@ module Hyrax
     # @option directives [String] url URI for the parent object.
     def self.retrieve_file_set(directives)
       uri = URI(directives.fetch(:url))
-      raise ArgumentError, "#{uri} is not an http(s) uri" unless uri.is_a?(URI::HTTP)
-      Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: Hyrax::Base.uri_to_id(uri.to_s), use_valkyrie: false)
+      if uri.is_a?(URI::HTTP)
+        Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: Hyrax::Base.uri_to_id(uri.to_s), use_valkyrie: false)
+      else
+        raise ArgumentError, "#{uri} is not an file/http(s) uri" unless uri.is_a?(URI::File)
+
+        fileset_for_directives(directives)
+      end
     end
     private_class_method :retrieve_file_set
 
+    # The filepath will look something like
+    # /app/samvera/hyrax-webapp/derivatives/95/93/tv/12/3-thumbnail.jpeg and
+    # we want to extract the FileSet id, which in this case would be 9593tv123
+    #
+    # @param [String] path
+    # @return [Hyrax::FileSet]
+    def self.fileset_for_directives(directives)
+      path = URI(directives.fetch(:url)).path
+      id = path.sub(Hyrax.config.derivatives_path.to_s, "")
+               .delete('/')
+               .match(/^(.*)-\w*(\.\w+)*$/) { |m| m[1] }
+      raise "Could not extract fileset id from path #{path}" unless id
+
+      Hyrax.metadata_adapter.query_service.find_by(id: id)
+    end
+    private_class_method :fileset_for_directives
+
     # Override this implementation if you need a remote file from a different location
     # @param file_set [FileSet] the container of the remote file
     # @param directives [Hash] directions which can be used to determine where to persist to

data/app/services/hyrax/solr_query_service.rb

@@ -28,21 +28,21 @@ module Hyrax
     ##
     # execute the query using a GET request
     # @return [Hash] the results returned from solr for the current query
-    def get
-      solr_service.get(build)
+    def get(**args)
+      solr_service.get(build, **args)
     end
 
     ##
     # execute the solr query and return results
     # @return [Hash] the results returned from solr for the current query
-    def query_result
-      solr_service.query_result(build)
+    def query_result(**args)
+      solr_service.query_result(build, **args)
     end
 
     ##
     # @return [Enumerable<SolrDocument>]
-    def solr_documents
-      query_result['response']['docs'].map { |doc| self.class.document_model.new(doc) }
+    def solr_documents(**args)
+      query_result(**args)['response']['docs'].map { |doc| self.class.document_model.new(doc) }
     end
 
     ##
@@ -107,6 +107,7 @@ module Hyrax
     def with_generic_type(generic_type: 'Work')
       # TODO: Generic type was originally stored as `sim`.  Since it is never multi-valued, it is moving to being stored
       #       as `si`.  Until a migration is created to correct existing solr docs, this query searches in both fields.
+      #       @see https://github.com/samvera/hyrax/issues/6086
       field_pairs = { generic_type_si: generic_type, generic_type_sim: generic_type }
       type_query = construct_query_for_pairs(field_pairs, ' OR ', 'field')
       @query += [type_query]

data/app/services/hyrax/statistics/depositors/summary.rb

@@ -58,7 +58,7 @@ module Hyrax
         end
 
         def query_service
-          Hyrax::Statistics::QueryService.new
+          Hyrax::Statistics::ValkyrieQueryService.new
         end
       end
     end

data/app/services/hyrax/statistics/over_time.rb

@@ -40,7 +40,7 @@ module Hyrax
       end
 
       def query_service
-        Hyrax::Statistics::QueryService.new
+        Hyrax::Statistics::ValkyrieQueryService.new
       end
 
       # How many points are in this data set

data/app/services/hyrax/statistics/users/over_time.rb

@@ -26,7 +26,9 @@ module Hyrax
         end
 
         def point(date_string)
-          relation.where(query(date_string)).count
+          # convert the User::ActiveRecord_Relation to an array so that ".size" returns a number,
+          # instead of a hash of { user_id: size }
+          relation.where(query(date_string)).to_a.size
         end
       end
     end

data/app/services/hyrax/statistics/valkyrie_query_service.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module Hyrax
+  module Statistics
+    class ValkyrieQueryService < QueryService
+      # query to find works created during the time range
+      # @param [DateTime] start_datetime starting date time for range query
+      # @param [DateTime] end_datetime ending date time for range query
+      def find_by_date_created(start_datetime, end_datetime = nil)
+        return [] if start_datetime.blank? # no date just return nothing
+        return super unless non_wings_valkyire?
+
+        Hyrax.query_service.custom_queries.find_by_date_range(start_datetime: start_datetime,
+                                                              end_datetime: end_datetime,
+                                                              models: relation.allowable_types).to_a
+      end
+
+      def find_registered_in_date_range(start_datetime, end_datetime = nil)
+        return super unless non_wings_valkyire?
+        find_by_date_created(start_datetime, end_datetime) & where_registered.to_a
+      end
+
+      def find_public_in_date_range(start_datetime, end_datetime = nil)
+        return super unless non_wings_valkyire?
+        find_by_date_created(start_datetime, end_datetime) & where_public.to_a
+      end
+
+      def relation
+        return super unless non_wings_valkyire?
+        Hyrax::ValkyrieWorkRelation.new
+      end
+
+      private
+
+      def where_access_is(access_level)
+        # returns all works where the access level is public
+        return super unless non_wings_valkyire?
+
+        Hyrax.custom_queries.find_models_by_access(mode: 'read',
+                                                   models: relation.allowable_types,
+                                                   group: true,
+                                                   agent: access_level)
+      end
+
+      def non_wings_valkyire?
+        Hyrax.config.use_valkyrie? && (!defined?(Wings) || (defined?(Wings) && Hyrax.config.disable_wings))
+      end
+    end
+  end
+end

data/app/services/hyrax/statistics/works/count.rb

@@ -44,7 +44,7 @@ module Hyrax
         private
 
         def query_service
-          @query_service ||= Hyrax::Statistics::QueryService.new
+          @query_service ||= Hyrax::Statistics::ValkyrieQueryService.new
         end
 
         def by_date_and_permission

data/app/services/hyrax/thumbnail_path_service.rb

@@ -30,6 +30,11 @@ module Hyrax
       def fetch_thumbnail(object)
         return object if object.thumbnail_id == object.id ||
                          object.try(:file_ids)&.detect { |fid| fid == object.thumbnail_id }
+        begin
+          return Hyrax.query_service.find_by(id: object.thumbnail_id)
+        rescue
+          nil
+        end
         Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: object.thumbnail_id)
       rescue Valkyrie::Persistence::ObjectNotFoundError, Hyrax::ObjectNotFoundError
         Hyrax.logger.error("Couldn't find thumbnail #{object.thumbnail_id} for #{object.id}")

data/app/services/hyrax/valkyrie_persist_derivatives.rb

@@ -22,20 +22,17 @@ module Hyrax
       file_set = fileset_for_directives(directives)
 
       # Valkyrie storage adapters will typically expect an IO-like object that
-      # responds to #path -- here we only have a StringIO, so some
-      # transformation is in order
+      # responds to #rewind and #read so we have created a StringIO
       tmpfile = Tempfile.new(file_set.id, encoding: 'ascii-8bit')
-      tmpfile.write stream.read
+      stream = StringIO.new(stream) if stream.is_a?(String)
+      stream.rewind
+      output = tmpfile.write(stream.read)
+      tmpfile.flush
+      raise 'blank file detected' if output.zero?
 
       filename = filename(directives)
-      Hyrax.logger.debug "Uploading thumbnail for FileSet #{file_set.id} as #{filename}"
-
-      uploader.upload(
-        io: tmpfile,
-        filename: filename,
-        file_set: file_set,
-        use: Hyrax::FileMetadata::Use::THUMBNAIL
-      )
+      Hyrax.logger.debug "Uploading derivative for FileSet #{file_set.id} as #{filename}"
+      uploader.upload(io: tmpfile, filename: filename, file_set: file_set, use: file_metadata(directives))
     end
 
     # The filepath will look something like
@@ -57,5 +54,13 @@ module Hyrax
     def self.filename(directives)
       URI(directives.fetch(:url)).path.split('/').last
     end
+
+    def self.file_metadata(directives)
+      if directives.key?(:container)
+        "Hyrax::FileMetadata::Use::#{directives[:container].upcase}".constantize
+      else
+        Hyrax::FileMetadata::Use::THUMBNAIL
+      end
+    end
   end
 end

data/app/services/hyrax/valkyrie_upload.rb

@@ -38,7 +38,8 @@ class Hyrax::ValkyrieUpload
     streamfile = storage_adapter.upload(file: io, original_filename: filename, resource: file_set)
     file_metadata = Hyrax::FileMetadata(streamfile)
     file_metadata.file_set_id = file_set.id
-    file_metadata.type += [use]
+    file_metadata.pcdm_use = [use]
+    file_metadata.recorded_size = [io.size]
 
     if use == Hyrax::FileMetadata::Use::ORIGINAL_FILE
       # Set file set label.
@@ -50,7 +51,8 @@ class Hyrax::ValkyrieUpload
     end
 
     saved_metadata = Hyrax.persister.save(resource: file_metadata)
-    Hyrax.publisher.publish("object.file.uploaded", metadata: saved_metadata)
+    saved_metadata.original_filename = filename if saved_metadata.original_filename.blank?
+    Hyrax.publisher.publish("file.uploaded", metadata: saved_metadata)
 
     add_file_to_file_set(file_set: file_set,
                          file_metadata: saved_metadata,
@@ -83,7 +85,7 @@ class Hyrax::ValkyrieUpload
   #   the file to add
   # @return [void]
   def set_file_use_ids(file_set, file_metadata)
-    file_metadata.type.each do |type|
+    file_metadata.pcdm_use.each do |type|
       case type
       when Hyrax::FileMetadata::Use::ORIGINAL_FILE
         file_set.original_file_id = file_metadata.id

data/app/services/hyrax/versioning_service.rb

@@ -41,6 +41,7 @@ module Hyrax
           []
         end
       else
+        return resource.versions if resource.versions.is_a?(Array)
         resource.versions.all.to_a
       end
     end

data/app/services/hyrax/visibility_intention.rb

@@ -86,10 +86,7 @@ module Hyrax
       return true if date.is_a?(Date)
       return true if date.is_a?(Time)
       Date.parse(date)
-      # In Ruby 2.7.x, Date::Error descends from ArgumentError; Once
-      # we stop supporting pre-2.7, we can switch this to the more
-      # narrow Date::Error
-    rescue ArgumentError
+    rescue Date::Error
       false
     end
   end

data/app/services/hyrax/visibility_propagator.rb

@@ -10,7 +10,7 @@ module Hyrax
     # @return [#propagate]
     def self.for(source:)
       case source
-      when Hyrax::WorkBehavior # ActiveFedora
+      when ActiveFedora::Base # ActiveFedora
         FileSetVisibilityPropagator.new(source: source)
       when Hyrax::Resource # Valkyrie
         ResourceVisibilityPropagator.new(source: source)