geoblacklight_sidecar_images 0.0.1

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb

@@ -0,0 +1,193 @@
+require 'rack/mime'
+
+class ImageService
+  def initialize(document)
+    @document = document
+    @logger ||= ActiveSupport::TaggedLogging.new(
+      Logger.new(
+        File.join(
+          Rails.root, '/log/', "image_service_#{Rails.env}.log"
+        )
+      )
+    )
+  end
+
+  # Stores the document's image in SolrDocumentSidecar
+  # using Carrierwave
+  # @return [Boolean]
+  #
+  # @TODO: EWL
+  def store
+    sidecar = @document.sidecar
+    sidecar.image = image_tempfile(@document.id)
+    sidecar.save!
+    @logger.tagged(@document.id, 'STATUS') { @logger.info 'SUCCESS' }
+    @logger.tagged(@document.id, 'SIDECAR_IMAGE_URL') { @logger.info @document.sidecar.image_url }
+  rescue ActiveRecord::RecordInvalid, FloatDomainError => invalid
+    @logger.tagged(@document.id, 'STATUS') { @logger.info 'FAILURE' }
+    @logger.tagged(@document.id, 'EXCEPTION') { @logger.info invalid.inspect }
+  end
+
+  # Returns hash containing placeholder thumbnail for the document.
+  # @return [Hash]
+  #   * :type [String] image mime type
+  #   * :data [String] image file data
+  def placeholder
+    placeholder_data
+  end
+
+  private
+
+  def image_tempfile(document_id)
+    @logger.tagged(@document.id, 'remote_content_type') { @logger.info remote_content_type }
+    @logger.tagged(@document.id, 'viewer_protocol') { @logger.info @document.viewer_protocol }
+    @logger.tagged(@document.id, 'service_url') { @logger.info service_url }
+    @logger.tagged(@document.id, 'image_extension') { @logger.info image_extension }
+
+    file = Tempfile.new([document_id, image_extension])
+    file.binmode
+    file.write(image_data[:data])
+    file.close
+
+    @logger.tagged(@document.id, 'IMAGE_TEMPFILE') { @logger.info file.inspect }
+
+    file
+  end
+
+  # Returns geoserver auth credentials if the document is a restriced Local WMS layer.
+  def geoserver_credentials
+    return unless restricted_wms_layer?
+    Settings.PROXY_GEOSERVER_AUTH.gsub('Basic ', '')
+  end
+
+  # Tests if geoserver credentials are set beyond the default.
+  def geoserver_credentials_valid?
+    Settings.PROXY_GEOSERVER_AUTH != 'Basic base64encodedusername:password'
+  end
+
+  def placeholder_base_path
+    Rails.root.join('app', 'assets', 'images')
+  end
+
+  # Generates hash containing placeholder mime_type and image.
+  def placeholder_data
+    { type: 'image/png', data: placeholder_image }
+  end
+
+  # Gets placeholder image from disk.
+  def placeholder_image
+    File.read(placeholder_image_path)
+  end
+
+  # Path to placeholder image based on the layer geometry.
+  def placeholder_image_path
+    geom_type = @document.fetch('layer_geom_type_s', '').tr(' ', '-').downcase
+    thumb_path = "#{placeholder_base_path}/thumbnail-#{geom_type}.png"
+    return "#{placeholder_base_path}/thumbnail-paper-map.png" unless File.exist?(thumb_path)
+    thumb_path
+  end
+
+  # Generates hash containing thumbnail mime_type and image.
+  def image_data
+    return placeholder_data unless image_url
+    { type: remote_content_type, data: remote_image }
+  end
+
+  # Gets thumbnail image from URL. On error, returns document's placeholder image.
+  def remote_content_type
+    auth = geoserver_credentials
+
+    conn = Faraday.new(url: image_url) do |b|
+      b.use FaradayMiddleware::FollowRedirects
+      b.adapter :net_http
+    end
+
+    conn.options.timeout = timeout
+    conn.options.timeout = timeout
+    conn.authorization :Basic, auth if auth
+
+    conn.head.headers['content-type']
+  rescue Faraday::Error::ConnectionFailed
+    placeholder_data[:type]
+  rescue Faraday::Error::TimeoutError
+    placeholder_data[:type]
+  end
+
+  # Gets thumbnail image from URL. On error, returns document's placeholder image.
+  def remote_image
+    auth = geoserver_credentials
+    conn = Faraday.new(url: image_url)
+    conn.options.timeout = timeout
+    conn.options.timeout = timeout
+    conn.authorization :Basic, auth if auth
+
+    conn.get.body
+  rescue Faraday::Error::ConnectionFailed
+    placeholder_image
+  rescue Faraday::Error::TimeoutError
+    placeholder_image
+  end
+
+  # Returns the thumbnail url.
+  # If the layer is restriced Local WMS, and the geoserver credentials
+  # have not been set beyond the default, then a thumbnail url from
+  # dct references is used instead.
+  def image_url
+    @image_url ||= begin
+      if restricted_scanned_map?
+        image_reference
+      elsif restricted_wms_layer? && !geoserver_credentials_valid?
+        image_reference
+      else
+        service_url || image_reference
+      end
+    end
+  end
+
+  # Determines the image file extension
+  def image_extension
+    @image_extension ||= Rack::Mime::MIME_TYPES.rassoc(remote_content_type).try(:first) || '.png'
+  end
+
+  # Checks if the document is Local restriced access and is a scanned map.
+  def restricted_scanned_map?
+    @document.local_restricted? && @document['layer_geom_type_s'] == 'Image'
+  end
+
+  # Checks if the document is Local restriced access and is a wms layer.
+  def restricted_wms_layer?
+    @document.local_restricted? && @document.viewer_protocol == 'wms'
+  end
+
+  # Gets the url for a specific service endpoint if the item is
+  # public, has the same institution as the GBL instance, and the viewer
+  # protocol is not 'map' or nil. A module name is then dynamically generated
+  # from the viewer protocol, and if it's loaded, the image_url
+  # method is called.
+  def service_url
+    @service_url ||= begin
+      return unless @document.available?
+      protocol = @document.viewer_protocol
+      return if protocol == 'map' || protocol.nil?
+      "ImageService::#{protocol.camelcase}".constantize.image_url(@document, image_size)
+    rescue NameError
+      return nil
+    end
+  end
+
+  # Retreives a url to a static thumbnail from the document's dct_references field, if it exists.
+  def image_reference
+    return nil if @document[@document.references.reference_field].nil?
+    JSON.parse(@document[@document.references.reference_field])['http://schema.org/thumbnailUrl']
+  end
+
+  # Default thumbnail size.
+  def image_size
+    300
+  end
+
+  # Faraday timeout value.
+  def timeout
+    30
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/dynamic_map_layer.rb

@@ -0,0 +1,11 @@
+class ImageService
+  module DynamicMapLayer
+    ##
+    # Formats and returns a thumbnail url from an ESRI Dynamic Map Layer endpoint.
+    # @param [SolrDocument]
+    # @return [String] image url
+    def self.image_url(document, _size)
+      "#{document.viewer_endpoint}/info/thumbnail/thumbnail.png"
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/iiif.rb

@@ -0,0 +1,13 @@
+class ImageService
+  module Iiif
+    ##
+    # Formats and returns a thumbnail url from an International Image
+    # Interoperability Framework endpoint.
+    # @param [SolrDocument]
+    # @param [Integer] thumbnail size
+    # @return [String] iiif thumbnail url
+    def self.image_url(document, size)
+      "#{document.viewer_endpoint.gsub('info.json', '')}full/#{size},/0/default.jpg"
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/image_map_layer.rb

@@ -0,0 +1,13 @@
+class ImageService
+  module ImageMapLayer
+    ##
+    # Formats and returns a thumbnail url from an ESRI Image Map Layer endpoint.
+    # information about the layer.
+    # @param [SolrDocument]
+    # @param [Integer] thumbnail size
+    # @return [String] thumbnail url
+    def self.image_url(document, _size)
+      "#{document.viewer_endpoint}/info/thumbnail/thumbnail.png"
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/tiled_map_layer.rb

@@ -0,0 +1,11 @@
+class ImageService
+  module TiledMapLayer
+    ##
+    # Formats and returns an image url from an ESRI Tiled Map Layer endpoint.
+    # @param [SolrDocument]
+    # @return [String] image url
+    def self.image_url(document, _size)
+      "#{document.viewer_endpoint}/info/thumbnail/thumbnail.png"
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/wms.rb

@@ -0,0 +1,24 @@
+class ImageService
+  module Wms
+    ##
+    # Formats and returns a thumbnail url from a Web Map Service endpoint.
+    # This utilizes the GeoServer specific 'reflect' service to generate
+    # parameters like bbox that are difficult to tweak without more detailed
+    # information about the layer.
+    # @param [SolrDocument]
+    # @param [Integer] thumbnail size
+    # @return [String] wms thumbnail url
+    def self.image_url(document, size)
+      # Swap proxy url with princeton geoserver url.
+      # Thumbnail requests send geoserver auth.
+      endpoint = document.viewer_endpoint.gsub(Settings.PROXY_GEOSERVER_URL,
+                                               Settings.INSTITUTION_GEOSERVER_URL)
+      "#{endpoint}/reflect?" \
+        '&FORMAT=image%2Fpng' \
+        '&TRANSPARENT=TRUE' \
+        "&LAYERS=#{document['layer_id_s']}" \
+        "&WIDTH=#{size}" \
+        "&HEIGHT=#{size}"
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/uploaders/image_uploader.rb

@@ -0,0 +1,53 @@
+class ImageUploader < CarrierWave::Uploader::Base
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  include CarrierWave::MiniMagick
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url(*args)
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path(
+  #       "fallback/" + [version_name, "default.png"].compact.join('_')
+  #   # )
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process scale: [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  version :thumb do
+    process resize_to_fill: [300, 300]
+  end
+
+  version :square, from_version: :thumb do
+    process resize_to_fill: [100, 100]
+  end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_whitelist
+    %w[jpg jpeg gif png]
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+end

data/lib/generators/geoblacklight_sidecar_images/templates/views/catalog/_index_split_default.html.erb

@@ -0,0 +1,27 @@
+<% # header bar for doc items in index view -%>
+<%= content_tag :div, class: 'documentHeader row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
+    <div class='more-info-area-split'>
+      <div class='status-icons'>
+        <%= render partial: 'header_icons', locals: { document: document } %>
+      </div>
+      <div class="thumbnail">
+        <img src="<%=document.sidecar.image_url%>"/>
+      </div>
+    </div>
+  <div class="document-wrapper">
+    <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
+      <% counter = document_counter_with_offset(document_counter) %>
+      <span class="document-counter">
+        <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+      </span>
+      <%= link_to_document document, document_show_link_field(document), counter: counter, title: document[blacklight_config.index.title_field] %>
+    </h3>
+    <div class='col-xs-12'>
+      <div>
+        <small>
+          <%= geoblacklight_present(:index_fields_display, document) %>
+        </small>
+      </div>
+    </div>
+  </div>
+<% end %>

data/lib/generators/geoblacklight_sidecar_images/uploaders_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module GeoblacklightSidecarImages
+  class UploadersGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Creates an app/uploaders directory
+       2. Creates uploader models within the app/uploaders directory
+    DESCRIPTION
+
+    def create_image_uploader
+      directory 'uploaders', 'app/uploaders'
+    end
+  end
+end

data/lib/generators/geoblacklight_sidecar_images/views_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module GeoblacklightSidecarImages
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc <<-DESCRIPTION
+      This generator makes the following changes to your application:
+       1. Creates an app/views/catalog directory
+    DESCRIPTION
+
+    def create_views
+      copy_file(
+        'views/catalog/_index_split_default.html.erb',
+        'app/views/catalog/_index_split_default.html.erb'
+      )
+    end
+  end
+end

data/lib/geoblacklight_sidecar_images.rb

@@ -0,0 +1,5 @@
+require 'geoblacklight_sidecar_images/engine'
+
+module GeoblacklightSidecarImages
+  # Your code goes here...
+end

data/lib/geoblacklight_sidecar_images/engine.rb

@@ -0,0 +1,5 @@
+module GeoblacklightSidecarImages
+  class Engine < ::Rails::Engine
+    isolate_namespace GeoblacklightSidecarImages
+  end
+end

data/lib/geoblacklight_sidecar_images/version.rb

@@ -0,0 +1,3 @@
+module GeoblacklightSidecarImages
+  VERSION = '0.0.1'.freeze
+end

data/lib/tasks/geoblacklight_sidecar_images_tasks.rake

@@ -0,0 +1,76 @@
+namespace :geoblacklight_sidecar_images do
+  namespace :sample_data do
+    desc 'Ingests a directory of geoblacklight.json files'
+    task :ingest, [:directory] => :environment do |_t, args|
+      args.with_defaults(directory: 'data')
+      Dir.glob(File.join(args[:directory], '**', '*.json')).each do |fn|
+        puts "Ingesting #{fn}"
+        begin
+          Blacklight.default_index.connection.add(JSON.parse(File.read(fn)))
+        rescue => e
+          puts "Failed to ingest #{fn}: #{e.inspect}"
+        end
+      end
+      puts 'Committing changes to Solr'
+      Blacklight.default_index.connection.commit
+    end
+  end
+
+  namespace :images do
+    desc 'Pre-cache specific image'
+    task :precache_id, [:doc_id] => [:environment] do |_t, args|
+      query = "dc_identifier_s:#{args[:doc_id]}"
+      layers = %w[
+        layer_slug_s
+        layer_id_s
+        dc_rights_s
+        dct_provenance_s
+        layer_geom_type_s
+        dct_references_s
+      ]
+      index = Geoblacklight::SolrDocument.index
+      results = index.send_and_receive(index.blacklight_config.solr_path,
+                                       q: query,
+                                       fl: layers.join(','),
+                                       rows: 100_000_000)
+      num_found = results.response[:numFound]
+      doc_counter = 0
+      results.docs.each do |document|
+        begin
+          StoreImageJob.perform_later(document.to_h)
+        rescue Blacklight::Exceptions::RecordNotFound
+          next
+        end
+      end
+    end
+
+    desc 'Pre-cache all images'
+    task :precache_all, [:override_existing] => [:environment] do |_t, args|
+      begin
+        query = 'layer_slug_s:*'
+        layers = %w[
+          layer_slug_s
+          layer_id_s
+          dc_rights_s
+          dct_provenance_s
+          layer_geom_type_s
+          dct_references_s
+        ]
+        index = Geoblacklight::SolrDocument.index
+        results = index.send_and_receive(index.blacklight_config.solr_path,
+                                         q: query,
+                                         fl: layers.join(','),
+                                         rows: 100_000_000)
+        num_found = results.response[:numFound]
+        doc_counter = 0
+        results.docs.each do |document|
+          begin
+            StoreImageJob.perform_later(document.to_h)
+          rescue Blacklight::Exceptions::RecordNotFound
+            next
+          end
+        end
+      end
+    end
+  end
+end