/
registry.py
72 lines (55 loc) · 2.34 KB
/
registry.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
"""The search engine backend registry."""
from djblets.siteconfig.models import SiteConfiguration
from reviewboard.registries.registry import Registry
from reviewboard.search.search_backends.elasticsearch import \
ElasticsearchBackend
from reviewboard.search.search_backends.whoosh import WhooshBackend
class SearchBackendRegistry(Registry):
"""A registry for search engines backends.
Extensions can add support for additional search engine backends.
See :py:ref:`the registry documentation <registry-guides>` for information
on how registries work.
"""
lookup_attrs = ['search_backend_id']
def get_search_backend(self, search_backend_id):
"""Return the search backend with the specified ID.
Args:
search_backend_id (unicode):
The unique identifier of the search engine.
Returns:
reviewboard.search.search_engines.base.SearchBackend:
The search engine class, if it could be found. Otherwise, ``None``.
"""
return self.get('search_backend_id', search_backend_id)
def get_defaults(self):
"""Return the default search backends.
Returns:
list of reviewboard.search.search_backends.base.SearchBackend:
The default search backends to use.
"""
return [
WhooshBackend(),
ElasticsearchBackend(),
]
@property
def on_the_fly_indexing_enabled(self):
"""Whether or not on-the-fly indexing is enabled."""
siteconfig = SiteConfiguration.objects.get_current()
return siteconfig.get('search_on_the_fly_indexing')
@property
def search_enabled(self):
"""Whether or not search is enabled."""
siteconfig = SiteConfiguration.objects.get_current()
return siteconfig.get('search_enable')
@property
def results_per_page(self):
"""The number of search results per page."""
siteconfig = SiteConfiguration.objects.get_current()
return siteconfig.get('search_results_per_page')
@property
def current_backend(self):
"""The current search backend, or ``None`` if search is disabled."""
if not self.search_enabled:
return None
siteconfig = SiteConfiguration.objects.get_current()
return self.get_search_backend(siteconfig.get('search_backend_id'))