Module: Searchable

Defined in:
public/app/controllers/concerns/searchable.rb

Defined Under Namespace

Classes: NoResultsError

Constant Summary collapse

ABSTRACT =

also sets up searches, handles search results. TODO: refactor processing

%w(abstract scopecontent)

Instance Method Summary collapse

Instance Method Details

#default_search_opts(default = {}) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'public/app/controllers/concerns/searchable.rb', line 333

def default_search_opts(default = {})
  opts = {}
  default.each do |k, v|
    opts[k] = v
  end
  if AppConfig[:solr_params].any?
    AppConfig[:solr_params].each do |param, value|
      if value.respond_to? :call
        opts[param.to_sym] = self.instance_eval(&value)
      else
        opts[param.to_sym] = value
      end
    end
  end
  opts
end

#get_filter_years(params) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
 
# File 'public/app/controllers/concerns/searchable.rb', line 180

def get_filter_years(params)
  years = {}
  from = params.fetch(:filter_from_year, '').strip
  to = params.fetch(:filter_to_year, '').strip
  if !from.blank? || !to.blank?
    years['from_year'] = from.blank? ? '*' : from
    years['to_year'] = to.blank? ? '*' : to
  end
  years
end

#handle_results(results, full = true) ⇒ Object

process search results in one place, including stripping 0-value facets, and JSON-izing any expected JSON if full is false, only process notes for ‘abstract’ and ‘scopecontent’, don’t process dates or extents results[‘json’}[‘html’][type]



225
226
227
228
229
230
231
232
233
 
# File 'public/app/controllers/concerns/searchable.rb', line 225

def handle_results(results, full = true)
  # FIXME: move facet handling to SolrResults
  unless results['facets'].blank? || results['facets']['facet_fields'].blank?
    results['facets']['facet_fields'] = strip_facet_fields(results['facets']['facet_fields'])
  end
  # FIXME: remove this method as we no longer process results here - Record does the needful
  # results['results'] = process_results(results['results'], full)
  results
end

#html_notes(json, full) ⇒ Object

process notes



275
276
277
278
279
280
281
282
283
 
# File 'public/app/controllers/concerns/searchable.rb', line 275

def html_notes(json, full)
  json['html'] = {}
  if json.has_key?('notes')
    notes_html = process_json_notes(json['notes'], (!full ? ABSTRACT : nil))
    notes_html.each do |type, html|
      json['html'][type] = html
    end
  end
end

#process_results(results, full) ⇒ Object

processes the json portion of the results; if !full, only get notes for ‘abstract’ and ‘scopecontent’, don’t process dates or extents



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'public/app/controllers/concerns/searchable.rb', line 236

def process_results(results, full)
  results.each do |result|
    if !result['json'].blank?
      result['json'] = ASUtils.json_parse(result['json']) || {}
    end
    result['json']['display_string'] = full_title(result['json'])
    html_notes(result['json'], full)
    # handle dates
    handle_dates( result['json']) if result['json'].has_key?('dates') && full
    handle_external_docs(result['json']) if full
    # the info is deeply nested; find & bring it up
    if result['_resolved_repository'].is_a?(Hash)
      rr = result['_resolved_repository'].shift
      if !rr[1][0]['json'].blank?
        result['_resolved_repository']['json'] = ASUtils.json_parse( rr[1][0]['json'])
      end
    end
    # A different kind of convolution
    if result['_resolved_resource'].is_a?(Hash)
      keys = result['_resolved_resource'].keys
      if keys
        rr = result['_resolved_resource'][keys[0]]
        result['_resolved_resource']['json'] = rr[0]
      end
    end
    # and yet another kind of convolution
    if result['_resolved_top_container_uri_u_sstr'].is_a?(Hash)
#Pry::ColorPrinter.pp result['_resolved_top_container_uri_u_sstr']
      rr = result['_resolved_top_container_uri_u_sstr'].shift
      if !rr[1][0]['json'].blank?
        result['_resolved_top_container_uri_u_sstr']['json'] = ASUtils.json_parse( rr[1][0]['json'])
      end
    end
  end
  results
end

#process_search_results(base = "/search") ⇒ Object 



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
216
217
218
219
 
# File 'public/app/controllers/concerns/searchable.rb', line 191

def process_search_results(base="/search")
  @facets = {}
  hits = Integer(@results['total_hits'])
  if !@results['facets'].blank?
    @results['facets']['facet_fields'].keys.each do |type|
      facet_group = strip_facets( @results['facets']['facet_fields'][type], 1, type, hits)
      if facet_group.present?
        @facets[type] = facet_group
        if type == 'repository'
          @facets['repository'].reject! { |f| f.key == 'global' }
        end
      end
    end
  end
  @results = handle_results(@results, false)
  @repo = {}
  if @results['results'].length > 0 && @results['results'][0]['_resolved_repository'].present?
    @repo = @results['results'][0]['_resolved_repository']['json'] || {}
  end
#    q = params.require(:q)
  @page_search = "#{base}#{@facet_filter.get_filter_url_params}#{@search.get_filter_q_params}"

  @page_search += "&sort=#{@sort}" if defined?(@sort) && @sort

  @filters = @facet_filter.get_filter_hash(@page_search)

  @pager = Pager.new(@page_search, @results['this_page'], @results['last_page'])
  @page_title = I18n.t('search_results.page_title', :count => @results['total_hits'])
end

#repo_context(repo_id, type) ⇒ Object 



350
351
352
353
354
355
356
 
# File 'public/app/controllers/concerns/searchable.rb', line 350

def repo_context(repo_id, type)
  cont = []
  if repo_id
    cont.push({:uri => "/repositories/#{repo_id}", :crumb => get_pretty_facet_value('repository', "/repositories/#{repo_id}"), type: 'repository'})
    cont.push({:uri => '', :crumb => I18n.t("#{type}._plural"), type: type})
  end
end

#search_terms(params) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'public/app/controllers/concerns/searchable.rb', line 300

def search_terms(params)
  terms = ''
  queries = params.fetch(:q, nil)
  if queries
    ops = params.fetch(:op, [])
    field = params.fetch(:field, [])
    from_year = params.fetch(:from_year, [])
    to_year = params.fetch(:to_year, [])
    limit = params.fetch(:limit, '')
    queries.each_with_index do |query, i|
      if i == 0
        terms = query
        unless limit.blank?
          limit_term = limit == 'resource'? 'resources' : 'digital'
          terms += ' ' + I18n.t('search-limiting', :limit => I18n.t("search-limits.#{limit_term}"))
        end
      else
        terms += ' ' + ops[i] + ' ' + query
      end
      unless field[i].blank?
        field_term = (field[i] == 'creators_text'? I18n.t('search_results.filter.creators') : I18n.t("search_results.filter.#{field[i]}"))
        terms += ' ' + I18n.t('searched-field', :field => field_term)
      end
      unless from_year[i].blank? && to_year[i].blank?
        terms += ' ' + I18n.t('search_results.filter.from_to',
                              :begin =>(from_year[i].blank? || from_year[i] == '*' ? I18n.t('search_results.filter_year_begin') : from_year[i]),
                              :end => (to_year[i].blank? || to_year[i] == '*' ? I18n.t('search_results.filter.year_now') : to_year[i]) )
      end
    end
  end
  terms
end

#set_up_advanced_search(default_types = [], default_facets = [], default_search_opts = {}, params = {}) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'public/app/controllers/concerns/searchable.rb', line 86

def set_up_advanced_search(default_types = [], default_facets=[], default_search_opts={}, params={})
  @search = Search.new(params)
  unless @search[:limit].blank?
    default_types = @search[:limit].split(",")
  end
  set_search_statement
  raise I18n.t('navbar.error_no_term') unless @search.has_query?
  have_query = false
  advanced_query_builder = AdvancedQueryBuilder.new
  @search[:q].each_with_index { |query, i|
    query.gsub!(/\[\]/x) { |c| "\\" + c }
    query = '*' if query.blank?
    have_query = true
    op = @search[:op][i]
    field = @search[:field][i].blank? ? 'keyword' : @search[:field][i]
    from = @search[:from_year][i] || ''
    to = @search[:to_year][i] || ''
    @base_search += '&' if @base_search.last != '?'
    @base_search += "q[]=#{CGI.escape(query)}&op[]=#{CGI.escape(op)}&field[]=#{CGI.escape(field)}&from_year[]=#{CGI.escape(from)}&to_year[]=#{CGI.escape(to)}"
    builder = AdvancedQueryBuilder.new
    # add field part of the row
    builder.and(field, query, 'text', false, op == 'NOT')
    # add year range part of the row
    unless from.blank? && to.blank?
      builder.and('years', AdvancedQueryBuilder::RangeValue.new(from, to), 'range', false, op == 'NOT')
    end
    # add to the builder based on the op
    if op == 'OR'
      advanced_query_builder.or(builder)
    else
      advanced_query_builder.and(builder)
    end
  }
  raise I18n.t('navbar.error_no_term') unless have_query  # just in case we missed something

  filter_query_builder = AdvancedQueryBuilder.new

   # we have to add filtered dates, if they exist
  unless @search[:dates_searched]
    years = get_filter_years(params)
    unless years['from_year'].blank? && years['to_year'].blank?
      builder = AdvancedQueryBuilder.new
      builder.and('years', AdvancedQueryBuilder::RangeValue.new(years['from_year'], years['to_year']), 'range', false, false)
      filter_query_builder.and(builder)
      @base_search = "#{@base_search}&filter_from_year=#{years['from_year']}&filter_to_year=#{years['to_year']}"
    end
  end
  @criteria = default_search_opts
  @criteria['sort'] = @search[:sort] if @search[:sort]  # sort can be passed as default or via params
  # we have to pass the sort along in the URL
  @sort = @criteria['sort']
  Rails.logger.debug("SORT: #{@sort}")
 # if there's an fq passed along...
  unless @criteria['fq'].blank?
    @criteria['fq'].each do |fq|
      f, v = fq.split(":")
      advanced_query_builder.and(f, v, "text", false, false)
    end
  end

  unless @criteria['repo_id'].blank?
    repo_uri = "/repositories/" + @criteria['repo_id']

    # Add a filter to limit to this repository (or things that link to it)
    this_repo = AdvancedQueryBuilder.new
    this_repo
      .and('repository', repo_uri, 'uri')
      .or('used_within_published_repository', repo_uri, 'uri')

    advanced_query_builder.and(this_repo)
  end
  @base_search += "&limit=#{@search[:limit]}" unless @search[:limit].blank?

  @facet_filter = FacetFilter.new(default_facets, @search[:filter_fields], @search[:filter_values])

  # building the query for the facetting
  type_query_builder = AdvancedQueryBuilder.new
  default_types.reduce(type_query_builder) {|b, type|
    b.or('types', type)
  }

  @criteria['aq'] = advanced_query_builder.build.to_json
  @criteria['filter'] = filter_query_builder.and(@facet_filter.get_filter_query.and(type_query_builder)).build.to_json

 # apply any "search within" clauses
  @criteria['filter_query[]'] = @search[:filter_q].map {|v|
    v if !v.to_s.empty?
  }.compact

  @criteria['facet[]'] = @facet_filter.get_facet_types
  @criteria['page_size'] = params.fetch(:page_size, AppConfig[:pui_search_results_page_size])
end

#set_up_and_run_search(default_types = [], default_facets = [], default_search_opts = {}, params = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'public/app/controllers/concerns/searchable.rb', line 75

def set_up_and_run_search(default_types = [], default_facets=[], default_search_opts={}, params={})
  set_up_advanced_search(default_types, default_facets, default_search_opts, params)
  page = Integer(params.fetch(:page, "1"))
  @results = archivesspace.advanced_search('/search', page, @criteria)
  if @results['total_hits'].blank? || @results['total_hits'] == 0
    raise NoResultsError.new
  else
    process_search_results(@base_search)
  end
end

#set_up_search(default_types = [], default_facets = [], default_search_opts = {}, params = {}, q = '') ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
 
# File 'public/app/controllers/concerns/searchable.rb', line 12

def set_up_search(default_types = [], default_facets=[], default_search_opts={}, params={}, q='')
  @search = Search.new(params)
  limit = params.fetch(:limit, '')
  limit_param_exists = params.key?(:limit)

  # Apply the default scope if no limit is specified
  if limit.blank? && SearchConfigHelper.default_search_scope == 'collections_only' && !limit_param_exists
    limit = 'resource'
  end

  field = params.fetch(:field, nil)
  if !limit.blank?
    default_types = [limit]
  end
  @query = ''
  q = nil if q.strip.blank?
  record_types = params.fetch(:recordtypes, nil)
  if record_types
    record_types.each do |type|
      @query = "primary_type:#{type} #{@query}"
      @base_search += "&recordtypes[]=#{type}"
    end
    @query = "publish:true AND (#{@query})"
  elsif q
    @query = q
    @base_search = "#{@base_search}q=#{q}"
  else
    pq = params.fetch(:q, '*').strip
    pq = '*' if pq.blank?
    @query += "#{field}:" if !field.blank?
    @query += pq
    @base_search = "#{@base_search}q=#{@query}"
  end
  res_id = params.fetch(:res_id, '')
  repo_id = params.fetch(:repo_id, '')
  if !res_id.blank?
    @query = @query != '*' ? "#{@query} AND " : ''
    @query += "resource:\"#{res_id}\""
    @base_search = "#{@base_search}&res_id=#{res_id.gsub('/', '%2f')}"
  elsif !repo_id.blank?
    @query = @query != '*' ? "#{@query} AND " : ''
    @query += "repository:\"#{repo_id}\""
    @base_search = "#{@base_search}&repo_id=#{repo_id.gsub('/', '%2f')}"
  end
  years = get_filter_years(params)
  if !years.blank?
    @query = "#{@query} AND years:[#{years['from_year']} TO #{years['to_year']}]"
    @base_search = "#{@base_search}&filter_from_year=#{years['from_year']}&filter_to_year=#{years['to_year']}"
  end
  @base_search += "&limit=#{limit}" if !limit.blank?
#    Rails.logger.debug("SEARCHABLE BASE: #{@base_search}")
  @criteria = default_search_opts
  @facet_filter = FacetFilter.new(default_facets, params.fetch(:filter_fields, []), params.fetch(:filter_values, []))
  # building the query for the facetting
  type_query_builder = AdvancedQueryBuilder.new
  default_types.reduce(type_query_builder) {|b, type|
    b.or('types', type)
  }
  @criteria['filter'] = @facet_filter.get_filter_query.and(type_query_builder).build.to_json
  @criteria['facet[]'] = @facet_filter.get_facet_types
  @criteria['page_size'] = params.fetch(:page_size, AppConfig[:pui_search_results_page_size])
end

#strip_facet_fields(facet_fields) ⇒ Object

we don’t want any ‘ead/’ or ‘archdesc/’ stuff



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'public/app/controllers/concerns/searchable.rb', line 286

def strip_facet_fields(facet_fields)
  facet_fields.each do |key, arr|
    facets = {}
    arr.each_slice(2) do |t, ct|
      next if (ct == 0)
      next if t.start_with?("ead/ archdesc/ ")
      facets[t] = ct
    end
    facet_fields[key] = facets
  end
  facet_fields
end