/
bot.py
266 lines (235 loc) · 11.1 KB
/
bot.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
import logging
import pendulum
import celery
from django.apps import apps
from django.conf import settings
from django.db.models import Q
from elasticsearch import Elasticsearch
from share.search import SearchIndexer
from share.search.fetchers import CreativeWorkFetcher
logger = logging.getLogger(__name__)
def chunk(iterable, size):
iterable = iter(iterable)
try:
while True:
chunk = []
for _ in range(size):
chunk.append(next(iterable))
yield chunk
except StopIteration:
yield chunk
class ElasticSearchBot:
# Sources are also indexed as a special case
INDEX_MODELS = [
'CreativeWork',
'Agent',
'Tag',
# 'Subject',
]
SETTINGS = {
'analysis': {
'filter': {
'autocomplete_filter': {
'type': 'edge_ngram',
'min_gram': 1,
'max_gram': 20
}
},
'analyzer': {
'default': {
# same as 'standard' analyzer, plus html_strip
'type': 'custom',
'tokenizer': 'standard',
'filter': ['lowercase', 'stop'],
'char_filter': ['html_strip']
},
'autocomplete': {
'type': 'custom',
'tokenizer': 'standard',
'filter': [
'lowercase',
'autocomplete_filter'
]
},
'subject_analyzer': {
'type': 'custom',
'tokenizer': 'subject_tokenizer',
'filter': [
'lowercase',
]
},
'subject_search_analyzer': {
'type': 'custom',
'tokenizer': 'keyword',
'filter': [
'lowercase',
]
},
},
'tokenizer': {
'subject_tokenizer': {
'type': 'path_hierarchy',
'delimiter': CreativeWorkFetcher.SUBJECT_DELIMITER,
}
}
}
}
AUTOCOMPLETE_FIELD = {
'autocomplete': {
'type': 'string',
'analyzer': 'autocomplete',
'search_analyzer': 'standard',
'include_in_all': False
}
}
EXACT_FIELD = {
'exact': {
'type': 'keyword',
# From Elasticsearch documentation:
# The value for ignore_above is the character count, but Lucene counts bytes.
# If you use UTF-8 text with many non-ASCII characters, you may want to set the limit to 32766 / 3 = 10922 since UTF-8 characters may occupy at most 3 bytes
'ignore_above': 10922
}
}
MAPPINGS = {
'creativeworks': {
'dynamic': 'strict',
'properties': {
'affiliations': {'type': 'text', 'fields': EXACT_FIELD},
'contributors': {'type': 'text', 'fields': EXACT_FIELD},
'date': {'type': 'date', 'format': 'strict_date_optional_time', 'include_in_all': False},
'date_created': {'type': 'date', 'format': 'strict_date_optional_time', 'include_in_all': False},
'date_modified': {'type': 'date', 'format': 'strict_date_optional_time', 'include_in_all': False},
'date_published': {'type': 'date', 'format': 'strict_date_optional_time', 'include_in_all': False},
'date_updated': {'type': 'date', 'format': 'strict_date_optional_time', 'include_in_all': False},
'description': {'type': 'text'},
'funders': {'type': 'text', 'fields': EXACT_FIELD},
'hosts': {'type': 'text', 'fields': EXACT_FIELD},
'id': {'type': 'keyword', 'include_in_all': False},
'identifiers': {'type': 'text', 'fields': EXACT_FIELD},
'justification': {'type': 'text', 'include_in_all': False},
'language': {'type': 'keyword', 'include_in_all': False},
'publishers': {'type': 'text', 'fields': EXACT_FIELD},
'registration_type': {'type': 'keyword', 'include_in_all': False},
'retracted': {'type': 'boolean', 'include_in_all': False},
'sources': {'type': 'keyword', 'include_in_all': False},
'subjects': {'type': 'text', 'include_in_all': False, 'analyzer': 'subject_analyzer', 'search_analyzer': 'subject_search_analyzer'},
'subject_synonyms': {'type': 'text', 'include_in_all': False, 'analyzer': 'subject_analyzer', 'search_analyzer': 'subject_search_analyzer', 'copy_to': 'subjects'},
'tags': {'type': 'text', 'fields': EXACT_FIELD},
'title': {'type': 'text', 'fields': EXACT_FIELD},
'type': {'type': 'keyword', 'include_in_all': False},
'types': {'type': 'keyword', 'include_in_all': False},
'withdrawn': {'type': 'boolean', 'include_in_all': False},
'lists': {'type': 'object', 'dynamic': True, 'include_in_all': False},
},
'dynamic_templates': [
{'exact_field_on_lists_strings': {'path_match': 'lists.*', 'match_mapping_type': 'string', 'mapping': {'type': 'text', 'fields': EXACT_FIELD}}},
]
},
'agents': {
'dynamic': False,
'properties': {
'id': {'type': 'keyword', 'include_in_all': False},
'identifiers': {'type': 'text', 'fields': EXACT_FIELD},
'name': {'type': 'text', 'fields': {**AUTOCOMPLETE_FIELD, **EXACT_FIELD}},
'family_name': {'type': 'text', 'include_in_all': False},
'given_name': {'type': 'text', 'include_in_all': False},
'additional_name': {'type': 'text', 'include_in_all': False},
'suffix': {'type': 'text', 'include_in_all': False},
'location': {'type': 'text', 'include_in_all': False},
'sources': {'type': 'keyword', 'include_in_all': False},
'type': {'type': 'keyword', 'include_in_all': False},
'types': {'type': 'keyword', 'include_in_all': False},
}
},
'sources': {
'dynamic': False,
'properties': {
'id': {'type': 'keyword', 'include_in_all': False},
'name': {'type': 'text', 'fields': {**AUTOCOMPLETE_FIELD, **EXACT_FIELD}},
'short_name': {'type': 'keyword', 'include_in_all': False},
'type': {'type': 'keyword', 'include_in_all': False},
}
},
'tags': {
'dynamic': False,
'properties': {
'id': {'type': 'keyword', 'include_in_all': False},
'name': {'type': 'text', 'fields': {**AUTOCOMPLETE_FIELD, **EXACT_FIELD}},
'type': {'type': 'keyword', 'include_in_all': False},
}
},
}
def __init__(self, **kwargs):
self.es_filter = kwargs.pop('es_filter', None)
self.es_index = kwargs.pop('es_index', None) or settings.ELASTICSEARCH['INDEX']
self.es_models = kwargs.pop('es_models', None)
self.es_setup = bool(kwargs.pop('es_setup', False))
self.es_url = kwargs.pop('es_url', None) or settings.ELASTICSEARCH['URL']
self.to_daemon = kwargs.pop('to_daemon', True)
if self.es_models:
self.es_models = [x.lower() for x in self.es_models]
if kwargs:
raise TypeError('__init__ got unexpect keyword arguments {}'.format(kwargs))
self.es_client = Elasticsearch(self.es_url)
def get_most_recently_modified(self):
resp = self.es_client.search(
index=(self.es_index or settings.ELASTICSEARCH['INDEX']),
doc_type='creativeworks',
body='{"sort": {"date_modified": "desc"}, "size": 1}'
)
if resp['hits']['hits']:
return resp['hits']['hits'][0]['_source']['date_modified']
return '2000-01-01T00:00:00-00:00'
def run(self, chunk_size=500):
from bots.elasticsearch import tasks # TODO fix me
if self.es_setup:
self.setup()
else:
logger.debug('Skipping ES setup')
logger.info('Loading up indexed models')
for model_name in self.INDEX_MODELS:
if self.es_models and model_name.lower() not in self.es_models:
continue
model = apps.get_model('share', model_name)
if self.es_filter:
logger.info('Looking for %ss that match %s', model, self.es_filter)
qs = model.objects.filter(**self.es_filter).values_list('id', flat=True)
else:
most_recent_result = pendulum.parse(self.get_most_recently_modified())
logger.info('Looking for %ss that have been modified after %s', model, most_recent_result)
q = Q(date_modified__gt=most_recent_result)
if hasattr(model, 'subjects') and hasattr(model, 'subject_relations'):
q = q | Q(subjects__date_modified__gt=most_recent_result) | Q(subject_relations__date_modified__gt=most_recent_result)
qs = model.objects.filter(q).values_list('id', flat=True)
for batch in chunk(qs.iterator(), chunk_size):
if batch:
if not self.to_daemon:
tasks.index_model.apply_async((model.__name__, batch,), {'es_url': self.es_url, 'es_index': self.es_index})
else:
try:
SearchIndexer(celery.current_app).index(model.__name__, *batch, index=self.es_index if self.es_index != settings.ELASTICSEARCH['INDEX'] else None)
except ValueError:
logger.warning('Not sending model type %r to the SearchIndexer', model)
if self.es_models and 'source' in self.es_models:
logger.info('Starting task to index sources')
tasks.index_sources.apply_async((), {'es_url': self.es_url, 'es_index': self.es_index})
def setup(self):
logger.debug('Ensuring Elasticsearch index %s', self.es_index)
self.es_client.indices.create(self.es_index, ignore=400)
logger.debug('Waiting for yellow status')
self.es_client.cluster.health(wait_for_status='yellow')
logger.info('Putting Elasticsearch settings')
self.es_client.indices.close(index=self.es_index)
try:
self.es_client.indices.put_settings(body=self.SETTINGS, index=self.es_index)
finally:
self.es_client.indices.open(index=self.es_index)
logger.info('Putting Elasticsearch mappings')
for doc_type, mapping in self.MAPPINGS.items():
logger.debug('Putting mapping for %s', doc_type)
self.es_client.indices.put_mapping(
doc_type=doc_type,
body={doc_type: mapping},
index=self.es_index
)