iiif_print 1.0.0 → 1.1.0

data/app/services/iiif_print/manifest_builder_service_behavior.rb

@@ -1,14 +1,20 @@
 module IiifPrint
+  # rubocop:disable Metrics/ModuleLength
   module ManifestBuilderServiceBehavior
     def initialize(*args,
                    version: IiifPrint.config.default_iiif_manifest_version,
                    iiif_manifest_factory: iiif_manifest_factory_for(version),
                    &block)
-      super(*args, iiif_manifest_factory: iiif_manifest_factory, &block)
+      # Ensure we're setting the version before we go any further.
       @version = version.to_i
+      @child_works = nil
+      super(*args, iiif_manifest_factory: iiif_manifest_factory, &block)
     end
 
+    attr_reader :child_works, :version
+
     def manifest_for(presenter:)
+      @child_works = get_solr_hits(member_ids_for(presenter))
       build_manifest(presenter: presenter)
     end
 
@@ -36,62 +42,113 @@ module IiifPrint
       # ManifestFactory interface?
       manifest = manifest_factory.new(presenter).to_h
       hash = JSON.parse(manifest.to_json)
-      hash = send("sanitize_v#{@version}", hash: hash, presenter: presenter)
-      send("sorted_canvases_v#{@version}", hash: hash, sort_field: IiifPrint.config.sort_iiif_manifest_canvases_by)
+      parent_and_child_solr_hits = parent_and_child_solr_hits(presenter) if @child_works.present?
+      hash = send("sanitize_v#{@version}", hash: hash, presenter: presenter, solr_doc_hits: parent_and_child_solr_hits)
+      if @child_works.present? && IiifPrint.config.sort_iiif_manifest_canvases_by
+        send("sort_canvases_v#{@version}",
+             hash: hash,
+             sort_field: IiifPrint.config.sort_iiif_manifest_canvases_by)
+      end
+      hash
     end
 
-    def sanitize_v2(hash:, presenter:)
+    def sanitize_v2(hash:, presenter:, solr_doc_hits:)
       hash['label'] = CGI.unescapeHTML(sanitize_value(hash['label'])) if hash.key?('label')
       hash.delete('description') # removes default description since it's in the metadata fields
       hash['sequences']&.each do |sequence|
         sequence['canvases']&.each do |canvas|
           canvas['label'] = CGI.unescapeHTML(sanitize_value(canvas['label']))
-          apply_v2_metadata_to_canvas(canvas: canvas, presenter: presenter)
+          apply_metadata_to_canvas(canvas: canvas, presenter: presenter, solr_doc_hits: solr_doc_hits)
         end
       end
       hash
     end
 
-    def sanitize_v3(hash:, **)
-      # TODO: flesh out metadata for v3
+    def sanitize_v3(hash:, presenter:, solr_doc_hits:)
+      hash['label']['none'].map! { |text| CGI.unescapeHTML(sanitize_value(text)) } if hash.key('label')
+      hash['items'].each do |canvas|
+        canvas['label']['none'].map! { |text| CGI.unescapeHTML(sanitize_value(text)) }
+        apply_metadata_to_canvas(canvas: canvas, presenter: presenter, solr_doc_hits: solr_doc_hits)
+      end
       hash
     end
 
-    def apply_v2_metadata_to_canvas(canvas:, presenter:)
-      solr_docs = get_solr_docs(presenter)
-      # uses the '@id' property which is a URL that contains the FileSet id
-      file_set_id = canvas['@id'].split('/').last
+    def apply_metadata_to_canvas(canvas:, presenter:, solr_doc_hits:)
+      return if @child_works.empty?
+
+      # uses the 'id' property for v3 manifest and `@id' for v2, which is a URL that contains the FileSet id
+      file_set_id = (canvas['id'] || canvas['@id']).split('/').last
       # finds the image that the FileSet is attached to and creates metadata on that canvas
-      image = solr_docs.find { |doc| doc[:member_ids_ssim]&.include?(file_set_id) }
-      canvas_metadata = IiifPrint.manifest_metadata_for(work: image,
-                                                        current_ability: presenter.ability,
-                                                        base_url: presenter.base_url)
-      canvas['metadata'] = canvas_metadata
+      image = solr_doc_hits.find { |hit| hit[:member_ids_ssim]&.include?(file_set_id) }
+      return unless image
+      # prevents duplicating the child and parent metadata
+      return if image.id == presenter.id
+
+      canvas['metadata'] = IiifPrint.manifest_metadata_from(work: image, presenter: presenter)
+    end
+
+    LARGEST_SORT_ORDER_CHAR = '~'.freeze
+
+    def sort_canvases_v2(hash:, sort_field:)
+      return sort_by_label_v2(hash) if sort_field == :label
+
+      sort_field = Hyrax::Renderers::AttributeRenderer.new(sort_field, nil).label
+      hash['sequences']&.first&.[]('canvases')&.sort_by! do |canvas|
+        selection = canvas['metadata'].select { |h| h['label'] == sort_field }
+        fallback = [{ label: sort_field,
+                      value: [LARGEST_SORT_ORDER_CHAR] }]
+        sort_field_metadata = selection.presence || fallback
+        sort_field_metadata.first['value'] if sort_field_metadata.present?
+      end
+      hash
     end
 
-    def sorted_canvases_v2(hash:, sort_field:)
+    def sort_canvases_v3(hash:, sort_field:)
       sort_field = Hyrax::Renderers::AttributeRenderer.new(sort_field, nil).label
-      hash["sequences"]&.first&.[]("canvases")&.sort_by! do |canvas|
-        selection = canvas["metadata"].select { |h| h["label"] == sort_field }
-        fallback = [{ label: sort_field, value: ['~'] }]
-        identifier_metadata = selection.presence || fallback
-        identifier_metadata.first["value"] if identifier_metadata.present?
+      hash['items']&.sort_by! do |item|
+        selection = item['metadata'].select { |h| h['label'][I18n.locale.to_s] == [sort_field] }
+        fallback = [{ label: { "#{I18n.locale}": [sort_field] },
+                      value: { none: [LARGEST_SORT_ORDER_CHAR] } }]
+        sort_field_metadata = selection.presence || fallback
+        sort_field_metadata.first['value']['none'] if sort_field_metadata.present?
       end
       hash
     end
 
-    def sorted_canvases_v3(hash:, **)
-      # TODO: flesh out metadata for v3
+    # TODO: implement this for v3
+    def sort_by_label_v2(hash)
+      hash['sequences']&.first&.[]('canvases')&.sort_by! do |canvas|
+        canvas['label']
+      end
       hash
     end
 
-    def get_solr_docs(presenter)
-      parent_id = [presenter._source['id']]
-      child_ids = presenter._source['member_ids_ssim']
-      parent_id_and_child_ids = parent_id + child_ids
-      query = ActiveFedora::SolrQueryBuilder.construct_query_for_ids(parent_id_and_child_ids)
-      solr_hits = ActiveFedora::SolrService.query(query, fq: "-has_model_ssim:FileSet", rows: 100_000)
-      solr_hits.map { |solr_hit| ::SolrDocument.new(solr_hit) }
+    def member_ids_for(presenter)
+      member_ids = presenter.try(:ordered_ids) || presenter.try(:member_ids)
+      member_ids.nil? ? [] : member_ids
+    end
+
+    def parent_and_child_solr_hits(presenter)
+      get_solr_hits([presenter.id]) + @child_works
+    end
+
+    SOLR_QUERY_PAGE_SIZE = 512
+    ##
+    # return an array of work SolrHits, gathered via paginated segmentation of the ids list
+    # to avoid Solr's limit on 1024 logical connections
+    # @param ids [Array]
+    # @return [Array<ActiveFedora::SolrHit>]
+    def get_solr_hits(ids)
+      results = []
+      ids.each_slice(SOLR_QUERY_PAGE_SIZE) do |paged_ids|
+        query = "id:(#{paged_ids.join(' OR ')})"
+        results += ActiveFedora::SolrService.query(
+          query,
+          { fq: "-has_model_ssim:FileSet", rows: paged_ids.size, method: :post }
+        )
+      end
+      results
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/app/services/iiif_print/pluggable_derivative_service.rb

@@ -39,7 +39,7 @@ class IiifPrint::PluggableDerivativeService
   #   multiple plugins, some of which may or may not be valid, so
   #   validity checks happen within as well.
   def valid?
-    !valid_plugins.size.zero?
+    !valid_plugins.empty?
   end
 
   # get derivative services relevant to method name and file_set context
@@ -105,16 +105,10 @@ class IiifPrint::PluggableDerivativeService
   # set would use.  That "possibility" is based on the work.  Later, we will check the plugin's
   # "valid?" which would now look at the specific file_set for validity.
   def plugins_for(file_set)
-    parent = parent_for(file_set)
+    parent = IiifPrint.parent_for(file_set)
     return Array(default_plugins) if parent.nil?
     return Array(default_plugins) unless parent.respond_to?(:iiif_print_config)
 
-    (file_set.parent.iiif_print_config.derivative_service_plugins + Array(default_plugins)).flatten.compact.uniq
-  end
-
-  def parent_for(file_set)
-    # fallback to Fedora-stored relationships if work's aggregation of
-    #   file set is not indexed in Solr
-    file_set.parent || file_set.member_of.find(&:work?)
+    (parent.iiif_print_config.derivative_service_plugins + Array(default_plugins)).flatten.compact.uniq
   end
 end

data/app/views/catalog/_index_header_list_default.html.erb

@@ -0,0 +1,13 @@
+<%# OVERRIDE Hyrax 2.9.6 to show parent_query params if metadata is found in parent record %>
+
+<div class="search-results-title-row">
+  <h3 class="search-result-title">
+  <% if params['q'].present? && document.any_highlighting? %>
+    <%= link_to document.title_or_label, [document, { parent_query: params['q'] }] %></h3>
+  <% elsif params['q'].present? %>
+    <%= link_to document.title_or_label, [document, { query: params['q'] }] %></h3>
+  <% else %>
+    <%= link_to document.title_or_label, document %></h3>
+  <% end %>
+  </h3>
+</div>

data/app/views/hyrax/base/_representative_media.html.erb

@@ -1,9 +1,10 @@
-<% if presenter.iiif_viewer? %>
-  <% if defined?(viewer) && viewer %>
+<% if presenter.representative_id.present? && presenter.representative_presenter.present? %>
+  <% if defined?(viewer) && viewer && presenter.iiif_viewer? %>
     <%= iiif_viewer_display presenter %>
   <% else %>
     <%= render media_display_partial(presenter.representative_presenter), file_set: presenter.representative_presenter %>
   <% end %>
 <% else %>
-  <%= image_tag 'default.png', class: "canonical-image", alt: 'default representative image' %>
+  <% alt = block_for(name: 'default_work_image_text') || 'Default work thumbnail' %>
+  <%= image_tag default_work_image, class: "canonical-image", alt: alt %>
 <% end %>

data/app/views/hyrax/base/iiif_viewers/_universal_viewer.html.erb

@@ -1,7 +1,7 @@
 <div class="viewer-wrapper">
   <iframe
     id="uv-iframe"
-    src="<%= universal_viewer_base_url %>#?manifest=<%= main_app.polymorphic_url [main_app, :manifest, presenter], { locale: nil } %>&config=<%= universal_viewer_config_url %>"
+    src="<%= universal_viewer_base_url %>#?manifest=<%= main_app.polymorphic_url [main_app, :manifest, presenter], { locale: nil } %>&config=<%= universal_viewer_config_url %><%= uv_search_param %>"
     allowfullscreen="true"
     frameborder="0"
   ></iframe>

data/app/views/hyrax/file_sets/_actions.html.erb

@@ -32,7 +32,8 @@
       <%= link_to 'Download', hyrax.download_path(file_set),
         title: "Download #{file_set.to_s.inspect}", target: "_blank" %>
     </li>
-    <% IiifPrint::Data::WorkDerivatives.new(file_set.id).keys.each do |name| %>
+    <% work_deriv = IiifPrint::Data::WorkDerivatives.new(fileset: file_set) %>
+    <% work_deriv.keys.each do |name| %>
       <li role="menuitem" tabindex="-1">
         <a href="<%= "/downloads/#{file_set.id}?locale=en&file=#{name}" %>" download>
           Download <em>(as <%= name %>)</em>

data/app/views/hyrax/file_sets/_show_actions.html.erb

@@ -0,0 +1,24 @@
+<div class="form-actions">
+  <% if Hyrax.config.analytics? %>
+    <% # turbolinks needs to be turned off or the page will use the cache and the %>
+    <% # analytics graph will not show unless the page is refreshed. %>
+    <%= link_to t('.analytics'), @presenter.stats_path, id: 'stats', class: 'btn btn-default', data: { turbolinks: false } %>
+  <% end %>
+
+  <%# Hyrax 2.9.6 does not respond to workflow_restriction; that is something added in later versions. %>
+  <% if @presenter.editor? && (!respond_to?(:workflow_restriction?) || !workflow_restriction?(@presenter)) %>
+      <%= link_to t(".edit_this", type: @presenter.human_readable_type), edit_polymorphic_path([main_app, @presenter]),
+                  class: 'btn btn-default' %>
+      <%= link_to t(".delete_this", type: @presenter.human_readable_type), [main_app, @presenter],
+                  class: 'btn btn-danger', data: { confirm: t(".confirm_delete_this", type: @presenter.human_readable_type) },
+                  method: :delete %>
+  <% end %>
+
+  <% if @presenter.editor? && @presenter.pdf? %>
+    <%= link_to t("iiif_print.file_set.split_this"), iiif_print.split_pdf_path(@presenter),
+     class: 'btn btn-default', data: { confirm: t("iiif_print.file_set.confirm_split_this") },
+     method: :post %>
+  <% end %>
+
+  <%= render 'social_media' %>
+</div>

data/config/locales/iiif_print.en.yml

@@ -52,6 +52,10 @@ en:
         label: 'Place of publication'
       publication_title:
         label: 'Publication'
+    file_set:
+      split_this: 'Re-Split PDF'
+      confirm_split_this: 'Re-Split PDF'
+      split_submitted: 'Submitted PDF re-splitting job for FileSet ID=%{id}'
     newspapers_search:
       title:                    'Search Newspapers'
       text:                     'Use this form to search for full-text newspaper content.'

data/config/routes.rb

@@ -0,0 +1,3 @@
+IiifPrint::Engine.routes.draw do
+  post "split_pdfs/:file_set_id" => "split_pdfs#create", as: :split_pdf
+end

data/db/migrate/20231110163052_add_model_details_to_iiif_print_pending_relationships.rb

@@ -0,0 +1,7 @@
+class AddModelDetailsToIiifPrintPendingRelationships < ActiveRecord::Migration[5.2]
+  def change
+    add_column :iiif_print_pending_relationships, :parent_model, :string
+    add_column :iiif_print_pending_relationships, :child_model, :string
+    add_column :iiif_print_pending_relationships, :file_id, :string
+  end
+end

data/docker-compose.yml

@@ -85,12 +85,12 @@ services:
     environment:
       - VIRTUAL_PORT=3000
       - VIRTUAL_HOST=.hyku.test
-    command: tail -f /dev/null
+    # command: tail -f /dev/null
     ##
     ## Similar to the above, except we will bundle and then tell the container
     ## to wait.  You'll then need to bash into the web container to do much of
     ## anything.
-    # command: sh -l -c "bundle && echo \"Finished bundling now waiting...\" && tail -f /dev/null"
+    command: sh -l -c "bundle install && echo \"Finished bundling now waiting...\" && tail -f /dev/null"
     depends_on:
       db:
         condition: service_started

data/iiif_print.gemspec

@@ -12,21 +12,18 @@ Gem::Specification.new do |spec|
   spec.email       = ['sean.upton@utah.edu', 'jacob.reed@utah.edu',
                       'brian.mcbride@utah.edu', 'eenglish@bpl.org', 'kirk.wang@scientist.com',
                       'larita@scientist.com', 'jeremy.n.friesen@gmail.com']
-  spec.homepage    = 'https://github.com/samvera-labs/iiif_print'
+  spec.homepage    = 'https://github.com/scientist-softserv/iiif_print/'
   spec.description = 'Gem/Engine for IIIF Print works in Hyrax-based Samvera Application.'
   spec.summary     = <<-SUMMARY
-  iiif_print is a Rails Engine gem providing model and administrative
-  functions to Hyrax-based Samvera applications, for management of
-  (primarily scanned) content.
+  IiifPrint is a gem (Rails "engine") for Hyrax-based digital repository applications to support displaying parent/child works in the same viewer (Universal Viewer) and the ability to search OCR from the parent work to the child work(s). IiifPring was originally based off of the samvera-labs Newspaper gem.
 SUMMARY
   spec.license = 'Apache-2.0'
   spec.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.add_dependency 'blacklight_iiif_search', '~> 1.0'
-  spec.add_dependency 'dry-monads', '~> 1.4.0'
-  spec.add_dependency 'hyrax', '>= 2.5', '< 4.0'
+  spec.add_dependency 'blacklight_iiif_search', '>= 1.0', '< 3.0'
+  spec.add_dependency 'derivative-rodeo', "~> 0.5"
+  spec.add_dependency 'hyrax', '>= 2.5', '< 6'
   spec.add_dependency 'nokogiri', '>=1.13.2'
-  spec.add_dependency 'rails', '~> 5.0'
   spec.add_dependency 'rdf-vocab', '~> 3.0'
 
   spec.add_development_dependency 'bixby'
@@ -34,10 +31,14 @@ SUMMARY
   spec.add_development_dependency 'engine_cart', '~> 2.2'
   spec.add_development_dependency "factory_bot", '~> 4.4'
   spec.add_development_dependency 'fcrepo_wrapper', '~> 0.5', '>= 0.5.1'
+  # TODO: We want to remove dependency on this
   spec.add_development_dependency 'newspaper_works_fixtures', '~> 0.3', '>=0.3.1'
   spec.add_development_dependency 'rails-controller-testing', '~> 1'
-  spec.add_development_dependency 'rspec-rails', '~> 3.1'
+  spec.add_development_dependency 'json-canonicalization', '0.3.1'
+  spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'rspec-activemodel-mocks'
   spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
   spec.add_development_dependency 'solr_wrapper', '>= 1.1', '< 3.0'
+  spec.add_development_dependency 'solargraph'
+  spec.add_development_dependency 'yard'
 end

data/lib/generators/iiif_print/install_generator.rb

@@ -15,13 +15,21 @@ module IiifPrint
       say_status('info',
                  'BLACKLIGHT IIIF SEARCH NOT INSTALLED; INSTALLING BLACKLIGHT IIIF SEARCH',
                  :blue)
-      generate 'blacklight_iiif_search:install'
+      generate 'blacklight_iiif_search:install --skip-solr'
     end
 
     def catalog_controller_configuration
       generate 'iiif_print:catalog_controller'
     end
 
+    def install_routes
+      return if IO.read('config/routes.rb').include?('mount IiifPrint::Engine')
+
+      inject_into_file 'config/routes.rb', after: /mount Hyrax::Engine\s*\n/ do
+        "  mount IiifPrint::Engine, at: '/'\n"\
+      end
+    end
+
     def inject_configuration
       copy_file 'config/initializers/iiif_print.rb'
     end
@@ -30,6 +38,10 @@ module IiifPrint
       generate 'iiif_print:assets'
     end
 
+    def inject_helper
+      copy_file 'helpers/iiif_print_helper.rb' 'app/helpers/iiif_print_helper.rb'
+    end
+
     # Blacklight IIIF Search generator has some linting that does not agree with CircleCI on Hyku
     # ref https://github.com/boston-library/blacklight_iiif_search/blob/v1.0.0/lib/generators/blacklight_iiif_search/controller_generator.rb
     # the follow two methods does a clean up to appease Rubocop
@@ -48,5 +60,13 @@ module IiifPrint
       contents.insert(0, "# frozen_string_literal: true\n\n")
       File.write(file, contents)
     end
+
+    def add_allinson_flex_fields_method_to_iiif_search_builder
+      file_path = "app/models/iiif_search_builder.rb"
+      contents = File.read(file_path)
+      contents.gsub!('include Blacklight::Solr::SearchBuilderBehavior', "include Blacklight::Solr::SearchBuilderBehavior\n  include IiifPrint::AllinsonFlexFields")
+      contents.gsub!('self.default_processor_chain += [:ocr_search_params]', 'self.default_processor_chain += %i[ocr_search_params include_allinson_flex_fields]')
+      File.write(file_path, contents)
+    end
   end
 end

data/lib/generators/iiif_print/templates/config/initializers/iiif_print.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Lint/UnusedBlockArgument
 IiifPrint.config do |config|
   # NOTE: WorkTypes and models are used synonymously here.
   # Add models to be excluded from search so the user
@@ -15,8 +16,14 @@ IiifPrint.config do |config|
   # @example
   #   config.excluded_model_name_solr_field_key = 'some_solr_field_key'
 
-  # Configure how the manifest sorts the canvases, by default it sorts by :title,
-  # but a different model property may be desired such as :date_published
-  # @example
-  #   config.sort_iiif_manifest_canvases_by = :date_published
+  if Rails.env.development?
+    if DerivativeRodeo.config.aws_s3_access_key_id.present? && DerivativeRodeo.config.aws_s3_secret_access_key.present?
+      Rails.logger.info("DerivativeRodeo S3 Credentials detected using 's3' for IiifPrint::DerivativeRodeoService.preprocessed_location_adapter_name")
+      IiifPrint::DerivativeRodeoService.preprocessed_location_adapter_name = 's3'
+    else
+      Rails.logger.info("DerivativeRodeo S3 Credentials not-detected using 'file' for IiifPrint::DerivativeRodeoService.preprocessed_location_adapter_name")
+      IiifPrint::DerivativeRodeoService.preprocessed_location_adapter_name = 'file'
+    end
+  end
 end
+# rubocop:enable Lint/UnusedBlockArgument

data/lib/generators/iiif_print/templates/helpers/iiif_print_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IiifPrintHelper
+  include IiifPrint::IiifPrintHelperBehavior
+end

data/lib/iiif_print/base_derivative_service.rb

@@ -25,7 +25,8 @@ module IiifPrint
     # @see IiifPrint::PluggableDerivativeService#plugins_for
     # @return [Boolean]
     def valid?
-      true
+      # @note We are taking a shortcut because currently we are only concerned about images.
+      file_set.class.image_mime_types.include?(file_set.mime_type)
     end
 
     def derivative_path_factory

data/lib/iiif_print/blacklight_iiif_search/annotation_decorator.rb

@@ -2,6 +2,7 @@
 module IiifPrint
   module BlacklightIiifSearch
     module AnnotationDecorator
+      INVALID_MATCH_TEXT = "#xywh=INVALID,INVALID,INVALID,INVALID".freeze
       ##
       # Create a URL for the annotation
       # use a Hyrax-y URL syntax:
@@ -28,23 +29,33 @@ module IiifPrint
       # @return [String]
       def coordinates
         return default_coords if query.blank?
+
+        sanitized_query = sanitize_query.downcase
         coords_json = fetch_and_parse_coords
-        return default_coords unless coords_json && coords_json['coords']
-        query_terms = query.split(' ').map(&:downcase)
+        return derived_coords_json_and_properties(sanitized_query) unless coords_json && coords_json['coords']
+
+        query_terms = sanitized_query.split(' ')
+
         matches = coords_json['coords'].select do |k, _v|
           k.downcase =~ /(#{query_terms.join('|')})/
         end
         return default_coords if matches.blank?
+
         coords_array = matches.values.flatten(1)[hl_index]
-        return default unless coords_array
+        return default_coords unless coords_array
+
         "#xywh=#{coords_array.join(',')}"
       end
 
+      def sanitize_query
+        query.match(additional_query_terms_regex)[1].strip
+      end
+
       ##
       # return the JSON word-coordinates file contents
       # @return [JSON]
       def fetch_and_parse_coords
-        coords = IiifPrint::Data::WorkDerivatives.data(from: file_set_id, of_type: 'json')
+        coords = IiifPrint.config.ocr_coords_from_json_function.call(file_set_id: file_set_id, document: document)
         return nil if coords.blank?
         begin
           JSON.parse(coords)
@@ -53,6 +64,23 @@ module IiifPrint
         end
       end
 
+      # This is a bit hacky but it is checking if any of the properties contain the query term
+      # if there are no coords and there is a metadata property match
+      # then we return the default coords
+      # else we insert a invalid match text to be stripped out at a later point
+      # @see IiifPrint::IiifSearchResponseDecorator#annotation_list
+      def derived_coords_json_and_properties(sanitized_query)
+        property = @document.keys.detect do |key|
+          (key.ends_with?("_tesim") || key.ends_with?("_tsim")) && property_includes_sanitized_query?(key, sanitized_query)
+        end
+
+        property ? default_coords : INVALID_MATCH_TEXT
+      end
+
+      def property_includes_sanitized_query?(property, sanitized_query)
+        @document[property].join.downcase.include?(sanitized_query)
+      end
+
       ##
       # a default set of coordinates
       # @return [String]
@@ -77,7 +105,31 @@ module IiifPrint
 
         file_set_ids = document['file_set_ids_ssim']
         raise "#{self.class}: NO FILE SET ID" if file_set_ids.blank?
-        file_set_ids.first
+
+        # Since a parent work's `file_set_ids_ssim` can contain child work ids as well as file set ids,
+        # this will ensure that the file set id is indeed a `FileSet`
+        file_set_ids.detect { |id| SolrDocument.find(id).file_set? }
+      end
+
+      ##
+      # This method is a workaround to compensate for overriding the solr_params method in
+      # BlacklightIiifSearch::IiifSearch. In the override, the solr_params method adds an additional filter to the query
+      # to include either the object_relation_field OR the parent document's id and removes the :f parameter from the
+      # query. This resulted in the query split here returning more than the actual query term.
+      #
+      # @see IiifPrint::IiifSearchDecorator#solr_params
+      # @return [Regexp] A regular expression to find the last AND and everything after it
+      # @example
+      #   'foo AND (is_page_of_ssim:\"123123\" OR id:\"123123\")' #=> 'foo'
+      def additional_query_terms_regex
+        /(.*)(?= AND (\(.+\)|\w+)$)/
+      end
+
+      ##
+      # @return [IIIF::Presentation::Resource]
+      def text_resource_for_annotation
+        IIIF::Presentation::Resource.new('@type' => 'cnt:ContentAsText',
+                                         'chars' => sanitize_query)
       end
     end
   end

data/lib/iiif_print/catalog_search_builder.rb

@@ -11,12 +11,16 @@ module IiifPrint
     include IiifPrint::HighlightSearchParams
     # TODO: Do we need the following as a module?  It hides the behavior
     include IiifPrint::ExcludeModels
+    include IiifPrint::AllinsonFlexFields
 
     # NOTE: If you are using advanced_search, the :exclude_models and :highlight_search_params must
     # be added after the advanced_search methods (which are not part of this gem).  In other tests,
     # we found that having the advanced search processing after the two aforementioned processors
     # resulted in improper evaluation of keyword querying.
-    self.default_processor_chain += [:exclude_models, :highlight_search_params, :show_parents_only]
+    self.default_processor_chain += [:exclude_models,
+                                     :highlight_search_params,
+                                     :show_parents_only,
+                                     :include_allinson_flex_fields]
 
     # rubocop:enable Naming/PredicateName
     def show_parents_only(solr_parameters)