blacklight-spotlight 0.32.0 → 0.33.0

data/app/models/spotlight/reindexing_log_entry.rb

@@ -10,6 +10,7 @@ module Spotlight
     # null start times sort to the top, to more easily surface pending reindexing
     default_scope { order('start_time IS NOT NULL, start_time DESC') }
     scope :recent, -> { limit(5) }
+    scope :started_or_completed, -> { where.not(job_status: 'unstarted') }
 
     def duration
       end_time - start_time if end_time

data/app/models/spotlight/resources/iiif_harvester.rb

@@ -0,0 +1,33 @@
+require 'iiif/presentation'
+
+module Spotlight
+  module Resources
+    # harvest Images from IIIF Manifest and turn them into a Spotlight::Resource
+    # Note: IIIF API : http://iiif.io/api/presentation/2.0
+    class IiifHarvester < Spotlight::Resource
+      self.document_builder_class = Spotlight::Resources::IiifBuilder
+      self.weight = -5000
+
+      validate :valid_url?
+
+      def iiif_manifests
+        @iiif_manifests ||= IiifService.parse(url)
+      end
+
+      private
+
+      def valid_url?
+        errors.add(:url, 'Invalid IIIF URL') unless url_is_iiif?(url)
+      end
+
+      def url_is_iiif?(url)
+        valid_content_types = ['application/json', 'application/ld+json']
+        req = Faraday.head(url)
+        return unless req.success?
+        valid_content_types.any? do |valid_type|
+          req.headers['content-type'].include?(valid_type)
+        end
+      end
+    end
+  end
+end

data/app/models/spotlight/resources/iiif_manifest.rb

@@ -0,0 +1,211 @@
+module Spotlight
+  module Resources
+    ##
+    # A PORO to construct a solr hash for a given IiifManifest
+    class IiifManifest
+      attr_reader :collection
+      def initialize(attrs = {})
+        @url = attrs[:url]
+        @manifest = attrs[:manifest]
+        @collection = attrs[:collection]
+        @solr_hash = {}
+      end
+
+      def to_solr
+        add_document_id
+        add_label
+        add_thumbnail_url
+        add_full_image_urls
+        add_manifest_url
+        add_image_urls
+        add_metadata
+        add_collection_id
+        solr_hash
+      end
+
+      def with_exhibit(e)
+        @exhibit = e
+      end
+
+      def compound_id
+        Digest::MD5.hexdigest("#{exhibit.id}-#{url}")
+      end
+
+      private
+
+      attr_reader :url, :manifest, :exhibit, :solr_hash
+      delegate :blacklight_config, to: :exhibit
+
+      def add_document_id
+        solr_hash[exhibit.blacklight_config.document_model.unique_key.to_sym] = compound_id
+      end
+
+      def add_collection_id
+        solr_hash[collection_id_field] = [collection.compound_id] if collection
+      end
+
+      def collection_id_field
+        Spotlight::Engine.config.iiif_collection_id_field
+      end
+
+      def add_manifest_url
+        solr_hash[Spotlight::Engine.config.iiif_manifest_field] = url
+      end
+
+      def add_thumbnail_url
+        return unless thumbnail_field && manifest['thumbnail'].present?
+        solr_hash[thumbnail_field] = manifest['thumbnail']['@id']
+      end
+
+      def add_full_image_urls
+        return unless full_image_field && full_image_url
+        solr_hash[full_image_field] = full_image_url
+      end
+
+      def add_label
+        return unless title_field && manifest.try(:label)
+        solr_hash[title_field] = manifest.label
+      end
+
+      def add_image_urls
+        solr_hash[tile_source_field] = image_urls
+      end
+
+      def add_metadata
+        solr_hash.merge!(manifest_metadata)
+        sidecar.update(data: sidecar.data.merge(manifest_metadata))
+      end
+
+      def manifest_metadata
+        metadata = metadata_class.new(manifest).to_solr
+        return {} unless metadata.present?
+        create_sidecars_for(*metadata.keys)
+
+        metadata.each_with_object({}) do |(key, value), hash|
+          next unless (field = exhibit_custom_fields[key])
+          hash[field.field] = value
+        end
+      end
+
+      def create_sidecars_for(*keys)
+        missing_keys(keys).each do |k|
+          exhibit.custom_fields.create! label: k, readonly_field: true
+        end
+        @exhibit_custom_fields = nil
+      end
+
+      def missing_keys(keys)
+        custom_field_keys = exhibit_custom_fields.keys.map(&:downcase)
+        keys.reject do |key|
+          custom_field_keys.include?(key.downcase)
+        end
+      end
+
+      def exhibit_custom_fields
+        @exhibit_custom_fields ||= exhibit.custom_fields.each_with_object({}) do |value, hash|
+          hash[value.label] = value
+        end
+      end
+
+      def image_urls
+        @image_urls ||= resources.map do |resource|
+          next unless resource && !resource.service.empty?
+          image_url = resource.service['@id']
+          image_url << '/info.json' unless image_url.downcase.ends_with?('/info.json')
+          image_url
+        end
+      end
+
+      def full_image_url
+        resources.first.try(:[], '@id')
+      end
+
+      def resources
+        @resources ||= sequences
+                       .flat_map(&:canvases)
+                       .flat_map(&:images)
+                       .flat_map(&:resource)
+      end
+
+      def sequences
+        manifest.try(:sequences) || []
+      end
+
+      def thumbnail_field
+        blacklight_config.index.try(:thumbnail_field)
+      end
+
+      def full_image_field
+        Spotlight::Engine.config.full_image_field
+      end
+
+      def tile_source_field
+        blacklight_config.show.try(:tile_source_field)
+      end
+
+      def title_field
+        blacklight_config.index.try(:title_field)
+      end
+
+      def sidecar
+        @sidecar ||= document_model.new(id: compound_id).sidecar(exhibit)
+      end
+
+      def document_model
+        exhibit.blacklight_config.document_model
+      end
+
+      def metadata_class
+        Spotlight::Engine.config.iiif_metadata_class.call
+      end
+
+      ###
+      #  A simple class to map the metadata field
+      #  in a IIIF document to label/value pairs
+      #  This is intended to be overriden by an
+      #  application if a different metadata
+      #  strucure is used by the consumer
+      class Metadata
+        def initialize(manifest)
+          @manifest = manifest
+        end
+
+        def to_solr
+          metadata_hash.merge(manifest_level_metadata)
+        end
+
+        private
+
+        attr_reader :manifest
+
+        def metadata
+          manifest.try(:metadata) || []
+        end
+
+        def metadata_hash
+          return {} unless metadata.present?
+          return {} unless metadata.is_a?(Array)
+
+          metadata.each_with_object({}) do |md, hash|
+            next unless md['label'] && md['value']
+            hash[md['label']] ||= []
+            hash[md['label']] += Array(md['value'])
+          end
+        end
+
+        def manifest_level_metadata
+          manifest_fields.each_with_object({}) do |field, hash|
+            next unless manifest.respond_to?(field) &&
+                        manifest.send(field).present?
+            hash[field.capitalize] ||= []
+            hash[field.capitalize] += Array(manifest.send(field))
+          end
+        end
+
+        def manifest_fields
+          %w(attribution description license)
+        end
+      end
+    end
+  end
+end

data/app/models/spotlight/resources/iiif_service.rb

@@ -0,0 +1,93 @@
+require 'iiif/presentation'
+module Spotlight
+  module Resources
+    ###
+    # Wrapper around IIIF-Presentation's IIIF::Service that provides the
+    # ability to recursively traverse through all collections and manifests
+    class IiifService
+      def initialize(url)
+        @url = url
+      end
+
+      def collections
+        @collections ||= (object.try(:collections) || []).map do |collection|
+          self.class.new(collection['@id'])
+        end
+      end
+
+      def manifests
+        @manifests ||= if manifest?
+                         [create_iiif_manifest(object)]
+                       else
+                         build_collection_manifest.to_a
+                       end
+      end
+
+      def self.parse(url)
+        recursive_manifests(new(url))
+      end
+
+      protected
+
+      def object
+        @object ||= IIIF::Service.parse(response)
+      end
+
+      private
+
+      attr_reader :url
+
+      class << self
+        def iiif_response(url)
+          Faraday.get(url).body
+        rescue Faraday::Error::ConnectionFailed, Faraday::TimeoutError => e
+          Rails.logger.warn("HTTP GET for #{url} failed with #{e}")
+          {}.to_json
+        end
+
+        private
+
+        def recursive_manifests(thing, &block)
+          return to_enum(:recursive_manifests, thing) unless block_given?
+
+          thing.manifests.each(&block)
+
+          return unless thing.collections.present?
+
+          thing.collections.each do |collection|
+            recursive_manifests(collection, &block)
+          end
+        end
+      end
+
+      def create_iiif_manifest(manifest, collection = nil)
+        IiifManifest.new(url: manifest['@id'], manifest: manifest, collection: collection)
+      end
+
+      def manifest?
+        object.is_a?(IIIF::Presentation::Manifest)
+      end
+
+      def collection?
+        object.is_a?(IIIF::Presentation::Collection)
+      end
+
+      def response
+        @response ||= self.class.iiif_response(url)
+      end
+
+      def build_collection_manifest
+        return to_enum(:build_collection_manifest) unless block_given?
+
+        if collection?
+          self_manifest = create_iiif_manifest(object)
+          yield self_manifest
+        end
+
+        (object.try(:manifests) || []).each do |manifest|
+          yield create_iiif_manifest(self.class.new(manifest['@id']).object, self_manifest)
+        end
+      end
+    end
+  end
+end

data/app/models/spotlight/resources/upload.rb

@@ -4,8 +4,7 @@ module Spotlight
     ##
     # Exhibit-specific resources, created using uploaded and custom fields
     class Upload < Spotlight::Resource
-      mount_uploader :url, Spotlight::ItemUploader
-      include Spotlight::ImageDerivatives
+      belongs_to :upload, class_name: 'Spotlight::FeaturedImage'
 
       # we want to do this before reindexing
       after_create :update_document_sidecar

data/app/models/spotlight/search.rb

@@ -2,7 +2,6 @@ module Spotlight
   ##
   # Exhibit saved searches
   class Search < ActiveRecord::Base
-    include DefaultThumbnailable
     extend FriendlyId
     friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
 
@@ -16,23 +15,12 @@ module Spotlight
 
     belongs_to :masthead, dependent: :destroy
     belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
-    accepts_nested_attributes_for :thumbnail, update_only: true
-    accepts_nested_attributes_for :masthead, update_only: true
+    accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
+    accepts_nested_attributes_for :masthead, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     def thumbnail_image_url
-      thumbnail.image.thumb.url if thumbnail && thumbnail.image
-    end
-
-    def images
-      return enum_for(:images) { documents.size } unless block_given?
-
-      documents.each do |doc|
-        yield [
-          doc.first(blacklight_config.document_model.unique_key),
-          doc.first(blacklight_config.index.title_field),
-          doc.first(blacklight_config.index.thumbnail_field)
-        ]
-      end
+      return unless thumbnail && thumbnail.iiif_url
+      thumbnail.iiif_url
     end
 
     def documents
@@ -58,22 +46,6 @@ module Spotlight
       masthead && masthead.display?
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def set_default_thumbnail
-      self.thumbnail ||= begin
-        return unless Spotlight::Engine.config.full_image_field
-        doc = documents.detect { |x| x.first(Spotlight::Engine.config.full_image_field) }
-        if doc
-          create_thumbnail(
-            source: 'exhibit',
-            document_global_id: doc.to_global_id.to_s,
-            remote_image_url: doc.first(Spotlight::Engine.config.full_image_field)
-          )
-        end
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-
     def search_params
       search_builder.with(query_params.with_indifferent_access).merge(facet: false, fl: default_search_fields)
     end
@@ -102,8 +74,7 @@ module Spotlight
       [
         blacklight_config.document_model.unique_key,
         blacklight_config.index.title_field,
-        blacklight_config.index.thumbnail_field,
-        Spotlight::Engine.config.full_image_field
+        blacklight_config.index.thumbnail_field
       ].compact
     end
 

data/app/presenters/spotlight/iiif_manifest_presenter.rb

@@ -0,0 +1,79 @@
+module Spotlight
+  ##
+  # A presenter class that provides the methods that IIIFManifest expects, as well as convenience methods
+  #  that will generate a IIIFManifest object, and the actual JSON manifest from the IIIFManifest object.
+  #  Instances of this class represent IIIF leaf nodes.  We do not currently generate manifests with interstitial
+  #  nodes.
+  #
+  # IIIFManifest expects the following methods:  #file_set_presenters, #work_presenters, #manifest_url, #description.
+  #  see: https://github.com/projecthydra-labs/iiif_manifest/blob/master/README.md
+  class IiifManifestPresenter
+    require 'iiif_manifest'
+
+    # The class that represents the leaf nodes must implement #id (here implemented
+    # via delegation to the resource, since this class represents leaf nodes).
+    delegate :id, :uploaded_resource, to: :resource
+    delegate :blacklight_config, to: :controller
+
+    attr_accessor :resource, :controller
+
+    def initialize(resource, controller)
+      @resource = resource
+      @controller = controller
+    end
+
+    # IIIFManifest expects leaf nodes to implement #display_image, which returns an instance of IIIFManifest::DisplayImage.
+    def display_image
+      IIIFManifest::DisplayImage.new(id,
+                                     width: resource.first(:spotlight_full_image_width_ssm),
+                                     height: resource.first(:spotlight_full_image_height_ssm),
+                                     format: 'image/jpeg',
+                                     iiif_endpoint: endpoint)
+    end
+
+    # Returns an array of leaf nodes.  Currently, this is a single element array containing this presenter
+    # instance, since we're only building a single-image manifest for the given resource.
+    def file_set_presenters
+      [self]
+    end
+
+    # This is an empty array, since we're not building manifests for works at the moment.
+    def work_presenters
+      []
+    end
+
+    # where this manifest can be found
+    def manifest_url
+      controller.spotlight.manifest_exhibit_solr_document_url(uploaded_resource.exhibit, resource)
+    end
+
+    # a description of the manifest
+    def description
+      resource.first(Spotlight::Engine.config.upload_description_field)
+    end
+
+    # IIIFManifest will call #to_s on each leaf node to get its respective label (not called out in README).
+    def to_s
+      resource.first(blacklight_config.view_config(:show).title_field)
+    end
+
+    def iiif_manifest
+      IIIFManifest::ManifestFactory.new(self)
+    end
+
+    def iiif_manifest_json
+      iiif_manifest.to_h.to_json
+    end
+
+    private
+
+    def endpoint
+      IIIFManifest::IIIFEndpoint.new(iiif_url, profile: 'http://iiif.io/api/image/2/level2.json')
+    end
+
+    def iiif_url
+      # yes this is hacky, and we are appropriately ashamed.
+      controller.riiif.info_url.sub(%r{/info\.json\Z}, '')
+    end
+  end
+end