blacklight-spotlight 3.0.0.rc4 → 3.0.0.rc5

data/app/models/sir_trevor_rails/blocks/uploaded_items_block.rb

@@ -11,6 +11,10 @@ module SirTrevorRails
       def files
         (item || {}).map { |_, file| file }.select { |file| file[:display].to_s == 'true' }
       end
+
+      def zpr_link?
+        zpr_link == 'true'
+      end
     end
   end
 end

data/app/models/spotlight/ability.rb

@@ -19,7 +19,7 @@ module Spotlight
       can :manage, [Spotlight::BlacklightConfiguration, Spotlight::ContactEmail, Spotlight::Language], exhibit_id: user.admin_roles.pluck(:resource_id)
       can :manage, Spotlight::Role, resource_id: user.admin_roles.pluck(:resource_id), resource_type: 'Spotlight::Exhibit'
 
-      can :manage, [PaperTrail::Version, Spotlight::FeaturedImage] if user.roles.any?
+      can :manage, [PaperTrail::Version, Spotlight::FeaturedImage] if user.exhibit_roles.any?
 
       # exhibit curator
       can :manage, [
@@ -34,10 +34,12 @@ module Spotlight
         Translation
       ], exhibit_id: user.exhibit_roles.pluck(:resource_id)
 
+      can :read, Spotlight::JobTracker, on_id: user.exhibit_roles.pluck(:resource_id), on_type: 'Spotlight::Exhibit'
+
       can :manage, Spotlight::Lock, by: user
 
       can :read, Spotlight::Language, exhibit_id: user.exhibit_roles.pluck(:resource_id)
-      can %i[read curate tag], Spotlight::Exhibit, id: user.exhibit_roles.pluck(:resource_id)
+      can %i[read curate tag bulk_update], Spotlight::Exhibit, id: user.exhibit_roles.pluck(:resource_id)
 
       # public
       can :read, Spotlight::HomePage
@@ -46,6 +48,8 @@ module Spotlight
       can :read, Spotlight::Search, published: true
       can :read, Spotlight::Group, published: true
       can :read, Spotlight::Language, public: true
+
+      can :read, Spotlight::Exhibit, id: user.viewer_roles.pluck(:resource_id)
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end

data/app/models/spotlight/attachment.rb

@@ -8,7 +8,7 @@ module Spotlight
     mount_uploader :file, Spotlight::AttachmentUploader
 
     def as_json(options = nil)
-      file.as_json(options).merge(name: name, uid: uid, id: id, class: self.class.to_s)
+      file.as_json(options).merge(name: name, uid: uid, attachment: to_global_id)
     end
   end
 end

data/app/models/spotlight/{reindex_progress.rb → background_job_progress.rb}

@@ -2,14 +2,15 @@
 
 module Spotlight
   ##
-  # ReindexProgress is a class that models the progress of reindexing a list of resources
-  class ReindexProgress
-    attr_reader :exhibit
+  # BackgroundJobProgress is a class that models the progress of a list of resources
+  class BackgroundJobProgress
+    attr_reader :exhibit, :job_class
 
     delegate :updated_at, to: :most_relevant_job_tracker
 
-    def initialize(exhibit)
+    def initialize(exhibit, job_class:)
       @exhibit = exhibit
+      @job_class = job_class
     end
 
     def as_json(*)
@@ -28,7 +29,7 @@ module Spotlight
     private
 
     def job_trackers
-      @job_trackers ||= exhibit.job_trackers.where(job_class: 'Spotlight::ReindexExhibitJob').recent
+      @job_trackers ||= exhibit.job_trackers.where(job_class: job_class.to_s).recent
     end
 
     def most_relevant_job_tracker
@@ -59,13 +60,13 @@ module Spotlight
     end
 
     def total
-      return most_relevant_job_tracker.total if finished?
+      return most_relevant_job_tracker.total if finished? || most_relevant_job_tracker.job_trackers.none?
 
       most_relevant_job_tracker.job_trackers.sum(&:total)
     end
 
     def completed
-      return most_relevant_job_tracker.progress if finished?
+      return most_relevant_job_tracker.progress if finished? || most_relevant_job_tracker.job_trackers.none?
 
       most_relevant_job_tracker.job_trackers.sum(&:progress)
     end

data/app/models/spotlight/blacklight_configuration.rb

@@ -80,10 +80,26 @@ module Spotlight
 
         config.index.thumbnail_field ||= Spotlight::Engine.config.thumbnail_field
 
-        config.add_results_collection_tool 'save_search', if: :render_save_this_search?
+        config.add_results_collection_tool 'curator_actions', if: :render_curator_actions?
+
+        unless config.curator_actions
+          config.curator_actions ||= Blacklight::NestedOpenStructWithHashAccess.new(Blacklight::Configuration::ToolConfig)
+          config.curator_actions.save_search
+          config.curator_actions.bulk_actions
+        end
+
+        unless config.bulk_actions
+          config.bulk_actions ||= Blacklight::NestedOpenStructWithHashAccess.new(Blacklight::Configuration::ToolConfig)
+
+          config.bulk_actions.change_visibility
+          config.bulk_actions.add_tags
+          config.bulk_actions.remove_tags
+        end
 
         config.default_solr_params = config.default_solr_params.merge(default_solr_params)
 
+        config.default_per_page = default_per_page if default_per_page
+
         config.view.embed.partials ||= ['openseadragon']
         config.view.embed.if = false
         config.view.embed.locals ||= { osd_container_class: '' }
@@ -186,11 +202,6 @@ module Spotlight
 
         config.per_page = (config.per_page & per_page) unless per_page.blank?
 
-        if default_per_page
-          config.per_page.delete(default_per_page)
-          config.per_page.unshift(default_per_page)
-        end
-
         unless document_index_view_types.blank?
           config.view.each do |k, v|
             v.original = v.dup

data/app/models/spotlight/bulk_update.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spotlight
+  class BulkUpdate < ActiveRecord::Base
+    mount_uploader :file, Spotlight::BulkUpdatesUploader
+    belongs_to :exhibit
+  end
+end

data/app/models/spotlight/exhibit.rb

@@ -57,6 +57,7 @@ module Spotlight
     has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
     has_many :groups, dependent: :delete_all
     has_many :job_trackers, as: :on, dependent: :delete_all
+    has_many :bulk_updates, dependent: :delete_all
     has_many :main_navigations, dependent: :delete_all
     has_many :resources
     has_many :roles, as: :resource, dependent: :delete_all
@@ -135,7 +136,7 @@ module Spotlight
     end
 
     def reindex_progress
-      @reindex_progress ||= ReindexProgress.new(self)
+      @reindex_progress ||= BackgroundJobProgress.new(self, job_class: Spotlight::ReindexExhibitJob)
     end
 
     def available_locales

data/app/models/spotlight/feature_page.rb

@@ -14,8 +14,6 @@ module Spotlight
 
     accepts_nested_attributes_for :child_pages
 
-    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
-
     before_validation unless: :top_level_page? do
       self.exhibit = top_level_page_or_self.exhibit
     end

data/app/models/spotlight/featured_image.rb

@@ -68,10 +68,16 @@ module Spotlight
         self[:iiif_tilesource]
       elsif file_present?
         riiif = Riiif::Engine.routes.url_helpers
-        riiif.info_path(id)
+        riiif.info_path(self)
       end
     end
 
+    # Include a hashed updated_at timestamp in the parameter key to bust any
+    # browser caching.
+    def to_param
+      "#{id}-#{Digest::MD5.hexdigest(updated_at.iso8601)}"
+    end
+
     private
 
     def image_size

data/app/models/spotlight/field_metadata.rb

@@ -45,18 +45,14 @@ module Spotlight
 
     # This gets the number of *documents* with a field
     def document_counts
-      @document_count ||= begin
-        solr_response.facet_queries.each_with_object({}) do |(k, v), h|
-          h[k.split(/:/).first] = v
-        end
+      @document_count ||= solr_response.facet_queries.each_with_object({}) do |(k, v), h|
+        h[k.split(/:/).first] = v
       end
     end
 
     def terms
-      @terms ||= begin
-        solr_response.aggregations.each_with_object({}) do |(facet_name, facet), h|
-          h[facet_name] = facet.items.map(&:label)
-        end
+      @terms ||= solr_response.aggregations.each_with_object({}) do |(facet_name, facet), h|
+        h[facet_name] = facet.items.map(&:label)
       end
     end
 

data/app/models/spotlight/job_tracker.rb

@@ -12,6 +12,7 @@ module Spotlight
     belongs_to :user, optional: true, class_name: Spotlight::Engine.config.user_class # rubocop:disable Rails/ReflectionClassName
     has_many :events, as: :resource, dependent: :delete_all
     has_many :job_trackers, as: :on, dependent: Rails.version > '6.1' ? :destroy_async : :destroy
+    has_many :subevents, through: :job_trackers, source: :events
 
     serialize :data
 
@@ -66,6 +67,14 @@ module Spotlight
       (100.0 * progress) / total
     end
 
+    def status
+      @status ||= super
+      @status ||= 'missing'
+      @status = 'in_progress' if @status == 'completed' && job_trackers.any? { |t| t.in_progress? || t.enqueued? }
+
+      @status
+    end
+
     def enqueued?
       status == 'enqueued'
     end
@@ -82,8 +91,8 @@ module Spotlight
       status == 'failed'
     end
 
-    def append_log_entry(type:, **args)
-      events.create(type: type, data: args)
+    def append_log_entry(type:, exhibit: nil, **args)
+      events.create(type: type, exhibit: exhibit, data: args)
     rescue StandardError => e
       Rails.logger.error("Unable to create log entry for job tracker #{id}: #{e}")
     end

data/app/models/spotlight/page.rb

@@ -51,9 +51,7 @@ module Spotlight
     end
 
     def content
-      @content ||= begin
-        Spotlight::PageContent.for(self, :content)
-      end
+      @content ||= Spotlight::PageContent.for(self, :content)
     end
 
     def content_type

data/app/models/spotlight/resource.rb

@@ -31,14 +31,14 @@ module Spotlight
     # Persist the record to the database, and trigger a reindex to solr
     #
     # @param [Hash] All arguments will be passed through to ActiveRecord's #save method
-    def save_and_index(*args)
-      save(*args) && reindex_later
+    def save_and_index(reindex_options: {}, **args)
+      save(*args) && reindex_later(**reindex_options)
     end
 
     ##
     # Enqueue an asynchronous reindexing job for this resource
-    def reindex_later
-      Spotlight::ReindexJob.perform_later(self)
+    def reindex_later(**args)
+      Spotlight::ReindexJob.perform_later(self, **args)
     end
 
     def document_model

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

@@ -33,8 +33,8 @@ module Spotlight
 
       def url_is_iiif?(url)
         valid_content_types = ['application/json', 'application/ld+json']
-        req = Faraday.head(url)
-        req = Faraday.get(url) if req.status == 405
+        req = Spotlight::Resources::IiifService.http_client.head(url)
+        req = Spotlight::Resources::IiifService.http_client.get(url) if req.status == 405
         return unless req.success?
 
         valid_content_types.any? do |valid_type|

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

@@ -29,6 +29,13 @@ module Spotlight
         recursive_manifests(new(url))
       end
 
+      def self.http_client
+        Faraday.new do |b|
+          b.use FaradayMiddleware::FollowRedirects
+          b.adapter Faraday.default_adapter
+        end
+      end
+
       protected
 
       def object
@@ -41,7 +48,7 @@ module Spotlight
 
       class << self
         def iiif_response(url)
-          Faraday.get(url).body
+          Spotlight::Resources::IiifService.http_client.get(url).body
         rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
           Rails.logger.warn("HTTP GET for #{url} failed with #{e}")
           {}.to_json

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

@@ -41,7 +41,7 @@ module Spotlight
       end
 
       def to_solr
-        return {} unless upload.file_present?
+        return {} unless upload&.file_present?
 
         spotlight_routes = Spotlight::Engine.routes.url_helpers
         riiif = Riiif::Engine.routes.url_helpers
@@ -51,7 +51,7 @@ module Spotlight
         {
           spotlight_full_image_width_ssm: dimensions.width,
           spotlight_full_image_height_ssm: dimensions.height,
-          Spotlight::Engine.config.thumbnail_field => riiif.image_path(upload_id, size: '!400,400'),
+          Spotlight::Engine.config.thumbnail_field => riiif.image_path(upload, size: '!400,400'),
           Spotlight::Engine.config.iiif_manifest_field => spotlight_routes.manifest_exhibit_solr_document_path(exhibit, compound_id)
         }
       end

data/app/models/spotlight/role.rb

@@ -4,11 +4,10 @@ module Spotlight
   ##
   # Exhibit authorization roles
   class Role < ActiveRecord::Base
-    ROLES = %w[admin curator].freeze
     belongs_to :resource, polymorphic: true, optional: true
     belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true, optional: false
 
-    validates :role, inclusion: { in: ROLES }
+    validates :role, inclusion: { in: Spotlight::Engine.config.exhibit_roles }
     validate :user_must_be_unique, if: :user
 
     def user_key

data/app/presenters/spotlight/iiif_manifest_presenter.rb

@@ -79,7 +79,7 @@ module Spotlight
 
     def iiif_url
       # yes this is hacky, and we are appropriately ashamed.
-      controller.riiif.info_url(uploaded_resource.upload.id).sub(%r{/info\.json\Z}, '')
+      controller.riiif.info_url(uploaded_resource.upload).sub(%r{/info\.json\Z}, '')
     end
   end
 end

data/app/services/spotlight/bulk_updates_csv_template_service.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Spotlight
+  # A service to generate a CSV template suitable for re-uploading for bulk updates
+  class BulkUpdatesCsvTemplateService
+    attr_reader :exhibit
+
+    def initialize(exhibit:)
+      @exhibit = exhibit
+    end
+
+    def template(view_context:, title: true, tags: true, visibility: true)
+      return to_enum(:template, view_context: view_context, title: title, tags: tags, visibility: visibility) unless block_given?
+
+      yield ::CSV.generate_line(csv_headers(title: title, tags: tags, visibility: visibility))
+      each_document do |document|
+        sidecar = document.sidecar(exhibit)
+        yield ::CSV.generate_line([
+          document.id,
+          (title_column(view_context, document) if title),
+          (visibility_column(sidecar) if visibility),
+          (tags_column(sidecar) if tags)
+        ].flatten.compact)
+      end
+    end
+
+    private
+
+    def title_column(view_context, document)
+      CGI.unescapeHTML(view_context.document_presenter(document).heading)
+    end
+
+    def visibility_column(sidecar)
+      sidecar.public ? 'TRUE' : ' '
+    end
+
+    def tags_column(sidecar)
+      exhibit_tags.map do |tag|
+        sidecar.all_tags_list.include?(tag) ? 'TRUE' : ' '
+      end
+    end
+
+    def exhibit_tags
+      @exhibit_tags ||= exhibit.owned_tags.map(&:name)
+    end
+
+    def csv_headers(title:, tags:, visibility:)
+      headers = [bulk_updates_config.csv_id]
+      headers.append(bulk_updates_config.csv_title) if title
+      headers.append(bulk_updates_config.csv_visibility) if visibility
+      if tags
+        exhibit_tags.each do |tag|
+          headers.append(format(bulk_updates_config.csv_tags, tag))
+        end
+      end
+      headers
+    end
+
+    def bulk_updates_config
+      Spotlight::Engine.config.bulk_updates
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def each_document(&block)
+      return to_enum(:each_document) unless block_given?
+
+      cursor_mark = nil
+      next_cursor_mark = '*'
+
+      solr_params = exhibit&.exhibit_search_builder&.to_h || {}
+
+      until next_cursor_mark == cursor_mark || next_cursor_mark.nil?
+        cursor_mark = next_cursor_mark
+        response = exhibit.blacklight_config.repository.search(
+          solr_params.merge(
+            'q' => '*',
+            'rows' => Spotlight::Engine.config.bulk_actions_batch_size,
+            'cursorMark' => cursor_mark,
+            'sort' => "#{exhibit.blacklight_config.document_model.unique_key} asc"
+          )
+        )
+        response.documents.each do |document|
+          block.call(document)
+        end
+
+        next_cursor_mark = response['nextCursorMark']
+      end
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+  end
+end