Skip to content

Commit

Permalink
Extract Blacklight::Solr::SearchBuilder with processing chain for con…
Browse files Browse the repository at this point in the history 
…verting blacklight parameters to solr request parameters
  • Loading branch information
@cbeer
cbeer committed Feb 18, 2015
1 parent 4f302ea commit 1ed0a07
Show file tree
Hide file tree
Showing 9 changed files with 937 additions and 859 deletions.
7 changes: 6 additions & 1 deletion lib/blacklight/configuration.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ def default_values
default_per_page: nil,
# how many searches to save in session history
# (TODO: move the value into the configuration?)
search_history_window: Blacklight::Catalog::SearchHistoryWindow
search_history_window: Blacklight::Catalog::SearchHistoryWindow,
default_facet_limit: 10
}
end
end
Expand Down Expand Up @@ -204,6 +205,10 @@ def response_model= *args
deprecation_deprecate :solr_response_model
deprecation_deprecate :solr_response_model=

def default_per_page
super || per_page.first
end

##
# DSL helper
def configure
Expand Down
287 changes: 16 additions & 271 deletions lib/blacklight/request_builders.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ def solr_search_params_logic= logic
deprecation_deprecate :solr_search_params_logic=
end

def search_builder_class
Blacklight::Solr::SearchBuilder
end

def search_builder processor_chain = search_params_logic
search_builder_class.new(processor_chain, self)
end


# @returns a params hash for searching solr.
# The CatalogController #index action uses this.
Expand All @@ -69,8 +77,7 @@ def solr_search_params_logic= logic
# Incoming parameter :f is mapped to :fq solr parameter.
def solr_search_params(user_params = params || {}, processor_chain = search_params_logic)
Deprecation.warn(RequestBuilders, "solr_search_params is deprecated and will be removed in blacklight-6.0. Use SearchBuilder#processed_parameters instead.")

Blacklight::SearchBuilder.new(user_params, processor_chain, self).processed_parameters
search_builder(processor_chain).with(user_params).processed_parameters
end

##
Expand All @@ -80,27 +87,24 @@ def solr_search_params(user_params = params || {}, processor_chain = search_para
# added to the query post processing
def build_solr_query(user_params, processor_chain, extra_params=nil)
Deprecation.warn(RequestBuilders, "build_solr_query is deprecated and will be removed in blacklight-6.0. Use SearchBuilder#query instead")
Blacklight::SearchBuilder.new(user_params, processor_chain, self).query(extra_params)
search_builder(processor_chain).with(user_params).query(extra_params)
end

##
# Retrieve the results for a list of document ids
def solr_document_ids_params(ids = [])
solr_documents_by_field_values_params blacklight_config.document_model.unique_key, ids
Deprecation.silence(Blacklight::RequestBuilders) do
solr_documents_by_field_values_params blacklight_config.document_model.unique_key, ids
end
end

##
# Retrieve the results for a list of document ids
# @deprecated
def solr_documents_by_field_values_params(field, values)
q = if Array(values).empty?
"{!lucene}NOT *:*"
else
"{!lucene}#{field}:(#{ Array(values).map { |x| solr_param_quote(x) }.join(" OR ")})"
end

{ q: q, spellcheck: 'false', fl: "*" }
search_builder([:add_query_to_solr]).with(q: { field => values}).query(fl: '*')
end
deprecation_deprecate :solr_documents_by_field_values_params

##
# Retrieve a facet's paginated values.
Expand All @@ -111,7 +115,7 @@ def solr_facet_params(facet_field, user_params=params || {}, extra_controller_pa
solr_params = {}

# Now override with our specific things for fetching facet values
solr_params[:"facet.field"] = with_ex_local_param((facet_config.ex if facet_config.respond_to?(:ex)), facet_field)
solr_params[:"facet.field"] = search_builder.with_ex_local_param((facet_config.ex if facet_config.respond_to?(:ex)), facet_field)

limit = if respond_to?(:facet_list_limit)
facet_list_limit.to_s.to_i
Expand Down Expand Up @@ -162,214 +166,7 @@ def previous_and_next_document_params(index, window = 1)
solr_params[:facet] = false
solr_params
end

####
# Start with general defaults from BL config. Need to use custom
# merge to dup values, to avoid later mutating the original by mistake.
def default_solr_parameters(solr_parameters, user_params)
blacklight_config.default_solr_params.each do |key, value|
solr_parameters[key] = value.dup rescue value
end
end

##
# Take the user-entered query, and put it in the solr params,
# including config's "search field" params for current search field.
# also include setting spellcheck.q.
def add_query_to_solr(solr_parameters, user_parameters)
###
# Merge in search field configured values, if present, over-writing general
# defaults
###
# legacy behavior of user param :qt is passed through, but over-ridden
# by actual search field config if present. We might want to remove
# this legacy behavior at some point. It does not seem to be currently
# rspec'd.
solr_parameters[:qt] = user_parameters[:qt] if user_parameters[:qt]

search_field_def = blacklight_config.search_fields[user_parameters[:search_field]]
if (search_field_def)
solr_parameters[:qt] = search_field_def.qt
solr_parameters.merge!( search_field_def.solr_parameters) if search_field_def.solr_parameters
end

##
# Create Solr 'q' including the user-entered q, prefixed by any
# solr LocalParams in config, using solr LocalParams syntax.
# http://wiki.apache.org/solr/LocalParams
##
if (search_field_def && hash = search_field_def.solr_local_parameters)
local_params = hash.collect do |key, val|
key.to_s + "=" + solr_param_quote(val, :quote => "'")
end.join(" ")
solr_parameters[:q] = "{!#{local_params}}#{user_parameters[:q]}"
else
solr_parameters[:q] = user_parameters[:q] if user_parameters[:q]
end


##
# Set Solr spellcheck.q to be original user-entered query, without
# our local params, otherwise it'll try and spellcheck the local
# params! Unless spellcheck.q has already been set by someone,
# respect that.
#
# TODO: Change calling code to expect this as a symbol instead of
# a string, for consistency? :'spellcheck.q' is a symbol. Right now
# rspec tests for a string, and can't tell if other code may
# insist on a string.
solr_parameters["spellcheck.q"] = user_parameters[:q] unless solr_parameters["spellcheck.q"]
end

##
# Add any existing facet limits, stored in app-level HTTP query
# as :f, to solr as appropriate :fq query.
def add_facet_fq_to_solr(solr_parameters, user_params)

# convert a String value into an Array
if solr_parameters[:fq].is_a? String
solr_parameters[:fq] = [solr_parameters[:fq]]
end

# :fq, map from :f.
if ( user_params[:f])
f_request_params = user_params[:f]

f_request_params.each_pair do |facet_field, value_list|
Array(value_list).each do |value|
next if value.blank? # skip empty strings
solr_parameters.append_filter_query facet_value_to_fq_string(facet_field, value)
end
end
end
end

##
# Add appropriate Solr facetting directives in, including
# taking account of our facet paging/'more'. This is not
# about solr 'fq', this is about solr facet.* params.
def add_facetting_to_solr(solr_parameters, user_params)
# While not used by BL core behavior, legacy behavior seemed to be
# to accept incoming params as "facet.field" or "facets", and add them
# on to any existing facet.field sent to Solr. Legacy behavior seemed
# to be accepting these incoming params as arrays (in Rails URL with []
# on end), or single values. At least one of these is used by
# Stanford for "faux hieararchial facets".
if user_params.has_key?("facet.field") || user_params.has_key?("facets")
solr_parameters[:"facet.field"].concat( [user_params["facet.field"], user_params["facets"]].flatten.compact ).uniq!
end

blacklight_config.facet_fields.select { |field_name,facet|
facet.include_in_request || (facet.include_in_request.nil? && blacklight_config.add_facet_fields_to_solr_request)
}.each do |field_name, facet|
solr_parameters[:facet] ||= true

case
when facet.pivot
solr_parameters.append_facet_pivot with_ex_local_param(facet.ex, facet.pivot.join(","))
when facet.query
solr_parameters.append_facet_query facet.query.map { |k, x| with_ex_local_param(facet.ex, x[:fq]) }
else
solr_parameters.append_facet_fields with_ex_local_param(facet.ex, facet.field)
end

if facet.sort
solr_parameters[:"f.#{facet.field}.facet.sort"] = facet.sort
end

if facet.solr_params
facet.solr_params.each do |k, v|
solr_parameters[:"f.#{facet.field}.#{k}"] = v
end
end

# Support facet paging and 'more'
# links, by sending a facet.limit one more than what we
# want to page at, according to configured facet limits.
solr_parameters[:"f.#{facet.field}.facet.limit"] = (facet_limit_for(field_name) + 1) if facet_limit_for(field_name)
end
end

def add_solr_fields_to_query solr_parameters, user_parameters
blacklight_config.show_fields.select(&method(:should_add_to_solr)).each do |field_name, field|
if field.solr_params
field.solr_params.each do |k, v|
solr_parameters[:"f.#{field.field}.#{k}"] = v
end
end
end

blacklight_config.index_fields.select(&method(:should_add_to_solr)).each do |field_name, field|
if field.highlight
solr_parameters[:hl] = true
solr_parameters.append_highlight_field field.field
end

if field.solr_params
field.solr_params.each do |k, v|
solr_parameters[:"f.#{field.field}.#{k}"] = v
end
end
end
end

###
# copy paging params from BL app over to solr, changing
# app level per_page and page to Solr rows and start.
def add_paging_to_solr(solr_params, user_params)

# user-provided parameters should override any default row
solr_params[:rows] = user_params[:rows].to_i unless user_params[:rows].blank?
solr_params[:rows] = user_params[:per_page].to_i unless user_params[:per_page].blank?

# configuration defaults should only set a default value, not override a value set elsewhere (e.g. search field parameters)
solr_params[:rows] ||= blacklight_config.default_per_page unless blacklight_config.default_per_page.blank?
solr_params[:rows] ||= blacklight_config.per_page.first unless blacklight_config.per_page.blank?

# set a reasonable default
Rails.logger.info "Solr :rows parameter not set (by the user, configuration, or default solr parameters); using 10 rows by default"
solr_params[:rows] ||= 10

# ensure we don't excede the max page size
solr_params[:rows] = blacklight_config.max_per_page if solr_params[:rows].to_i > blacklight_config.max_per_page
unless user_params[:page].blank?
solr_params[:start] = solr_params[:rows].to_i * (user_params[:page].to_i - 1)
solr_params[:start] = 0 if solr_params[:start].to_i < 0
end

end

###
# copy sorting params from BL app over to solr
def add_sorting_to_solr(solr_parameters, user_params)
if user_params[:sort].blank? and sort_field = blacklight_config.default_sort_field
# no sort param provided, use default
solr_parameters[:sort] = sort_field.sort unless sort_field.sort.blank?
elsif sort_field = blacklight_config.sort_fields[user_params[:sort]]
# check for sort field key
solr_parameters[:sort] = sort_field.sort unless sort_field.sort.blank?
else
# just pass the key through
solr_parameters[:sort] = user_params[:sort]
end
end

# Remove the group parameter if we've faceted on the group field (e.g. for the full results for a group)
def add_group_config_to_solr solr_parameters, user_parameters
if user_parameters[:f] and user_parameters[:f][grouped_key_for_results]
solr_parameters[:group] = false
end
end

def with_ex_local_param(ex, value)
if ex
"{!ex=#{ex}}#{value}"
else
value
end
end


DEFAULT_FACET_LIMIT = 10

# Look up facet limit for given facet_field. Will look at config, and
Expand All @@ -396,57 +193,5 @@ def facet_limit_for(facet_field)
facet.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
end
end

##
# A helper method used for generating solr LocalParams, put quotes
# around the term unless it's a bare-word. Escape internal quotes
# if needed.
def solr_param_quote(val, options = {})
options[:quote] ||= '"'
unless val =~ /^[a-zA-Z0-9$_\-\^]+$/
val = options[:quote] +
# Yes, we need crazy escaping here, to deal with regexp esc too!
val.gsub("'", "\\\\\'").gsub('"', "\\\\\"") +
options[:quote]
end
return val
end

private

def should_add_to_solr field_name, field
field.include_in_request || (field.include_in_request.nil? && blacklight_config.add_field_configuration_to_solr_request)
end

##
# Convert a facet/value pair into a solr fq parameter
def facet_value_to_fq_string(facet_field, value)
facet_config = blacklight_config.facet_fields[facet_field]

local_params = []
local_params << "tag=#{facet_config.tag}" if facet_config and facet_config.tag

prefix = ""
prefix = "{!#{local_params.join(" ")}}" unless local_params.empty?

fq = case
when (facet_config and facet_config.query)
facet_config.query[value][:fq]
when (facet_config and facet_config.date)
# in solr 3.2+, this could be replaced by a !term query
"#{prefix}#{facet_field}:#{RSolr.escape(value)}"
when (value.is_a?(DateTime) or value.is_a?(Date) or value.is_a?(Time))
"#{prefix}#{facet_field}:#{RSolr.escape(value.to_time.utc.strftime("%Y-%m-%dT%H:%M:%SZ"))}"
when (value.is_a?(TrueClass) or value.is_a?(FalseClass) or value == 'true' or value == 'false'),
(value.is_a?(Integer) or (value.to_i.to_s == value if value.respond_to? :to_i)),
(value.is_a?(Float) or (value.to_f.to_s == value if value.respond_to? :to_f))
"#{prefix}#{facet_field}:#{RSolr.escape(value.to_s)}"
when value.is_a?(Range)
"#{prefix}#{facet_field}:[#{value.first} TO #{value.last}]"
else
"{!raw f=#{facet_field}#{(" " + local_params.join(" ")) unless local_params.empty?}}#{value}"
end

end
end
end

0 comments on commit 1ed0a07

Please sign in to comment.