geoblacklight 4.0.0.pre.alpha.2 → 4.0.0.pre.rc2

data/lib/generators/geoblacklight/templates/settings.gbl_v1.yml

@@ -25,7 +25,7 @@ OVERLAP_RATIO_BOOST: '2'
 FIELDS:
   :ACCESS_RIGHTS: 'dc_rights_s'
   #:ALTERNATIVE_TITLE: 'dct_alternative_sm'
-  #:CENTROID: 'dcat_centroid_ss'
+  #:CENTROID: 'dcat_centroid'
   :CREATOR: 'dc_creator_sm'
   :DATE_ISSUED: 'dct_issued_s'
   #:DATE_RANGE: 'gbl_dateRange_drsim'
@@ -57,7 +57,7 @@ FIELDS:
   #:RIGHTS_HOLDER: 'dct_rightsHolder_sm'
   :SOURCE: 'dc_source_sm'
   :SPATIAL_COVERAGE: 'dct_spatial_sm'
-  :SPATIAL_EXTENT: 'solr_geom'
+  :GEOMETRY: 'solr_geom'
   :SUBJECT: 'dc_subject_sm'
   :SUPPRESSED: 'suppressed_b'
   :TEMPORAL_COVERAGE: 'dct_temporal_sm'
@@ -159,15 +159,15 @@ LEAFLET:
     DETECT_RETINA: true
     INDEX:
       DEFAULT: &default
-        color: "#1eb300"
+        color: "#7FCDBB"
         weight: "1"
         radius: "4"
       UNAVAILABLE:
         <<: *default
-        color: "#b3001e"
+        color: "#EDF8B1"
       SELECTED:
         <<: *default
-        color: "#006bde"
+        color: "#2C7FB8"
   VIEWERS:
     WMS:
       <<: *opacity_control

data/lib/generators/geoblacklight/templates/settings.yml

@@ -10,9 +10,6 @@ ARCGIS_BASE_URL: 'https://www.arcgis.com/home/webmap/viewer.html'
 # Download path can be configured using this setting
 #DOWNLOAD_PATH: "./tmp/cache/downloads"
 
-# DEPRECATED Main Solr geometry field used for spatial search and bounding box. Should be type 'rpt'
-GEOMETRY_FIELD: 'solr_geom'
-
 # The bq boost value for spatial search matches within a bounding box
 BBOX_WITHIN_BOOST: '10'
 
@@ -29,7 +26,7 @@ HOMEPAGE_MAP_GEOM: null
 FIELDS:
   :ACCESS_RIGHTS: 'dct_accessRights_s'
   :ALTERNATIVE_TITLE: 'dct_alternative_sm'
-  :CENTROID: 'dcat_centroid_ss'
+  :CENTROID: 'dcat_centroid'
   :CREATOR: 'dct_creator_sm'
   :DATE_ISSUED: 'dct_issued_s'
   :DATE_RANGE: 'gbl_dateRange_drsim'
@@ -42,9 +39,10 @@ FIELDS:
   :INDEX_YEAR: 'gbl_indexYear_im'
   :IS_PART_OF: 'dct_isPartOf_sm'
   :IS_REPLACED_BY: 'dct_isReplacedBy_sm'
-  :ISO_TOPIC_CATEGORY: 'dcat_theme_sm'
+  :THEME: 'dcat_theme_sm'
   :KEYWORD: 'dcat_keyword_sm'
   :LANGUAGE: 'dct_language_sm'
+  :LAYER_MODIFIED: 'gbl_mdModified_dt'
   :LICENSE: 'dct_license_sm'
   :MEMBER_OF: 'pcdm_memberOf_sm'
   :METADATA_VERSION: 'gbl_mdVersion_s'
@@ -61,7 +59,7 @@ FIELDS:
   :RIGHTS_HOLDER: 'dct_rightsHolder_sm'
   :SOURCE: 'dct_source_sm'
   :SPATIAL_COVERAGE: 'dct_spatial_sm'
-  :SPATIAL_EXTENT: 'locn_geometry'
+  :GEOMETRY: 'locn_geometry'
   :SUBJECT: 'dct_subject_sm'
   :SUPPRESSED: 'gbl_suppressed_b'
   :TEMPORAL_COVERAGE: 'dct_temporal_sm'
@@ -93,6 +91,9 @@ WEBSERVICES_SHOWN:
   - 'wms'
   - 'tms'
   - 'wfs'
+  - 'xyz'
+  - 'wmts'
+  - 'tilejson'
   - 'iiif'
   - 'feature_layer'
   - 'tiled_map_layer'
@@ -106,11 +107,16 @@ RELATIONSHIPS_SHOWN:
     query_type: ancestors
     icon: nil
     label: geoblacklight.relations.member_of
-  PART_OF:
+  PART_OF_ANCESTORS:
     field: dct_isPartOf_sm
     query_type: ancestors
     icon: nil
-    label: geoblacklight.relations.part_of
+    label: geoblacklight.relations.part_of_ancestors
+  PART_OF_DESCENDANTS:
+    field: dct_isPartOf_sm
+    query_type: descendants
+    icon: child-item
+    label: geoblacklight.relations.part_of_descendants
   RELATION:
     field: dct_relation_sm
     query_type: ancestors
@@ -129,12 +135,12 @@ RELATIONSHIPS_SHOWN:
   SOURCE_ANCESTORS:
     field: dct_source_sm
     query_type: ancestors
-    icon: pagelines-brands
+    icon: parent-item
     label: geoblacklight.relations.ancestor
   SOURCE_DESCENDANTS:
     field: dct_source_sm
     query_type: descendants
-    icon: leaf
+    icon: child-item
     label: geoblacklight.relations.descendant
   VERSION_OF:
     field: dct_isVersionOf_sm
@@ -153,36 +159,48 @@ WMS_PARAMS:
   :INFO_FORMAT: 'text/html'
 
 # Settings for leaflet
-OPACITY_CONTROL: &opacity_control
-  CONTROLS:
-    - 'Opacity'
-
 LEAFLET:
   MAP:
   LAYERS:
     DETECT_RETINA: true
     INDEX:
       DEFAULT: &default
-        color: "#1eb300"
+        color: "#7FCDBB"
         weight: "1"
         radius: "4"
       UNAVAILABLE:
         <<: *default
-        color: "#b3001e"
+        color: "#EDF8B1"
       SELECTED:
         <<: *default
-        color: "#006bde"
+        color: "#2C7FB8"
   VIEWERS:
-    WMS:
-      <<: *opacity_control
-    TILEDMAPLAYER:
-      <<: *opacity_control
-    FEATURELAYER:
-      <<: *opacity_control
     DYNAMICMAPLAYER:
-      <<: *opacity_control
+      CONTROLS:
+        - 'Opacity'
+        - 'Fullscreen'
+    FEATURELAYER:
+      CONTROLS:
+        - 'Opacity'
+        - 'Fullscreen'
+    IIIF:
+      CONTROLS:
+        - 'Fullscreen'
     IMAGEMAPLAYER:
-      <<: *opacity_control
+      CONTROLS:
+        - 'Opacity'
+        - 'Fullscreen'
+    INDEXMAP:
+      CONTROLS:
+        - 'Fullscreen'
+    TILEDMAPLAYER:
+      CONTROLS:
+        - 'Opacity'
+        - 'Fullscreen'
+    WMS:
+      CONTROLS:
+        - 'Opacity'
+        - 'Fullscreen'
 
 # Toggle the help text feature that offers users context
 HELP_TEXT:

data/lib/geoblacklight/bounding_box.rb

@@ -23,12 +23,16 @@ module Geoblacklight
       "ENVELOPE(#{west}, #{east}, #{north}, #{south})"
     end
 
+    def to_param
+      "#{west} #{south} #{east} #{north}"
+    end
+
     ##
     # Create a Geoblacklight::BoundingBox from a Solr rectangle syntax
     # @param [String] bbox as "W S E N"
     # @return [Geoblacklight::BoundingBox]
     def self.from_rectangle(rectangle)
-      rectangle_array = rectangle.split
+      rectangle_array = rectangle.is_a?(String) ? rectangle.split : []
       message = 'Bounding box should be a string in Solr rectangle syntax e.g."W S E N"'
       fail Geoblacklight::Exceptions::WrongBoundingBoxFormat, message if rectangle_array.count != 4
       new(

data/lib/geoblacklight/constants.rb

@@ -16,7 +16,10 @@ module Geoblacklight
       wcs: 'http://www.opengis.net/def/serviceType/ogc/wcs',
       wfs: 'http://www.opengis.net/def/serviceType/ogc/wfs',
       wms: 'http://www.opengis.net/def/serviceType/ogc/wms',
+      wmts: 'http://www.opengis.net/def/serviceType/ogc/wmts',
       tms: 'https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification',
+      tilejson: 'https://github.com/mapbox/tilejson-spec',
+      xyz: 'https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames',
       hgl: 'http://schema.org/DownloadAction',
       feature_layer: 'urn:x-esri:serviceType:ArcGIS#FeatureLayer',
       tiled_map_layer: 'urn:x-esri:serviceType:ArcGIS#TiledMapLayer',

data/lib/geoblacklight/engine.rb

@@ -3,7 +3,6 @@ require 'blacklight'
 require 'coderay'
 require 'config'
 require 'faraday'
-require 'faraday_middleware'
 require 'geoblacklight/version'
 require 'nokogiri'
 require 'mime/types'
@@ -19,7 +18,9 @@ module Geoblacklight
     end
 
     config.to_prepare do
-      Geoblacklight.inject!
+      unless SearchHistoryController.helpers.is_a?(Geoblacklight::ViewHelperOverride)
+        SearchHistoryController.send(:helper, Geoblacklight::ViewHelperOverride)
+      end
     end
   end
 end

data/lib/geoblacklight/faraday_middleware/follow_redirects.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+# :nocov:
+require 'faraday'
+require 'set'
+
+module Geoblacklight
+  # NOTE: We copied this class from faraday_middleware in order to support
+  # both Faraday 1 & 2. If this middleware is ever extracted from
+  # faraday_middleware into its own gem we should remove this and use that
+  # instead.
+  module FaradayMiddleware
+    # Exception thrown when the maximum amount of requests is
+    # exceeded.
+    class RedirectLimitReached < ::Faraday::ClientError
+      attr_reader :response
+
+      def initialize(response)
+        super "too many redirects; last one to: #{response['location']}"
+        @response = response
+      end
+    end
+
+    # Public: Follow HTTP 301, 302, 303, 307, and 308 redirects.
+    #
+    # For HTTP 301, 302, and 303, the original GET, POST, PUT, DELETE, or PATCH
+    # request gets converted into a GET. With `:standards_compliant => true`,
+    # however, the HTTP method after 301/302 remains unchanged. This allows you
+    # to opt into HTTP/1.1 compliance and act unlike the major web browsers.
+    #
+    # This middleware currently only works with synchronous requests; i.e. it
+    # doesn't support parallelism.
+    #
+    # If you wish to persist cookies across redirects, you could use
+    # the faraday-cookie_jar gem:
+    #
+    #   Faraday.new(:url => url) do |faraday|
+    #     faraday.use FaradayMiddleware::FollowRedirects
+    #     faraday.use :cookie_jar
+    #     faraday.adapter Faraday.default_adapter
+    #   end
+    #
+    class FollowRedirects < ::Faraday::Middleware
+      # HTTP methods for which 30x redirects can be followed
+      ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
+      # HTTP redirect status codes that this middleware implements
+      REDIRECT_CODES  = Set.new [301, 302, 303, 307, 308]
+      # Keys in env hash which will get cleared between requests
+      ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+
+      # Default value for max redirects followed
+      FOLLOW_LIMIT = 3
+
+      # Regex that matches characters that need to be escaped in URLs, sans
+      # the "%" character which we assume already represents an escaped sequence.
+      URI_UNSAFE = %r{[^\-_.!~*'()a-zA-Z\d;/?:@&=+$,\[\]%]}.freeze
+
+      AUTH_HEADER = 'Authorization'
+
+      # Public: Initialize the middleware.
+      #
+      # options - An options Hash (default: {}):
+      #     :limit                      - A Numeric redirect limit (default: 3)
+      #     :standards_compliant        - A Boolean indicating whether to respect
+      #                                  the HTTP spec when following 301/302
+      #                                  (default: false)
+      #     :callback                   - A callable used on redirects
+      #                                  with the old and new envs
+      #     :cookies                    - An Array of Strings (e.g.
+      #                                  ['cookie1', 'cookie2']) to choose
+      #                                  cookies to be kept, or :all to keep
+      #                                  all cookies (default: []).
+      #     :clear_authorization_header - A Boolean indicating whether the request
+      #                                  Authorization header should be cleared on
+      #                                  redirects (default: true)
+      def initialize(app, options = {})
+        super(app)
+        @options = options
+
+        @convert_to_get = Set.new [303]
+        @convert_to_get << 301 << 302 unless standards_compliant?
+      end
+
+      def call(env)
+        perform_with_redirection(env, follow_limit)
+      end
+
+      private
+
+      def convert_to_get?(response)
+        [:head, :options].exclude?(response.env[:method]) &&
+          @convert_to_get.include?(response.status)
+      end
+
+      def perform_with_redirection(env, follows)
+        request_body = env[:body]
+        response = @app.call(env)
+
+        response.on_complete do |response_env|
+          if follow_redirect?(response_env, response)
+            fail RedirectLimitReached, response if follows.zero?
+
+            new_request_env = update_env(response_env.dup, request_body, response)
+            callback&.call(response_env, new_request_env)
+            response = perform_with_redirection(new_request_env, follows - 1)
+          end
+        end
+        response
+      end
+
+      def update_env(env, request_body, response)
+        redirect_from_url = env[:url].to_s
+        redirect_to_url = safe_escape(response['location'] || '')
+        env[:url] += redirect_to_url
+
+        ENV_TO_CLEAR.each { |key| env.delete key }
+
+        if convert_to_get?(response)
+          env[:method] = :get
+          env[:body] = nil
+        else
+          env[:body] = request_body
+        end
+
+        clear_authorization_header(env, redirect_from_url, redirect_to_url)
+
+        env
+      end
+
+      def follow_redirect?(env, response)
+        ALLOWED_METHODS.include?(env[:method]) &&
+          REDIRECT_CODES.include?(response.status)
+      end
+
+      def follow_limit
+        @options.fetch(:limit, FOLLOW_LIMIT)
+      end
+
+      def standards_compliant?
+        @options.fetch(:standards_compliant, false)
+      end
+
+      def callback
+        @options[:callback]
+      end
+
+      # Internal: escapes unsafe characters from an URL which might be a path
+      # component only or a fully qualified URI so that it can be joined onto an
+      # URI:HTTP using the `+` operator. Doesn't escape "%" characters so to not
+      # risk double-escaping.
+      def safe_escape(uri)
+        uri = uri.split('#')[0] # we want to remove the fragment if present
+        uri.to_s.gsub(URI_UNSAFE) do |match|
+          "%#{match.unpack('H2' * match.bytesize).join('%').upcase}"
+        end
+      end
+
+      def clear_authorization_header(env, from_url, to_url)
+        return env if redirect_to_same_host?(from_url, to_url)
+        return env unless @options.fetch(:clear_authorization_header, true)
+
+        env[:request_headers].delete(AUTH_HEADER)
+      end
+
+      def redirect_to_same_host?(from_url, to_url)
+        return true if to_url.start_with?('/')
+
+        from_uri = URI.parse(from_url)
+        to_uri = URI.parse(to_url)
+
+        [from_uri.scheme, from_uri.host, from_uri.port] ==
+          [to_uri.scheme, to_uri.host, to_uri.port]
+      end
+    end
+  end
+end
+# :nocov:

data/lib/geoblacklight/item_viewer.rb

@@ -51,8 +51,20 @@ module Geoblacklight
       @references.tms
     end
 
+    def xyz
+      @references.xyz
+    end
+
+    def tilejson
+      @references.tilejson
+    end
+
+    def wmts
+      @references.wmts
+    end
+
     def viewer_preference
-      [oembed, index_map, tms, wms, iiif, tiled_map_layer, dynamic_map_layer,
+      [oembed, index_map, tilejson, xyz, wmts, tms, wms, iiif, tiled_map_layer, dynamic_map_layer,
        image_map_layer, feature_layer].compact.map(&:to_hash).first
     end
   end

data/lib/geoblacklight/metadata/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'geoblacklight/faraday_middleware/follow_redirects'
 module Geoblacklight
   module Metadata
     ##
@@ -47,7 +48,7 @@ module Geoblacklight
       # connection error
       def retrieve_metadata
         connection = Faraday.new(url: @reference.endpoint) do |conn|
-          conn.use FaradayMiddleware::FollowRedirects
+          conn.use Geoblacklight::FaradayMiddleware::FollowRedirects
           conn.adapter Faraday.default_adapter
         end
         begin

data/lib/geoblacklight/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Geoblacklight
-  VERSION = '4.0.0-alpha.2'
+  VERSION = '4.0.0-rc2'
 end

data/lib/geoblacklight/view_helper_override.rb

@@ -1,41 +1,15 @@
 # frozen_string_literal: true
 module Geoblacklight
+  # Override Blacklight helpers to inject behavior
   module ViewHelperOverride
-    include CatalogHelperOverride
-
-    def spatial_parameters?
-      params[:bbox]
-    end
-
-    # Overrides BL method to enable results for spatial only params
-    def has_search_parameters?
-      spatial_parameters? || super
-    end
-
-    def query_has_constraints?(localized_params = params)
-      has_search_parameters? || super(localized_params)
-    end
-
     def render_search_to_s(params)
       super + render_search_to_s_bbox(params)
     end
 
     def render_search_to_s_bbox(params)
       return ''.html_safe if params['bbox'].blank?
-      render_search_to_s_element(t('geoblacklight.bbox_label'), render_filter_value(params['bbox']))
-    end
 
-    def render_constraints_filters(localized_params = params)
-      content = super(localized_params)
-      localized_params = localized_params.to_h if localized_params.respond_to?(:to_h)
-
-      if localized_params[:bbox]
-        path = search_action_path(remove_spatial_filter_group(:bbox, localized_params))
-        content << render_constraint_element(t('geoblacklight.bbox_label'),
-                                             localized_params[:bbox], remove: path)
-      end
-
-      content
+      render_search_to_s_element(t('geoblacklight.bbox_label'), render_filter_value(params['bbox']))
     end
   end
 end

data/lib/geoblacklight.rb

@@ -4,7 +4,6 @@ require 'geoblacklight/engine'
 
 module Geoblacklight
   require 'geoblacklight/bounding_box'
-  require 'geoblacklight/catalog_helper_override'
   require 'geoblacklight/constants'
   require 'geoblacklight/exceptions'
   require 'geoblacklight/geometry'
@@ -34,15 +33,6 @@ module Geoblacklight
   require 'geoblacklight/relation/ancestors'
   require 'geoblacklight/relation/relation_response'
 
-  def self.inject!
-    CatalogController.send(:include, Geoblacklight::CatalogHelperOverride)
-    CatalogController.send(:include, Geoblacklight::ViewHelperOverride)
-    CatalogController.send(:helper, Geoblacklight::ViewHelperOverride) unless
-      CatalogController.helpers.is_a?(Geoblacklight::ViewHelperOverride)
-    SearchHistoryController.send(:helper, Geoblacklight::ViewHelperOverride) unless
-      SearchHistoryController.helpers.is_a?(Geoblacklight::ViewHelperOverride)
-  end
-
   def self.logger
     ::Rails.logger
   end

data/lib/tasks/geoblacklight.rake

@@ -87,7 +87,7 @@ namespace :geoblacklight do
         fail 'Please supply required arguments [document_id, download_type and timeout]'
       end
       document = Geoblacklight::SolrDocument.find(args[:doc_id])
-      fail Blacklight::Exceptions::RecordNotFound if document[:layer_slug_s] != args[:doc_id]
+      fail Blacklight::Exceptions::RecordNotFound if document[:id] != args[:doc_id]
       download = "Geoblacklight::#{args[:download_type].capitalize}Download"
                  .constantize.new(document, timeout: args[:timeout].to_i)
       download.get

data/schema/geoblacklight-schema-aardvark.json

@@ -67,28 +67,7 @@
     "dcat_theme_sm": {
       "type": "array",
       "items": {
-        "type": "string",
-        "enum": [
-          "Farming",
-          "Biota",
-          "Boundaries",
-          "Climatology, Meteorology and Atmosphere",
-          "Economy",
-          "Elevation",
-          "Environment",
-          "Geoscientific Information",
-          "Health",
-          "Imagery and Base Maps",
-          "Intelligence and Military",
-          "Inland Waters",
-          "Location",
-          "Oceans",
-          "Planning and Cadastral",
-          "Society",
-          "Structure",
-          "Transportation",
-          "Utilities and Communications"
-        ]
+        "type": "string"
       }
     },
     "dcat_keyword_sm": {
@@ -123,7 +102,8 @@
       }
     },
     "locn_geometry": { "type": "string" },
-    "dcat_centroid_ss": { "type": "string" },
+    "dcat_bbox": { "type": "string" },
+    "dcat_centroid": { "type": "string" },
     "dct_relation_sm": {
       "type": "array",
       "items": {