/** * @covers LucenePlugin * @covers SolrSearchRequest */ public function testCallbackRetrieveResults() { // Test data. $testCases = array(array(null => 'test AND query'), array(SUBMISSION_SEARCH_AUTHOR => 'author'), array(SUBMISSION_SEARCH_TITLE => 'title'), array(SUBMISSION_SEARCH_ABSTRACT => 'abstract'), array(SUBMISSION_SEARCH_INDEX_TERMS => 'Nicht index terms'), array(SUBMISSION_SEARCH_GALLEY_FILE => 'full OR text'), array(null => 'test query', SUBMISSION_SEARCH_AUTHOR => 'author', SUBMISSION_SEARCH_TITLE => 'title', SUBMISSION_SEARCH_DISCIPLINE => 'discipline', SUBMISSION_SEARCH_SUBJECT => 'subject', SUBMISSION_SEARCH_TYPE => 'type', SUBMISSION_SEARCH_COVERAGE => 'coverage', SUBMISSION_SEARCH_GALLEY_FILE => 'full text')); $expectedResults = array(array('authors|title|abstract|galleyFullText|discipline|subject|type|coverage' => 'test AND query'), array('authors' => 'author'), array('title' => 'title'), array('abstract' => 'abstract'), array('discipline|subject|type|coverage' => 'Nicht index terms'), array('galleyFullText' => 'full OR text'), array('authors|title|abstract|galleyFullText|discipline|subject|type|coverage' => 'test query', 'authors' => 'author', 'title' => 'title', 'discipline' => 'discipline', 'subject' => 'subject', 'type' => 'type', 'coverage' => 'coverage', 'galleyFullText' => 'full text')); $journal = new Journal(); $fromDate = '2000-01-01 00:00:00'; $hook = 'SubmissionSearch::retrieveResults'; $totalResults = null; $error = null; $facetCategories = array('discipline', 'subject', 'type', 'coverage', 'authors'); foreach ($testCases as $testNum => $testCase) { // Build the expected search request. $searchRequest = new SolrSearchRequest(); $searchRequest->setJournal($journal); $searchRequest->setFromDate($fromDate); $searchRequest->setQuery($expectedResults[$testNum]); $searchRequest->setSpellcheck(true); $searchRequest->setHighlighting(true); // Facets should only be requested for categories that have no // active filter. $expectedFacetCategories = array_values(array_diff($facetCategories, array_keys($expectedResults[$testNum]))); $searchRequest->setFacetCategories($expectedFacetCategories); // Mock a SolrWebService. $webService = $this->getMock('SolrWebService', array('retrieveResults'), array(), '', false); // Check whether the Lucene plug-in calls the web service // with the right parameters. $webService->expects($this->once())->method('retrieveResults')->with($this->equalTo($searchRequest), $this->equalTo($totalResults)); $this->lucenePlugin->_solrWebService = $webService; unset($webService, $searchRequest); // Execute the test. $params = array($journal, $testCase, $fromDate, null, 1, 25, &$totalResults, &$error); $this->lucenePlugin->callbackRetrieveResults($hook, $params); } // Test an error condition. $webService = $this->getMock('SolrWebService', array('retrieveResults', 'getServiceMessage'), array(), '', false); $webService->expects($this->once())->method('retrieveResults')->will($this->returnValue(null)); $webService->expects($this->any())->method('getServiceMessage')->will($this->returnValue('some error message')); $originalWebService = $this->lucenePlugin->_solrWebService; $this->lucenePlugin->_solrWebService = $webService; $params = array($journal, array(null => 'test'), null, null, 1, 25, &$totalResults, &$error); $this->assertEquals(array(), $this->lucenePlugin->callbackRetrieveResults($hook, $params)); $this->assertEquals('some error message ##plugins.generic.lucene.message.techAdminInformed##', $error); $this->lucenePlugin->_solrWebService = $originalWebService; }
/** * AJAX request for search query auto-completion. * @param $args array * @param $request Request * @return JSON string */ function queryAutocomplete($args, $request) { $this->validate(null, $request); // Check whether auto-suggest is enabled. $suggestionList = array(); $lucenePlugin = $this->_getLucenePlugin(); $enabled = (bool) $lucenePlugin->getSetting(0, 'autosuggest'); if ($enabled) { // Retrieve search criteria from the user input. $articleSearch = new ArticleSearch(); $searchFilters = $articleSearch->getSearchFilters($request); // Get the autosuggest input and remove it from // the filter array. $autosuggestField = $request->getUserVar('searchField'); $userInput = $searchFilters[$autosuggestField]; if (isset($searchFilters[$autosuggestField])) { unset($searchFilters[$autosuggestField]); } // Instantiate a search request. $searchRequest = new SolrSearchRequest(); $searchRequest->setJournal($searchFilters['searchJournal']); $searchRequest->setFromDate($searchFilters['fromDate']); $searchRequest->setToDate($searchFilters['toDate']); $keywords = $articleSearch->getKeywordsFromSearchFilters($searchFilters); $searchRequest->addQueryFromKeywords($keywords); // Get the web service. $solrWebService = $lucenePlugin->getSolrWebService(); /* @var $solrWebService SolrWebService */ $suggestions = $solrWebService->getAutosuggestions($searchRequest, $autosuggestField, $userInput, (int) $lucenePlugin->getSetting(0, 'autosuggestType')); // Prepare a suggestion list as understood by the // autocomplete JS handler. foreach ($suggestions as $suggestion) { $suggestionList[] = array('label' => $suggestion, 'value' => $suggestion); } } // Return the suggestions as JSON message. $json = new JSONMessage(true, $suggestionList); return $json->getString(); }
/** * @see ArticleSearch::retrieveResults() */ function callbackRetrieveResults($hookName, $params) { assert($hookName == 'ArticleSearch::retrieveResults'); // Unpack the parameters. list($journal, $keywords, $fromDate, $toDate, $page, $itemsPerPage, $dummy) = $params; $totalResults =& $params[6]; // need to use reference $error =& $params[7]; // need to use reference // Instantiate a search request. $searchRequest = new SolrSearchRequest(); $searchRequest->setJournal($journal); $searchRequest->setFromDate($fromDate); $searchRequest->setToDate($toDate); $searchRequest->setPage($page); $searchRequest->setItemsPerPage($itemsPerPage); $searchRequest->addQueryFromKeywords($keywords); // Get the ordering criteria. list($orderBy, $orderDir) = $this->_getResultSetOrdering($journal); $searchRequest->setOrderBy($orderBy); $searchRequest->setOrderDir($orderDir == 'asc' ? true : false); // Configure alternative spelling suggestions. $spellcheck = (bool) $this->getSetting(0, 'spellcheck'); $searchRequest->setSpellcheck($spellcheck); // Configure highlighting. $highlighting = (bool) $this->getSetting(0, 'highlighting'); $searchRequest->setHighlighting($highlighting); // Configure faceting. // 1) Faceting will be disabled for filtered search categories. $activeFilters = array_keys($searchRequest->getQuery()); if (is_a($journal, 'Journal')) { $activeFilters[] = 'journalTitle'; } if (!empty($fromDate) || !empty($toDate)) { $activeFilters[] = 'publicationDate'; } // 2) Switch faceting on for enabled categories that have no // active filters. $facetCategories = array_values(array_diff($this->_getEnabledFacetCategories(), $activeFilters)); $searchRequest->setFacetCategories($facetCategories); // Configure custom ranking. $customRanking = (bool) $this->getSetting(0, 'customRanking'); if ($customRanking) { $sectionDao =& DAORegistry::getDAO('SectionDAO'); /* @var $sectionDao SectionDAO */ if (is_a($journal, 'Journal')) { $sections = $sectionDao->getJournalSections($journal->getId()); } else { $sections = $sectionDao->getSections(); } while (!$sections->eof()) { /* @var $sections DAOResultFactory */ $section =& $sections->next(); $rankingBoost = $section->getData('rankingBoost'); if (isset($rankingBoost)) { $sectionBoost = (double) $rankingBoost; } else { $sectionBoost = LUCENE_PLUGIN_DEFAULT_RANKING_BOOST; } if ($sectionBoost != LUCENE_PLUGIN_DEFAULT_RANKING_BOOST) { $searchRequest->addBoostFactor('section_id', $section->getId(), $sectionBoost); } unset($section); } unset($sections); } // Call the solr web service. $solrWebService =& $this->getSolrWebService(); $result =& $solrWebService->retrieveResults($searchRequest, $totalResults); if (is_null($result)) { $error = $solrWebService->getServiceMessage(); $this->_informTechAdmin($error, $journal, true); $error .= ' ' . __('plugins.generic.lucene.message.techAdminInformed'); return array(); } else { // Store spelling suggestion, highlighting and faceting info // internally. We cannot route these back through the request // as the default search implementation does not support // these features. if ($spellcheck && isset($result['spellingSuggestion'])) { $this->_spellingSuggestion = $result['spellingSuggestion']; // Identify the field for which we got the suggestion. foreach ($keywords as $bitmap => $searchPhrase) { if (!empty($searchPhrase)) { switch ($bitmap) { case null: $queryField = 'query'; break; case ARTICLE_SEARCH_INDEX_TERMS: $queryField = 'indexTerms'; break; default: $indexFieldMap = ArticleSearch::getIndexFieldMap(); assert(isset($indexFieldMap[$bitmap])); $queryField = $indexFieldMap[$bitmap]; } } } $this->_spellingSuggestionField = $queryField; } if ($highlighting && isset($result['highlightedArticles'])) { $this->_highlightedArticles = $result['highlightedArticles']; } if (!empty($facetCategories) && isset($result['facets'])) { $this->_facets = $result['facets']; } // Return the scored results. if (isset($result['scoredResults']) && !empty($result['scoredResults'])) { return $result['scoredResults']; } else { return array(); } } }
/** * @covers SolrWebService::getAutosuggestions() */ public function testGetAutosuggestions() { // Fake a search request. $searchRequest = new SolrSearchRequest(); $journal = new Journal(); $journal->setId(2); $searchRequest->setJournal($journal); $searchRequest->setQuery(array('authors' => 'McAutomatic')); // Only the last word should be corrected. This also // checks whether suggestions come from different fields. self::assertEquals(array('chic (AND wings', 'chic (AND wide'), $this->solrWebService->getAutosuggestions($searchRequest, 'query', 'chic (AND wi', SOLR_AUTOSUGGEST_SUGGESTER)); // The faceting component will return no suggestions for // the same query as it wouldn't return any results. self::assertEquals(array(), $this->solrWebService->getAutosuggestions($searchRequest, 'query', 'chic (AND wi', SOLR_AUTOSUGGEST_FACETING)); // Even when we correct the first word, we'll not get // results due to the fact that there's no such article // with the author given in the search request. self::assertEquals(array(), $this->solrWebService->getAutosuggestions($searchRequest, 'query', 'chicken (AND wi', SOLR_AUTOSUGGEST_FACETING)); // We start to get a result from the faceting component // when we enter another author. But the result will only // include suggestions that actually return something. $searchRequest->setQuery(array('authors' => 'Peter Poultry')); self::assertEquals(array('chicken (AND wings'), $this->solrWebService->getAutosuggestions($searchRequest, 'query', 'chicken (AND wi', SOLR_AUTOSUGGEST_FACETING)); $searchRequest->setQuery(array()); foreach (array(SOLR_AUTOSUGGEST_FACETING, SOLR_AUTOSUGGEST_SUGGESTER) as $autosuggestType) { // When the last word cannot be improved then // return no results. self::assertEquals(array(), $this->solrWebService->getAutosuggestions($searchRequest, 'query', 'chicken AND dslgkhsi', $autosuggestType)); // Check whether results for index term suggestions // come from different sources (but not all sources). // The following search should not return 'lucene' for // example, which would come from a non-index field. self::assertEquals(array('lunch', 'lunchtime'), $this->solrWebService->getAutosuggestions($searchRequest, 'indexTerms', 'lu', $autosuggestType)); } // Check one of the "simple" search fields, e.g. authors. // This also shows that the suggester will propose terms // from other journals. The author "tester" does not appear // in the journal chosen for the search request above. self::assertEquals(array('tester'), $this->solrWebService->getAutosuggestions($searchRequest, 'authors', 'tes', SOLR_AUTOSUGGEST_SUGGESTER)); // In the case of the faceting component this should not return // any result as the author comes from a different journal. self::assertEquals(array(), $this->solrWebService->getAutosuggestions($searchRequest, 'authors', 'tes', SOLR_AUTOSUGGEST_FACETING)); // This changes when we look for author names that // exist in the journal. self::assertEquals(array('author', 'authorname'), $this->solrWebService->getAutosuggestions($searchRequest, 'authors', 'au', SOLR_AUTOSUGGEST_FACETING)); }