-
Notifications
You must be signed in to change notification settings - Fork 444
/
SubmissionSearch.inc.php
379 lines (339 loc) · 12.5 KB
/
SubmissionSearch.inc.php
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
<?php
/**
* @file classes/search/SubmissionSearch.inc.php
*
* Copyright (c) 2014-2018 Simon Fraser University
* Copyright (c) 2003-2018 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class SubmissionSearch
* @ingroup search
* @see SubmissionSearchDAO
*
* @brief Class for retrieving search results.
*
* FIXME: NEAR; precedence w/o parens?; stemming; weighted counting
*/
// Search types
define('SUBMISSION_SEARCH_AUTHOR', 0x00000001);
define('SUBMISSION_SEARCH_TITLE', 0x00000002);
define('SUBMISSION_SEARCH_ABSTRACT', 0x00000004);
define('SUBMISSION_SEARCH_DISCIPLINE', 0x00000008);
define('SUBMISSION_SEARCH_SUBJECT', 0x00000010);
define('SUBMISSION_SEARCH_TYPE', 0x00000020);
define('SUBMISSION_SEARCH_COVERAGE', 0x00000040);
define('SUBMISSION_SEARCH_GALLEY_FILE', 0x00000080);
define('SUBMISSION_SEARCH_SUPPLEMENTARY_FILE', 0x00000100);
define('SUBMISSION_SEARCH_INDEX_TERMS', 0x00000078);
define('SUBMISSION_SEARCH_DEFAULT_RESULT_LIMIT', 20);
import('lib.pkp.classes.search.SubmissionSearchIndex');
abstract class SubmissionSearch {
/**
* Constructor
*/
function __construct() {
}
/**
* Parses a search query string.
* Supports +/-, AND/OR, parens
* @param $query
* @return array of the form ('+' => <required>, '' => <optional>, '-' => excluded)
*/
function _parseQuery($query) {
$count = preg_match_all('/(\+|\-|)("[^"]+"|\(|\)|[^\s\)]+)/', $query, $matches);
$pos = 0;
return $this->_parseQueryInternal($matches[1], $matches[2], $pos, $count);
}
/**
* Query parsing helper routine.
* Returned structure is based on that used by the Search::QueryParser Perl module.
*/
function _parseQueryInternal($signTokens, $tokens, &$pos, $total) {
$return = array('+' => array(), '' => array(), '-' => array());
$postBool = $preBool = '';
$submissionSearchIndex = new SubmissionSearchIndex();
$notOperator = PKPString::strtolower(__('search.operator.not'));
$andOperator = PKPString::strtolower(__('search.operator.and'));
$orOperator = PKPString::strtolower(__('search.operator.or'));
while ($pos < $total) {
if (!empty($signTokens[$pos])) $sign = $signTokens[$pos];
else if (empty($sign)) $sign = '+';
$token = PKPString::strtolower($tokens[$pos++]);
switch ($token) {
case $notOperator:
$sign = '-';
break;
case ')':
return $return;
case '(':
$token = $this->_parseQueryInternal($signTokens, $tokens, $pos, $total);
default:
$postBool = '';
if ($pos < $total) {
$peek = PKPString::strtolower($tokens[$pos]);
if ($peek == $orOperator) {
$postBool = 'or';
$pos++;
} else if ($peek == $andOperator) {
$postBool = 'and';
$pos++;
}
}
$bool = empty($postBool) ? $preBool : $postBool;
$preBool = $postBool;
if ($bool == 'or') $sign = '';
if (is_array($token)) {
$k = $token;
} else {
$k = $submissionSearchIndex->filterKeywords($token, true);
}
if (!empty($k)) $return[$sign][] = $k;
$sign = '';
break;
}
}
return $return;
}
/**
* Takes an unordered list of search result data, flattens it, orders it
* and excludes unwanted results.
* @param $unorderedResults array An unordered list of search data (article ID
* as key and ranking data as values).
* @param $orderBy string One of the values returned by ArticleSearch::getResultSetOrderingOptions();
* @param $orderDir string 'asc' or 'desc', see ArticleSearch::getResultSetOrderingDirectionOptions();
* @param $exclude array A list of article IDs to exclude from the result.
* @return array An ordered and flattened list of article IDs.
*/
function _getMergedArray($context, &$keywords, $publishedFrom, $publishedTo) {
$resultsPerKeyword = Config::getVar('search', 'results_per_keyword');
$resultCacheHours = Config::getVar('search', 'result_cache_hours');
if (!is_numeric($resultsPerKeyword)) $resultsPerKeyword = 100;
if (!is_numeric($resultCacheHours)) $resultCacheHours = 24;
$mergedKeywords = array('+' => array(), '' => array(), '-' => array());
foreach ($keywords as $type => $keyword) {
if (!empty($keyword['+']))
$mergedKeywords['+'][] = array('type' => $type, '+' => $keyword['+'], '' => array(), '-' => array());
if (!empty($keyword['']))
$mergedKeywords[''][] = array('type' => $type, '+' => array(), '' => $keyword[''], '-' => array());
if (!empty($keyword['-']))
$mergedKeywords['-'][] = array('type' => $type, '+' => array(), '' => $keyword['-'], '-' => array());
}
return $this->_getMergedKeywordResults($context, $mergedKeywords, null, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours);
}
/**
* Recursive helper for _getMergedArray.
*/
function _getMergedKeywordResults($context, &$keyword, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours) {
$mergedResults = null;
if (isset($keyword['type'])) {
$type = $keyword['type'];
}
foreach ($keyword['+'] as $phrase) {
$results = $this->_getMergedPhraseResults($context, $phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours);
if ($mergedResults === null) {
$mergedResults = $results;
} else {
foreach ($mergedResults as $submissionId => $data) {
if (isset($results[$submissionId])) {
$mergedResults[$submissionId]['count'] += $results[$submissionId]['count'];
} else {
unset($mergedResults[$submissionId]);
}
}
}
}
if ($mergedResults == null) {
$mergedResults = array();
}
if (!empty($mergedResults) || empty($keyword['+'])) {
foreach ($keyword[''] as $phrase) {
$results = $this->_getMergedPhraseResults($context, $phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours);
foreach ($results as $submissionId => $data) {
if (isset($mergedResults[$submissionId])) {
$mergedResults[$submissionId]['count'] += $data['count'];
} else if (empty($keyword['+'])) {
$mergedResults[$submissionId] = $data;
}
}
}
foreach ($keyword['-'] as $phrase) {
$results = $this->_getMergedPhraseResults($context, $phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours);
foreach ($results as $submissionId => $count) {
if (isset($mergedResults[$submissionId])) {
unset($mergedResults[$submissionId]);
}
}
}
}
return $mergedResults;
}
/**
* Recursive helper for _getMergedArray.
*/
function _getMergedPhraseResults($context, &$phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours) {
if (isset($phrase['+'])) {
return $this->_getMergedKeywordResults($context, $phrase, $type, $publishedFrom, $publishedTo, $resultsPerKeyword, $resultCacheHours);
}
$mergedResults = array();
$searchDao = $this->getSearchDao();
return $searchDao->getPhraseResults(
$context,
$phrase,
$publishedFrom,
$publishedTo,
$type,
$resultsPerKeyword,
$resultCacheHours
);
}
/**
* Return an array of search results matching the supplied
* keyword IDs in decreasing order of match quality.
* Keywords are supplied in an array of the following format:
* $keywords[SUBMISSION_SEARCH_AUTHOR] = array('John', 'Doe');
* $keywords[SUBMISSION_SEARCH_...] = array(...);
* $keywords[null] = array('Matches', 'All', 'Fields');
* @param $request Request
* @param $context object The context to search
* @param $keywords array List of keywords
* @param $error string a reference to a variable that will
* contain an error message if the search service produces
* an error.
* @param $publishedFrom object Search-from date
* @param $publishedTo object Search-to date
* @param $rangeInfo Information on the range of results to return
* @param $exclude array An array of article IDs to exclude from the result.
* @return VirtualArrayIterator An iterator with one entry per retrieved
* article containing the article, published article, issue, context, etc.
*/
function retrieveResults($request, $context, $keywords, &$error, $publishedFrom = null, $publishedTo = null, $rangeInfo = null, $exclude = array()) {
// Pagination
if ($rangeInfo && $rangeInfo->isValid()) {
$page = $rangeInfo->getPage();
$itemsPerPage = $rangeInfo->getCount();
} else {
$page = 1;
$itemsPerPage = SUBMISSION_SEARCH_DEFAULT_RESULT_LIMIT;
}
// Result set ordering.
list($orderBy, $orderDir) = $this->getResultSetOrdering($request);
// Check whether a search plug-in jumps in to provide ranked search results.
$totalResults = null;
$hookResult = HookRegistry::call(
'SubmissionSearch::retrieveResults',
array(&$context, &$keywords, $publishedFrom, $publishedTo, $orderBy, $orderDir, $exclude, $page, $itemsPerPage, &$totalResults, &$error, &$results)
);
// If no search plug-in is activated then fall back to the
// default database search implementation.
if ($hookResult === false) {
// Parse the query.
foreach($keywords as $searchType => $query) {
$keywords[$searchType] = $this->_parseQuery($query);
}
// Fetch all the results from all the keywords into one array
// (mergedResults), where mergedResults[submission_id]
// = sum of all the occurences for all keywords associated with
// that article ID.
$mergedResults = $this->_getMergedArray($context, $keywords, $publishedFrom, $publishedTo);
// Convert mergedResults into an array (frequencyIndicator =>
// $submissionId).
// The frequencyIndicator is a synthetically-generated number,
// where higher is better, indicating the quality of the match.
// It is generated here in such a manner that matches with
// identical frequency do not collide.
$results = $this->getSparseArray($mergedResults, $orderBy, $orderDir, $exclude);
$totalResults = count($results);
// Use only the results for the specified page.
$offset = $itemsPerPage * ($page-1);
$length = max($totalResults - $offset, 0);
$length = min($itemsPerPage, $length);
if ($length == 0) {
$results = array();
} else {
$results = array_slice(
$results,
$offset,
$length
);
}
}
// Take the range of results and retrieve the Article, Journal,
// and associated objects.
$results = $this->formatResults($results, $request->getUser());
// Return the appropriate iterator.
import('lib.pkp.classes.core.VirtualArrayIterator');
return new VirtualArrayIterator($results, $totalResults, $page, $itemsPerPage);
}
/**
* Return the available options for the result
* set ordering direction.
* @return array
*/
function getResultSetOrderingDirectionOptions() {
return array(
'asc' => __('search.results.orderDir.asc'),
'desc' => __('search.results.orderDir.desc')
);
}
/**
* Return the currently selected result
* set ordering option (default: descending relevance).
* @param $request Request
* @return array An array with the order field as the
* first entry and the order direction as the second
* entry.
*/
function getResultSetOrdering($request) {
// Order field.
$orderBy = $request->getUserVar('orderBy');
$orderByOptions = $this->getResultSetOrderingOptions($request);
if (is_null($orderBy) || !in_array($orderBy, array_keys($orderByOptions))) {
$orderBy = 'score';
}
// Ordering direction.
$orderDir = $request->getUserVar('orderDir');
$orderDirOptions = $this->getResultSetOrderingDirectionOptions();
if (is_null($orderDir) || !in_array($orderDir, array_keys($orderDirOptions))) {
$orderDir = $this->getDefaultOrderDir($orderBy);
}
return array($orderBy, $orderDir);
}
//
// Methods to be implemented by subclasses.
//
/**
* See implementation of retrieveResults for a description of this
* function.
*
* Note that this function is also called externally to fetch
* results for the title index, and possibly elsewhere.
*
* @param $results array
* @param $user User optional (if availability information is desired)
* @return array
*/
abstract function formatResults($results, $user = null);
/**
* Return the available options for result set ordering.
* @param $request Request
* @return array
*/
abstract function getResultSetOrderingOptions($request);
/**
* See implementation of retrieveResults for a description of this
* function.
*/
abstract protected function getSparseArray($unorderedResults, $orderBy, $orderDir, $exclude);
/**
* Return the default order direction.
* @param $orderBy string
* @return string
*/
abstract protected function getDefaultOrderDir($orderBy);
/**
* Return the search DAO
* @return DAO
*/
abstract protected function getSearchDao();
}
?>