blacklight-spotlight 0.32.0 → 0.33.0

data/app/assets/stylesheets/spotlight/_croppable.scss

@@ -1,16 +1,11 @@
-@mixin jcrop-loading-background {
-  background-image: image-url('Jcrop.gif');
-  background-color: transparent !important;
-}
-.form-group.croppable-loading-area {
-  min-height: 100px;
-  margin: ($padding-large-vertical * 2) $padding-large-vertical;
+.leaflet-container {
+  height: 400px;
+  margin: 0;
 }
 
-.loading-jcrop {
-  @include jcrop-loading-background;
-  .jcrop-tracker {
-    @include jcrop-loading-background;
-  }
+.leaflet-areaselect-container {
+  height: 100%;
+  position: absolute;
+  width: 100%;
+  z-index: 800;
 }
-

data/app/assets/stylesheets/spotlight/_multi_image_selector.scss

@@ -1,7 +1,7 @@
 .thumbs-list {
   overflow-y: hidden;
   overflow-x: scroll;
-  height: 110px;
+  height: 150px;
   padding-bottom: 10px;
   position: relative;
   ul {

data/app/assets/stylesheets/spotlight/_pages.scss

@@ -108,6 +108,7 @@
   float: left;
   margin-right: 15px;
   margin-top: 3px;
+  max-height: 70px;
 }
 
 // Indent contact fields so they align evenly, only when there is a contact photo
@@ -288,3 +289,7 @@
   padding-left: 2 * $padding-large-horizontal;
   padding-right: 2 * $padding-large-horizontal;
 }
+
+.zpr-link {
+  @extend .btn-sm;
+}

data/app/assets/stylesheets/spotlight/typeahead.css

@@ -37,7 +37,6 @@
 }
 
 .twitter-typeahead {
-  z-index: 1000 !important; /* get typeahead to float on top of e.g. jcrop */
   .tt-suggestion {
     font-size: 18px;
     line-height: 24px;

data/app/controllers/concerns/spotlight/base.rb

@@ -24,14 +24,12 @@ module Spotlight
         id: doc.id,
         title: CGI.unescapeHTML(view_context.presenter(doc).heading.to_str),
         thumbnail: doc.first(blacklight_config.index.thumbnail_field),
-        thumbnails: doc.spotlight_image_versions.try(:thumb) || doc[blacklight_config.index.thumbnail_field],
-        full_image_url: doc.spotlight_image_versions.try(:full).try(:first),
-        full_images: doc.spotlight_image_versions.try(:full),
-        image_versions: doc.spotlight_image_versions.image_versions(:thumb, :full),
+        full_image_url: doc.first(Spotlight::Engine.config.full_image_field),
         description: doc.id,
         url: polymorphic_path([current_exhibit, doc]),
         private: doc.private?(current_exhibit),
-        global_id: doc.to_global_id.to_s
+        global_id: doc.to_global_id.to_s,
+        iiif_manifest: doc[Spotlight::Engine.config.iiif_manifest_field]
       }
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/app/controllers/spotlight/appearances_controller.rb

@@ -23,19 +23,21 @@ module Spotlight
     protected
 
     def exhibit_params
-      params.require(:exhibit).permit(main_navigations_attributes: [:id, :display, :label, :weight],
+      params.require(:exhibit).permit(:theme,
+                                      main_navigations_attributes: [:id, :display, :label, :weight],
                                       masthead_attributes: featured_image_params,
                                       thumbnail_attributes: featured_image_params)
     end
 
     def featured_image_params
       [
+        :iiif_region, :iiif_tilesource,
+        :iiif_manifest_url, :iiif_canvas_id,
+        :iiif_image_id,
         :display,
         :source,
         :image,
-        :remote_image_url,
-        :document_global_id,
-        :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h
+        :document_global_id
       ]
     end
   end

data/app/controllers/spotlight/catalog_controller.rb

@@ -109,6 +109,16 @@ module Spotlight
       end
     end
 
+    def manifest
+      _, document = fetch params[:id]
+
+      if document.uploaded_resource?
+        render json: Spotlight::IiifManifestPresenter.new(document, self).iiif_manifest_json
+      else
+        head :not_found
+      end
+    end
+
     protected
 
     # TODO: move this out of app/helpers/blacklight/catalog_helper_behavior.rb and into blacklight/catalog.rb

data/app/controllers/spotlight/contacts_controller.rb

@@ -47,12 +47,8 @@ module Spotlight
 
     def contact_params
       params.require(:contact).permit(:name,
-                                      :avatar,
-                                      :avatar_crop_x,
-                                      :avatar_crop_y,
-                                      :avatar_crop_w,
-                                      :avatar_crop_h,
-                                      contact_info: Spotlight::Contact.fields.keys)
+                                      contact_info: Spotlight::Contact.fields.keys,
+                                      avatar_attributes: [:iiif_tilesource, :iiif_region])
     end
   end
 end

data/app/controllers/spotlight/featured_images_controller.rb

@@ -0,0 +1,26 @@
+module Spotlight
+  # Handles requests to upload images for exhibit thumbnails
+  class FeaturedImagesController < Spotlight::ApplicationController
+    load_and_authorize_resource instance_name: :featured_image
+
+    def create
+      if @featured_image.save && @featured_image.file_present?
+        render json: { tilesource: tilesource, id: @featured_image.id }
+      else
+        render json: { error: 'unable to create image' }, status: :bad_request
+      end
+    end
+
+    private
+
+    def tilesource
+      riiif.info_url(@featured_image.id)
+    end
+
+    # The create action can be called from a number of different forms, so
+    # we normalize all the parameters.
+    def create_params
+      params.require(:featured_image).permit(:image)
+    end
+  end
+end

data/app/controllers/spotlight/pages_controller.rb

@@ -4,6 +4,7 @@ module Spotlight
   class PagesController < Spotlight::ApplicationController
     before_action :authenticate_user!, except: [:show]
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_and_authorize_resource through: :exhibit, instance_name: 'page', only: [:index]
 
     helper Openseadragon::OpenseadragonHelper
     include Spotlight::Base
@@ -115,8 +116,8 @@ module Spotlight
 
     def featured_image_attributes
       [
-        :source, :image, :remote_image_url, :document_global_id,
-        :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h
+        :source, :image, :document_global_id, :iiif_region, :iiif_tilesource,
+        :iiif_manifest_url, :iiif_canvas_id, :iiif_image_id
       ]
     end
 

data/app/controllers/spotlight/resources/iiif_harvester_controller.rb

@@ -0,0 +1,10 @@
+module Spotlight
+  module Resources
+    # IIIF resources harvesting endpoint
+    class IiifHarvesterController < Spotlight::ResourcesController
+      def resource_class
+        Spotlight::Resources::IiifHarvester
+      end
+    end
+  end
+end

data/app/controllers/spotlight/resources/upload_controller.rb

@@ -13,9 +13,10 @@ module Spotlight
 
       load_and_authorize_resource class: 'Spotlight::Resources::Upload', through_association: 'exhibit.resources', instance_name: 'resource'
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def create
         @resource.attributes = resource_params
+        @resource.build_upload(image: params[:resources_upload][:url])
 
         if @resource.save_and_index
           flash[:notice] = t('spotlight.resources.upload.success')
@@ -29,7 +30,7 @@ module Spotlight
           redirect_to admin_exhibit_catalog_path(@resource.exhibit, sort: :timestamp)
         end
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
       private
 
@@ -38,7 +39,7 @@ module Spotlight
       end
 
       def resource_params
-        params.require(:resources_upload).permit(:url, data: data_param_keys)
+        params.require(:resources_upload).permit(data: data_param_keys)
       end
 
       def data_param_keys

data/app/controllers/spotlight/searches_controller.rb

@@ -2,17 +2,19 @@ module Spotlight
   ##
   # CRUD actions for curating browse categories (see
   # {Spotlight::BrowseController} for the end-user read and index actions)
+  # rubocop:disable Metrics/ClassLength
   class SearchesController < Spotlight::ApplicationController
     load_resource :exhibit, class: 'Spotlight::Exhibit'
     before_action :authenticate_user!
     before_action :only_curators!
+    before_action :create_or_load_resource, only: [:create]
     load_and_authorize_resource through: :exhibit
     before_action :attach_breadcrumbs, only: [:index, :edit], unless: -> { request.format.json? }
 
     include Spotlight::Base
 
     def create
-      @search.attributes = search_params
+      @search.assign_attributes(search_params.except((:title unless @search.new_record?)))
       @search.query_params = query_params
 
       if @search.save
@@ -99,8 +101,8 @@ module Spotlight
         :title,
         :long_description,
         :default_index_view_type,
-        masthead_attributes: featured_image_attributes,
-        thumbnail_attributes: featured_image_attributes
+        masthead_attributes: featured_image_params,
+        thumbnail_attributes: featured_image_params
       )
     end
 
@@ -108,8 +110,15 @@ module Spotlight
       params.to_unsafe_h.with_indifferent_access.except(:exhibit_id, :search, *blacklisted_search_session_params).reject { |_k, v| v.blank? }
     end
 
-    def featured_image_attributes
-      [:display, :source, :image, :remote_image_url, :document_global_id, :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h]
+    def featured_image_params
+      [
+        :iiif_region, :iiif_tilesource,
+        :iiif_manifest_url, :iiif_canvas_id, :iiif_image_id,
+        :display,
+        :source,
+        :image,
+        :document_global_id
+      ]
     end
 
     def only_curators!
@@ -117,11 +126,16 @@ module Spotlight
     end
 
     def blacklisted_search_session_params
-      [:commit, :counter, :total, :search_id, :page, :per_page, :authenticity_token, :utf8, :action, :controller]
+      [:id, :commit, :counter, :total, :search_id, :page, :per_page, :authenticity_token, :utf8, :action, :controller]
     end
 
     def fallback_url
       spotlight.exhibit_searches_path(current_exhibit)
     end
+
+    def create_or_load_resource
+      @search = current_exhibit.searches.find(params[:id]) if params[:id].present?
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/app/controllers/spotlight/sites_controller.rb

@@ -45,11 +45,8 @@ module Spotlight
     def masthead_params
       [
         :display,
-        :source,
-        :image,
-        :remote_image_url,
-        :document_global_id,
-        :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h
+        :iiif_region,
+        :iiif_tilesource
       ]
     end
   end

data/app/helpers/spotlight/application_helper.rb

@@ -4,8 +4,8 @@ module Spotlight
   module ApplicationHelper
     include CrudLinkHelpers
     include TitleHelper
-    include JcropHelper
     include MetaHelper
+    include CropHelper
 
     ##
     # Give the application name a chance to include the exhibit title
@@ -132,6 +132,19 @@ module Spotlight
       current_exhibit.blacklight_configuration.default_blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
 
+    def exhibit_stylesheet_link_tag(tag)
+      if current_exhibit_theme && current_exhibit.theme != 'default'
+        stylesheet_link_tag "#{tag}_#{current_exhibit_theme}"
+      else
+        Rails.logger.warn "Exhibit theme '#{current_exhibit_theme}' not in white-list of available themes: #{Spotlight::Engine.config.exhibit_themes}"
+        stylesheet_link_tag(tag)
+      end
+    end
+
+    def current_exhibit_theme
+      current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && Spotlight::Engine.config.exhibit_themes.include?(current_exhibit.theme)
+    end
+
     private
 
     def main_app_url_helper?(method)

data/app/helpers/spotlight/crop_helper.rb

@@ -0,0 +1,37 @@
+module Spotlight
+  ##
+  # iiif-crop options helpers
+  module CropHelper
+    def iiif_cropper_tags(f, initial_crop_selection:)
+      content_tag(:div) do
+        concat f.hidden_field(:iiif_manifest_url)
+        concat f.hidden_field(:iiif_canvas_id)
+        concat f.hidden_field(:iiif_image_id)
+        concat f.hidden_field(:iiif_region)
+        concat f.hidden_field(:iiif_tilesource)
+        concat iiif_cropper_tag(f, initial_crop_selection: initial_crop_selection)
+      end
+    end
+
+    def iiif_cropper_tag(f, initial_crop_selection:)
+      content_tag :div, '', id: "#{form_prefix(f)}_iiif_cropper", data: {
+        behavior: 'iiif-cropper',
+        cropper_key: f.object.model_name.singular_route_key,
+        'crop-width': initial_crop_selection.first,
+        'crop-height': initial_crop_selection.last
+      }
+    end
+
+    def iiif_upload_tag(f)
+      f.file_field_without_bootstrap :file, name: 'featured_image[image]', data: { endpoint: polymorphic_path(f.object.model_name.route_key) }
+    end
+
+    def form_prefix(f)
+      if Rails::VERSION::MAJOR >= 5
+        f.object_name.parameterize(separator: '_')
+      else
+        f.object_name.parameterize('_')
+      end
+    end
+  end
+end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -34,5 +34,18 @@ module Spotlight
         show_presenter(document)
       end
     end
+
+    def exhibit_stylesheet_link_tag(tag)
+      if current_exhibit_theme && current_exhibit.theme != 'default'
+        stylesheet_link_tag "#{tag}_#{current_exhibit_theme}"
+      else
+        Rails.logger.warn "Exhibit theme '#{current_exhibit_theme}' not in white-list of available themes: #{Spotlight::Engine.config.exhibit_themes}"
+        stylesheet_link_tag(tag)
+      end
+    end
+
+    def current_exhibit_theme
+      current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && Spotlight::Engine.config.exhibit_themes.include?(current_exhibit.theme)
+    end
   end
 end

data/app/helpers/spotlight/meta_helper.rb

@@ -11,14 +11,18 @@ module Spotlight
         card.url exhibit_root_url(current_exhibit)
         card.title current_exhibit.title
         card.description current_exhibit.subtitle
-        card.image carrierwave_url(current_exhibit.thumbnail.image.thumb) if current_exhibit.thumbnail
+        card.image meta_image if current_exhibit.thumbnail
       end
     end
 
+    def meta_image
+      current_exhibit.thumbnail.iiif_url
+    end
+
     def exhibit_opengraph_content
       opengraph do |graph|
         graph.title current_exhibit.title
-        graph.image carrierwave_url(current_exhibit.thumbnail.image.thumb) if current_exhibit.thumbnail
+        graph.image meta_image if current_exhibit.thumbnail
         graph.site_name site_title
       end
     end
@@ -31,7 +35,7 @@ module Spotlight
     def page_twitter_card_content(page)
       twitter_card('summary_large_image') do |card|
         card.title page.title
-        card.image carrierwave_url(page.thumbnail.image.thumb) if page.thumbnail
+        card.image page.thumbnail.iiif_url if page.thumbnail
       end
     end
 
@@ -40,7 +44,7 @@ module Spotlight
         graph.type 'article'
         graph.site_name application_name
         graph.title page.title
-        graph.send('og:image', carrierwave_url(page.thumbnail.image.thumb)) if page.thumbnail
+        graph.send('og:image', page.thumbnail.iiif_url) if page.thumbnail
         graph.send('article:published_time', page.created_at.iso8601)
         graph.send('article:modified_time', page.updated_at.iso8601)
       end
@@ -54,7 +58,7 @@ module Spotlight
     def browse_twitter_card_content(browse)
       twitter_card('summary_large_image') do |card|
         card.title browse.title
-        card.image carrierwave_url(browse.thumbnail.image.thumb) if browse.thumbnail
+        card.image browse.thumbnail.iiif_url if browse.thumbnail
       end
     end
 
@@ -63,7 +67,7 @@ module Spotlight
         graph.type 'article'
         graph.site_name application_name
         graph.title browse.title
-        graph.send('og:image', carrierwave_url(browse.thumbnail.image.thumb)) if browse.thumbnail
+        graph.send('og:image', browse.thumbnail.iiif_url) if browse.thumbnail
         graph.send('article:published_time', browse.created_at.iso8601)
         graph.send('article:modified_time', browse.updated_at.iso8601)
       end
@@ -92,19 +96,5 @@ module Spotlight
         graph.send('og:image', document.first(blacklight_config.index.thumbnail_field))
       end
     end
-
-    private
-
-    def carrierwave_url(upload)
-      # Carrierwave's #url returns either a full url (if asset path was configured)
-      # or just the path to the image. We'll try to normalize it to a url.
-      url = upload.url
-
-      if url.nil? || url.starts_with?('http')
-        url
-      else
-        (URI.parse(Rails.application.config.asset_host || root_url) + url).to_s
-      end
-    end
   end
 end