hyrax 3.3.0 → 3.4.2

data/app/services/hyrax/custom_queries/navigators/parent_work_navigator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module CustomQueries
+    module Navigators
+      ##
+      # Navigate from a resource to it's parent work.
+      #
+      # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+      # @since 3.4.0
+      class ParentWorkNavigator
+        # Define the queries that can be fulfilled by this navigator.
+        def self.queries
+          [:find_parent_work, :find_parent_work_id]
+        end
+
+        attr_reader :query_service
+
+        def initialize(query_service:)
+          @query_service = query_service
+        end
+
+        ##
+        # Find parent work of a given resource, and map to Valkyrie Resources
+        # @note There should be only one parent resource.  A warning is logged if
+        #   more than one resource is found and the first of the resources is returned.
+        # @param [Valkyrie::Resource] resource
+        #
+        # @return [Array<Valkyrie::Resource>]
+        def find_parent_work(resource:)
+          results = Hyrax.query_service.find_inverse_references_by(resource: resource,
+                                                                   property: :member_ids).select(&:work?)
+          if results.count > 1
+            Hyrax.logger.warn("#{resource.work? ? 'Work' : 'File set'} " \
+                              "#{resource.id} is in #{results.count} works when it " \
+                              "should be in no more than one.")
+          end
+          results.first
+        end
+
+        ##
+        # Find the id of the parent work of a given resource, and map to Valkyrie Resources IDs
+        # @note There should be only one parent resource.  A warning is logged if
+        #   more than one resource is found and the first of the resources is returned.
+        # @param [Valkyrie::Resource] resource
+        #
+        # @return [Array<Valkyrie::ID>]
+        def find_parent_work_id(resource:)
+          find_parent_work(resource: resource)&.id
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/default_middleware_stack.rb

@@ -42,6 +42,9 @@ module Hyrax
         # Decode the private/public/institution on the form into permisisons on
         # the model
         middleware.use Hyrax::Actors::InterpretVisibilityActor
+        #
+        # Handles transfering ownership of works from one user to another
+        middleware.use Hyrax::Actors::TransferRequestActor
 
         # Copies default permissions from the PermissionTemplate to the work
         middleware.use Hyrax::Actors::ApplyPermissionTemplateActor

data/app/services/hyrax/file_set_derivatives_service.rb

@@ -3,13 +3,22 @@ module Hyrax
   # Responsible for creating and cleaning up the derivatives of a file_set
   class FileSetDerivativesService
     attr_reader :file_set
-    delegate :uri, :mime_type, to: :file_set
+    delegate :mime_type, to: :file_set
 
     # @param file_set [Hyrax::FileSet] At least for this class, it must have #uri and #mime_type
     def initialize(file_set)
       @file_set = file_set
     end
 
+    def uri
+      # If given a FileMetadata object, use its parent ID.
+      if file_set.respond_to?(:file_set_id)
+        file_set.file_set_id.to_s
+      else
+        file_set.uri
+      end
+    end
+
     def cleanup_derivatives
       derivative_path_factory.derivatives_for_reference(file_set).each do |path|
         FileUtils.rm_f(path)
@@ -33,12 +42,22 @@ module Hyrax
     # The destination_name parameter has to match up with the file parameter
     # passed to the DownloadsController
     def derivative_url(destination_name)
-      path = derivative_path_factory.derivative_path_for_reference(file_set, destination_name)
+      path = derivative_path_factory.derivative_path_for_reference(derivative_url_target, destination_name)
       URI("file://#{path}").to_s
     end
 
     private
 
+    # If given a FileMetadata object pass the file_set_id for derivative URL
+    # creation.
+    def derivative_url_target
+      if file_set.try(:file_set_id)
+        file_set.file_set_id.to_s
+      else
+        file_set
+      end
+    end
+
     def supported_mime_types
       file_set.class.pdf_mime_types +
         file_set.class.office_document_mime_types +

data/app/services/hyrax/file_set_type_service.rb

@@ -17,13 +17,10 @@ module Hyrax
     attr_reader :file_set
 
     ##
-    # @todo make `file_set_characterization_proxy` (or something better?)
-    #   application-level configuration.
-    #
     # @param [Hyrax::FileSet] file_set
     # @param [Symbol] characterization_proxy defaults to the setting provided by
     #   the application's ActiveFedora `FileSet` class.
-    def initialize(file_set:, characterization_proxy: ::FileSet.characterization_proxy, query_service: Hyrax.custom_queries)
+    def initialize(file_set:, characterization_proxy: Hyrax.config.characterization_proxy, query_service: Hyrax.custom_queries)
       @file_set = file_set
       @proxy_use = Hyrax::FileMetadata::Use.uri_for(use: characterization_proxy)
       @queries = query_service
@@ -48,7 +45,7 @@ module Hyrax
     private
 
     def audio_types
-      return ::FileSet.audio_mime_types if defined?(::FileSet)
+      return ::FileSet.audio_mime_types if defined?(::FileSet) && ::FileSet.respond_to?(:audio_mime_types)
       DEFAULT_AUDIO_TYPES
     end
   end

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

@@ -3,13 +3,43 @@
 module Hyrax
   module Listeners
     ##
-    # Listens for events related to Hyrax::FileMetadata
+    # Listens for events related to {Hyrax::FileMetadata}
     class FileMetadataListener
+      ##
+      # Called when 'file.characterized' event is published;
+      # allows post-characterization handling, like derivatives generation.
+      #
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_characterized(event)
+        CreateDerivativesJob
+          .perform_later(event[:file_set], event[:file_id], event[:path_hint])
+      end
+
+      ##
+      # Called when 'file.metadata.updated' event is published; reindexes a
+      # {Hyrax::FileSet} when a file claiming to be its `pcdm_use:OriginalFile`
+      #
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_metadata_updated(event)
+        return unless event[:metadata].original_file?
+
+        file_set = Hyrax.query_service.find_by(id: event[:metadata].file_set_id)
+        Hyrax.index_adapter.save(resource: file_set)
+      rescue Valkyrie::Persistence::ObjectNotFoundError => err
+        Hyrax.logger.warn "tried to index file with id #{event[:metadata].id} " \
+                          "in response to an event of type #{event.id} but " \
+                          "encountered an error #{err.message}. should this " \
+                          "object be in a FileSet #{event[:metadata]}"
+      end
+
       ##
       # Called when 'object.file.uploaded' event is published
       # @param [Dry::Events::Event] event
       # @return [void]
       def on_object_file_uploaded(event)
+        # Run characterization
         Hyrax.config
              .characterization_service
              .run(metadata: event[:metadata], file: event[:metadata].file)

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

@@ -3,7 +3,7 @@
 module Hyrax
   module Listeners
     ##
-    # Listens for object deleted events and cleans up associated members
+    # Listens for resource deleted events and cleans up associated members
     class MemberCleanupListener
       # Called when 'object.deleted' event is published
       # @param [Dry::Events::Event] event
@@ -12,16 +12,32 @@ module Hyrax
         return unless event.payload.key?(:object) # legacy callback
         return if event[:object].is_a?(ActiveFedora::Base) # handled by legacy code
 
-        Hyrax.custom_queries.find_child_filesets(resource: event[:object]).each do |file_set|
-          begin
-            Hyrax.persister.delete(resource: file_set)
-            Hyrax.publisher
-                 .publish('object.deleted', object: file_set, id: file_set.id, user: user)
-          rescue StandardError # we don't uncaught errors looping filesets
-            Hyrax.logger.warn "Failed to delete #{file_set.class}:#{file_set.id} " \
-                              "during cleanup for resource: #{event[:object]}. " \
-                              'This member may now be orphaned.'
-          end
+        Hyrax.custom_queries.find_child_file_sets(resource: event[:object]).each do |file_set|
+          Hyrax.persister.delete(resource: file_set)
+          Hyrax.publisher
+               .publish('object.deleted', object: file_set, id: file_set.id, user: event[:user])
+        rescue StandardError # we don't uncaught errors looping filesets
+          Hyrax.logger.warn "Failed to delete #{file_set.class}:#{file_set.id} " \
+                            "during cleanup for resource: #{event[:object]}. " \
+                            'This member may now be orphaned.'
+        end
+      end
+
+      # Called when 'collection.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_collection_deleted(event)
+        return unless event.payload.key?(:collection) # legacy callback
+        return if event[:collection].is_a?(ActiveFedora::Base) # handled by legacy code
+
+        Hyrax.custom_queries.find_members_of(collection: event[:collection]).each do |resource|
+          resource.member_of_collection_ids -= [event[:collection].id]
+          Hyrax.persister.save(resource: resource)
+          Hyrax.publisher
+               .publish('collection.membership.updated', collection: event[:collection], user: event[:user])
+        rescue StandardError
+          Hyrax.logger.warn "Failed to remove collection reference from #{work.class}:#{work.id} " \
+                            "during cleanup for collection: #{event[:collection]}. "
         end
       end
     end

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

@@ -22,6 +22,34 @@ module Hyrax
         Hyrax.index_adapter.save(resource: event[:collection])
       end
 
+      ##
+      # Re-index the resource.
+      #
+      # Called when 'file.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_file_metadata_updated(event)
+        return unless resource? event[:metadata]
+        Hyrax.index_adapter.save(resource: event[:metadata])
+      end
+
+      ##
+      # Re-index the resource.
+      #
+      # Called when 'object.membership.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_object_membership_updated(event)
+        resource = event.to_h.fetch(:object) { Hyrax.query_service.find_by(id: event[:object_id]) }
+        return unless resource?(resource)
+
+        Hyrax.index_adapter.save(resource: resource)
+      rescue Valkyrie::Persistence::ObjectNotFoundError => err
+        Hyrax.logger.error("Tried to index for an #{event.id} event with " \
+                           "payload #{event.payload}, but failed due to error:\n"\
+                           "\t#{err.message}")
+      end
+
       ##
       # Re-index the resource.
       #
@@ -44,6 +72,17 @@ module Hyrax
         Hyrax.index_adapter.delete(resource: event[:object])
       end
 
+      ##
+      # Remove the resource from the index.
+      #
+      # Called when 'collection.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_collection_deleted(event)
+        return unless resource?(event.payload[:collection])
+        Hyrax.index_adapter.delete(resource: event[:collection])
+      end
+
       private
 
       def resource?(resource)

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

@@ -3,19 +3,25 @@
 module Hyrax
   module Listeners
     ##
-    # Listens for deposit events, and checks for proxy situations. When a user
+    # @deprecated transfer requests are now carried out synchronously during
+    # object save
+    #
+    ## Listens for deposit events, and checks for proxy situations. When a user
     # deposits an item `on_behalf_of` another, ensures transfer is handled.
     class ProxyDepositListener
       ##
       # Called when 'object.deposited' event is published
-      # @param [Dry::Events::Event] event
+      # @param [Dry::Events::Event] _event
       # @return [void]
-      def on_object_deposited(event)
-        return if event[:object].try(:on_behalf_of).blank? ||
-                  (event[:object].on_behalf_of == event[:object].depositor)
-
-        ContentDepositorChangeEventJob
-          .perform_later(event[:object], ::User.find_by_user_key(event[:object].on_behalf_of))
+      def on_object_deposited(_event)
+        Deprecation.warn(
+          "The ProxyDepositListener was deprecated, effective immediately, in \
+          response to a difficult-to-diagnose race condition bug. This listener \
+          is now a no-op. To retain functionality ensure that \
+          DefaultMiddlewareStack is configured to use \
+          Hyrax::Actors::TransferRequestActor. To quiet this deprecation remove any \
+          local initializer configuration that subscribes this listener."
+        )
       end
     end
   end

data/app/services/hyrax/location_service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Hyrax
+  class LocationService < ::Qa::Authorities::Geonames
+    CACHE_KEY_PREFIX = 'hyrax_geonames_label-v1-'
+    CACHE_EXPIRATION = 1.week
+
+    def full_label(uri)
+      return if uri.blank?
+      id = extract_id uri
+      Rails.cache.fetch(cache_key(id), expires_in: CACHE_EXPIRATION) do
+        label.call(find(id))
+      end
+    end
+
+    private
+
+    def extract_id(obj)
+      uri = case obj
+            when String
+              URI(obj)
+            when URI
+              obj
+            else
+              raise ArgumentError, "#{obj} is not a valid type"
+            end
+      uri.path.split('/').last
+    end
+
+    def cache_key(id)
+      "#{CACHE_KEY_PREFIX}#{id}"
+    end
+  end
+end

data/app/services/hyrax/multiple_membership_checker.rb

@@ -11,6 +11,28 @@ module Hyrax
       @item = item
     end
 
+    # @api public
+    #
+    # Validate member_of_collection_ids does not have any membership conflicts
+    # based on the collection types of the members.
+    #
+    # Collections that have a collection type declaring
+    # `allow_multiple_membership` as `false` require that its members do not
+    # also belong to other collections of the same type.
+    #
+    # @return [True, String] true if no conflicts; otherwise, an error message string
+    # @deprecated Use #check instead; for removal in 4.0.0
+    def validate
+      Deprecation.warn "#{self.class}##{__method__} is deprecated; use #check instead."
+      return true if item.member_of_collection_ids.empty? || item.member_of_collection_ids.count <= 1
+      return true unless single_membership_collection_types_exist?
+
+      collections_to_check = filter_to_single_membership_collections(item.member_of_collection_ids)
+      problematic_collections = check_collections(collections_to_check)
+      errs = build_error_message(problematic_collections)
+      errs.presence || true
+    end
+
     # @api public
     #
     # Scan a list of collection_ids for multiple single-membership collections.
@@ -42,15 +64,18 @@ module Hyrax
 
     private
 
+    # @return [Boolean] true if there a any collection types that restrict membership
     def single_membership_collection_types_exist?
       single_membership_collection_types_gids.present?
     end
 
+    # @return [Array<String] global ids of collection types that restrict membership
     def single_membership_collection_types_gids
       @single_membership_collection_types_gids ||=
         Hyrax::CollectionType.gids_that_do_not_allow_multiple_membership&.map(&:to_s)
     end
 
+    # @return [Array<Hyrax::PcdmCollection>] list of collection instances for single membership collections
     def filter_to_single_membership_collections(collection_ids)
       return [] if collection_ids.blank?
       field_pairs = {
@@ -58,11 +83,14 @@ module Hyrax
       }
       Hyrax::SolrQueryService.new
                              .with_generic_type(generic_type: "Collection")
-                             .with_ids(ids: Array[collection_ids])
+                             .with_ids(ids: Array(collection_ids).map(&:to_s))
                              .with_field_pairs(field_pairs: field_pairs, join_with: ' OR ')
                              .get_objects(use_valkyrie: true).to_a
     end
 
+    # @param proposed [Array<Hyrax::PcdmCollection>] collections with restricted membership that are being added
+    # @param include_current_members [Boolean] true if current collections for item should also be checked
+    # @return [Array<Hyrax::PcdmCollection>] collections with restricted membership
     def collections_to_check(proposed, include_current_members)
       # ActorStack does a wholesale collection membership replacement, such that
       # proposed collections include existing and new collections.  Parameter
@@ -72,6 +100,19 @@ module Hyrax
       proposed | filter_to_single_membership_collections(item.member_of_collection_ids)
     end
 
+    # @param collections_to_check [Array<Hyrax::PcdmCollection>] collections with restricted membership
+    # @return [Array<Array>] collections groups by collection type
+    # @example example return result
+    #   [
+    #     [
+    #       <Collection(id: 1, collection_type_gid: 1, ...)>,
+    #       <Collection(id: 4, collection_type_gid: 1, ...)>
+    #     ],
+    #     [
+    #       <Collection(id: 13, collection_type_gid: 8, ...)>,
+    #       <Collection(id: 26, collection_type_gid: 8, ...)>
+    #     ]
+    #   ]
     def check_collections(collections_to_check)
       # uniq insures we include a collection only once when it is in the list multiple
       # group_by groups collections of the same collection type together
@@ -82,6 +123,7 @@ module Hyrax
                           .select { |_gid, list| list.count > 1 }
     end
 
+    # @return [nil, String] nil if no errors; otherwise, errors appended into a single human readable message
     def build_error_message(problematic_collections)
       return if problematic_collections.blank?
       error_message_clauses = problematic_collections.map do |gid, list|
@@ -93,10 +135,13 @@ module Hyrax
         "#{error_message_clauses.join('; ')}"
     end
 
+    # @return [String] title of the collection type
     def collection_type_title_from_gid(gid)
       Hyrax::CollectionType.find_by_gid(gid).title
     end
 
+    # @return [String] comma separated (with and before final) list of titles
+    # @example "Title 1, Title 2, and Title 3"
     def collection_titles_from_list(collection_list)
       collection_list.map do |collection|
         collection.title.first

data/app/services/hyrax/resource_visibility_propagator.rb

@@ -39,7 +39,7 @@ module Hyrax
     #
     # @raise [RuntimeError] if visibility propagation fails
     def propagate
-      queries.find_child_filesets(resource: source).each do |file_set|
+      queries.find_child_file_sets(resource: source).each do |file_set|
         file_set.visibility = source.visibility
         embargo_manager.copy_embargo_to(target: file_set)
         lease_manager.copy_lease_to(target: file_set)

data/app/services/hyrax/simple_schema_loader.rb

@@ -76,7 +76,11 @@ module Hyrax
       ##
       # @return [Dry::Types::Type]
       def type
-        collection_type = config['multiple'] ? Valkyrie::Types::Array : Identity
+        collection_type = if config['multiple']
+                            Valkyrie::Types::Array.constructor { |v| Array(v).select(&:present?) }
+                          else
+                            Identity
+                          end
         collection_type.of(type_for(config['type']))
       end
 

data/app/services/hyrax/solr_query_service.rb

@@ -59,10 +59,11 @@ module Hyrax
     end
 
     ##
+    # @param join_with [String] the connector (eg. 'AND', 'OR') used to join each clause (default: 'AND')
     # @return [String] the combined query that can be submitted to solr
-    def build
+    def build(join_with: 'AND')
       return 'id:NEVER_USE_THIS_ID' if @query.blank? # forces this method to always return a valid solr query
-      @query.join(' AND ')
+      @query.join(padded_join_with(join_with))
     end
 
     ##
@@ -106,8 +107,8 @@ module Hyrax
 
     ##
     # @param field_pairs [Hash] a list of pairs of property name and values (e.g. { field1: values, field2: values })
-    # @param join_with [String] the connector used to join the field pairs (default: ' AND ')
-    # @param type [String] type of query to run. Either 'raw' or 'field' (default: 'field')
+    # @param join_with [String] the connector (eg. 'AND', 'OR') used to join the field pairs (default: 'AND')
+    # @param type [String] type of query to run (e.g. 'raw', 'field', 'terms') (default: 'field')
     # @return [SolrQueryService] the existing service with field_pair query appended
     def with_field_pairs(field_pairs: {}, join_with: default_join_with, type: 'field')
       pairs_query = construct_query_for_pairs(field_pairs, join_with, type)
@@ -140,7 +141,7 @@ module Hyrax
 
     # Construct a solr query from a list of pairs (e.g. { field1: values, field2: values })
     # @param [Hash] field_pairs a list of pairs of property name and values
-    # @param [String] join_with the value we're joining the clauses with (default: ' AND ')
+    # @param [String] join_with the value (e.g. 'AND', 'OR') we're joining the clauses with (default: 'AND')
     # @param [String] type of query to run. Either 'raw' or 'field' (default: 'field')
     # @return [String] a solr query
     # @example
@@ -150,7 +151,7 @@ module Hyrax
       clauses = pairs_to_clauses(field_pairs, type)
       return "" if clauses.count.zero?
       return clauses.first if clauses.count == 1
-      "(#{clauses.join(join_with)})"
+      "(#{clauses.join(padded_join_with(join_with))})"
     end
 
     # Construct a solr query from the model (e.g. Collection, Monograph)
@@ -184,7 +185,11 @@ module Hyrax
     end
 
     def default_join_with
-      ' AND '
+      'AND'
+    end
+
+    def padded_join_with(join_with)
+      " #{join_with.strip} "
     end
 
     # @param [Array<Array>] pairs a list of (key, value) pairs. The value itself may

data/app/services/hyrax/thumbnail_path_service.rb

@@ -9,7 +9,7 @@ module Hyrax
 
         thumb = fetch_thumbnail(object)
 
-        return unless thumb
+        return default_image unless thumb
         return call(thumb) unless thumb.file_set?
         if audio?(thumb)
           audio_image

data/app/services/hyrax/valkyrie_persist_derivatives.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module Hyrax
+  class ValkyriePersistDerivatives < Hydra::Derivatives::PersistOutputFileService
+    # Persists a derivative using the defined Valkyrie storage adapter
+    #
+    # This Service conforms to the signature of `Hydra::Derivatives::PersistOutputFileService`.
+    # This service is a Valkyrized alternative to the default Hydra::Derivatives::PersistOutputFileService.
+    # This service will always update existing and does not do versioning of persisted files.
+    #
+    # to replace the default AF derivative pipeline, set
+    #     ```
+    #     Hydra::Derivatives.config.output_file_service = Hyrax::ValkyriePersistDerivatives
+    #     Hydra::Derivatives.config.source_file_service = Hyrax::LocalFileService
+    #     ```
+    #
+    # @param [#read] stream the derivative filestream
+    # @param [Hash] directives
+    # @option directives [String] :url a url to the file destination
+    def self.call(stream, directives)
+      filepath = URI(directives.fetch(:url)).path
+      fileset_id = fileset_id_from_path(filepath)
+      fileset = Hyrax.metadata_adapter.query_service.find_by(id: fileset_id)
+
+      # 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
+      tmpfile = Tempfile.new(fileset_id, encoding: 'ascii-8bit')
+      tmpfile.write stream.read
+
+      Rails.logger.debug "Uploading thumbnail for FileSet #{fileset_id} as #{filepath}"
+      Hyrax.config.derivatives_storage_adapter.upload(
+        file: tmpfile,
+        original_filename: filepath,
+        resource: fileset
+      )
+    end
+
+    # 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 [String]
+    def self.fileset_id_from_path(path)
+      path.sub(Hyrax.config.derivatives_path.to_s, "")
+          .sub(/-[^\/]+\..*$/, "")
+          .delete("/")
+    end
+  end
+end