hyrax 2.8.0 → 2.9.5

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -61,10 +61,20 @@ module Hyrax
       @model ||= ModelWrapper.new(hydra_model, id)
     end
 
+    ##
+    # @return [Boolean]
     def collection?
       hydra_model == ::Collection
     end
 
+    ##
+    # @return [Boolean]
+    def file_set?
+      hydra_model == ::FileSet
+    end
+
+    ##
+    # @return [Boolean]
     def admin_set?
       hydra_model == ::AdminSet
     end

data/app/presenters/hyrax/displays_image.rb

@@ -11,20 +11,11 @@ module Hyrax
     # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
     def display_image
       return nil unless solr_document.image? && current_ability.can?(:read, solr_document)
-
-      latest_file_id = lookup_original_file_id
-
       return nil unless latest_file_id
 
-      url = Hyrax.config.iiif_image_url_builder.call(
-        latest_file_id,
-        request.base_url,
-        Hyrax.config.iiif_image_size_default
-      )
-
       # @see https://github.com/samvera-labs/iiif_manifest
-      IIIFManifest::DisplayImage.new(url,
-                                     format: image_format([]),
+      IIIFManifest::DisplayImage.new(display_image_url(request.base_url),
+                                     format: image_format(alpha_channels),
                                      width: width,
                                      height: height,
                                      iiif_endpoint: iiif_endpoint(latest_file_id))
@@ -32,16 +23,24 @@ module Hyrax
 
     private
 
-      def iiif_endpoint(file_id)
+      def display_image_url(base_url)
+        Hyrax.config.iiif_image_url_builder.call(
+          latest_file_id,
+          base_url,
+          Hyrax.config.iiif_image_size_default
+        )
+      end
+
+      def iiif_endpoint(file_id, base_url: request.base_url)
         return unless Hyrax.config.iiif_image_server?
         IIIFManifest::IIIFEndpoint.new(
-          Hyrax.config.iiif_info_url_builder.call(file_id, request.base_url),
+          Hyrax.config.iiif_info_url_builder.call(file_id, base_url),
           profile: Hyrax.config.iiif_image_compliance_level_uri
         )
       end
 
       def image_format(channels)
-        channels.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
+        channels&.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
       end
 
       def unindexed_current_file_version
@@ -49,13 +48,18 @@ module Hyrax
         ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
       end
 
-      def lookup_original_file_id
-        result = original_file_id
-        if result.blank?
-          Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
-          result = ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
-        end
-        result
+      def latest_file_id
+        @latest_file_id ||=
+          begin
+            result = original_file_id
+
+            if result.blank?
+              Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
+              result = Hyrax::VersioningService.versioned_file_id ::FileSet.find(id).original_file
+            end
+
+            result
+          end
       end
   end
 end

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # This presenter wraps objects in the interface required by `IIIFManifiest`.
+  # It will accept either a Work-like resource or a SolrDocument.
+  #
+  # @example with a work
+  #
+  #   monograph = Monograph.new
+  #   presenter = IiifManifestPresenter.new(monograph)
+  #   presenter.title # => []
+  #
+  #   monograph.title = ['Comet in Moominland']
+  #   presenter.title # => ['Comet in Moominland']
+  #
+  # @see https://www.rubydoc.info/gems/iiif_manifest
+  class IiifManifestPresenter < Draper::Decorator
+    delegate_all
+
+    ##
+    # @!attribute [w] ability
+    #   @return [Ability]
+    # @!attribute [w] hostname
+    #   @return [String]
+    attr_writer :ability, :hostname
+
+    class << self
+      ##
+      # @param [Hyrax::Resource, SolrDocument]
+      def for(model)
+        klass = model.file_set? ? DisplayImagePresenter : IiifManifestPresenter
+
+        klass.new(model)
+      end
+    end
+
+    ##
+    # @return [#can?]
+    def ability
+      @ability ||= NullAbility.new
+    end
+
+    ##
+    # @return [String]
+    def description
+      Array(super).first || ''
+    end
+
+    ##
+    # @return [Boolean]
+    def file_set?
+      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet')
+    end
+
+    ##
+    # @return [Array<DisplayImagePresenter>]
+    def file_set_presenters
+      member_presenters.select(&:file_set?)
+    end
+
+    ##
+    # IIIF metadata for inclusion in the manifest
+    #  Called by the `iiif_manifest` gem to add metadata
+    #
+    # @todo should this use the simple_form i18n keys?! maybe the manifest
+    #   needs its own?
+    #
+    # @return [Array<Hash{String => String}>] array of metadata hashes
+    def manifest_metadata
+      metadata_fields.map do |field_name|
+        {
+          'label' => I18n.t("simple_form.labels.defaults.#{field_name}"),
+          'value' => Array(self[field_name]).map { |value| scrub(value.to_s) }
+        }
+      end
+    end
+
+    ##
+    # @return [String] the URL where the manifest can be found
+    def manifest_url
+      return '' if id.blank?
+
+      Rails.application.routes.url_helpers.polymorphic_url([:manifest, model], host: hostname)
+    end
+
+    ##
+    # @return [Array<#to_s>]
+    def member_ids
+      Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
+    end
+
+    ##
+    # @note cache member presenters to avoid querying repeatedly; we expect this
+    #   presenter to live only as long as the request.
+    #
+    # @note skips presenters for objects the current `@ability` cannot read.
+    #   the default ability has all permissions.
+    #
+    # @return [Array<IiifManifestPresenter>]
+    def member_presenters
+      @member_presenters_cache ||= Factory.build_for(ids: member_ids, presenter_class: self.class).map do |presenter|
+        next unless ability.can?(:read, presenter.model)
+
+        presenter.hostname = hostname
+        presenter.ability  = ability
+        presenter
+      end.compact
+    end
+
+    ##
+    # @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 }
+        next unless rendering
+
+        { '@id' => Hyrax::Engine.routes.url_helpers.download_url(rendering.id, host: hostname),
+          'format' => rendering.mime_type.present? ? rendering.mime_type : I18n.t("hyrax.manifest.unknown_mime_text"),
+          'label' => I18n.t("hyrax.manifest.download_text") + (rendering.label || '') }
+      end.flatten
+    end
+
+    ##
+    # @return [Boolean]
+    def work?
+      object.try(:work?) || !file_set?
+    end
+
+    ##
+    # @return [Array<IiifManifestPresenter>]
+    def work_presenters
+      member_presenters.select(&:work?)
+    end
+
+    ##
+    # @note ideally, this value will be cheap to retrieve, and will reliably
+    #   change any time the manifest JSON will change. the current implementation
+    #   is more blunt than this, changing only when the work itself changes.
+    #
+    # @return [String] a string tag suitable for cache keys for this manifiest
+    def version
+      object.try(:modified_date)&.to_s || ''
+    end
+
+    ##
+    # An Ability-like object that gives `true` for all `can?` requests
+    class NullAbility
+      ##
+      # @return [Boolean] true
+      def can?(*)
+        true
+      end
+    end
+
+    class Factory < PresenterFactory
+      ##
+      # @return [Array]
+      def build
+        ids.map do |id|
+          solr_doc = load_docs.find { |doc| doc.id == id }
+          presenter_class.for(solr_doc) if solr_doc
+        end.compact
+      end
+
+      private
+
+        ##
+        # cache the docs in this method, rather than #build;
+        # this can probably be pushed up to the parent class
+        def load_docs
+          @cached_docs ||= super
+        end
+    end
+
+    ##
+    # a Presenter for producing `IIIFManifest::DisplayImage` objects
+    #
+    class DisplayImagePresenter < Draper::Decorator
+      delegate_all
+
+      include Hyrax::DisplaysImage
+
+      ##
+      # @!attribute [w] ability
+      #   @return [Ability]
+      # @!attribute [w] hostname
+      #   @return [String]
+      attr_writer :ability, :hostname
+
+      ##
+      # Creates a display image only where #model is an image.
+      #
+      # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
+      def display_image
+        return nil unless model.image?
+        return nil unless latest_file_id
+
+        IIIFManifest::DisplayImage
+          .new(display_image_url(hostname),
+               format: image_format(alpha_channels),
+               width: width,
+               height: height,
+               iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
+      end
+
+      def hostname
+        @hostname || 'localhost'
+      end
+
+      ##
+      # @return [Boolean] false
+      def work?
+        false
+      end
+    end
+
+    private
+
+      def hostname
+        @hostname || 'localhost'
+      end
+
+      def metadata_fields
+        Hyrax.config.iiif_metadata_fields
+      end
+
+      def scrub(value)
+        Loofah.fragment(value).scrub!(:whitewash).to_s
+      end
+  end
+end

data/app/presenters/hyrax/member_presenter_factory.rb

@@ -36,14 +36,8 @@ module Hyrax
       @work_presenters ||= member_presenters(ordered_ids - file_set_ids, work_presenter_class)
     end
 
-    # TODO: Extract this to ActiveFedora::Aggregations::ListSource
     def ordered_ids
-      @ordered_ids ||= begin
-                         ActiveFedora::SolrService.query("proxy_in_ssi:#{id}",
-                                                         rows: 10_000,
-                                                         fl: "ordered_targets_ssim")
-                                                  .flat_map { |x| x.fetch("ordered_targets_ssim", []) }
-                       end
+      @ordered_ids ||= Hyrax::SolrDocument::OrderedMembers.decorate(@work).ordered_member_ids
     end
 
     private

data/app/services/hyrax/caching_iiif_manifest_builder.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # constructs IIIF Manifests and holds them in the Rails cache,
+  # this approach avoids long manifest build times for some kinds of requests,
+  # at the cost of introducing cache invalidation issues.
+  class CachingIiifManifestBuilder < ManifestBuilderService
+    KEY_PREFIX = 'iiif-cache-v1'
+
+    attr_accessor :expires_in
+
+    ##
+    # @api public
+    #
+    # @param iiif_manifest_factory [Class] a class that initializes with presenter
+    #        object and returns an object that responds to `#to_h`
+    # @param expires_in [Integer] the number of seconds until the cache expires
+    # @see Hyrax::Configuration#iiif_manifest_cache_duration
+    def initialize(iiif_manifest_factory: ::IIIFManifest::ManifestFactory, expires_in: Hyrax.config.iiif_manifest_cache_duration)
+      self.expires_in = expires_in
+
+      super(iiif_manifest_factory: iiif_manifest_factory)
+    end
+
+    ##
+    # @see ManifestBuilderService#as_json
+    def manifest_for(presenter:)
+      Rails.cache.fetch(manifest_cache_key(presenter: presenter), expires_in: expires_in) do
+        super
+      end
+    end
+
+    private
+
+      ##
+      # @note adding a version_for suffix helps us manage cache expiration,
+      #   reducing false cache hits
+      #
+      # @param presenter [Hyrax::IiifManifestPresenter]
+      #
+      # @return [String]
+      def manifest_cache_key(presenter:)
+        "#{KEY_PREFIX}_#{presenter.id}/#{version_for(presenter)}"
+      end
+
+      ##
+      # @return [String]
+      def version_for(presenter)
+        presenter.version
+      end
+  end
+end

data/app/services/hyrax/collection_types/permissions_service.rb

@@ -13,7 +13,7 @@ module Hyrax
       #   If calling from Abilities, pass the ability.  If you try to get the ability from the user, you end up in an infinit loop.
       def self.collection_type_ids_for_user(roles:, user: nil, ability: nil)
         return false unless user.present? || ability.present?
-        return Hyrax::CollectionType.all.pluck('DISTINCT id') if user_admin?(user, ability)
+        return Hyrax::CollectionType.all.pluck(Arel.sql('DISTINCT id')) if user_admin?(user, ability)
         Hyrax::CollectionTypeParticipant.where(agent_type: Hyrax::CollectionTypeParticipant::USER_TYPE,
                                                agent_id: user_id(user, ability),
                                                access: roles)
@@ -21,7 +21,7 @@ module Hyrax
                                           Hyrax::CollectionTypeParticipant.where(agent_type: Hyrax::CollectionTypeParticipant::GROUP_TYPE,
                                                                                  agent_id: user_groups(user, ability),
                                                                                  access: roles)
-                                        ).pluck('DISTINCT hyrax_collection_type_id')
+                                        ).pluck(Arel.sql('DISTINCT hyrax_collection_type_id'))
       end
 
       # @api public
@@ -174,7 +174,7 @@ module Hyrax
       def self.agent_ids_for(collection_type:, agent_type:, access:)
         Hyrax::CollectionTypeParticipant.where(hyrax_collection_type_id: collection_type.id,
                                                agent_type: agent_type,
-                                               access: access).pluck('DISTINCT agent_id')
+                                               access: access).pluck(Arel.sql('DISTINCT agent_id'))
       end
       private_class_method :agent_ids_for
 

data/app/services/hyrax/collections/permissions_service.rb

@@ -13,7 +13,7 @@ module Hyrax
       def self.source_ids_for_user(access:, ability:, source_type: nil, exclude_groups: [])
         scope = PermissionTemplateAccess.for_user(ability: ability, access: access, exclude_groups: exclude_groups)
                                         .joins(:permission_template)
-        ids = scope.pluck('DISTINCT source_id')
+        ids = scope.pluck(Arel.sql('DISTINCT source_id'))
         return ids unless source_type
         filter_source(source_type: source_type, ids: ids)
       end

data/app/services/hyrax/contextual_path.rb

@@ -10,7 +10,7 @@ module Hyrax
 
     def show
       if parent_presenter
-        polymorphic_path([:hyrax, :parent, presenter.model_name.singular],
+        polymorphic_path([:hyrax, :parent, presenter.model_name.singular.to_sym],
                          parent_id: parent_presenter.id,
                          id: presenter.id)
       else