blacklight_allmaps 0.1.0

data/app/models/blacklight/allmaps/sidecar.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+##
+# ActiveRecord appendage for SolrDocuments
+module Blacklight
+  module Allmaps
+    class Sidecar < ApplicationRecord
+      self.table_name = "blacklight_allmaps_sidecars"
+
+      alias_attribute :georeferenced, :annotated
+
+      before_save :set_allmaps_id
+
+      def solr_document
+        document_type.constantize.find(solr_document_id)
+      end
+
+      def set_allmaps_id
+        self.allmaps_id = Digest::SHA1.hexdigest(manifest_id)[0..15] if manifest_id.present?
+      end
+    end
+  end
+end

data/app/models/concerns/blacklight/allmaps/solr_document.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Extends Blacklight::Solr::Document for Blacklight::Allmaps specific functionality
+module Blacklight
+  module Allmaps
+    module SolrDocument
+      # Blacklight
+      # @TODO: Make this configurable
+      def iiif_manifest_url
+        self["iiif_manifest_url_ssi"]
+      end
+    end
+  end
+end

data/app/views/allmaps/show/_blacklight.html.erb

@@ -0,0 +1,213 @@
+<!-- Georeferenced Map -->
+<h3 class="h6">Georeferenced Map</h3>
+<div id="allmaps-map" class="mt-3 mb-3" style="height: 400px;"></div>
+
+<!-- Leaflet -->
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.min.css">
+<script src="https://cdn.jsdelivr.net/npm/leaflet@1.9.4/dist/leaflet.min.js"></script>
+
+<!-- Leaflet Fullscreen -->
+<script src="https://cdn.jsdelivr.net/npm/leaflet-fullscreen@1.0.2/dist/Leaflet.fullscreen.min.js"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet-fullscreen@1.0.2/dist/leaflet.fullscreen.min.css">
+
+<!-- Leaflet Layer Opacity -->
+<script>
+  // Adopts the Mapbox opacity control into a Leaflet plugin
+
+  !function(global) {
+    'use strict';
+
+    L.Control.LayerOpacity = L.Control.extend({
+      initialize: function(layer) {
+        var options = { position: 'topleft' };
+
+        // check if layer is actually a layer group
+        if (typeof layer.getLayers !== 'undefined') {
+
+          // add first layer from layer group to options
+          options.layer = layer.getLayers()[0];
+        } else {
+
+          // add layer to options
+          options.layer = layer;
+        }
+
+        L.Util.setOptions(this, options);
+      },
+
+      onAdd: function(map) {
+        var container = L.DomUtil.create('div', 'opacity-control unselectable'),
+          controlArea = L.DomUtil.create('div', 'opacity-area', container),
+          handle = L.DomUtil.create('div', 'opacity-handle', container),
+          handleArrowUp = L.DomUtil.create('div', 'opacity-arrow-up', handle),
+          handleText = L.DomUtil.create('div', 'opacity-text', handle),
+          handleArrowDown = L.DomUtil.create('div', 'opacity-arrow-down', handle),
+          bottom = L.DomUtil.create('div', 'opacity-bottom', container);
+
+        L.DomEvent.stopPropagation(container);
+        L.DomEvent.disableClickPropagation(container);
+
+        this.setListeners(handle, bottom, handleText);
+        handle.style.top = handle.offsetTop - 13 + 50 + 'px';
+        handleText.innerHTML = parseInt(this.options.layer.options.opacity * 100) + '%';
+        return container;
+      },
+
+      setListeners: function(handle, bottom, handleText) {
+        var _this = this,
+          start = false,
+          startTop;
+
+        L.DomEvent.on(document, 'mousemove', function(e) {
+          if (!start) return;
+          var percentInverse = Math.max(0, Math.min(200, startTop + parseInt(e.clientY, 10) - start)) / 2;
+          handle.style.top = ((percentInverse * 2) - 13) + 'px';
+          handleText.innerHTML = Math.round((1 - (percentInverse / 100)) * 100) + '%';
+          bottom.style.height = Math.max(0, (((100 - percentInverse) * 2) - 13)) + 'px';
+          bottom.style.top = Math.min(200, (percentInverse * 2) + 13) + 'px';
+          _this.options.layer.setOpacity(1 - (percentInverse / 100));
+        });
+
+        L.DomEvent.on(handle, 'mousedown', function(e) {
+          start = parseInt(e.clientY, 10);
+          startTop = handle.offsetTop - 12;
+          return false;
+        });
+
+        L.DomEvent.on(document, 'mouseup', function(e) {
+          start = null;
+        });
+      }
+    });
+  }(this);
+</script>
+<style>
+  .leaflet-control.opacity-control {
+    background-color: #a9acb1;
+    border-radius: 15px;
+    color: black;
+    font: bold 18px 'Lucida Console', Monaco, monospace;
+    display: block;
+    height: 200px;
+    left: 11px;
+    position: relative;
+    top: 15px;
+    width: 5px;
+    
+    .opacity-handle {
+      background-color: #fff;
+      border-radius: 4px;
+      border: 1px solid #eee;
+      cursor: ns-resize;
+      font-size: 10px;
+      height: 26px;
+      left: -11px;
+      line-height: 26px;
+      position: absolute;
+      text-align: center;
+      top: 0;
+      width: 26px;
+      @include map-control-shadow;
+      
+      &:hover {
+        background-color: #f4f4f4;
+      }
+    }
+    
+    .opacity-arrow-up {
+      color: #aaa;
+      position: absolute;
+      top: -11px;
+      text-align: center;
+      width: 100%;
+      
+      &:before {
+        content: '=';
+      } 
+    }
+    
+    .opacity-arrow-down {
+      bottom: -10px;
+      color: #aaa;
+      position: absolute;
+      text-align: center;
+      width: 100%;
+      
+      &:before {
+        content: '=';
+      }  
+    }
+
+    .opacity-bottom {
+      background-color: #017afd;
+      border-radius: 15px;
+      display: block;
+      height: 137px;
+      left: 0px;
+      position: relative;
+      top: 63px;
+      width: 5px;  
+    }
+    
+    // Area underneath slider to prevent unintentioned map clicks
+    .opacity-area {
+      padding: 14px;
+      cursor: default;
+      height: 200px;
+      left: -11px;
+      position: absolute;
+      top: 0px;
+      width: 20px;
+    }
+  }
+
+  .opacity-control.unselectable {
+    -webkit-touch-callout: none;
+    -webkit-user-select: none;
+    -khtml-user-select: none;
+    -moz-user-select: none;
+    -ms-user-select: none;
+    user-select: none;
+  }
+</style>
+
+<!-- Allmaps -->
+<script src="https://cdn.jsdelivr.net/npm/@allmaps/leaflet/dist/bundled/allmaps-leaflet-1.9.umd.js"></script>
+
+<script>
+  document.addEventListener("DOMContentLoaded", () => {
+    const element = document.getElementById("allmaps-map");
+
+    const map = L.map("allmaps-map", {
+      center: [0, 0],
+      zoom: 15,
+      zoomAnimationThreshold: 1
+    });
+    
+    // Basemap and Attribution
+    L.tileLayer("https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png", {
+      attribution: "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a> contributors",
+      maxZoom: 18
+    }).addTo(map);
+    
+    // Fullscreen control
+    map.addControl(new L.Control.Fullscreen({
+      position: "topright"
+    }));
+
+    const annotationUrl = "https://annotations.allmaps.org/manifests/<%= document.sidecar_allmaps.allmaps_id %>";
+    const warpedMapLayer = new Allmaps.WarpedMapLayer(annotationUrl)
+      .addTo(map);
+
+    // Layer opacity control
+    map.addControl(new L.Control.LayerOpacity(warpedMapLayer));
+
+    map.on(
+      "warpedmapadded",
+      (event) => {
+        map.fitBounds(warpedMapLayer.getBounds());
+      },
+      map
+    );
+  });
+</script>

data/app/views/allmaps/show/_geoblacklight.html.erb

@@ -0,0 +1,47 @@
+<!-- Georeferenced Map -->
+<h3 class="h6">Georeferenced Map</h3>
+<div id="allmaps-map" data-map-geom="<%= document.geometry.geojson %>" style="height: 400px;"></div>
+
+<script src="https://cdn.jsdelivr.net/npm/@allmaps/leaflet/dist/bundled/allmaps-leaflet-1.9.umd.js"></script>
+<script>
+  document.addEventListener("DOMContentLoaded", () => {
+    const element = document.getElementById("allmaps-map");
+    const value = element.getAttribute("data-map-geom");
+    const layer = L.geoJSON();
+    layer.addData(JSON.parse(value));
+    const bounds = layer.getBounds();
+    const annotationUrl = "https://annotations.allmaps.org/manifests/<%= document.sidecar_allmaps.allmaps_id %>";
+    const warpedMapLayer = new Allmaps.WarpedMapLayer(annotationUrl);
+    const geoTab = document.getElementById("georeferenced-tab");
+    const map = L.map("allmaps-map");
+
+    // Basemap and Attribution
+    L.tileLayer("https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png", {
+      attribution: "&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a> contributors",
+      maxZoom: 18
+    }).addTo(map);
+
+    // Fullscreen control
+    map.addControl(new L.Control.Fullscreen({
+      position: "topright"
+    }));
+
+    // Layer opacity control
+    map.addControl(new L.Control.LayerOpacity(warpedMapLayer));
+
+    // Leaflet: Multiple maps on the same page is a challenge...
+    // 1. Need to watch the page DOM mutate
+    // 2. When the georeferenced tab is visible, invalidate the map size
+    // 3. Add the WarpedMapLayer to the map
+    // 4. Fit the map to the GeoJSON bounds
+    const observer = new MutationObserver(function(){
+      if(geoTab.style.display !== "none"){
+        map.invalidateSize();
+        warpedMapLayer.addTo(map);
+        map.fitBounds(bounds);
+      }
+    });
+
+    observer.observe(geoTab, { attributes: true });
+  });
+</script>

data/app/views/allmaps/sidebar/_allmaps.html.erb

@@ -0,0 +1,55 @@
+<div class="card mb-3 mt-3" id="allmaps-sidebar" data-iiif-manifest="<%=@document.iiif_manifest_url %>">
+  <div class="card-header">
+    <h2 class="mb-0 h6"><%= t('home.georeferencing') %></h2>
+  </div>
+
+  <div class="card-body" id="georeferencing">
+    <% if @document.sidecar_allmaps.georeferenced? %>
+      <div id="georef_present">
+        <%= link_to 'View this georeferenced item', 'https://viewer.allmaps.org/?url=https://annotations.allmaps.org/?url=' + @document.iiif_manifest_url, target: '_blank' %>
+      </div>
+    <% else %>    
+      <%# content will be updated via updateGeorefLinks(); %>
+      <div id="georef_loading">
+        Loading...
+      </div>
+    <% end %>
+  </div>
+
+  <div class="card-footer text-muted">
+    <small>
+      <a href="https://allmaps.org" class="text-decoration-none text-dark">
+        <%= image_tag 'blacklight/allmaps/allmaps-logo.svg', alt: 'Allmaps', height:"20" %>
+        Allmaps
+      </a>
+    </small>
+  </div>
+</div>
+
+<script type="text/javascript">
+  document.addEventListener('DOMContentLoaded', () => {
+    const updateGeorefLinks = async () => {
+      const manifestUrl = document.getElementById('allmaps-sidebar').getAttribute('data-iiif-manifest');
+      const georefDiv = document.getElementById('georeferencing');
+      const annotationUrlByIIIFUri = `https://annotations.allmaps.org/?url=${manifestUrl}`;
+
+      try {
+        const response = await fetch(annotationUrlByIIIFUri);
+        if (!response.ok) {
+          georefDiv.innerHTML = `<a href="https://editor.allmaps.org/#/collection?url=${manifestUrl}">Georeference this item</a>`;
+        } else {
+          const annotationUrl = response.url;
+          georefDiv.innerHTML = `<a href="https://viewer.allmaps.org/?url=${annotationUrl}">View this georeferenced item</a>`;
+          
+          // TODO: Ping Blacklight::Allmaps::AnnotationsController to save the annotation data
+          
+
+        }
+      } catch (error) {
+        console.error("Fetch error:", error);
+      }
+    };
+
+    updateGeorefLinks();
+  });
+</script>

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

@@ -0,0 +1,52 @@
+<% document ||= @document %>
+<div class='row'>
+  <div id='viewer-container' class="col-md-12">
+
+    <span class="sr-only">Georeferenced: <%= document.sidecar_allmaps.georeferenced? %></span>
+
+    <ul class="nav nav-tabs mt-3" id="myTab" role="tablist">
+      <li class="nav-item" role="presentation">
+        <button class="nav-link active" id="item-viewer" data-toggle="tab" data-target="#item-viewer-tab" type="button" role="tab" aria-controls="home" aria-selected="true">Item Viewer</button>
+      </li>
+      <% if document.sidecar_allmaps.georeferenced? %>
+        <li class="nav-item" role="presentation">
+          <button class="nav-link" id="georeferenced-viewer" data-toggle="tab" data-target="#georeferenced-tab" type="button" role="tab" aria-controls="profile" aria-selected="false">Georeferenced Map</button>
+        </li>
+      <% end %>
+    </ul>
+
+    <div class="tab-content mt-3">
+      <div class="tab-pane fade show active" id="item-viewer-tab" role="tabpanel" aria-labelledby="item-viewer-tab">
+        <% if show_help_text?('viewer_protocol', document.viewer_protocol) %>
+          <%= render_help_text_entry('viewer_protocol', document.viewer_protocol) %>
+        <% end %>
+
+        <% if document.item_viewer.index_map %>
+          <div class="index-map-legend">
+            <div class="index-map-legend-info">
+              <span class="index-map-legend-default"></span>
+              <p><span class="sr-only">Green tile indicates </span>Map held by collection</p>
+            </div>
+            <div class="index-map-legend-info">
+              <span class="index-map-legend-unavailable"></span>
+              <p><span class="sr-only">Yellow tile indicates </span>Map not held by collection</p>
+            </div>
+            <div class="index-map-legend-info">
+              <span class="index-map-legend-selected"></span>
+              <p><span class="sr-only">Blue tile indicates </span>Selected map tile</p>
+            </div>
+          </div>
+        <% end %>
+
+        <%= content_tag :div, id: 'map', aria: { label: t('geoblacklight.map.label') }, data: { map: 'item', protocol: document.viewer_protocol.camelize, url: document.viewer_endpoint, 'layer-id' => document.wxs_identifier, 'map-geom' => document.geometry.geojson, 'catalog-path'=> search_catalog_path, available: document_available?, inspect: show_attribute_table?, basemap: geoblacklight_basemap, leaflet_options: leaflet_options } do %>
+        <% end %>
+      </div>
+      
+      <% if document.sidecar_allmaps.georeferenced? %>
+        <div class="tab-pane fade" id="georeferenced-tab" role="tabpanel" aria-labelledby="georeferenced-tab">
+          <%= render partial: 'allmaps/show/geoblacklight', locals: { document: document } %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,58 @@
+<% if Blacklight::VERSION.to_i > 8 %>
+  <%= render blacklight_config.track_search_session.item_pagination_component.new(search_context: @search_context, search_session: search_session, current_document: @document) if blacklight_config.track_search_session.item_pagination_component %>
+  <% @page_title = t('blacklight.search.show.title', document_title: document_presenter(@document).html_title, application_name: application_name).html_safe %>
+  <% content_for(:head) { render_link_rel_alternates } %>
+
+  <% document_component = blacklight_config.view_config(:show).document_component -%>
+  <%= render (document_component).new(document_component.collection_parameter => document_presenter(@document), component: :div, show: true, partials: blacklight_config.view_config(:show).partials) do |component| %>
+    <% component.with_title(as: 'h1', classes: '', link_to_document: false, actions: false) %>
+    <% component.with_footer do %>
+
+      <% unless defined?(Geoblacklight) %>
+        <% if @document.sidecar_allmaps.georeferenced? %>
+          <%= render partial: 'allmaps/show/blacklight', locals: { document: @document } %>
+        <% end %>
+      <% end %>
+      
+      <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
+        <!-- COinS, for Zotero among others. -->
+        <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(document_presenter(@document).display_type) %>"></span>
+      <% end %>
+    <% end %>
+  <% end %>
+
+<% else %>
+  <%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) if search_session['document_id'] == @document.id %>
+
+  <% @page_title = t('blacklight.search.show.title', document_title: Deprecation.silence(Blacklight::BlacklightHelperBehavior) { document_show_html_title }, application_name: application_name).html_safe %>
+  <% content_for(:head) { render_link_rel_alternates } %>
+
+  <%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), component: :div, title_component: :h1, show: true) do |component| %>
+    <% component.with_footer do %>
+
+      <% unless defined?(Geoblacklight) %>
+        <% if @document.sidecar_allmaps.georeferenced? %>
+          <%= render partial: 'allmaps/show/blacklight', locals: { document: @document } %>
+        <% end %>
+      <% end %>
+
+      <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
+        <!--
+            // COinS, for Zotero among others.
+            // This document_partial_name(@document) business is not quite right,
+            // but has been there for a while.
+        -->
+        <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(Deprecation.silence(Blacklight::RenderPartialsHelperBehavior) { document_partial_name(@document) }) %>"></span>
+      <% end %>
+    <%  end %>
+
+    <%# Use :body for complete backwards compatibility (overriding the component body markup),
+          but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
+    <% component.public_send(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :with_body : :with_partial) do %>
+      <div id="doc_<%= @document.id.to_s.parameterize %>">
+        <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>
+

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

@@ -0,0 +1,5 @@
+<% if defined?(Geoblacklight) && Geoblacklight::VERSION %>
+  <%= render :partial => 'show_sidebar_geoblacklight' %>
+<% elsif Blacklight::VERSION %>
+  <%= render :partial => 'show_sidebar_blacklight' %>
+<% end %>

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

@@ -0,0 +1,10 @@
+<% if Blacklight::VERSION.to_i > 8 %>
+  <% presenter = document_presenter(document) %>
+  <%= render presenter.view_config.sidebar_component.new(presenter: presenter) %>
+<% else %>
+  <%= render 'show_tools', document: @document %>
+  <%= render(Blacklight::Document::MoreLikeThisComponent.new(document: @document)) %>
+  <% if georeferenceable? %>
+    <%= render :partial => "allmaps/sidebar/allmaps" %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,20 @@
+<%= render :partial => 'show_sidebar_static_map' if render_sidebar_map?(@document) %>
+<%= render :partial => 'show_tools' %>
+
+<% if georeferenceable? %>
+  <%= render :partial => "allmaps/sidebar/allmaps" %>
+<% end %>
+
+<div class="sidebar-buttons">
+<%= render :partial => "show_web_services" %>
+<%= render :partial => "show_downloads" %>
+</div>
+
+<% unless @document.more_like_this.empty? %>
+  <div class="card">
+    <div class="card-header">More Like This</div>
+    <div class="card-body">
+      <%= render :collection => @document.more_like_this, :partial => 'show_more_like_this', :as => :document %>
+    </div>
+  </div>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Blacklight::Allmaps::Engine.routes.draw do
+end

data/db/migrate/20240307155110_create_solr_document_sidecars.rb

@@ -0,0 +1,15 @@
+class CreateSolrDocumentSidecars < ActiveRecord::Migration[7.0]
+  def change
+    create_table :blacklight_allmaps_sidecars do |t|
+      t.string :solr_document_id, index: true
+      t.string :document_type, default: "SolrDocument"
+      t.string :manifest_id, index: true
+      t.boolean :annotated, default: false
+      t.string :allmaps_id, index: true
+      t.text :iiif_manifest
+      t.text :allmaps_annotation
+      t.bigint :solr_version
+      t.timestamps
+    end
+  end
+end

data/lib/blacklight/allmaps/engine.rb

@@ -0,0 +1,6 @@
+module Blacklight
+  module Allmaps
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/blacklight/allmaps/rake_task.rb

@@ -0,0 +1,7 @@
+module Blacklight
+  module Allmaps
+    module RakeTask
+      Dir[File.expand_path(File.join(File.dirname(__FILE__), "tasks/*.rake"))].each { |ext| load ext } if defined?(Rake)
+    end
+  end
+end

data/lib/blacklight/allmaps/tasks/index.rake

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "blacklight"
+
+namespace :blacklight_allmaps do
+  namespace :index do
+    desc "Index - add Allmaps fixture data to Blacklight solr"
+    task :bl_fixtures do
+      # @TODO: JSON works when pasted into Solr, but fails here?
+      docs = Dir["spec/fixtures/solr_documents/bl_*.json"].map { |f| JSON.parse File.read(f) }.flatten
+      Blacklight.default_index.connection.add docs
+      Blacklight.default_index.connection.commit
+    end
+
+    desc "Index - add Allmaps fixture data to GeoBlacklight solr"
+    task :gbl_fixtures do
+      docs = Dir["spec/fixtures/solr_documents/gbl_*.json"].map { |f| JSON.parse File.read(f) }.flatten
+      Blacklight.default_index.connection.add docs
+      Blacklight.default_index.connection.commit
+    end
+
+    desc "Index - add Allmaps facet data to GeoBlacklight solr"
+    task gbl_georeferenced_facet: [:environment] do
+      # Steps
+      # 1. Use cursor to paginate all documents in Solr
+      # 2. Determine which documents have georeferenced data
+      # 3. Clean JSON for re-indexing
+      # 4. Add gbl_georeferenced_b values
+      # 5. Re-index the georeferenced documents
+
+      # 1. Get all the documents from Solr
+      cursor_mark = "*"
+      loop do
+        response = Blacklight.default_index.connection.get(
+          "select", params: {
+            q: "*:*", # all docs
+            fl: "*",  # all fields
+            cursorMark: cursor_mark, # use the cursor mark to handle paging
+            rows: 1000,
+            sort: "id asc" # must sort by id to use the cursor mark
+          }
+        )
+
+        response["response"]["docs"].each do |doc|
+          # 2. Determine which documents have georeferenced data
+          solr_document = SolrDocument.find(doc["id"])
+          if solr_document.sidecar.present? && solr_document.sidecar.annotated?
+
+            # 3. Clean JSON for re-indexing
+            keys_for_deletion = %w[
+              _version_
+              timestamp
+              solr_bboxtype
+              solr_bboxtype__minX
+              solr_bboxtype__minY
+              solr_bboxtype__maxX
+              solr_bboxtype__maxY
+            ]
+
+            cleaned_doc = doc.except!(*keys_for_deletion)
+
+            # 4. Add gbl_georeferenced_b value
+            # @TODO: add allmaps_id?
+            cleaned_doc["gbl_georeferenced_b"] = true
+
+            # 5. Re-index the georeferenced documents
+            Blacklight.default_index.connection.add cleaned_doc
+          end
+        end
+
+        break if response["nextCursorMark"] == cursor_mark # this means the result set is finished
+        cursor_mark = response["nextCursorMark"]
+      end
+      Blacklight.default_index.connection.commit
+    end
+  end
+end

data/lib/blacklight/allmaps/tasks/sidecars.rake

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+namespace :blacklight_allmaps do
+  namespace :sidecars do
+    namespace :harvest do
+      desc "Sidecars - Harvest: Crawl SolrDocuments to store Allmaps data locally"
+      task allmaps: [:environment] do
+        cursor_mark = "*"
+        loop do
+          response = Blacklight.default_index.connection.get(
+            "select", params: {
+              q: "*:*", # all docs
+              fl: "id",  # just id field
+              cursorMark: cursor_mark, # use the cursor mark to handle paging
+              rows: 1000,
+              sort: "id asc" # must sort by id to use the cursor mark
+            }
+          )
+
+          response["response"]["docs"].each do |doc|
+            puts "Harvesting Allmaps data for #{doc["id"]}"
+            Blacklight::Allmaps::StoreSidecarAnnotation.perform_later(doc["id"])
+          end
+
+          break if response["nextCursorMark"] == cursor_mark # this means the result set is finished
+          cursor_mark = response["nextCursorMark"]
+        end
+      end
+    end
+
+    desc "Sidecars - Purage all: Destroy all harvested images and sidecar AR objects"
+    task purge_all: [:environment] do
+      Blacklight::Allmaps::Sidecar.destroy_all
+    end
+
+    desc "Sidecars - Purge orphans: Destroy orphaned sidecar Active Record objects"
+    # When a Sidecar object exists,
+    # but it's corresponding SolrDocument is no longer in the Solr index.
+    task purge_orphans: [:environment] do
+      # Remove all sidecars that have no corresponding SolrDocument
+      sidecars = Blacklight::Allmaps::Sidecar.all
+      sidecars.each do |sc|
+        ::SolrDocument.find(sc.document_id)
+      rescue
+        sc.destroy
+        puts "orphaned / #{sc.document_id} / destroyed"
+      end
+    end
+  end
+end