function getSpellingSearches($searchTerm)
{
//First check for things we don't want to load spelling suggestions for
if (is_numeric($searchTerm)) {
return array();
}
if (strpos($searchTerm, '(') !== FALSE || strpos($searchTerm, ')') !== FALSE) {
return array();
}
if (preg_match('/http:|mailto:|https:/i', $searchTerm)) {
return array();
}
if (strlen($searchTerm) >= 256) {
return array();
}
$spellingWord = new SpellingWord();
$words = explode(" ", $searchTerm);
$suggestions = array();
foreach ($words as $word) {
//First check to see if the word is spelled properly
$wordCheck = new SpellingWord();
$wordCheck->word = $word;
if (!$wordCheck->find()) {
//This word is not spelled properly, get suggestions for how it should be spelled
$suggestionsSoFar = $suggestions;
$wordSuggestions = $spellingWord->getSpellingSuggestions($word);
foreach ($wordSuggestions as $suggestedWord) {
$newSearch = str_replace($word, $suggestedWord, $searchTerm);
$searchInfo = new SearchStatNew();
$searchInfo->phrase = $newSearch;
$numSearches = 0;
if ($searchInfo->find(true)) {
$numSearches = $searchInfo->numSearches;
}
$suggestions[str_pad($numSearches, 10, '0', STR_PAD_LEFT) . $newSearch] = array('phrase' => $newSearch, 'numSearches' => $numSearches, 'numResults' => 1);
//Also try replacements on any suggestions we have so far
foreach ($suggestionsSoFar as $tmpSearch) {
$newSearch = str_replace($word, $suggestedWord, $tmpSearch['phrase']);
$searchInfo = new SearchStatNew();
$searchInfo->phrase = $newSearch;
$numSearches = 0;
if ($searchInfo->find(true)) {
$numSearches = $searchInfo->numSearches;
}
$suggestions[str_pad($numSearches, 10, '0', STR_PAD_LEFT) . $newSearch] = array('phrase' => $newSearch, 'numSearches' => $numSearches, 'numResults' => 1);
}
}
}
}
krsort($suggestions);
//Return up to 10 results max
if (count($suggestions) > 10) {
$suggestions = array_slice($suggestions, 0, 10);
}
return $suggestions;
}
/**
* Retrieve the top 20 search terms by popularity from the search_stats table
* Enter description here ...
*/
function getTopSearches()
{
require_once ROOT_DIR . '/Drivers/marmot_inc/SearchStatNew.php';
$numSearchesToReturn = isset($_REQUEST['numResults']) ? $_REQUEST['numResults'] : 20;
$searchStats = new SearchStatNew();
$searchStats->query("SELECT phrase, numSearches as numTotalSearches FROM `search_stats_new` where phrase != '' order by numTotalSearches DESC LIMIT " . $numSearchesToReturn);
$searches = array();
while ($searchStats->fetch()) {
$searches[] = $searchStats->phrase;
}
return $searches;
}
function launch()
{
global $interface;
global $configArray;
global $timer;
global $analytics;
global $library;
/** @var string|LibrarySearchSource|LocationSearchSource $searchSource */
$searchSource = isset($_REQUEST['searchSource']) ? $_REQUEST['searchSource'] : 'local';
if (preg_match('/library\\d+/', $searchSource)) {
$trimmedId = str_replace('library', '', $searchSource);
$searchSourceObj = new LibrarySearchSource();
$searchSourceObj->id = $trimmedId;
if ($searchSourceObj->find(true)) {
$searchSource = $searchSourceObj;
}
}
if (isset($_REQUEST['replacementTerm'])) {
$replacementTerm = $_REQUEST['replacementTerm'];
$interface->assign('replacementTerm', $replacementTerm);
$oldTerm = $_REQUEST['lookfor'];
$interface->assign('oldTerm', $oldTerm);
$_REQUEST['lookfor'] = $replacementTerm;
$_GET['lookfor'] = $replacementTerm;
$oldSearchUrl = $_SERVER['REQUEST_URI'];
$oldSearchUrl = str_replace('replacementTerm=' . urlencode($replacementTerm), 'disallowReplacements', $oldSearchUrl);
$interface->assign('oldSearchUrl', $oldSearchUrl);
}
$interface->assign('showDplaLink', false);
if ($configArray['DPLA']['enabled']) {
if ($library->includeDplaResults) {
$interface->assign('showDplaLink', true);
}
}
// Include Search Engine Class
require_once ROOT_DIR . '/sys/Solr.php';
$timer->logTime('Include search engine');
//Check to see if the year has been set and if so, convert to a filter and resend.
$dateFilters = array('publishDate');
foreach ($dateFilters as $dateFilter) {
if (isset($_REQUEST[$dateFilter . 'yearfrom']) && !empty($_REQUEST[$dateFilter . 'yearfrom']) || isset($_REQUEST[$dateFilter . 'yearto']) && !empty($_REQUEST[$dateFilter . 'yearto'])) {
$queryParams = $_GET;
$yearFrom = preg_match('/^\\d{2,4}$/', $_REQUEST[$dateFilter . 'yearfrom']) ? $_REQUEST[$dateFilter . 'yearfrom'] : '*';
$yearTo = preg_match('/^\\d{2,4}$/', $_REQUEST[$dateFilter . 'yearto']) ? $_REQUEST[$dateFilter . 'yearto'] : '*';
if (strlen($yearFrom) == 2) {
$yearFrom = '19' . $yearFrom;
} else {
if (strlen($yearFrom) == 3) {
$yearFrom = '0' . $yearFrom;
}
}
if (strlen($yearTo) == 2) {
$yearTo = '19' . $yearTo;
} else {
if (strlen($yearFrom) == 3) {
$yearTo = '0' . $yearTo;
}
}
if ($yearTo != '*' && $yearFrom != '*' && $yearTo < $yearFrom) {
$tmpYear = $yearTo;
$yearTo = $yearFrom;
$yearFrom = $tmpYear;
}
unset($queryParams['module']);
unset($queryParams['action']);
unset($queryParams[$dateFilter . 'yearfrom']);
unset($queryParams[$dateFilter . 'yearto']);
if (!isset($queryParams['sort'])) {
$queryParams['sort'] = 'year';
}
$queryParamStrings = array();
foreach ($queryParams as $paramName => $queryValue) {
if (is_array($queryValue)) {
foreach ($queryValue as $arrayValue) {
if (strlen($arrayValue) > 0) {
$queryParamStrings[] = $paramName . '[]=' . $arrayValue;
}
}
} else {
if (strlen($queryValue)) {
$queryParamStrings[] = $paramName . '=' . $queryValue;
}
}
}
if ($yearFrom != '*' || $yearTo != '*') {
$queryParamStrings[] = "&filter[]={$dateFilter}:[{$yearFrom}+TO+{$yearTo}]";
}
$queryParamString = join('&', $queryParamStrings);
header("Location: {$configArray['Site']['path']}/Search/Results?{$queryParamString}");
exit;
}
}
$rangeFilters = array('lexile_score', 'accelerated_reader_reading_level', 'accelerated_reader_point_value');
foreach ($rangeFilters as $filter) {
if (isset($_REQUEST[$filter . 'from']) && strlen($_REQUEST[$filter . 'from']) > 0 || isset($_REQUEST[$filter . 'to']) && strlen($_REQUEST[$filter . 'to']) > 0) {
$queryParams = $_GET;
$from = isset($_REQUEST[$filter . 'from']) && preg_match('/^\\d*(\\.\\d*)?$/', $_REQUEST[$filter . 'from']) ? $_REQUEST[$filter . 'from'] : '*';
$to = isset($_REQUEST[$filter . 'to']) && preg_match('/^\\d*(\\.\\d*)?$/', $_REQUEST[$filter . 'to']) ? $_REQUEST[$filter . 'to'] : '*';
if ($to != '*' && $from != '*' && $to < $from) {
$tmpFilter = $to;
$to = $from;
$from = $tmpFilter;
}
unset($queryParams['module']);
unset($queryParams['action']);
unset($queryParams[$filter . 'from']);
unset($queryParams[$filter . 'to']);
$queryParamStrings = array();
foreach ($queryParams as $paramName => $queryValue) {
if (is_array($queryValue)) {
foreach ($queryValue as $arrayValue) {
if (strlen($arrayValue) > 0) {
$queryParamStrings[] = $paramName . '[]=' . $arrayValue;
}
}
} else {
if (strlen($queryValue)) {
$queryParamStrings[] = $paramName . '=' . $queryValue;
}
}
}
if ($from != '*' || $to != '*') {
$queryParamStrings[] = "&filter[]={$filter}:[{$from}+TO+{$to}]";
}
$queryParamString = join('&', $queryParamStrings);
header("Location: {$configArray['Site']['path']}/Search/Results?{$queryParamString}");
exit;
}
}
// Initialise from the current search globals
/** @var SearchObject_Solr $searchObject */
$searchObject = SearchObjectFactory::initSearchObject();
// $searchObject->viewOptions = $this->viewOptions; // set valid view options for the search object
$searchObject->init($searchSource);
$timer->logTime("Init Search Object");
// Build RSS Feed for Results (if requested)
if ($searchObject->getView() == 'rss') {
// Throw the XML to screen
echo $searchObject->buildRSS();
// And we're done
exit;
} else {
if ($searchObject->getView() == 'excel') {
// Throw the Excel spreadsheet to screen for download
echo $searchObject->buildExcel();
// And we're done
exit;
}
}
$displayMode = $searchObject->getView();
if ($displayMode == 'covers') {
$searchObject->setLimit(24);
// a set of 24 covers looks better in display
}
// Set Interface Variables
// Those we can construct BEFORE the search is executed
$displayQuery = $searchObject->displayQuery();
$pageTitle = $displayQuery;
if (strlen($pageTitle) > 20) {
$pageTitle = substr($pageTitle, 0, 20) . '...';
}
$pageTitle .= ' | Search Results';
$interface->setPageTitle($pageTitle);
$interface->assign('sortList', $searchObject->getSortList());
$interface->assign('rssLink', $searchObject->getRSSUrl());
$interface->assign('excelLink', $searchObject->getExcelUrl());
$timer->logTime('Setup Search');
// Process Search
$result = $searchObject->processSearch(true, true);
if (PEAR_Singleton::isError($result)) {
PEAR_Singleton::raiseError($result->getMessage());
}
$timer->logTime('Process Search');
// Some more variables
// Those we can construct AFTER the search is executed, but we need
// no matter whether there were any results
$interface->assign('qtime', round($searchObject->getQuerySpeed(), 2));
$interface->assign('spellingSuggestions', $searchObject->getSpellingSuggestions());
$interface->assign('lookfor', $displayQuery);
$interface->assign('searchType', $searchObject->getSearchType());
// Will assign null for an advanced search
$interface->assign('searchIndex', $searchObject->getSearchIndex());
// We'll need recommendations no matter how many results we found:
$interface->assign('topRecommendations', $searchObject->getRecommendationsTemplates('top'));
$interface->assign('sideRecommendations', $searchObject->getRecommendationsTemplates('side'));
// 'Finish' the search... complete timers and log search history.
$searchObject->close();
$interface->assign('time', round($searchObject->getTotalSpeed(), 2));
// Show the save/unsave code on screen
// The ID won't exist until after the search has been put in the search history
// so this needs to occur after the close() on the searchObject
$interface->assign('showSaved', true);
$interface->assign('savedSearch', $searchObject->isSavedSearch());
$interface->assign('searchId', $searchObject->getSearchId());
$currentPage = isset($_REQUEST['page']) ? $_REQUEST['page'] : 1;
$interface->assign('page', $currentPage);
//Enable and disable functionality based on library settings
//This must be done before we process each result
$interface->assign('showNotInterested', false);
$interface->assign('page_body_style', 'sidebar_left');
$interface->assign('overDriveVersion', isset($configArray['OverDrive']['interfaceVersion']) ? $configArray['OverDrive']['interfaceVersion'] : 1);
//Check to see if we should show unscoped results
global $solrScope;
$enableUnscopedSearch = false;
// fallback setting
if ($solrScope) {
$searchLibrary = Library::getSearchLibrary();
if ($searchLibrary != null && $searchLibrary->showMarmotResultsAtEndOfSearch) {
if (is_object($searchSource)) {
$enableUnscopedSearch = $searchSource->catalogScoping != 'unscoped';
$unscopedSearch = clone $searchObject;
} else {
$searchSources = new SearchSources();
$searchOptions = $searchSources->getSearchSources();
if (isset($searchOptions['marmot'])) {
//TODO: change name of search option to 'consortium'
$unscopedSearch = clone $searchObject;
$enableUnscopedSearch = true;
}
}
}
}
$showRatings = 1;
$enableProspectorIntegration = isset($configArray['Content']['Prospector']) ? $configArray['Content']['Prospector'] : false;
if (isset($library)) {
$enableProspectorIntegration = $library->enablePospectorIntegration == 1;
$showRatings = $library->showRatings;
}
if ($enableProspectorIntegration) {
$interface->assign('showProspectorLink', true);
$interface->assign('prospectorSavedSearchId', $searchObject->getSearchId());
} else {
$interface->assign('showProspectorLink', false);
}
$interface->assign('showRatings', $showRatings);
$numUnscopedTitlesToLoad = 0;
// Save the ID of this search to the session so we can return to it easily:
$_SESSION['lastSearchId'] = $searchObject->getSearchId();
// Save the URL of this search to the session so we can return to it easily:
$_SESSION['lastSearchURL'] = $searchObject->renderSearchUrl();
if (is_object($searchSource)) {
$translatedSearch = $searchSource->label;
} else {
$allSearchSources = SearchSources::getSearchSources();
if (!isset($allSearchSources[$searchSource]) && $searchSource == 'marmot') {
$searchSource = 'local';
}
$translatedSearch = $allSearchSources[$searchSource]['name'];
}
// Save the search for statistics
$analytics->addSearch($translatedSearch, $searchObject->displayQuery(), $searchObject->isAdvanced(), $searchObject->getFullSearchType(), $searchObject->hasAppliedFacets(), $searchObject->getResultTotal());
// No Results Actions //
if ($searchObject->getResultTotal() < 1) {
//We didn't find anything. Look for search Suggestions
//Don't try to find suggestions if facets were applied
$autoSwitchSearch = false;
$disallowReplacements = isset($_REQUEST['disallowReplacements']) || isset($_REQUEST['replacementTerm']);
if (!$disallowReplacements && (!isset($facetSet) || count($facetSet) == 0)) {
require_once ROOT_DIR . '/services/Search/lib/SearchSuggestions.php';
$searchSuggestions = new SearchSuggestions();
$commonSearches = $searchSuggestions->getAllSuggestions($searchObject->displayQuery(), $searchObject->getSearchIndex());
//assign here before we start popping stuff off
$interface->assign('searchSuggestions', $commonSearches);
//If the first search in the list is used 10 times more than the next, just show results for that
$numSuggestions = count($commonSearches);
if ($numSuggestions == 1) {
$firstSearch = array_pop($commonSearches);
$autoSwitchSearch = true;
} elseif ($numSuggestions >= 2) {
$firstSearch = array_shift($commonSearches);
$secondSearch = array_shift($commonSearches);
$firstTimesSearched = $firstSearch['numSearches'];
$secondTimesSearched = $secondSearch['numSearches'];
if ($secondTimesSearched > 0 && $firstTimesSearched / $secondTimesSearched > 10) {
// avoids division by zero
$autoSwitchSearch = true;
}
}
// Switch to search with a better search term //
// $interface->assign('autoSwitchSearch', $autoSwitchSearch);
if ($autoSwitchSearch) {
//Get search results for the new search
// $interface->assign('oldTerm', $searchObject->displayQuery());
// $interface->assign('newTerm', $commonSearches[0]['phrase']);
// The above assignments probably do nothing when there is a redirect below
$thisUrl = $_SERVER['REQUEST_URI'] . "&replacementTerm=" . urlencode($firstSearch['phrase']);
header("Location: " . $thisUrl);
exit;
}
}
// No record found
$interface->assign('recordCount', 0);
// Was the empty result set due to an error?
$error = $searchObject->getIndexError();
if ($error !== false) {
// If it's a parse error or the user specified an invalid field, we
// should display an appropriate message:
if (stristr($error['msg'], 'org.apache.lucene.queryParser.ParseException') || preg_match('/^undefined field/', $error['msg'])) {
$interface->assign('parseError', $error['msg']);
if (preg_match('/^undefined field/', $error['msg'])) {
// Setup to try as a possible subtitle search
$fieldName = trim(str_replace('undefined field', '', $error['msg'], $replaced));
// strip out the phrase 'undefined field' to get just the fieldname
$original = urlencode("{$fieldName}:");
if ($replaced === 1 && !empty($fieldName) && strpos($_SERVER['REQUEST_URI'], $original)) {
// ensure only 1 replacement was done, that the fieldname isn't an empty string, and the label is in fact in the Search URL
$new = urlencode("{$fieldName} :");
// include space in between the field name & colon to avoid the parse error
$thisUrl = str_replace($original, $new, $_SERVER['REQUEST_URI'], $replaced);
if ($replaced === 1) {
// ensure only one modification was made
header("Location: " . $thisUrl);
exit;
}
}
}
// Unexpected error -- let's treat this as a fatal condition.
} else {
PEAR_Singleton::raiseError(new PEAR_Error('Unable to process query<br />' . 'Solr Returned: ' . $error));
}
}
// Set up to try an Unscoped Search //
$numUnscopedTitlesToLoad = 10;
$timer->logTime('no hits processing');
} elseif ($searchObject->getResultTotal() == 1 && (strpos($searchObject->displayQuery(), 'id') === 0 || $searchObject->getSearchType() == 'id')) {
//Redirect to the home page for the record
$recordSet = $searchObject->getResultRecordSet();
$record = reset($recordSet);
$_SESSION['searchId'] = $searchObject->getSearchId();
if ($record['recordtype'] == 'list') {
$listId = substr($record['id'], 4);
header("Location: " . $configArray['Site']['path'] . "/MyResearch/MyList/{$listId}");
exit;
} elseif ($record['recordtype'] == 'econtentRecord') {
$shortId = str_replace('econtentRecord', '', $record['id']);
header("Location: " . $configArray['Site']['path'] . "/EcontentRecord/{$shortId}/Home");
exit;
} else {
header("Location: " . $configArray['Site']['path'] . "/Record/{$record['id']}/Home");
exit;
}
} else {
$timer->logTime('save search');
// Assign interface variables
$summary = $searchObject->getResultSummary();
$interface->assign('recordCount', $summary['resultTotal']);
$interface->assign('recordStart', $summary['startRecord']);
$interface->assign('recordEnd', $summary['endRecord']);
$facetSet = $searchObject->getFacetList();
$interface->assign('facetSet', $facetSet);
//Check to see if a format category is already set
$categorySelected = false;
if (isset($facetSet['top'])) {
foreach ($facetSet['top'] as $cluster) {
if ($cluster['label'] == 'Category') {
foreach ($cluster['list'] as $thisFacet) {
if ($thisFacet['isApplied']) {
$categorySelected = true;
break;
}
}
}
if ($categorySelected) {
break;
}
}
}
$interface->assign('categorySelected', $categorySelected);
$timer->logTime('load selected category');
}
// What Mode will search results be Displayed In //
if ($displayMode == 'covers') {
$displayTemplate = 'Search/covers-list.tpl';
// structure for bookcover tiles
} else {
// default
$displayTemplate = 'Search/list-list.tpl';
// structure for regular results
$displayMode = 'list';
// In case the view is not explicitly set, do so now for display & clients-side functions
// Process Paging (only in list mode)
if ($searchObject->getResultTotal() > 1) {
$link = $searchObject->renderLinkPageTemplate();
$options = array('totalItems' => $summary['resultTotal'], 'fileName' => $link, 'perPage' => $summary['perPage']);
$pager = new VuFindPager($options);
$interface->assign('pageLinks', $pager->getLinks());
if ($pager->isLastPage()) {
$numUnscopedTitlesToLoad = 5;
}
}
}
$timer->logTime('finish hits processing');
$interface->assign('subpage', $displayTemplate);
$interface->assign('displayMode', $displayMode);
// For user toggle switches
// Suplementary Unscoped Search //
if ($enableUnscopedSearch && isset($unscopedSearch)) {
// Total & Link will be shown in result header even if none of these results will be shown on this page
$unscopedSearch->setLimit($numUnscopedTitlesToLoad * 4);
$unscopedSearch->disableScoping();
$unscopedSearch->processSearch(false, false);
$numUnscopedResults = $unscopedSearch->getResultTotal();
$interface->assign('numUnscopedResults', $numUnscopedResults);
$unscopedSearchUrl = $unscopedSearch->renderSearchUrl();
if (preg_match('/searchSource=(.*?)(?:&|$)/', $unscopedSearchUrl)) {
$unscopedSearchUrl = preg_replace('/(.*searchSource=)(.*?)(&|$)(.*)/', '$1marmot$3$4', $unscopedSearchUrl);
// $unscopedSearchUrl = preg_replace('/&/', '&', $unscopedSearchUrl);
$unscopedSearchUrl = str_replace('&', '&', $unscopedSearchUrl);
// faster than preg_replace for simple substitutions
} else {
$unscopedSearchUrl .= "&searchSource=marmot";
}
$unscopedSearchUrl .= "&shard=";
$interface->assign('unscopedSearchUrl', $unscopedSearchUrl);
if ($numUnscopedTitlesToLoad > 0) {
$unscopedResults = $unscopedSearch->getSupplementalResultRecordHTML($searchObject->getResultRecordSet(), $numUnscopedTitlesToLoad, $searchObject->getResultTotal());
$interface->assign('recordSet', $unscopedResults);
$unscopedResults = $interface->fetch($displayTemplate);
$interface->assign('unscopedResults', $unscopedResults);
}
}
// Big one - our results //
$recordSet = $searchObject->getResultRecordHTML($displayMode);
$interface->assign('recordSet', $recordSet);
$timer->logTime('load result records');
if ($configArray['Statistics']['enabled'] && isset($_GET['lookfor']) && !is_array($_GET['lookfor'])) {
require_once ROOT_DIR . '/Drivers/marmot_inc/SearchStatNew.php';
$searchStat = new SearchStatNew();
$searchStat->saveSearch(strip_tags($_GET['lookfor']), strip_tags(isset($_GET['type']) ? $_GET['type'] : (isset($_GET['basicType']) ? $_GET['basicType'] : 'Keyword')), $searchObject->getResultTotal());
}
// Done, display the page
$interface->setTemplate($searchObject->getResultTotal() ? 'list.tpl' : 'list-none.tpl');
// main search results content
$interface->assign('sidebar', 'Search/results-sidebar.tpl');
$interface->display('layout.tpl');
}
function saveSearch($phrase, $type = false, $numResults)
{
//Don't bother to count things that didn't return results.
if (!isset($numResults) || $numResults == 0) {
return;
}
//Only save basic searches
if (strpos($phrase, '(') !== FALSE || strpos($phrase, ')') !== FALSE) {
return;
}
//Don't save searches that are numeric (if someone has a number they won't need suggestions).
if (is_numeric($phrase)) {
return;
}
//Don't save searches that look like spam
if (preg_match('/http:|mailto:|https:/i', $phrase)) {
return;
}
//Don't save really long searches
if (strlen($phrase) >= 256) {
return;
}
$phrase = str_replace("\t", '', $phrase);
$searchStat = new SearchStatNew();
$searchStat->phrase = trim(strtolower($phrase));
$searchStat->find();
$isNew = true;
if ($searchStat->N > 0) {
$searchStat->fetch();
$searchStat->numSearches++;
$isNew = false;
} else {
$searchStat->numSearches = 1;
}
$searchStat->lastSearch = time();
if ($isNew) {
$searchStat->insert();
} else {
$searchStat->update();
}
}
