Module: Blacklight::Solr::SearchBuilderBehavior

Extended by:
ActiveSupport::Concern
Defined in:
lib/blacklight/solr/search_builder_behavior.rb

Instance Method Summary collapse

Instance Method Details

#add_facet_fq_to_solr(solr_parameters) ⇒ Object

Add any existing facet limits, stored in app-level HTTP query as :f, to solr as appropriate :fq query.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 87

def add_facet_fq_to_solr(solr_parameters)
  # 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 blacklight_params[:f]
    f_request_params = blacklight_params[:f]

    f_request_params.each_pair do |facet_field, value_list|
      Array(value_list).reject(&:blank?).each do |value|
        solr_parameters.append_filter_query facet_value_to_fq_string(facet_field, value)
      end
    end
  end
end

#add_facet_paging_to_solr(solr_params) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 179

def add_facet_paging_to_solr(solr_params)
  return unless facet.present?

  facet_config = blacklight_config.facet_fields[facet]

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

  limit = if scope.respond_to?(:facet_list_limit)
            Deprecation.warn(self, "The use of facet_list_limit is deprecated and will be removed in 7.0. " \
              "Consider using the 'more_limit' option in the field configuration or 'default_more_limit' instead.")
            scope.facet_list_limit.to_s.to_i
          elsif solr_params["facet.limit"]
            solr_params["facet.limit"].to_i
          else
            facet_config.fetch(:more_limit, blacklight_config.default_more_limit)
          end

  page = blacklight_params.fetch(request_keys[:page], 1).to_i
  offset = (page - 1) * limit

  sort = blacklight_params[request_keys[:sort]]
  prefix = blacklight_params[request_keys[:prefix]]

  # Need to set as f.facet_field.facet.* to make sure we
  # override any field-specific default in the solr request handler.
  solr_params[:"f.#{facet_config.field}.facet.limit"] = limit + 1
  solr_params[:"f.#{facet_config.field}.facet.offset"] = offset
  if blacklight_params[request_keys[:sort]]
    solr_params[:"f.#{facet_config.field}.facet.sort"] = sort
  end
  if blacklight_params[request_keys[:prefix]]
    solr_params[:"f.#{facet_config.field}.facet.prefix"] = prefix
  end
  solr_params[:rows] = 0
end

#add_facetting_to_solr(solr_parameters) ⇒ Object

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.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 109

def add_facetting_to_solr(solr_parameters)
  facet_fields_to_include_in_request.each do |field_name, facet|
    solr_parameters[:facet] ||= true

    if facet.pivot
      solr_parameters.append_facet_pivot with_ex_local_param(facet.ex, facet.pivot.join(","))
    elsif 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

    limit = facet_limit_with_pagination(field_name)
    solr_parameters[:"f.#{facet.field}.facet.limit"] = limit if limit
  end
end

#add_group_config_to_solr(solr_parameters) ⇒ Object

Remove the group parameter if we've faceted on the group field (e.g. for the full results for a group)



173
174
175
176
177
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 173

def add_group_config_to_solr solr_parameters
  if blacklight_params[:f] and blacklight_params[:f][grouped_key_for_results]
    solr_parameters[:group] = false
  end
end

#add_paging_to_solr(solr_params) ⇒ Object

copy paging params from BL app over to solr, changing app level per_page and page to Solr rows and start.



158
159
160
161
162
163
164
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 158

def add_paging_to_solr(solr_params)
  rows(solr_params[:rows] || 10) if rows.nil?

  solr_params[:rows] = rows

  solr_params[:start] = start if start.nonzero?
end

#add_query_to_solr(solr_parameters) ⇒ Object

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.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
76
77
78
79
80
81
82
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 34

def add_query_to_solr(solr_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] = blacklight_params[:qt] if blacklight_params[:qt]

  if search_field
    solr_parameters[:qt] = search_field.qt
    solr_parameters.merge!( search_field.solr_parameters) if search_field.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 && search_field.solr_local_parameters.present?
    local_params = search_field.solr_local_parameters.map do |key, val|
      key.to_s + "=" + solr_param_quote(val, :quote => "'")
    end.join(" ")
    solr_parameters[:q] = "{!#{local_params}}#{blacklight_params[:q]}"

    ##
    # Set Solr spellcheck.q to be original user-entered query, without
    # our local params, otherwise it'll try and spellcheck the local
    # params!
    solr_parameters["spellcheck.q"] ||= blacklight_params[:q]
  elsif blacklight_params[:q].is_a? Hash
    q = blacklight_params[:q]
    solr_parameters[:q] = if q.values.any?(&:blank?)
      # if any field parameters are empty, exclude _all_ results
      "{!lucene}NOT *:*"
    else
      "{!lucene}" + q.map do |field, values|
        "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
      end.join(" AND ")
    end

    solr_parameters[:defType] = 'lucene'
    solr_parameters[:spellcheck] = 'false'
  elsif blacklight_params[:q]
    solr_parameters[:q] = blacklight_params[:q]
  end
end

#add_solr_fields_to_query(solr_parameters) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 136

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

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

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

#add_sorting_to_solr(solr_parameters) ⇒ Object

copy sorting params from BL app over to solr



168
169
170
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 168

def add_sorting_to_solr(solr_parameters)
  solr_parameters[:sort] = sort unless sort.blank?
end

#default_solr_parameters(solr_parameters) ⇒ Object

Start with general defaults from BL config. Need to use custom merge to dup values, to avoid later mutating the original by mistake.



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 18

def default_solr_parameters(solr_parameters)
  blacklight_config.default_solr_params.each do |key, value|
    solr_parameters[key] = if value.respond_to? :deep_dup
      value.deep_dup
    elsif value.respond_to? :dup and value.duplicable?
      value.dup
    else
      value
    end
  end
end

#facet_limit_for(facet_field) ⇒ Object

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 avaialble, 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.



231
232
233
234
235
236
237
238
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 231

def facet_limit_for(facet_field)
  facet = blacklight_config.facet_fields[facet_field]
  return if facet.blank?

  if facet.limit
    facet.limit == true ? blacklight_config.default_facet_limit : facet.limit
  end
end

#facet_limit_with_pagination(field_name) ⇒ Object

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.



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 243

def facet_limit_with_pagination(field_name)
  limit = facet_limit_for(field_name)

  return if limit.nil?

  if limit > 0
    limit + 1
  else
    limit
  end
end

#solr_param_quote(val, options = {}) ⇒ Object

A helper method used for generating solr LocalParams, put quotes around the term unless it's a bare-word. Escape internal quotes if needed.



259
260
261
262
263
264
265
266
267
268
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 259

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
  val
end

#with_ex_local_param(ex, value) ⇒ Object 



217
218
219
220
221
222
223
 
# File 'lib/blacklight/solr/search_builder_behavior.rb', line 217

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