Module: BlacklightAdvancedSearch::AdvancedSearchBuilder

Includes:
Blacklight::SearchFields
Defined in:
lib/blacklight_advanced_search/advanced_search_builder.rb

Constant Summary collapse

PARSLET_FAILED_EXCEPTIONS =

Different versions of Parslet raise different exception classes, need to figure out which one exists to rescue

if defined? Parslet::UnconsumedInput
                              [Parslet::UnconsumedInput].freeze
                            else
                              [Parslet::ParseFailed].freeze
end

Instance Method Summary collapse

Instance Method Details

#add_advanced_parse_q_to_solr(solr_parameters) ⇒ Object

This method can be included in the SearchBuilder to have us parse an ordinary entered :q for AND/OR/NOT and produce appropriate Solr query.

Note: For syntactically invalid input, we’ll just skip the adv parse and send it straight to solr same as if advanced_parse_q were not being used.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/blacklight_advanced_search/advanced_search_builder.rb', line 50

def add_advanced_parse_q_to_solr(solr_parameters)
  return if blacklight_params[:q].blank? || !blacklight_params[:q].respond_to?(:to_str)

  field_def = search_field_def_for_key(blacklight_params[:search_field]) ||
    default_search_field

  # If the individual field has advanced_parse_q suppressed, punt
  return if field_def[:advanced_parse] == false

  solr_direct_params = field_def[:solr_parameters] || {}
  solr_local_params = field_def[:solr_local_parameters] || {}

  # See if we can parse it, if we can't, we're going to give up
  # and just allow basic search, perhaps with a warning.
  begin
    adv_search_params = ParsingNesting::Tree.parse(blacklight_params[:q], blacklight_config.advanced_search[:query_parser]).to_single_query_params(solr_local_params)

    BlacklightAdvancedSearch.deep_merge!(solr_parameters, solr_direct_params)
    BlacklightAdvancedSearch.deep_merge!(solr_parameters, adv_search_params)
  rescue *PARSLET_FAILED_EXCEPTIONS => e
    # do nothing, don't merge our input in, keep basic search
    # optional TODO, display error message in flash here, but hard to
    # display a good one.
    return
  end
end

#add_advanced_search_to_solr(solr_parameters) ⇒ Object

this method should get added into the processor chain in a position AFTER normal query handling (:add_query_to_solr), so it’ll overwrite that if and only if it’s an advanced search. adds a ‘q’ and ‘fq’s based on advanced search form input.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/blacklight_advanced_search/advanced_search_builder.rb', line 15

def add_advanced_search_to_solr(solr_parameters)
  # If we've got the hint that we're doing an 'advanced' search, then
  # map that to solr #q, over-riding whatever some other logic may have set, yeah.
  # the hint right now is :search_field request param is set to a magic
  # key. OR of :f_inclusive is set for advanced params, we need processing too.
  if is_advanced_search?
    # Set this as a controller instance variable, not sure if some views/helpers depend on it. Better to leave it as a local variable
    # if not, more investigation later.
    advanced_query = BlacklightAdvancedSearch::QueryParser.new(blacklight_params, self.blacklight_config)
    BlacklightAdvancedSearch.deep_merge!(solr_parameters, advanced_query.to_solr)
    unless advanced_query.keyword_queries.empty?
      # force :qt if set, fine if it's nil, we'll use whatever CatalogController
      # ordinarily uses.
      solr_parameters[:qt] = self.blacklight_config.advanced_search[:qt]
      solr_parameters[:defType] = "lucene"
    end

  end
end

#facets_for_advanced_search_form(solr_p) ⇒ Object

A Solr param filter that is NOT included by default in the chain, but is appended by AdvancedController#index, to do a search for facets ignoring the current query, we want the facets as if the current query weren’t there.

Also adds any solr params set in blacklight_config.advanced_search



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/blacklight_advanced_search/advanced_search_builder.rb', line 83

def facets_for_advanced_search_form(solr_p)
  # ensure empty query is all records, to fetch available facets on entire corpus
  solr_p["q"]            = '{!lucene}*:*'
  # explicitly use lucene defType since we are passing a lucene query above (and appears to be required for solr 7)
  solr_p["defType"]      = 'lucene'
  # We only care about facets, we don't need any rows.
  solr_p["rows"]         = "0"

  # Anything set in config as a literal
  if blacklight_config.advanced_search[:form_solr_parameters]
    solr_p.merge!(blacklight_config.advanced_search[:form_solr_parameters])
  end
end

#is_advanced_search? ⇒ Boolean

Returns:

  • (Boolean) 


7
8
9
 
# File 'lib/blacklight_advanced_search/advanced_search_builder.rb', line 7

def is_advanced_search?
  (self.blacklight_config.advanced_search && blacklight_params[:search_field] == self.blacklight_config.advanced_search[:url_key]) || blacklight_params[:f_inclusive]
end