geoblacklight_admin 0.4.1 → 0.5.0

data/{lib/generators/geoblacklight_admin/templates → app}/javascript/controllers/results_controller.js

@@ -293,6 +293,44 @@ export default class extends Controller {
     form.submit();
   }
 
+  harvestThumbnails(event) {
+    var el = document.querySelector('#bulk_action_field_name');
+    el.setAttribute('value', "Harvest Thumbnails");
+
+    // Set field value
+    var el = document.querySelector('#bulk_action_field_value');
+    el.setAttribute(
+      'value',
+      event.currentTarget.innerHTML.toLowerCase().trim()
+    );
+
+    // Set scope value
+    this.setPubState(event);
+
+    // Submit form
+    var form = document.querySelector('#result-action-form');
+    form.submit();
+  }
+
+  deleteThumbnails(event) {
+    var el = document.querySelector('#bulk_action_field_name');
+    el.setAttribute('value', "Delete Thumbnails");
+
+    // Set field value
+    var el = document.querySelector('#bulk_action_field_value');
+    el.setAttribute(
+      'value',
+      event.currentTarget.innerHTML.toLowerCase().trim()
+    );
+
+    // Set scope value
+    this.setPubState(event);
+
+    // Submit form
+    var form = document.querySelector('#result-action-form');
+    form.submit();
+  }
+
   bulkActionDelete(event) {
     event.preventDefault();
 

data/app/javascript/entrypoints/engine.js

@@ -0,0 +1,8 @@
+console.log('Vite ⚡️ Rails - GBL Admin')
+
+// Stimulus
+import { Application } from '@hotwired/stimulus'
+import ResultsController from "../controllers/results_controller"
+
+window.Stimulus = Application.start()
+Stimulus.register("results", ResultsController)

data/app/javascript/index.js

@@ -0,0 +1,8 @@
+console.log('Vite ⚡️ Rails - GBL Admin')
+
+// Stimulus
+import { Application } from '@hotwired/stimulus'
+import ResultsController from "./controllers/results_controller"
+
+window.Stimulus = Application.start()
+Stimulus.register("results", ResultsController)

data/app/jobs/bulk_action_revert_document_job.rb

@@ -22,9 +22,9 @@ class BulkActionRevertDocumentJob < ApplicationJob
 
     versions = document.versions
     document = versions[doc.version].reify
-    document.skip_callbacks = true
+    document&.skip_callbacks = true
 
-    if document.save
+    if document&.save
       doc.state_machine.transition_to!(:success)
     else
       doc.state_machine.transition_to!(:failed)

data/app/jobs/bulk_action_run_document_job.rb

@@ -10,8 +10,12 @@ class BulkActionRunDocumentJob < ApplicationJob
       update_publication_status(doc, field_value)
     when :update_delete
       update_delete(doc, field_value)
-    # @TODO: Field Level changes
+    when :harvest_thumbnails
+      GeoblacklightAdmin::StoreImageJob.perform_later(doc.friendlier_id, doc.id, :priority)
+    when :delete_thumbnails
+      GeoblacklightAdmin::DeleteThumbnailJob.perform_later(doc.friendlier_id, doc.id, :priority)
     else
+      # @TODO: Field Level changes
       logger.debug("@TODO - #{field_name} => #{field_value}")
     end
   end

data/app/jobs/bulk_action_run_job.rb

@@ -4,6 +4,11 @@
 class BulkActionRunJob < ApplicationJob
   queue_as :priority
 
+  after_perform do |job|
+    logger.debug("BulkActionRunJob - After Perform - #{job.arguments.first.id}")
+    job.arguments.first.state_machine.transition_to!(:complete)
+  end
+
   def perform(bulk_action)
     action = case bulk_action.field_name
     when "Publication State"
@@ -12,13 +17,18 @@ class BulkActionRunJob < ApplicationJob
     when "Delete"
       logger.debug("BulkAction: Delete")
       :update_delete
+    when "Harvest Thumbnails"
+      logger.debug("BulkAction: Harvest Thumbnails")
+      :harvest_thumbnails
+    when "Delete Thumbnails"
+      logger.debug("BulkAction: Delete Thumbnails")
+      :delete_thumbnails
     else
       :update_field_value
     end
 
     bulk_action.documents.each do |doc|
       BulkActionRunDocumentJob.perform_later(action, doc, bulk_action.field_name, bulk_action.field_value)
-      doc.state_machine.transition_to!(:queued)
     end
 
     # Capture State

data/app/jobs/geoblacklight_admin/delete_thumbnail_job.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class DeleteThumbnailJob < ApplicationJob
+    queue_as do
+      arguments.last
+    end
+
+    def perform(solr_document_id, bad_id = nil, queue = :priority)
+      document = Document.find_by_friendlier_id(solr_document_id)
+      if document.thumbnail.present?
+        document.thumbnail.destroy!
+      end
+      BulkActionDocument.find(bad_id).state_machine.transition_to!(:success) if bad_id.present?
+    end
+  end
+end

data/app/jobs/geoblacklight_admin/remove_parent_dct_references_uri_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class RemoveParentDctReferencesUriJob < ApplicationJob
+    queue_as :priority
+
+    def perform(asset)
+      if asset.dct_references_uri_key.present?
+        asset.parent.dct_references_s.delete_if { |i| i.value == asset.full_file_url }
+        asset.parent.save!
+      end
+    rescue => e
+      Rails.logger.error "\nError - Removing parent dct_references URI: #{e.message} \n"
+    end
+  end
+end

data/app/jobs/geoblacklight_admin/set_parent_dct_references_uri_job.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class SetParentDctReferencesUriJob < ApplicationJob
+    queue_as :priority
+
+    def perform(asset)
+      if asset.dct_references_uri_key.present?
+        reference = Document::Reference.new
+        reference.category = asset.dct_references_uri_key
+        reference.value = asset.full_file_url
+        asset.parent.dct_references_s << reference
+        asset.parent.save!
+      end
+    rescue => e
+      Rails.logger.error "\nError - Setting parent DCT references URI: #{e.message}\n"
+    end
+  end
+end

data/app/jobs/geoblacklight_admin/store_image_job.rb

@@ -2,11 +2,30 @@
 
 module GeoblacklightAdmin
   class StoreImageJob < ApplicationJob
-    queue_as :default
+    queue_as do
+      arguments.last
+    end
 
-    def perform(solr_document_id)
+    def perform(solr_document_id, bad_id = nil, queue = :default)
+      # Find the document
       document = Document.find_by_friendlier_id(solr_document_id)
+
+      # Delete thumbnail if already present
+      if document&.thumbnail&.present?
+        document.thumbnail.destroy!
+      end
+
+      # Statesman
+      metadata = {}
+      metadata["solr_doc_id"] = solr_document_id
+      document.thumbnail_state_machine.transition_to!(:queued, metadata)
+
+      # Crawl politely
+      sleep(rand(1..5))
+
+      # Store the image
       GeoblacklightAdmin::ImageService.new(document).store
+      BulkActionDocument.find(bad_id).state_machine.transition_to!(:success) if bad_id.present?
     end
   end
 end

data/app/models/asset.rb

@@ -1,13 +1,51 @@
 class Asset < Kithe::Asset
   include AttrJson::Record::QueryScopes
+  include Rails.application.routes.url_helpers
+
+  # Default Sort Order
+  default_scope { order(parent_id: :desc, created_at: :asc) }
 
   set_shrine_uploader(AssetUploader)
 
   # AttrJSON
   attr_json :thumbnail, :boolean, default: "false"
   attr_json :derivative_storage_type, :string, default: "public"
+  attr_json :dct_references_uri_key, :string
+  attr_json :label, :string
 
   DERIVATIVE_STORAGE_TYPE_LOCATIONS = {
     "public" => :kithe_derivatives
   }.freeze
+
+  def full_file_url
+    if Rails.env.development?
+      "http://localhost:3000" + file.url
+    else
+      file.url
+    end
+  end
+
+  # After Promotion Callbacks
+  after_promotion :set_parent_dct_references_uri
+
+  def set_parent_dct_references_uri
+    GeoblacklightAdmin::SetParentDctReferencesUriJob.perform_later(self) if parent_id.present?
+  end
+
+  # Before Destroy Callbacks
+  before_destroy :remove_parent_dct_references_uri
+
+  def remove_parent_dct_references_uri
+    GeoblacklightAdmin::RemoveParentDctReferencesUriJob.perform_later(self) if parent_id.present?
+  end
+
+  # After Save Callbacks
+  after_save :reindex_parent
+
+  def reindex_parent
+    parent.save if parent.present?
+  end
 end
+
+# Allow DocumentAsset to be used as a synonym for Asset
+DocumentAsset = Asset

data/app/models/blacklight_api.rb

@@ -30,11 +30,11 @@ class BlacklightApi
   end
 
   def facets
-    fetch["included"]&.filter_map { |s| s if s["type"] == "facet" }
+    fetch["included"]&.select { |s| s["type"] == "facet" }
   end
 
   def sorts
-    fetch["included"].filter_map { |s| s if s["type"] == "sort" }
+    fetch["included"].select { |s| s["type"] == "sort" }
   end
 
   def meta

data/app/models/blacklight_api_facets.rb

@@ -15,6 +15,6 @@ class BlacklightApiFacets
   end
 
   def facets
-    fetch["included"].filter_map { |s| s if s["type"] == "facet" } if fetch["included"].present?
+    fetch["included"].select { |s| s["type"] == "facet" } if fetch["included"].present?
   end
 end

data/app/models/blacklight_api_ids.rb

@@ -33,11 +33,11 @@ class BlacklightApiIds
   end
 
   def facets
-    fetch["included"]&.filter_map { |s| s if s["type"] == "facet" }
+    fetch["included"]&.select { |s| s["type"] == "facet" }
   end
 
   def sorts
-    fetch["included"].filter_map { |s| s if s["type"] == "sort" }
+    fetch["included"].select { |s| s["type"] == "sort" }
   end
 
   def meta

data/app/models/bulk_action_document_state_machine.rb

@@ -9,8 +9,6 @@ class BulkActionDocumentStateMachine
   state :success
   state :failed
 
-  transition from: :created, to: %i[queued success]
-  transition from: :queued, to: %i[queued success failed]
-  transition from: :success, to: %i[queued success failed]
-  transition from: :failed, to: %i[queued success failed]
+  transition from: :created, to: %i[queued success failed]
+  transition from: :queued, to: %i[success failed]
 end

data/app/models/bulk_action_state_machine.rb

@@ -10,7 +10,7 @@ class BulkActionStateMachine
   state :failed
   state :reverted
 
-  transition from: :created, to: %i[queued complete failed]
-  transition from: :queued, to: %i[created queued complete failed]
-  transition from: :complete, to: %i[queued reverted]
+  transition from: :created, to: %i[queued]
+  transition from: :queued, to: %i[created complete failed]
+  transition from: :complete, to: %i[reverted]
 end

data/app/models/bulk_actions/change_publication_state.rb

@@ -18,4 +18,14 @@ module BulkActions
   class DraftDocument < BulkAction
     # Add specific methods and validations for DraftDocument here
   end
+
+  # Subclass for HarvestThumbnails
+  class HarvestThumbnails < BulkAction
+    # Add specific methods and validations for HarvestThumbnails here
+  end
+
+  # Subclass for DeleteThumbnails
+  class DeleteThumbnails < BulkAction
+    # Add specific methods and validations for DeleteThumbnails here
+  end
 end

data/app/models/document/reference.rb

@@ -90,6 +90,30 @@ class Document
       oembed: {
         label: "oEmbed",
         uri: "https://oembed.com"
+      },
+      cog: {
+        label: "COG",
+        uri: "https://github.com/cogeotiff/cog-spec"
+      },
+      pmtiles: {
+        label: "PMTiles",
+        uri: "https://github.com/protomaps/PMTiles"
+      },
+      xyz_tiles: {
+        label: "XYZ Tiles",
+        uri: "https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames"
+      },
+      wmts: {
+        label: "WMTS",
+        uri: "http://www.opengis.net/def/serviceType/ogc/wmts"
+      },
+      tile_json: {
+        label: "TileJSON",
+        uri: "https://github.com/mapbox/tilejson-spec"
+      },
+      tile_map_service: {
+        label: "Tile Map Service",
+        uri: "https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification"
       }
     }.freeze
 

data/app/models/document.rb

@@ -18,26 +18,59 @@ class Document < Kithe::Work
   belongs_to :import, optional: true
 
   # Statesman
+  # - Publication State
   has_many :document_transitions, foreign_key: "kithe_model_id", autosave: false, dependent: :destroy,
     inverse_of: :document
+  # - Thumbnail State
+  has_many :document_thumbnail_transitions, foreign_key: "kithe_model_id", autosave: false, dependent: :destroy,
+    inverse_of: :document
 
-  # DocumentAccesses
+  # Document Collections
+  # - DocumentAccesses
   has_many :document_accesses, primary_key: "friendlier_id", foreign_key: "friendlier_id", autosave: false, dependent: :destroy,
     inverse_of: :document
 
-  # DocumentDownloads
+  # - DocumentDownloads
   has_many :document_downloads, primary_key: "friendlier_id", foreign_key: "friendlier_id", autosave: false, dependent: :destroy,
     inverse_of: :document
 
+  # DocumentAssets - Thumbnails, Attachments, etc
+  # @TODO: Redundant? Kithe also includes a members association
+  def document_assets
+    scope = Kithe::Asset
+    scope = scope.where(parent_id: id)
+
+    # scope = scope.page(params[:page]).per(20).order(created_at: :desc)
+    scope.includes(:parent)
+  end
+
+  def downloadable_assets
+    document_assets.select { |a| a.dct_references_uri_key == "download" }
+  end
+
   include Statesman::Adapters::ActiveRecordQueries[
     transition_class: DocumentTransition,
     initial_state: :draft
   ]
 
+  # @TODO: Rename this to publication_state_machine
   def state_machine
     @state_machine ||= DocumentStateMachine.new(self, transition_class: DocumentTransition)
   end
 
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: DocumentThumbnailTransition,
+    initial_state: :initialized
+  ]
+
+  def thumbnail_state_machine
+    @thumbnail_state_machine ||= DocumentThumbnailStateMachine.new(self, transition_class: DocumentThumbnailTransition)
+  end
+
+  def raw_solr_document
+    Blacklight.default_index.connection.get("select", {params: {q: "id:\"#{geomg_id_s}\""}})["response"]["docs"][0]
+  end
+
   delegate :current_state, to: :state_machine
 
   before_save :transition_publication_state, unless: :skip_callbacks
@@ -78,27 +111,101 @@ class Document < Kithe::Work
   # Index Transformations - *_json functions
   def references
     references = ActiveSupport::HashWithIndifferentAccess.new
+
+    # Prep value arrays
+    send(GeoblacklightAdmin::Schema.instance.solr_fields[:reference]).each do |ref|
+      references[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] = []
+    end
+
+    # Seed value arrays
     send(GeoblacklightAdmin::Schema.instance.solr_fields[:reference]).each do |ref|
-      references[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] = ref.value
+      # @TODO: Need to support multiple entries per key here
+      references[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] << ref.value
+    end
+
+    logger.debug("\n\nDocument#references > seeded: #{references}")
+
+    # Apply Downloads
+    references = apply_downloads(references)
+
+    logger.debug("Document#references > downloads: #{references}\n\n")
+
+    # Need to flatten the arrays here to avoid the following potential error:
+    # - ArgumentError: Please use symbols for polymorphic route arguments.
+    # - Via: app/helpers/geoblacklight_helper.rb:224:in `render_references_url'
+    references.each do |key, value|
+      next if key == "http://schema.org/downloadUrl"
+      if value.is_a?(Array) && value.length == 1
+        references[key] = value.first
+      end
     end
-    apply_downloads(references)
+
+    references
   end
 
   def references_json
     references.to_json
   end
 
+  def asset_label(asset)
+    if asset.label.present?
+      asset.label
+    else
+      asset.title
+    end
+  end
+
+  # Apply Downloads
+  # 1. Native Aardvark Downloads
+  # 2. Multiple Document Download Links
+  # 3. Downloadable Document Assets
   def apply_downloads(references)
+    multiple_downloads = []
+
     dct_downloads = references["http://schema.org/downloadUrl"]
-    # Make sure downloads exist!
-    if document_downloads.present?
-      multiple_downloads = multiple_downloads_array
-      if dct_downloads.present?
+
+    logger.debug("Document#dct_downloads > init: #{dct_downloads}\n\n")
+
+    # Native Aardvark Downloads
+    # - Via CSV Import or via the webform
+    if dct_downloads.present?
+      dct_downloads.each do |download|
         multiple_downloads << {label: download_text(send(GeoblacklightAdmin::Schema.instance.solr_fields[:format])),
-                                url: dct_downloads}
+                              url: download}
+      end
+    end
+
+    logger.debug("Document#multiple_downloads > aardvark: #{multiple_downloads.inspect}\n\n")
+
+    # Multiple Document Download Links
+    # - Via DocumentDownloads
+    if document_downloads.present?
+      multiple_downloads << multiple_downloads_array
+    end
+
+    logger.debug("Document#dct_downloads > document_downloads: #{multiple_downloads.inspect}\n\n")
+
+    # Downloadable Document Assets
+    # - Via DocumentAssets (Assets)
+    # - With Downloadable URI
+    if downloadable_assets.present?
+      downloadable_assets.each do |asset|
+        logger.debug("\n\n Document#dct_downloads > dupe?: #{multiple_downloads.detect { |d| d[:url].include?(asset.file.url) }}\n\n")
+
+        if multiple_downloads.detect { |d| d[:url].include?(asset.file.url) }
+          logger.debug("\n\n Detected duplicate download URL: #{asset.file.url}\n\n")
+          index = multiple_downloads.index { |d| d[:url].include?(asset.file.url) }
+          multiple_downloads[index] = {label: asset_label(asset), url: asset.file.url}
+        else
+          logger.debug("\n\n No duplicate found - Adding downloadable asset: #{asset.file.url}\n\n")
+          multiple_downloads << {label: asset_label(asset), url: asset.file.url}
+        end
       end
-      references[:"http://schema.org/downloadUrl"] = multiple_downloads
     end
+
+    logger.debug("Document#dct_downloads > downloadable_assets: #{multiple_downloads.inspect}\n\n")
+
+    references[:"http://schema.org/downloadUrl"] = multiple_downloads.flatten unless multiple_downloads.empty?
     references
   end
 
@@ -231,8 +338,9 @@ class Document < Kithe::Work
 
   ### End / From GBL
 
+  # Thumbnail is a special case of document_assets
   def thumbnail
-    members.find { |m| m.respond_to?(:thumbnail) }
+    members.find { |m| m.respond_to?(:thumbnail) && m.thumbnail? }
   end
 
   def access_json
@@ -282,6 +390,9 @@ class Document < Kithe::Work
       if value[:delimited]
         send(value[:destination])&.join("|")
       elsif value[:destination] == "dct_references_s"
+        # @TODO: Downloads need to be handled differently
+        # - Need to support multiple entries per key here
+        # - Need to respect label and url
         dct_references_s_to_csv(key, value[:destination])
       elsif value[:destination] == "b1g_publication_state_s"
         send(:current_state)

data/app/models/document_thumbnail_state_machine.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Document Thumbnail State Machine
+class DocumentThumbnailStateMachine
+  include Statesman::Machine
+
+  state :initialized, initial: true
+  state :queued
+  state :processing
+  state :succeeded
+  state :failed
+  state :placeheld
+
+  # Queued => Background Job Init
+  # Processing => Failed, Placeheld, Succeeded
+  transition from: :initialized, to: %i[queued processing]
+  transition from: :queued, to: %i[queued processing]
+  transition from: :processing, to: %i[queued processing placeheld succeeded failed]
+  transition from: :placeheld, to: %i[queued processing failed]
+  transition from: :failed, to: %i[queued processing]
+  transition from: :succeeded, to: %i[queued processing]
+end

data/app/models/document_thumbnail_transition.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Add Document Thumbnail State Transitions
+class DocumentThumbnailTransition < ApplicationRecord
+  include Statesman::Adapters::ActiveRecordTransition
+
+  # If your transition table doesn't have the default `updated_at` timestamp column,
+  # you'll need to configure the `updated_timestamp_column` option, setting it to
+  # another column name (e.g. `:updated_on`) or `nil`.
+  #
+  # self.updated_timestamp_column = :updated_on
+  # self.updated_timestamp_column = nil
+
+  belongs_to :document, inverse_of: :document_thumbnail_transitions, foreign_key: "kithe_model_id"
+
+  after_destroy :update_most_recent, if: :most_recent?
+
+  private
+
+  def update_most_recent
+    last_transition = document.document_thumbnail_transitions.order(:sort_key).last
+    return if last_transition.blank?
+
+    last_transition.update_column(:most_recent, true)
+  end
+end

data/app/models/element.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Element < ApplicationRecord
-  serialize :html_attributes
+  serialize :html_attributes, coder: JSON
 
   # Scopes
   scope :formable, -> { where(formable: true) }

data/app/models/geoblacklight_admin/field_mappings_btaa_aardvark.rb

@@ -372,7 +372,13 @@ module GeoblacklightAdmin
         "urn:x-esri:serviceType:ArcGIS#ImageMapLayer": "arcgis_image_map_layer",
         "http://schema.org/DownloadAction": "harvard",
         "https://openindexmaps.org": "open_index_map",
-        "https://oembed.com": "oembed"
+        "https://oembed.com": "oembed",
+        "https://github.com/cogeotiff/cog-spec": "cog",
+        "https://github.com/protomaps/PMTiles": "pmtiles",
+        "https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames": "xyz_tiles",
+        "http://www.opengis.net/def/serviceType/ogc/wmts": "wmts",
+        "https://github.com/mapbox/tilejson-spec": "tile_json",
+        "https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification": "tile_map_service"
       })
     end
   end