-
Notifications
You must be signed in to change notification settings - Fork 2k
/
query.py
515 lines (422 loc) · 18.6 KB
/
query.py
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
# encoding: utf-8
from __future__ import annotations
import re
import logging
from typing import Any, NoReturn, Optional, Union, cast, Dict
from pyparsing import (
Word, QuotedString, Suppress, OneOrMore, Group, alphanums
)
from pyparsing.exceptions import ParseException
import pysolr
from ckan.common import asbool
from werkzeug.datastructures import MultiDict
import ckan.logic as logic
import ckan.model as model
from ckan.common import config
from ckan.lib.search.common import (
make_connection, SearchError, SearchQueryError, SolrConnectionError
)
from ckan.types import Context
log = logging.getLogger(__name__)
_open_licenses: Optional[list[str]] = None
VALID_SOLR_PARAMETERS = set([
'q', 'fl', 'fq', 'rows', 'sort', 'start', 'wt', 'qf', 'bf', 'boost',
'facet', 'facet.mincount', 'facet.limit', 'facet.field',
'extras', 'fq_list', 'tie', 'defType', 'mm', 'df'
])
# for (solr) package searches, this specifies the fields that are searched
# and their relative weighting
QUERY_FIELDS = "name^4 title^4 tags^2 groups^2 text"
solr_regex = re.compile(r'([\\+\-&|!(){}\[\]^"~*?:])')
def escape_legacy_argument(val: str) -> str:
# escape special chars \+-&|!(){}[]^"~*?:
return solr_regex.sub(r'\\\1', val)
def convert_legacy_parameters_to_solr(
legacy_params: dict[str, Any]) -> dict[str, Any]:
'''API v1 and v2 allowed search params that the SOLR syntax does not
support, so use this function to convert those to SOLR syntax.
See tests for examples.
raises SearchQueryError on invalid params.
'''
options = QueryOptions(**legacy_params)
options.validate()
solr_params = legacy_params.copy()
solr_q_list: list[str] = []
if solr_params.get('q'):
solr_q_list.append(solr_params['q'].replace('+', ' '))
non_solr_params = set(legacy_params.keys()) - VALID_SOLR_PARAMETERS
for search_key in non_solr_params:
value_obj = legacy_params[search_key]
value = value_obj.replace('+', ' ') if isinstance(value_obj, str) else value_obj
if search_key == 'all_fields':
if value:
solr_params['fl'] = '*'
elif search_key == 'offset':
solr_params['start'] = value
elif search_key == 'limit':
solr_params['rows'] = value
elif search_key == 'order_by':
solr_params['sort'] = '%s asc' % value
elif search_key == 'tags':
if isinstance(value_obj, list):
tag_list = value_obj
elif isinstance(value_obj, str):
tag_list = [value_obj]
else:
raise SearchQueryError('Was expecting either a string or JSON list for the tags parameter: %r' % value)
solr_q_list.extend(['tags:"%s"' % escape_legacy_argument(tag) for tag in tag_list])
else:
if len(value.strip()):
value = escape_legacy_argument(value)
if ' ' in value:
value = '"%s"' % value
solr_q_list.append('%s:%s' % (search_key, value))
del solr_params[search_key]
solr_params['q'] = ' '.join(solr_q_list)
if non_solr_params:
log.debug('Converted legacy search params from %r to %r',
legacy_params, solr_params)
return solr_params
def _parse_local_params(local_params: str) -> list[Union[str, list[str]]]:
"""
Parse a local parameters section as return it as a list, eg:
{!dismax qf=myfield v='some value'} -> ['dismax', ['qf', 'myfield'], ['v', 'some value']]
{!type=dismax qf=myfield v='some value'} -> [['type', 'dismax'], ['qf', 'myfield'], ['v', 'some value']]
"""
key = Word(alphanums + "_.")
value = QuotedString('"') | QuotedString("'") | Word(alphanums + "_$")
pair = Group(key + Suppress("=") + value)
expression = Suppress("{!") + OneOrMore(pair | key) + Suppress("}")
return expression.parse_string(local_params).as_list()
def _get_local_query_parser(q: str) -> str:
"""
Given a Solr parameter, extract any custom query parsers used in the
local parameters, .e.g. q={!child ...}...
"""
qp_type = ""
q = q.strip()
if not q.startswith("{!"):
return qp_type
try:
local_params = q[:q.rindex("}") + 1]
parts = _parse_local_params(local_params)
except (ParseException, ValueError) as e:
raise SearchQueryError(f"Could not parse incoming local parameters: {e}")
if isinstance(parts[0], str):
# Most common form of defining the query parser type e.g. {!knn ...}
qp_type = parts[0]
else:
# Alternative syntax e.g. {!type=knn ...}
type_part = [p for p in parts if p[0] == "type"]
if type_part:
qp_type = type_part[0][1]
return qp_type
class QueryOptions(Dict[str, Any]):
"""
Options specify aspects of the search query which are only tangentially related
to the query terms (such as limits, etc.).
NB This is used only by legacy package search and current resource & tag search.
Modern SOLR package search leaves this to SOLR syntax.
"""
BOOLEAN_OPTIONS = ['all_fields']
INTEGER_OPTIONS = ['offset', 'limit']
UNSUPPORTED_OPTIONS = ['filter_by_downloadable', 'filter_by_openness']
limit: int
offset: int
order_by: str
return_objects: bool
ref_entity_with_attr: str
all_fields: bool
search_tags: bool
def __init__(self, **kwargs: Any) -> None:
from ckan.lib.search import DEFAULT_OPTIONS
# set values according to the defaults
for option_name, default_value in DEFAULT_OPTIONS.items():
if not option_name in self:
self[option_name] = default_value
super(QueryOptions, self).__init__(**kwargs)
def validate(self) -> None:
for key, value in self.items():
if key in self.BOOLEAN_OPTIONS:
try:
value = asbool(value)
except ValueError:
raise SearchQueryError('Value for search option %r must be True or False (1 or 0) but received %r' % (key, value))
elif key in self.INTEGER_OPTIONS:
try:
value = int(value)
except ValueError:
raise SearchQueryError('Value for search option %r must be an integer but received %r' % (key, value))
elif key in self.UNSUPPORTED_OPTIONS:
raise SearchQueryError('Search option %r is not supported' % key)
self[key] = value
def __getattr__(self, name: str) -> Any:
return self.get(name)
def __setattr__(self, name: str, value: Any):
self[name] = value
class SearchQuery(object):
"""
A query is ... when you ask the search engine things. SearchQuery is intended
to be used for only one query, i.e. it sets state. Definitely not thread-safe.
"""
count: int
results: list[Any]
facets: dict[str, Any]
def __init__(self) -> None:
self.results = []
self.count = 0
@property
def open_licenses(self) -> list[str]:
# this isn't exactly the very best place to put these, but they stay
# there persistently.
# TODO: figure out if they change during run-time.
global _open_licenses
if not isinstance(_open_licenses, list):
_open_licenses = []
for license in model.Package.get_license_register().values():
if license and license.isopen():
_open_licenses.append(license.id)
return _open_licenses
def get_all_entity_ids(self, max_results: int=1000) -> list[str]:
"""
Return a list of the IDs of all indexed packages.
"""
return []
def run(self,
query: Optional[Union[str, dict[str, Any]]] = None,
terms: Optional[list[str]] = None,
fields: Optional[dict[str, Any]] = None,
facet_by: Optional[list[str]] = None,
options: Optional[QueryOptions] = None,
**kwargs: Any) -> NoReturn:
raise SearchError("SearchQuery.run() not implemented!")
# convenience, allows to query(..)
__call__ = run
class TagSearchQuery(SearchQuery):
"""Search for tags."""
def run(self,
query: Optional[Union[str, list[str]]] = None,
fields: Optional[dict[str, Any]] = None,
options: Optional[QueryOptions] = None,
**kwargs: Any) -> dict[str, Any]:
query = [] if query is None else query
fields = {} if fields is None else fields
if options is None:
options = QueryOptions(**kwargs)
else:
options.update(kwargs)
if isinstance(query, str):
query = [query]
query = query[:] # don't alter caller's query list.
for field, value in fields.items():
if field in ('tag', 'tags'):
query.append(value)
data_dict = {
'query': query,
'offset': options.get('offset'),
'limit': options.get('limit')
}
results = logic.get_action('tag_search')({}, data_dict)
if not options.return_objects:
# if options.all_fields is set, return a dict
# if not, return a list of resource IDs
if options.all_fields:
results['results'] = [r.as_dict() for r in results['results']]
else:
results['results'] = [r['name'] for r in results['results']]
self.count = results['count']
self.results = results['results']
return results
class ResourceSearchQuery(SearchQuery):
"""Search for resources."""
def run(self,
fields: Optional[dict[str, Any]] = None,
options: Optional[QueryOptions] = None,
**kwargs: Any) -> dict[str, Any]:
if options is None:
options = QueryOptions(**kwargs)
else:
options.update(kwargs)
context: Context = {'search_query': True}
# Transform fields into structure required by the resource_search
# action.
query: list[str] = []
if fields:
for field, terms in fields.items():
if isinstance(terms, str):
terms = terms.split()
for term in terms:
query.append(':'.join([field, term]))
data_dict = {
'query': query,
'offset': options.get('offset'),
'limit': options.get('limit'),
'order_by': options.get('order_by')
}
results = logic.get_action('resource_search')(context, data_dict)
if not options.return_objects:
# if options.all_fields is set, return a dict
# if not, return a list of resource IDs
if options.all_fields:
results['results'] = [r.as_dict() for r in results['results']]
else:
results['results'] = [r.id for r in results['results']]
self.count = results['count']
self.results = results['results']
return results
class PackageSearchQuery(SearchQuery):
def get_all_entity_ids(self, max_results: int = 1000) -> list[str]:
"""
Return a list of the IDs of all indexed packages.
"""
query = "*:*"
fq = "+site_id:\"%s\" " % config.get('ckan.site_id')
fq += "+state:active "
conn = make_connection()
data = conn.search(query, fq=fq, rows=max_results, fl='id')
return [r.get('id') for r in data.docs]
def get_index(self, reference: str) -> dict[str, Any]:
query = {
'rows': 1,
'q': 'name:"%s" OR id:"%s"' % (reference, reference),
'wt': 'json',
'fq': 'site_id:"%s" ' % config.get('ckan.site_id') + '+entity_type:package'}
conn = make_connection(decode_dates=False)
log.debug('Package query: %r' % query)
try:
solr_response = conn.search(**query)
except pysolr.SolrError as e:
raise SearchError(
'SOLR returned an error running query: %r Error: %r' %
(query, e))
if solr_response.hits == 0:
raise SearchError('Dataset not found in the search index: %s' %
reference)
else:
return cast("list[dict[str, Any]]", solr_response.docs)[0]
def run(self,
query: dict[str, Any],
permission_labels: Optional[list[str]] = None,
**kwargs: Any) -> dict[str, Any]:
'''
Performs a dataset search using the given query.
:param query: dictionary with keys like: q, fq, sort, rows, facet
:type query: dict
:param permission_labels: filter results to those that include at
least one of these labels. None to not filter (return everything)
:type permission_labels: list of unicode strings; or None
:returns: dictionary with keys results and count
May raise SearchQueryError or SearchError.
'''
assert isinstance(query, (dict, MultiDict))
# check that query keys are valid
if not set(query.keys()) <= VALID_SOLR_PARAMETERS:
invalid_params = [s for s in set(query.keys()) - VALID_SOLR_PARAMETERS]
raise SearchQueryError("Invalid search parameters: %s" % invalid_params)
# default query is to return all documents
q = query.get('q')
if not q or q == '""' or q == "''":
query['q'] = "*:*"
# number of results
rows_to_return = int(query.get('rows', 10))
# query['rows'] should be a defaulted int, due to schema, but make
# certain, for legacy tests
if rows_to_return > 0:
# #1683 Work around problem of last result being out of order
# in SOLR 1.4
rows_to_query = rows_to_return + 1
else:
rows_to_query = rows_to_return
query['rows'] = rows_to_query
fq = []
if 'fq' in query:
fq.append(query['fq'])
fq.extend(query.get('fq_list', []))
# show only results from this CKAN instance
fq.append('+site_id:%s' % solr_literal(config.get('ckan.site_id')))
# filter for package status
if not any('+state:' in _item for _item in fq):
fq.append('+state:active')
# only return things we should be able to see
if permission_labels is not None:
fq.append('+permission_labels:(%s)' % ' OR '.join(
solr_literal(p) for p in permission_labels))
query['fq'] = fq
# faceting
query['facet'] = query.get('facet', 'true')
query['facet.limit'] = query.get('facet.limit', config.get('search.facets.limit'))
query['facet.mincount'] = query.get('facet.mincount', 1)
# return the package ID and search scores
query['fl'] = query.get('fl', 'name')
# return results as json encoded string
query['wt'] = query.get('wt', 'json')
# If the query has a colon in it then consider it a fielded search and do use dismax.
defType = query.get('defType', 'dismax')
if ':' not in query['q'] or defType == 'edismax':
query['defType'] = defType
query['tie'] = query.get('tie', '0.1')
# this minimum match is explained
# http://wiki.apache.org/solr/DisMaxQParserPlugin#mm_.28Minimum_.27Should.27_Match.29
query['mm'] = query.get('mm', '2<-1 5<80%')
query['qf'] = query.get('qf', QUERY_FIELDS)
query.setdefault("df", "text")
query.setdefault("q.op", "AND")
def _check_query_parser(param: str, value: Any):
if isinstance(value, str) and value.strip().startswith("{!"):
if not _get_local_query_parser(value) in config["ckan.search.solr_allowed_query_parsers"]:
raise SearchError(f"Local parameters are not supported in param '{param}'.")
for param in query.keys():
if isinstance(query[param], str):
_check_query_parser(param, query[param])
elif isinstance(query[param], list):
for item in query[param]:
_check_query_parser(param, item)
conn = make_connection(decode_dates=False)
log.debug('Package query: %r' % query)
try:
solr_response = conn.search(**query)
except pysolr.SolrError as e:
# Error with the sort parameter. You see slightly different
# error messages depending on whether the SOLR JSON comes back
# or Jetty gets in the way converting it to HTML - not sure why
#
if e.args and isinstance(e.args[0], str):
if "Can't determine a Sort Order" in e.args[0] or \
"Can't determine Sort Order" in e.args[0] or \
'Unknown sort order' in e.args[0]:
raise SearchQueryError('Invalid "sort" parameter')
if "Failed to connect to server" in e.args[0] or \
"Connection to server" in e.args[0]:
log.warning("Connection Error: Failed to connect to Solr server.")
raise SolrConnectionError("Solr returned an error while searching.")
raise SearchError('SOLR returned an error running query: %r Error: %r' %
(query, e))
self.count = solr_response.hits
self.results = cast("list[Any]", solr_response.docs)
# #1683 Filter out the last row that is sometimes out of order
self.results = self.results[:rows_to_return]
# get any extras and add to 'extras' dict
for result in self.results:
extra_keys = filter(lambda x: x.startswith('extras_'), result.keys())
extras = {}
for extra_key in list(extra_keys):
value = result.pop(extra_key)
extras[extra_key[len('extras_'):]] = value
if extra_keys:
result['extras'] = extras
# if just fetching the id or name, return a list instead of a dict
if query.get('fl') in ['id', 'name']:
self.results = [r.get(query['fl']) for r in self.results]
# get facets and convert facets list to a dict
self.facets = solr_response.facets.get('facet_fields', {})
for field, values in self.facets.items():
self.facets[field] = dict(zip(values[0::2], values[1::2]))
return {'results': self.results, 'count': self.count}
def solr_literal(t: str) -> str:
'''
return a safe literal string for a solr query. Instead of escaping
each of + - && || ! ( ) { } [ ] ^ " ~ * ? : \\ / we're just dropping
double quotes -- this method currently only used by tokens like site_id
and permission labels.
'''
return u'"' + t.replace(u'"', u'') + u'"'