blacklight 5.7.2 → 5.8.0

data/lib/blacklight/base.rb

@@ -5,7 +5,6 @@ module Blacklight::Base
   include Blacklight::Configurable
   include Blacklight::SolrHelper
 
-  require 'blacklight/catalog/search_context'
   include Blacklight::Catalog::SearchContext
 
   included do  

data/lib/blacklight/bookmarks.rb

@@ -0,0 +1,135 @@
+# -*- encoding : utf-8 -*-
+# note that while this is mostly restful routing, the #update and #destroy actions
+# take the Solr document ID as the :id, NOT the id of the actual Bookmark action.
+module Blacklight::Bookmarks
+  extend ActiveSupport::Concern
+
+  included do
+    ##
+    # Give Bookmarks access to the CatalogController configuration
+    include Blacklight::Configurable
+    include Blacklight::SolrHelper
+    include Blacklight::TokenBasedUser
+
+    copy_blacklight_config_from(CatalogController)
+
+    before_filter :verify_user
+
+    blacklight_config.show.document_actions[:bookmark].if = false if blacklight_config.show.document_actions[:bookmark]
+    blacklight_config.show.document_actions[:sms].if = false if blacklight_config.show.document_actions[:sms]
+  end
+
+  def action_documents
+    bookmarks = token_or_current_or_guest_user.bookmarks
+    bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
+    get_solr_response_for_document_ids(bookmark_ids)
+  end
+
+  def action_success_redirect_path
+    bookmarks_path
+  end
+
+  # Blacklight uses #search_action_url to figure out the right URL for
+  # the global search box
+  def search_action_url *args
+    catalog_index_url *args
+  end
+
+  def index
+    @bookmarks = token_or_current_or_guest_user.bookmarks
+    bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
+
+    @response, @document_list = get_solr_response_for_document_ids(bookmark_ids)
+
+    respond_to do |format|
+      format.html { }
+      format.rss  { render :layout => false }
+      format.atom { render :layout => false }
+      format.json do
+        render json: render_search_results_as_json
+      end
+
+      additional_response_formats(format)
+      document_export_formats(format)
+    end
+  end
+
+
+  def update
+    create
+  end
+
+  # For adding a single bookmark, suggest use PUT/#update to
+  # /bookmarks/$docuemnt_id instead.
+  # But this method, accessed via POST to /bookmarks, can be used for
+  # creating multiple bookmarks at once, by posting with keys
+  # such as bookmarks[n][document_id], bookmarks[n][title].
+  # It can also be used for creating a single bookmark by including keys
+  # bookmark[title] and bookmark[document_id], but in that case #update
+  # is simpler.
+  def create
+    if params[:bookmarks]
+      @bookmarks = params[:bookmarks]
+    else
+      @bookmarks = [{ document_id: params[:id], document_type: blacklight_config.solr_document_model.to_s }]
+    end
+
+    current_or_guest_user.save! unless current_or_guest_user.persisted?
+
+    success = @bookmarks.all? do |bookmark|
+       current_or_guest_user.bookmarks.where(bookmark).exists? || current_or_guest_user.bookmarks.create(bookmark)
+    end
+
+    if request.xhr?
+      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
+    else
+      if @bookmarks.length > 0 && success
+        flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
+      elsif @bookmarks.length > 0
+        flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
+      end
+
+      redirect_to :back
+    end
+  end
+
+  # Beware, :id is the Solr document_id, not the actual Bookmark id.
+  # idempotent, as DELETE is supposed to be.
+  def destroy
+    bookmark = current_or_guest_user.bookmarks.where(document_id: params[:id], document_type: blacklight_config.solr_document_model).first
+
+    success = bookmark && bookmark.delete && bookmark.destroyed?
+
+    unless request.xhr?
+      if success
+        flash[:notice] =  I18n.t('blacklight.bookmarks.remove.success')
+      else
+        flash[:error] = I18n.t('blacklight.bookmarks.remove.failure')
+      end
+      redirect_to :back
+    else
+      # ajaxy request needs no redirect and should not have flash set
+      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
+    end
+  end
+
+  def clear
+    if current_or_guest_user.bookmarks.clear
+      flash[:notice] = I18n.t('blacklight.bookmarks.clear.success')
+    else
+      flash[:error] = I18n.t('blacklight.bookmarks.clear.failure')
+    end
+    redirect_to :action => "index"
+  end
+
+  protected
+  def verify_user
+    unless current_or_guest_user or (action == "index" and token_or_current_or_guest_user)
+      flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied
+    end
+  end
+
+  def start_new_search_session?
+    action_name == "index"
+  end
+end

data/lib/blacklight/catalog.rb

@@ -1,8 +1,17 @@
 # -*- encoding : utf-8 -*-
-module Blacklight::Catalog   
+module Blacklight::Catalog
   extend ActiveSupport::Concern
-  
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :ComponentConfiguration
+    autoload :DocumentActions
+    autoload :SearchContext
+  end
+
   include Blacklight::Base
+  include Blacklight::Catalog::ComponentConfiguration
+  include Blacklight::Facet
 
   SearchHistoryWindow = 100 # how many searches to save in session history
 
@@ -18,13 +27,13 @@ module Blacklight::Catalog
 
     record_search_parameters
   end
-  
+
     # get search results from the solr index
     def index
       (@response, @document_list) = get_search_results
-      
+
       respond_to do |format|
-        format.html { }
+        format.html { preferred_view }
         format.rss  { render :layout => false }
         format.atom { render :layout => false }
         format.json do
@@ -35,10 +44,10 @@ module Blacklight::Catalog
         document_export_formats(format)
       end
     end
-    
+
     # get single document from the solr index
     def show
-      @response, @document = get_solr_response_for_doc_id   
+      @response, @document = get_solr_response_for_doc_id params[:id]
 
       respond_to do |format|
         format.html {setup_next_and_previous_documents}
@@ -49,10 +58,10 @@ module Blacklight::Catalog
         # export formats.
         @document.export_formats.each_key do | format_name |
           # It's important that the argument to send be a symbol;
-          # if it's a string, it makes Rails unhappy for unclear reasons. 
+          # if it's a string, it makes Rails unhappy for unclear reasons.
           format.send(format_name.to_sym) { render :text => @document.export_as(format_name), :layout => false }
         end
-        
+
       end
     end
 
@@ -80,14 +89,14 @@ module Blacklight::Catalog
 
       respond_to do |format|
         # Draw the facet selector for users who have javascript disabled:
-        format.html 
+        format.html
         format.json { render json: render_facet_list_as_json }
 
         # Draw the partial for the "more" facet modal window:
         format.js { render :layout => false }
       end
     end
-    
+
     # method to serve up XML OpenSearch description and JSON autocomplete response
     def opensearch
       respond_to do |format|
@@ -99,72 +108,13 @@ module Blacklight::Catalog
         end
       end
     end
-    
-    # citation action
-    def citation
-      @response, @documents = get_solr_response_for_document_ids(params[:id])
-      respond_to do |format|
-        format.html
-        format.js { render :layout => false }
-      end
-    end
-
-    
-    # Email Action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
-    def email
-      @response, @documents = get_solr_response_for_document_ids(params[:id])
-      
-      if request.post? and validate_email_params
-        email = RecordMailer.email_record(@documents, {:to => params[:to], :message => params[:message]}, url_options)
-
-        if email.respond_to? :deliver_now
-          email.deliver_now
-        else
-          email.deliver
-        end
-
-        flash[:success] = I18n.t("blacklight.email.success")
-
-        respond_to do |format|
-          format.html { redirect_to catalog_path(params['id']) }
-          format.js { render 'email_sent' }
-        end and return
-      end
 
-      respond_to do |format|
-        format.html
-        format.js { render :layout => false }
-      end
+    def action_documents
+      get_solr_response_for_document_ids(params[:id])
     end
 
-    
-    # SMS action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
-    def sms 
-      @response, @documents = get_solr_response_for_document_ids(params[:id])
-      
-      if request.post? and validate_sms_params
-        to = "#{params[:to].gsub(/[^\d]/, '')}@#{params[:carrier]}"
-
-        sms = RecordMailer.sms_record(@documents, { :to => to }, url_options)
-
-        if sms.respond_to? :deliver_now
-          sms.deliver_now
-        else
-          sms.deliver
-        end
-
-        flash[:success] = I18n.t("blacklight.sms.success")
-
-        respond_to do |format|
-          format.html { redirect_to catalog_path(params['id']) }
-          format.js { render 'sms_sent' }
-        end and return
-      end
-        
-      respond_to do |format|
-        format.js { render :layout => false }
-        format.html
-      end
+    def action_success_redirect_path
+      catalog_path(params[:id])
     end
 
     ##
@@ -173,12 +123,22 @@ module Blacklight::Catalog
     def has_search_parameters?
       !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
     end
-    
-    protected    
+
+    protected
     #
     # non-routable methods ->
     #
 
+    ##
+    # If the params specify a view, then store it in the session. If the params
+    # do not specifiy the view, set the view parameter to the value stored in the
+    # session. This enables a user with a session to do subsequent searches and have
+    # them default to the last used view.
+    def preferred_view
+      session[:preferred_view] = params[:view] if params[:view]
+      params[:view] ||= session[:preferred_view]
+    end
+
     ##
     # Render additional response formats, as provided by the blacklight configuration
     def additional_response_formats format
@@ -265,7 +225,28 @@ module Blacklight::Catalog
 
       h
     end
-    
+
+     # Email Action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
+     def email_action documents
+       mail = RecordMailer.email_record(documents, {:to => params[:to], :message => params[:message]}, url_options)
+       if mail.respond_to? :deliver_now
+         mail.deliver_now
+       else
+         mail.deliver
+       end
+     end
+
+     # SMS action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
+     def sms_action documents
+       to = "#{params[:to].gsub(/[^\d]/, '')}@#{params[:carrier]}"
+       mail = RecordMailer.sms_record(documents, { :to => to }, url_options)
+       if mail.respond_to? :deliver_now
+         mail.deliver_now
+       else
+         mail.deliver
+       end
+     end
+
     def validate_sms_params
       case
       when params[:to].blank?

data/lib/blacklight/catalog/component_configuration.rb

@@ -0,0 +1,99 @@
+module Blacklight
+  module Catalog::ComponentConfiguration
+    extend ActiveSupport::Concern
+
+    included do
+      add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+
+      add_results_collection_tool(:sort_widget)
+      add_results_collection_tool(:per_page_widget)
+      add_results_collection_tool(:view_type_group)
+
+      add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+      add_show_tools_partial(:refworks, if: :render_refworks_action?)
+      add_show_tools_partial(:endnote, if: :render_endnote_action? )
+      add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
+      add_show_tools_partial(:sms, callback: :sms_action, validator: :validate_sms_params)
+      add_show_tools_partial(:citation)
+      add_show_tools_partial(:librarian_view, if: :render_librarian_view_control?)
+
+      add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
+      add_nav_action(:saved_searches, partial: 'blacklight/nav/saved_searches', if: :render_saved_searches?)
+      add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
+    end
+
+    module ClassMethods
+
+      ##
+      # Add a partial to the tools for rendering a document
+      # @param partial [String] the name of the document partial
+      # @param opts [Hash]
+      # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      def add_show_tools_partial name, opts = {}
+        blacklight_config.add_show_tools_partial(name, opts)
+
+        define_method name do
+          @response, @documents = action_documents
+
+          if request.post? and
+              opts[:callback] and
+              (opts[:validator].blank? || self.send(opts[:validator]))
+
+            self.send(opts[:callback], @documents)
+
+            flash[:success] ||= I18n.t("blacklight.#{name}.success", default: nil)
+
+            respond_to do |format|
+              format.html { redirect_to action_success_redirect_path }
+              format.js { render "#{name}_success" }
+            end
+          else
+            respond_to do |format|
+              format.html
+              format.js { render :layout => false }
+            end
+          end
+        end unless method_defined? name
+      end
+
+      ##
+      # Add a tool to be displayed for each document in the search results.
+      # @param partial [String] the name of the document partial
+      # @param opts [Hash]
+      # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      def add_results_document_tool name, opts = {}
+        blacklight_config.add_results_document_tool(name, opts)
+      end
+
+      ##
+      # Add a tool to be displayed for the list of search results themselves.
+      # @param partial [String] the name of the document partial
+      # @param opts [Hash]
+      # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      def add_results_collection_tool name, opts = {}
+        blacklight_config.add_results_collection_tool(name, opts)
+      end
+
+      ##
+      # Add a partial to the header navbar
+      # @param partial [String] the name of the document partial
+      # @param opts [Hash]
+      # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      def add_nav_action name, opts = {}
+        blacklight_config.add_nav_action(name, opts)
+      end
+    end
+  end
+end