searxng/searx/engines/solr.py

99 lines
2.4 KiB
Python
Raw Normal View History

2021-03-13 19:27:47 +00:00
# SPDX-License-Identifier: AGPL-3.0-or-later
""".. sidebar:: info
- :origin:`solr.py <searx/engines/solr.py>`
- `Solr <https://solr.apache.org>`_
- `Solr Resources <https://solr.apache.org/resources.html>`_
- `Install Solr <https://solr.apache.org/guide/installing-solr.html>`_
Solr_ is a popular search engine based on Lucene, just like Elasticsearch_. But
instead of searching in indices, you can search in collections.
Example
=======
This is an example configuration for searching in the collection
``my-collection`` and get the results in ascending order.
.. code:: yaml
- name: solr
engine: solr
shortcut: slr
base_url: http://localhost:8983
collection: my-collection
sort: asc
enable_http: true
2021-03-13 19:27:47 +00:00
"""
# pylint: disable=global-statement
2021-03-13 19:27:47 +00:00
from json import loads
from urllib.parse import urlencode
from searx.exceptions import SearxEngineAPIException
base_url = 'http://localhost:8983'
collection = ''
rows = 10
sort = '' # sorting: asc or desc
field_list = 'name' # list of field names to display on the UI
default_fields = '' # default field to query
query_fields = '' # query fields
2021-03-13 19:27:47 +00:00
_search_url = ''
paging = True
def init(_):
if collection == '':
raise ValueError('collection cannot be empty')
global _search_url
_search_url = base_url + '/solr/' + collection + '/select?{params}'
def request(query, params):
query_params = {'q': query, 'rows': rows}
if field_list != '':
query_params['fl'] = field_list
if query_fields != '':
query_params['qf'] = query_fields
if default_fields != '':
query_params['df'] = default_fields
if sort != '':
query_params['sort'] = sort
if 'pageno' in params:
query_params['start'] = rows * (params['pageno'] - 1)
params['url'] = _search_url.format(params=urlencode(query_params))
return params
def response(resp):
resp_json = __get_response(resp)
results = []
for result in resp_json['response']['docs']:
r = {key: str(value) for key, value in result.items()}
if len(r) == 0:
continue
r['template'] = 'key-value.html'
results.append(r)
return results
def __get_response(resp):
try:
resp_json = loads(resp.text)
except Exception as e:
raise SearxEngineAPIException("failed to parse response") from e
if 'error' in resp_json:
raise SearxEngineAPIException(resp_json['error']['msg'])
return resp_json