blacklight 7.33.0 → 8.0.0

data/app/controllers/concerns/blacklight/catalog.rb

@@ -1,37 +1,29 @@
 # frozen_string_literal: true
+
 module Blacklight::Catalog
   extend ActiveSupport::Concern
 
   # MimeResponds is part of ActionController::Base, but not ActionController::API
   include ActionController::MimeResponds
 
-  include Blacklight::Base
-  include Blacklight::Facet
+  include Blacklight::Configurable
+  include Blacklight::SearchContext
   include Blacklight::Searchable
 
-  extend Deprecation
-
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do
     if respond_to? :helper_method
-      helper_method :sms_mappings, :has_search_parameters?, :facet_limit_for
+      helper_method :sms_mappings, :has_search_parameters?
+      helper_method :search_facet_path
     end
 
-    helper Blacklight::Facet if respond_to? :helper
-
-    # The index action will more than likely throw this one.
-    # Example: when the standard query parser is used, and a user submits a "bad" query.
-    rescue_from Blacklight::Exceptions::InvalidRequest, with: :handle_request_error
-
     record_search_parameters
   end
 
   # get search results from the solr index
   def index
-    (@response, deprecated_document_list) = search_service.search_results
-
-    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, 'The @document_list instance variable is deprecated; use @response.documents instead.')
+    @response = search_service.search_results
 
     respond_to do |format|
       format.html { store_preferred_view }
@@ -49,8 +41,7 @@ module Blacklight::Catalog
   # get a single document from the index
   # to add responses for formats other than html or json see _Blacklight::Document::Export_
   def show
-    deprecated_response, @document = search_service.fetch(params[:id])
-    @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_response, 'The @response instance variable is deprecated; use @document.response instead.')
+    @document = search_service.fetch(params[:id])
 
     respond_to do |format|
       format.html { @search_context = setup_next_and_previous_documents }
@@ -67,7 +58,7 @@ module Blacklight::Catalog
   def raw
     raise(ActionController::RoutingError, 'Not Found') unless blacklight_config.raw_endpoint.enabled
 
-    _, @document = search_service.fetch(params[:id])
+    @document = search_service.fetch(params[:id])
     render json: @document
   end
 
@@ -95,7 +86,7 @@ module Blacklight::Catalog
     @response = search_service.facet_field_response(@facet.key)
     @display_facet = @response.aggregations[@facet.field]
 
-    @presenter = (@facet.presenter || Blacklight::FacetFieldPresenter).new(@facet, @display_facet, view_context)
+    @presenter = @facet.presenter.new(@facet, @display_facet, view_context)
     @pagination = @presenter.paginator
     respond_to do |format|
       format.html do
@@ -115,21 +106,19 @@ module Blacklight::Catalog
     end
   end
 
+  # Returns the dropdown list for autocomplete
   def suggest
-    respond_to do |format|
-      format.json do
-        render json: suggestions_service.suggestions
-      end
-    end
+    @suggestions = suggestions_service.suggestions
+    render 'suggest', layout: false
   end
 
   # @return [Array] first value is a Blacklight::Solr::Response and the second
   #                 is a list of documents
   def action_documents
-    deprecated_response, @documents = search_service.fetch(Array(params[:id]))
+    @documents = search_service.fetch(Array(params[:id]))
     raise Blacklight::Exceptions::RecordNotFound if @documents.blank?
 
-    [deprecated_response, @documents]
+    @documents
   end
 
   def action_success_redirect_path
@@ -143,34 +132,14 @@ module Blacklight::Catalog
     params[:search_field].present? || search_state.has_constraints?
   end
 
-  # TODO: deprecate this constant with #facet_limit_for
-  DEFAULT_FACET_LIMIT = 10
-
-  # Look up facet limit for given facet_field. Will look at config, and
-  # if config is 'true' will look up from Solr @response if available. If
-  # no limit is available, returns nil. Used from #add_facetting_to_solr
-  # to supply f.fieldname.facet.limit values in solr request (no @response
-  # available), and used in display (with @response available) to create
-  # a facet paginator with the right limit.
-  def facet_limit_for(facet_field)
-    facet = blacklight_config.facet_fields[facet_field]
-    return if facet.blank?
-
-    if facet.limit && @response && @response.aggregations[facet.field]
-      limit = @response.aggregations[facet.field].limit
-
-      if limit.nil? # we didn't get or a set a limit, so infer one.
-        facet.limit if facet.limit != true
-      elsif limit == -1 # limit -1 is solr-speak for unlimited
-        nil
-      else
-        limit.to_i - 1 # we added 1 to find out if we needed to paginate
-      end
-    elsif facet.limit
-      facet.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
-    end
+  def search_facet_path(options = {})
+    opts = search_state
+           .to_h
+           .merge(action: "facet", only_path: true)
+           .merge(options)
+           .except(:page)
+    url_for opts
   end
-  deprecation_deprecate facet_limit_for: 'moving to private logic in Blacklight::FacetFieldPresenter'
 
   private
 
@@ -314,26 +283,6 @@ module Blacklight::Catalog
     action_name == 'show' ? 'catalog_result' : super
   end
 
-  # when a method throws a Blacklight::Exceptions::InvalidRequest, this method is executed.
-  def handle_request_error(exception)
-    # Rails own code will catch and give usual Rails error page with stack trace
-    raise exception if Rails.env.development? || Rails.env.test?
-
-    flash_notice = I18n.t('blacklight.search.errors.request_error')
-
-    # If there are errors coming from the index page, we want to trap those sensibly
-
-    if flash[:notice] == flash_notice
-      logger&.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
-      raise exception
-    end
-
-    logger&.error exception
-
-    flash[:notice] = flash_notice
-    redirect_to search_action_url
-  end
-
   def blacklight_advanced_search_form_search_service
     form_search_state = search_state_class.new(blacklight_advanced_search_form_params, blacklight_config, self)
 

data/app/controllers/concerns/blacklight/controller.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
+
 # Filters added to this controller apply to all controllers in the hosting application
 # as this module is mixed-in to the application controller in the hosting app on installation.
 module Blacklight::Controller
   extend ActiveSupport::Concern
-  extend Deprecation
 
   included do
-    include Blacklight::SearchFields
-    helper Blacklight::SearchFields if respond_to? :helper
-
     include ActiveSupport::Callbacks
 
     # now in application.rb file under config.filter_parameters
@@ -16,6 +13,7 @@ module Blacklight::Controller
 
     # handle basic authorization exception with #access_denied
     rescue_from Blacklight::Exceptions::AccessDenied, with: :access_denied
+    helper BlacklightHelper
 
     if respond_to? :helper_method
       helper_method :current_user_session, :current_user, :current_or_guest_user
@@ -24,8 +22,7 @@ module Blacklight::Controller
       helper_method :has_user_authentication_provider?
       helper_method :blacklight_config, :blacklight_configuration_context # move to Catalog
       helper_method :search_action_url, :search_action_path
-      helper_method :search_facet_path # move to catalog? deprecate?
-      helper_method :search_state # move to catalog?
+      helper_method :search_state
     end
 
     # Which class to use for the search state. You can subclass SearchState if you
@@ -33,12 +30,6 @@ module Blacklight::Controller
     # TODO: move to Searchable
     class_attribute :search_state_class
     self.search_state_class = Blacklight::SearchState
-
-    # Which class to use for the search service. You can subclass SearchService if you
-    # want to override any of the methods (e.g. SearchService#fetch)
-    # TODO: move to Searchable
-    class_attribute :search_service_class
-    self.search_service_class = Blacklight::SearchService
   end
 
   # @private
@@ -64,8 +55,9 @@ module Blacklight::Controller
     has_user_authentication_provider? && current_or_guest_user.present?
   end
 
+  # This must be on every controller that uses the layout, because it is used in
+  # the header to draw Blacklight::SearchNavbarComponent (via the shared/header_navbar template)
   # @return [Blacklight::SearchState] a memoized instance of the parameter state.
-  # TODO: move to catalog?
   def search_state
     @search_state ||= search_state_class.new(params, blacklight_config, self)
   end
@@ -75,7 +67,7 @@ module Blacklight::Controller
   # which action the search form should use
   def search_action_url options = {}
     # Rails 4.2 deprecated url helpers accepting string keys for 'controller' or 'action'
-    search_catalog_url(options.except(:controller, :action))
+    search_catalog_url(options.to_h.except(:controller, :action))
   end
 
   def search_action_path *args
@@ -86,22 +78,6 @@ module Blacklight::Controller
     search_action_url(*args)
   end
 
-  # TODO: move to catalog? deprecate?
-  def search_facet_path(options = {})
-    opts = search_state
-           .to_h
-           .merge(action: "facet", only_path: true)
-           .merge(options)
-           .except(:page)
-    url_for opts
-  end
-
-  # Returns a list of Searches from the ids in the user's history.
-  # TODO: move to catalog? SearchHistory?
-  def searches_from_history
-    session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
-  end
-
   # Should be provided by authentication provider
   # def current_user
   # end
@@ -125,21 +101,9 @@ module Blacklight::Controller
     respond_to? :current_user
   end
 
-  def require_user_authentication_provider
-    raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
-  end
-  deprecation_deprecate require_user_authentication_provider: 'removed without replacement'
-
   ##
   # When a user logs in, transfer any saved searches or bookmarks to the current_user
   def transfer_guest_to_user
-    Deprecation.silence(Blacklight::Controller) do
-      transfer_guest_user_actions_to_current_user
-    end
-  end
-
-  # @deprecated use canonical `transfer_guest_to_user` method instead
-  def transfer_guest_user_actions_to_current_user
     return unless respond_to?(:current_user) && respond_to?(:guest_user) && current_user && guest_user
 
     current_user_searches = current_user.searches.pluck(:query_params)
@@ -158,7 +122,6 @@ module Blacklight::Controller
     # let guest_user know we've moved some bookmarks from under it
     guest_user.reload if guest_user.persisted?
   end
-  deprecation_deprecate :transfer_guest_user_actions_to_current_user
 
   ##
   # To handle failed authorization attempts, redirect the user to the

data/app/controllers/concerns/blacklight/search_context.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::SearchContext
   extend ActiveSupport::Concern
 
@@ -17,6 +18,38 @@ module Blacklight::SearchContext
     end
   end
 
+  # The current search session
+  def current_search_session
+    @current_search_session ||= find_search_session
+  end
+
+  # Returns a list of Searches from the ids in the user's history.
+  def searches_from_history
+    session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
+  end
+
+  # GET previous and next document json for the document specified by
+  # the counter param in current search
+  def page_links
+    counter_param = params.delete(:counter)
+    @page_link_data = {}
+    if counter_param
+      index = counter_param.to_i - 1
+      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset_search
+      if documents.detect(&:present?)
+        @page_link_data[:prev] = page_links_document_path(documents.first, index)
+        @page_link_data[:next] = page_links_document_path(documents.last, index + 2)
+      end
+      if response&.total && response.total.positive?
+        @page_link_data[:counterRaw] = counter_param
+        @page_link_data[:counterDelimited] = helpers.number_with_delimiter(counter_param.to_i)
+        @page_link_data[:totalRaw] = response.total
+        @page_link_data[:totalDelimited] = helpers.number_with_delimiter(response.total)
+      end
+    end
+    render json: @page_link_data
+  end
+
   private
 
   # sets up the session[:search] hash if it doesn't already exist
@@ -27,11 +60,6 @@ module Blacklight::SearchContext
     session[:search]
   end
 
-  # The current search session
-  def current_search_session
-    @current_search_session ||= find_search_session
-  end
-
   # Persist the current search session id to the user's session
   def set_current_search_session
     search_session['id'] = current_search_session.id if current_search_session
@@ -79,7 +107,9 @@ module Blacklight::SearchContext
   end
 
   def find_or_initialize_search_session_from_params params
-    params_copy = params.reject { |k, v| blacklisted_search_session_params.include?(k.to_sym) || v.blank? }
+    return unless blacklight_config.track_search_session.storage == 'server'
+
+    params_copy = params.reject { |k, v| nonpersisted_search_session_params.include?(k.to_sym) || v.blank? }
 
     return if params_copy.reject { |k, _v| [:action, :controller].include? k.to_sym }.blank?
 
@@ -102,22 +132,50 @@ module Blacklight::SearchContext
   end
 
   # A list of query parameters that should not be persisted for a search
-  def blacklisted_search_session_params
+  def nonpersisted_search_session_params
+    unless method(:blacklisted_search_session_params).source_location.first.end_with?('deprecation/method_wrappers.rb')
+      # The blacklisted_search_session_params was overridden, so call it.
+      Blacklight.deprecation.warn(self, "blacklisted_search_session_params was overriden in your app, " \
+                                        "but that method should be renamed to `nonpersisted_search_session_params'. " \
+                                        "The original behavior will be removed in the next major release.")
+      return blacklisted_search_session_params
+    end
     [:commit, :counter, :total, :search_id, :page, :per_page]
   end
 
+  def blacklisted_search_session_params
+    nonpersisted_search_session_params
+  end
+  Blacklight.deprecation.deprecate_methods(self, blacklisted_search_session_params: 'use nonpersisted_search_session_params instead')
+
   # calls setup_previous_document then setup_next_document.
   # used in the show action for single view pagination.
   def setup_next_and_previous_documents
-    if search_session['counter'] && current_search_session
-      index = search_session['counter'].to_i - 1
-      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params)
+    return { counter: params[:counter] } if setup_next_and_previous_on_client?
+    return nil unless setup_next_and_previous_on_server?
 
-      search_session['total'] = response.total
-      { prev: documents.first, next: documents.last }
-    end
+    index = search_session['counter'].to_i - 1
+    response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params)
+
+    search_session['total'] = response.total
+    { prev: documents.first, next: documents.last }
   rescue Blacklight::Exceptions::InvalidRequest => e
     logger&.warn "Unable to setup next and previous documents: #{e}"
     nil
   end
+
+  def setup_next_and_previous_on_server?
+    search_session['counter'] && current_search_session && blacklight_config.track_search_session.storage == 'server'
+  end
+
+  def setup_next_and_previous_on_client?
+    params[:counter] && blacklight_config.track_search_session.storage == 'client'
+  end
+
+  def page_links_document_path(document, counter)
+    return nil unless document
+    return search_state.url_for_document(document, counter: counter) if blacklight_config.view_config(:show).route
+
+    solr_document_path(document, counter: counter)
+  end
 end

data/app/controllers/concerns/blacklight/search_history.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
+
 module Blacklight
   module SearchHistory
     extend ActiveSupport::Concern
     include Blacklight::Configurable
+    include Blacklight::SearchContext
 
     included do
       copy_blacklight_config_from(CatalogController)

data/app/controllers/concerns/blacklight/searchable.rb

@@ -5,17 +5,28 @@
 # would be provided by Blacklight::Controller
 #  1. search_state
 #  2. blacklight_config
-#  3. search_service_class
 #
 # Additionally, the including class may override the search_service_context method to provide
 # further context to the SearchService. For example you could override this to provide the
 # currently signed in user.
 module Blacklight::Searchable
+  extend ActiveSupport::Concern
+
+  included do
+    # Which class to use for the search service. You can subclass SearchService if you
+    # want to override any of the methods (e.g. SearchService#fetch)
+    class_attribute :search_service_class
+    self.search_service_class = Blacklight::SearchService
+  end
+
   # @return [Blacklight::SearchService]
   def search_service
     search_service_class.new(config: blacklight_config, search_state: search_state, user_params: search_state.to_h, **search_service_context)
   end
 
+  # Override this method on the class that includes Blacklight::Searchable to provide more context to the search service if necessary.
+  # For example, if your search builder needs to be aware of the current user, override this method to return a hash including the current user.
+  # Then the search builder could use some property about the current user to construct a constraint on the search.
   # @return [Hash] a hash of context information to pass through to the search service
   def search_service_context
     {}

data/app/controllers/concerns/blacklight/token_based_user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Blacklight::TokenBasedUser
   extend ActiveSupport::Concern
 

data/app/controllers/search_history_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class SearchHistoryController < ApplicationController
   include Blacklight::SearchHistory
 end