forked from mozilla/kitsune
/
clients.py
159 lines (124 loc) · 4.01 KB
/
clients.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
from django.conf import settings
from .sphinxapi import SphinxClient
import re
MARKUP_PATTERNS = (
(r'^!+',),
(r'^;:',),
(r'^#',),
(r'\n|\r',),
(r'\{maketoc\}',),
(r'\{ANAME.*?ANAME\}',),
(r'\{[a-zA-Z]+.*?\}',),
(r'\{.*?$',),
(r'__',),
(r'\'\'',),
(r'%{2,}',),
(r'\*|\^|;|/\}',),
(r'~/?np~',),
(r'~/?(h|t)c~',),
(r'\(spans.*?\)',),
(r'\}',),
(r'\(\(.*?\|(?P<name>.*?)\)\)', '\g<name>'),
(r'\(\((?P<name>.*?)\)\)', '\g<name>'),
(r'\(\(',),
(r'\)\)',),
(r'\[.+?\|(?P<name>.+?)\]', '\g<name>'),
(r'\[(?P<name>.+?)\]', '\g<name>'),
(r'/wiki_up.*? ',),
(r'"',),
(r'^!! Issue.+!! Description',),
(r'\s+',),
)
class SearchClient(object):
"""
Base-class for search clients
"""
def __init__(self):
self.sphinx = SphinxClient()
self.sphinx.SetServer(settings.SPHINX_HOST, settings.SPHINX_PORT)
self.sphinx.SetLimits(0, settings.SEARCH_MAX_RESULTS)
# initialize regexes for markup cleaning
self.truncate_pattern = re.compile(r'\s.*', re.MULTILINE)
self.compiled_patterns = []
if MARKUP_PATTERNS:
for pattern in MARKUP_PATTERNS:
p = [re.compile(pattern[0], re.MULTILINE)]
if len(pattern) > 1:
p.append(pattern[1])
else:
p.append(' ')
self.compiled_patterns.append(p)
def query(self, query, filters): abstract
def excerpt(self, result, query):
"""
Returns an excerpt for the passed-in string
Takes in a string
"""
documents = [result]
# build excerpts that are longer and truncate
# see multiplier constant definition for details
raw_excerpt = self.sphinx.BuildExcerpts(documents, self.index, query,
{'limit': settings.SEARCH_SUMMARY_LENGTH
* settings.SEARCH_SUMMARY_LENGTH_MULTIPLIER})[0]
excerpt = raw_excerpt
for p in self.compiled_patterns:
excerpt = p[0].sub(p[1], excerpt)
# truncate long excerpts
if len(excerpt) > settings.SEARCH_SUMMARY_LENGTH:
excerpt = excerpt[:settings.SEARCH_SUMMARY_LENGTH] \
+ self.truncate_pattern.sub('', excerpt[settings.SEARCH_SUMMARY_LENGTH:])
if excerpt[-1] != '.':
excerpt += '...'
return excerpt
class ForumClient(SearchClient):
"""
Search the forum
"""
index = 'forum_threads'
def query(self, query, filters=None):
"""
Search through forum threads
"""
if filters is None:
filters = []
sc = self.sphinx
sc.ResetFilters()
sc.SetFieldWeights({'title': 4, 'content': 3})
for f in filters:
if f.get('range', False):
sc.SetFilterRange(f['filter'], f['min'],
f['max'], f.get('exclude', False))
else:
sc.SetFilter(f['filter'], f['value'],
f.get('exclude', False))
result = sc.Query(query, 'forum_threads')
if result:
return result['matches']
else:
return []
class WikiClient(SearchClient):
"""
Search the knowledge base
"""
index = 'wiki_pages'
def query(self, query, filters=None):
"""
Search through the wiki (ie KB)
"""
if filters is None:
filters = []
sc = self.sphinx
sc.ResetFilters()
sc.SetFieldWeights({'title': 4, 'keywords': 3})
for f in filters:
if f.get('range', False):
sc.SetFilterRange(f['filter'], f['min'],
f['max'], f.get('exclude', False))
else:
sc.SetFilter(f['filter'], f['value'],
f.get('exclude', False))
result = sc.Query(query, self.index)
if result:
return result['matches']
else:
return []