forked from Islandora/islandora_solr_search
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IslandoraSolrResults.inc
625 lines (544 loc) · 23.1 KB
/
IslandoraSolrResults.inc
1
2
3
4
5
6
7
8
9
10
11
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
74
75
76
77
78
79
80
81
82
83
84
85
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
178
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
<?php
/**
* @file
* Contains methods to search solr and display results. depends on Apache_Solr_Php client.
*/
/**
* Islandora Solr Results
*/
class IslandoraSolrResults {
static $facetSeparator = '~'; //used to separate facets in url
static $slashReplacement = '~slsh~'; // a pattern used to replace / in url's the slash breaks drupal clean url's
public static $SEARCH_CLASS_ADVANCED_SEARCH_NUMBER_FIELDS = 5;
public $facetFieldArray = array();
public $searchFieldArray = array();
public $resultFieldArray = array();
public $allSubsArray = array();
/**
* Constructor
*/
function IslandoraSolrResults() {
module_load_include('php', 'islandora_solr_search', 'SolrPhpClient/Apache/Solr/Service');
module_load_include('inc', 'islandora_solr_search', 'includes/common');
$this->prepFieldSubstitutions();
}
/**
* Output the main body of the search results
*
* @param type $solrQueryProcessor
* @param type $title
* @param type $output
* @return string
*/
function displayResults($solrQueryProcessor, $title = "Search Results", $output = '') {
$apacheSolrResult = $solrQueryProcessor->solrResult;
$total = (int) $apacheSolrResult->response->numFound;
$end = min(($solrQueryProcessor->solrLimit + $solrQueryProcessor->solrStart), $total);
// Check for empty resultset
if ($total === 0) {
$output = "<h2>Search Results</h2>";
$output .= "<div>Sorry, but your search returned no results.</div>";
return $output;
}
// Initialize drupal-style pager
islandora_solr_search_pager_init($total, $solrQueryProcessor->solrLimit);
// Get secondary display profiles
$secondary_display_profiles = module_invoke_all('islandora_solr_secondary_display');
// How about this for an expected return?
// return array(
// 'machine-name' = array(
// 'name' => 'Human Readable Name',
// 'module' => 'module_name',
// 'file' => 'FileName.inc',
// 'class' => 'ClassName',
// 'function' => 'function_name',
// 'description' => 'A description of the display profile',
// 'logo' => 'Some text, some <html>, an <img>, etc used to link to this output,
// );
// check if
// if the islandora_solr_search admin form has never been saved, then
// the variable 'islandora_solr_secondary_display' won't be set yet.
$secondary_array = variable_get('islandora_solr_secondary_display', array());
// count number of elements in array
$array_count = count($secondary_array);
// count number of disabled displays
$i = 0;
foreach ($secondary_array as $key => $value) {
if ($value === 0) {
$i++;
}
}
// if number of elements is the same as the number of disabled displays,
// this means that there are no displays enabled.
if ($array_count != $i) {
$output .= "<div id='islandora_solr_secondary_display_profiles'>";
foreach ($secondary_array as $name => $status) {
if ($status === $name) {
$description = $secondary_display_profiles[$name]['description'];
$logo = $secondary_display_profiles[$name]['logo'];
$attributes = array('title' => $description);
$query = array();
$query[] = drupal_query_string_encode(array('solr_profile' => $name));
$output .= l($logo, $_GET['q'], array('attributes' => $attributes, 'html' => TRUE, 'query' => count($query) ? implode('&', $query) : NULL));
}
}
$output .= "</div>";
}
$output .= '<h2>' . $title . '</h2>';
$output .= '<div id="islandora_solr_result_count">(' . ($solrQueryProcessor->solrStart + 1) . ' - ' . $end . ' of ' . $total . ')</div>';
$output .= '<div class="content">';
// drupal_set_message(print_r($secondary_display_profiles,1));
/*
* Then, here, we need to build links to the current query under the secondary query display
* profile for each such profile which uses the hook.
*
* The link should basically be $theCurrentURL with &proile=<profile_name> tacked on.
*
* Also, perhaps there's no difference between primary and secondary profiles?
*/
$output .= $this->printResults($solrQueryProcessor->solrResult);
// Render Drupal pager (bottom of search results)
$output .= theme('pager', NULL, $solrQueryProcessor->solrLimit, 0, NULL, 5);
$output .= "</div>"; // class = "content"
return $output;
}
/**
* Function: printResults
*
* Description: translates a solr query result into a basic in-browser search result.
*
* @param Apache_Solr_Object $results
*/
function printResults($results) {
$items = array();
$type = "ol";
$title = NULL;
$recordStart = $results->response->start;
$limitResults = variable_get('islandora_solr_search_limit_result_fields', 0);
$rawResponse = $results->getRawResponse();
$responseArray = json_decode($rawResponse, true);
$docs = $responseArray['response']['docs'];
//retrieve 'highlighing' from resultset.
$highlightResults = $responseArray['highlighting'];
$highlights = $results->highlighting;
foreach ($highlights as $highlight) {
$fields = get_object_vars($highlight);
$keys = array_keys($fields);
if (count($keys) > 0) {
foreach ($highlight->$keys[0] as $body) {
//drupal_set_message("$keys[0] $body");
}
}
//drupal_set_message($highlight->$keys[0]);
}
global $base_url;
if (empty($results)) {
return "no results";
}
foreach ($results->response->docs as $doc) {
$rows = array();
$row = 0;
$snippet = null;
foreach ($doc as $field => $value) {
if ($limitResults && empty($this->resultFieldArray[$field])) {
continue;
}
$translated_field_name = isset($this->allSubsArray[$field]) ? $this->allSubsArray[$field] : $field;
$rows[$row][] = array(
'data' => $translated_field_name,
'header' => TRUE,
);
if (is_array($value)) {
$value = implode(", ", $value);
}
if ($field == 'PID') {
$pid = $value;
$l = l($value, 'fedora/repository/' . htmlspecialchars($value, ENT_QUOTES, 'utf-8'));
$rows[$row][] = $l;
if (is_array($keys)) {
$snippet = $highlightResults[$value][$keys[0]];
}
}
else {
$rows[$row][] = $value;
}
$row++;
}
if ($snippet) {
$rows[$row][] = array(
'data' => 'Full Text',
'header' => TRUE,
);
$rows[$row][] = $snippet[0];
}
$items[] = theme_table(NULL, $rows, array('class' => 'islandora_solr_search_results_object'));
}
$output = theme_item_list($items, $title, $type, array('class' => 'stuff', 'start' => ($recordStart + 1)));
if (variable_get('islandora_solr_search_debug_mode', 0)) { // debug dump
$results_r .= "<pre>Results: " . print_r($results, TRUE) . "</pre>";
$fieldset_r = array(
'#title' => t("Raw Results"),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#value' => $results_r,
);
$output .= theme('fieldset', $fieldset_r);
}
return $output;
}
/**
* Function: currentQuery
*
* Description: Displays elements of the current solr query (with enabled filters).
* This functionality was previously rolled into the facet block, but it makes
* sense to separate the two functions, particularly as the current query is now
* imprinted in the system's breadcrumb.
*
* @param IslandoraSolrQueryProcessor $solrQueryProcessor
*/
function currentQuery($solrQueryProcessor) {
//dsm($solrQueryProcessor);
global $base_url;
$output = '';
$islandora_fq = restoreSlashes($solrQueryProcessor->solrFilters);
$islandora_facets = isset($solrQueryProcessor->solrResult->facet_counts->facet_fields) ?
$solrQueryProcessor->solrResult->facet_counts->facet_fields :
NULL;
//dsm($islandora_facets);
// look for the current display
global $current_display;
$display = isset($_GET['display']) ? $current_display : '';
$query = '';
if ($display) {
$query = array('display' => $display);
}
if (strlen(trim($solrQueryProcessor->solrQuery))) {
// Variables to build a drupal-ish unordered list
$query_list_title = "Query";
$query_list_items = array();
$query_list_type = "ul";
$query_list_attributes = array('class' => 'islandora_solr_search_query_list query_list');
// OK, so it's a list of one.
// In the future, we could reasonably break the query on boolean operators
// and allow one part to be removed at a time.
// set link properties
$image = '<img class="islandora_solr_add_remove_link" src="' . $base_url . '/' . drupal_get_path('module', 'islandora_solr_search') . '/images/delete.png" alt="Remove search term">';
$link = 'islandora/solr/search/' . " " . '/' . replaceSlashes($islandora_fq) . '/dismax';
$query_list_items[] .= l($image, $link, array('html' => TRUE, 'query' => $query )) . ' ' . stripslashes($solrQueryProcessor->solrQuery);
$output .= '<div class="islandora_solr_search_query_wrap">';
$output .= theme_item_list($query_list_items, $query_list_title, $query_list_type, $query_list_attributes);
$output .= '</div>'; // 'islandora_solr_search_query_wrap'
}
//////////////////////////////////////////////////////////////////////////////
// Here we will build links to remove currently enforced facet filters ... //
//////////////////////////////////////////////////////////////////////////////
$filters = empty($islandora_fq) ? NULL : explode(IslandoraSolrResults::$facetSeparator, $islandora_fq);
if (!empty($filters) && $islandora_fq != '-') {
// $filter_output = NULL;
// Variables to build a drupal-ish unordered list, which will be rendered
// a little bit farther down
$filter_list_title = "Enabled Filters";
$filter_list_items = array();
$filter_list_type = "ul";
$filter_list_attributes = array('class' => 'islandora_solr_search_filter_list filter_list');
foreach ($filters as $key => $filter) {
$edit_filters = $filters;
unset($edit_filters[$key]);
$filter_disable = implode(IslandoraSolrResults::$facetSeparator, $edit_filters);
if (empty($filter_disable)) {
$filter_disable = '-';
}
$filter_name_and_value = explode(":", $filter, 2);
$filter_name = $filter_name_and_value[0];
$filter_value = $filter_name_and_value[1];
if (strncmp($filter_name, '-', 1))
$exclude = FALSE;
else {
$exclude = TRUE;
$filter_name = substr($filter_name, 1);
}
// set link properties
$image = '<img class="islandora_solr_add_remove_link" src="' . $base_url . '/' . drupal_get_path('module', 'islandora_solr_search') . '/images/delete.png" alt="Remove this filter">';
$link = 'islandora/solr/search/' . replaceSlashes($solrQueryProcessor->solrQuery) . '/' . replaceSlashes($filter_disable) . '/' . $solrQueryProcessor->solrDefType;
$filter_list_items[] = l($image, $link, array('html' => TRUE, 'query' => $query )) . ' ' . $this->facetFieldArray[$filter_name] . ($exclude ? ' != ' : ' = ') . $filter_value;
}
}
if (!empty($filter_list_items)) {
// $filter_output = str_replace('%2B','%252B',$filter_output);
$output .= '<div class="islandora_solr_search_filter_wrap">';
$output .= theme_item_list($filter_list_items, $filter_list_title, $filter_list_type, $filter_list_attributes);
$output .= '</div>'; // 'islandora_solr_search_filter_wrap'
}
return $output;
}
/**
* Function: prepFieldSubstitutions
*
* Description: reads configuration values and preps a number of key=>value
* arrays for output substitution
*/
function prepFieldSubstitutions() {
$rawFacetVals = variable_get("islandora_solr_search_block_facets", 'dc.subject ~ Subject,dc.type ~ Type');
$this->facetFieldArray = islandora_build_substitution_list($rawFacetVals);
$rawSearchTerms = variable_get('islandora_solr_searchterms', 'dc.title ~ Title');
$this->searchFieldArray = islandora_build_substitution_list($rawSearchTerms);
$rawResultFields = variable_get('islandora_solr_search_result_fields', 'dc.subject ~ Subject,dc.type ~ Type');
$this->resultFieldArray = islandora_build_substitution_list($rawResultFields);
$this->allSubsArray = array_merge($this->facetFieldArray, $this->searchFieldArray, $this->resultFieldArray);
}
/**
* Function: displayFacets
*
* Description: Displays basic facets based on an apache solr query response,
* as contained with the IslandoraSolrQueryProcessor.
*
* @global string $base_url
* @param IslandoraSolrQueryProcessor $solrQueryProcessor
* @return string
*/
function displayFacets($solrQueryProcessor) {
global $base_url;
$facet_output = $output = '';
$islandora_fq = $solrQueryProcessor->solrFilters;
$islandora_facets = isset($solrQueryProcessor->solrResult->facet_counts->facet_fields) ? $solrQueryProcessor->solrResult->facet_counts->facet_fields : array();
if (empty($islandora_facets)) {
return $output; //no facets to show
}
// set counter to include javascript later
$i = 0;
foreach ($islandora_facets as $key => $field) {
$list_items = array();
$list_type = "ul";
$list_title = NULL;
$test = get_object_vars($field); //get the number of fields if there aren't any don't show the key
if (count($test) > 0) {
$facet_count = 0;
unset($normal_facet_output);
$filter_include = NULL;
$filter_exclude = NULL;
$disable_link = FALSE;
// dsm($field);
foreach ($field as $name => $number) {
if ($islandora_fq && $islandora_fq != '-') {//there are existing facets in the query
$disable_link = strstr($islandora_fq, $key . ':"' . replaceSlashes($name) . '"'); //we don't want a link for this facet as we already used it
if ($disable_link) {
//don't show link to this facet but include a link to remove it
}
else {
$filter_include = $key . ':' . '"' . $name . '"' . IslandoraSolrResults::$facetSeparator . $islandora_fq;
$filter_exclude = '-' . $key . ':' . '"' . $name . '"' . IslandoraSolrResults::$facetSeparator . $islandora_fq;
}
}
else { //no existing facets chosen
$filter_include = $key . ':' . '"' . $name . '"';
$filter_exclude = '-' . $key . ':' . '"' . $name . '"';
}
$filter_include = replaceSlashes($filter_include); //replace the slash so url does not break
$filter_exclude = replaceSlashes($filter_exclude); //replace the slash so url does not break
if ($disable_link) {
// we don't want to create a link, because we're already filtering on this value.
// Links to remove enabled facet filters are created down below.
}
else {//normal link
$evenodd = ( $facet_count % 2 ? 'odd' : 'even' );
$lplus = 'islandora/solr/search/' . $solrQueryProcessor->solrQuery . '/' . $filter_include . '/' . $solrQueryProcessor->solrDefType;
$lminus = 'islandora/solr/search/' . $solrQueryProcessor->solrQuery . '/' . $filter_exclude . '/' . $solrQueryProcessor->solrDefType;
// look for the current display
global $current_display;
$display = isset($_GET['display']) ? $current_display : '';
$query = '';
if ($display) {
$query = array('display' => $display);
}
$text = $name;
$list_items[] = l($text, $lplus, array('query' => $query)) . ' (' . $number . ')' .
'<span class="plusminus">' .
l('+', $lplus, array('attributes' => array('class' => 'plus'), 'query' => $query )) . ' ' .
l('-', $lminus, array('attributes' => array('class' => 'minus'), 'query' => $query )) .
'</span>';
$facet_count++;
}
}
if ($facet_count >= 1) {
$facet_output .='<div class="islandora_solr_search_facet">';
// shown limit
$shown_limit = variable_get('islandora_solr_search_block_facet_shown_limit', 0);
$facetlimit = variable_get('islandora_solr_search_block_facet_limit', '12');
$facetMinCount = variable_get('islandora_solr_search_block_facet_min_count', '2');
$list_title = $this->facetFieldArray[$key];
$list_type = "ul";
$list_attributes = array('class' => 'islandora_solr_search_facet_list facet_list');
// set show more variable
$show_more = FALSE;
// split the array if shown_limit is between the min and max limits and if the total is larger than the shown_limit.
if ($facet_count > $shown_limit AND $shown_limit < $facetlimit AND $shown_limit > $facetMinCount) {
$list_items_hidden = array_slice($list_items, $shown_limit);
$list_items = array_slice($list_items, 0, $shown_limit);
$show_more = TRUE;
}
$facet_output .= theme_item_list($list_items, $list_title, $list_type, $list_attributes);
// set counter
if ($show_more == TRUE) {
$i++;
$facet_output .= '<a href="#" class="shown-toggle">' . t('Show more') . '</a>';
$facet_output .= '<a href="#" class="shown-toggle hidden">' . t('Show less') . '</a>';
$facet_output .= '<div class="toggle-wrapper hidden">';
$facet_output .= theme_item_list($list_items_hidden, NULL, $list_type, $list_attributes);
$facet_output .= '</div>';
}
$facet_output .='</div>';
}
}
}
if ($i >= 1) {
// if there is at least one occurence of a split array, we add js to the page.
drupal_add_js(drupal_get_path('module', 'islandora_solr_search') . '/js/islandora_solr_search_shown_limit.js');
}
//////////////////////////////////////////////////////////////////////////////////////
// as we add additional facets, we're repeatedly URL-encoding old facet //
// strings. when we double-encode quotation marks they're incomprehensible to solr. //
// This is a quick workaround: //
//////////////////////////////////////////////////////////////////////////////////////
$facet_output = str_replace('%2B', '%252B', $facet_output);
if(!empty($facet_output)) {
$output .='<div class="islandora_solr_search_facet_wrap">';
$output .= $facet_output;
$output .= '</div>';
}
return $output;
}
/**
* Build solr search form
* @param type $repeat
* @param type $pathToSearchTerms
* @param type $query
* @return string
*/
function build_solr_search_form($repeat = NULL, $pathToSearchTerms = NULL, $query = NULL) {
$types = array();
$terms = trim(variable_get('islandora_solr_searchterms', 'dc.title ~ Title,dc.subject ~ Subject'));
$termsArray = preg_split('/[\n]/', $terms);
foreach ($termsArray as $term) {
$vals = split('~', $term);
if (!$vals[1]) {
$vals[1] = $vals[0];
}
$types[trim($vals[0])] = trim($vals[1]);
}
$queryArray = NULL;
if (isset($query)) {
$queryArray = preg_split('/( OR | AND )/', $query, 0, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
foreach ($queryArray as $key => $val) {
if ($val === ' OR ' || $val === ' AND ') {
$andOrs[] = trim($val); // that is, just 'OR' or 'AND'
unset($queryArray[$key]); //remove that from the array
}
}
$queryArray = array_values($queryArray);
}
$andOrArray = array(
'AND' => 'and',
'OR' => 'or',
);
$form = array();
if (!isset($repeat)) {
$repeat = variable_get('islandora_solr_search_block_repeat', '3');
}
$var0 = explode(':', $queryArray[0]);
$form['search_type']['type1'] = array(
'#title' => '',
'#type' => 'select',
'#options' => $types,
'#default_value' => trim($var0[0])
);
$form['fedora_terms1'] = array(
'#size' => '24',
'#type' => 'textfield',
'#title' => '',
'#default_value' => (count($var0) >= 2 ? restoreSlashes(trim($var0[1], '()')) : ''),
);
if ($repeat > 1 && $repeat < 9) { //don't want less then 2 or more then 9
for ($i = 2; $i < $repeat + 1; $i++) {
$t = $i - 1;
$j = $i - 2;
$andorj = ( isset($andOrs[$j]) ? $andOrs[$j] : 'AND' );
$field_and_term = isset($queryArray[$t]) ? explode(':', $queryArray[$t]) : array('', '');
$form["andor$t"] = array(
'#title' => '',
'#type' => 'select',
'#default_value' => $andorj,
'#options' => $andOrArray
);
$form['search_type']["type$i"] = array(
'#title' => '',
'#type' => 'select',
'#options' => $types,
'#default_value' => trim($field_and_term[0])
);
$form["fedora_terms$i"] = array(
'#size' => '24',
'#type' => 'textfield',
'#title' => '',
'#default_value' => (count($field_and_term) >= 2 ? trim($field_and_term[1], '()') : ''),
);
}
}
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('search')
);
return $form;
}
/**
* Build simple solr form
* @global type $islandora_query
* @return type
*/
function build_simple_solr_form() {
$required = FALSE;
if (variable_get('islandora_solr_search_block_request_handler', '') == 'standard') {
$required = TRUE;
}
global $islandora_query;
if (!strpos($islandora_query, ':')) {
$default = $islandora_query;
}
// TODO: Fix the above. The global is no longer valid, and the test is not conclusive. Should instead test for deftype=dismax.
$form["islandora_simple_search_query"] = array(
'#size' => '24%',
'#type' => 'textfield',
'#title' => '',
'#default_value' => $default,
'#required' => $required,
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('search')
);
return $form;
}
/**
* Theme solr search form
* @param type $form
* @return type
*/
function theme_solr_search_form($form) {
if (!isset($repeat)) {
$repeat = variable_get('islandora_solr_search_block_repeat', '3');
}
$output = drupal_render($form['search_type']['type1']);
$output .= drupal_render($form['fedora_terms1']);
$output .= drupal_render($form['andor1']) . drupal_render($form['search_type']['type2']);
$output .= drupal_render($form['fedora_terms2']);
if ($repeat > 2 && $repeat < 9) {
for ($i = 3; $i < $repeat + 1; $i++) {
$t = $i - 1;
$output .= drupal_render($form["andor$t"]) . drupal_render($form['search_type']["type$i"]);
$output .= drupal_render($form["fedora_terms$i"]);
}
}
$output .= drupal_render($form['submit']);
$output .= drupal_render($form);
return $output;
}
}