-
Notifications
You must be signed in to change notification settings - Fork 11
/
views.py
364 lines (312 loc) · 15.1 KB
/
views.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
import os
from pyramid.response import Response
from pyramid.response import FileResponse
from pyramid.view import view_config, view_defaults
from pyramid.httpexceptions import HTTPFound
from pyramid.threadlocal import get_current_registry
from pyramid.i18n import TranslationStringFactory
from sqlalchemy.orm.exc import NoResultFound
from skosprovider_sqlalchemy.models import Collection, Concept, LabelType, NoteType
from atramhasis.errors import SkosRegistryNotFoundException, ConceptSchemeNotFoundException, ConceptNotFoundException
from atramhasis.utils import update_last_visited_concepts
from atramhasis.cache import tree_region, invalidate_scheme_cache, invalidate_cache, list_region
from atramhasis.audit import audit
def labels_to_string(labels, ltype):
labelstring = ''
for label in (l for l in labels if l.labeltype_id == ltype):
labelstring += label.label + ' (' + label.language_id + '), '
return labelstring[:-2]
def get_definition(notes):
for note in notes:
if note.notetype_id == 'definition':
return note.note
@view_defaults(accept='text/html')
class AtramhasisView(object):
"""
This object groups HTML views part of the public user interface.
"""
def __init__(self, request):
self.request = request
self.skos_manager = self.request.data_managers['skos_manager']
self.conceptscheme_manager = self.request.data_managers['conceptscheme_manager']
if hasattr(request, 'skos_registry') and request.skos_registry is not None:
self.skos_registry = self.request.skos_registry
else:
raise SkosRegistryNotFoundException()
def _read_request_param(self, param):
value = None
if param in self.request.params:
value = self.request.params.getone(param).strip()
if not value:
value = None # pragma: no cover
return value
@view_config(name='favicon.ico')
def favicon_view(self):
"""
This view returns the favicon when requested from the web root.
"""
here = os.path.dirname(__file__)
icon = os.path.join(os.path.dirname(here), 'static', 'img', 'favicon.ico')
response = FileResponse(
icon,
request=self.request,
content_type='image/x-icon'
)
return response
@view_config(route_name='home', renderer='atramhasis:templates/home.jinja2')
def home_view(self):
"""
This view displays the homepage.
"""
conceptschemes = [
{'id': x.get_metadata()['id'],
'conceptscheme': x.concept_scheme}
for x in self.skos_registry.get_providers() if not any([not_shown in x.get_metadata()['subject']
for not_shown in ['external', 'hidden']])
]
return {'conceptschemes': conceptschemes}
@view_config(route_name='conceptschemes', renderer='atramhasis:templates/conceptschemes.jinja2')
def conceptschemes_view(self):
"""
This view displays a list of available conceptschemes.
"""
conceptschemes = [
{'id': x.get_metadata()['id'],
'conceptscheme': x.concept_scheme}
for x in self.skos_registry.get_providers() if not any([not_shown in x.get_metadata()['subject']
for not_shown in ['external', 'hidden']])
]
return {'conceptschemes': conceptschemes}
@audit
@view_config(route_name='conceptscheme', renderer='atramhasis:templates/conceptscheme.jinja2')
def conceptscheme_view(self):
"""
This view displays conceptscheme details.
"""
conceptschemes = [
{'id': x.get_metadata()['id'],
'conceptscheme': x.concept_scheme}
for x in self.skos_registry.get_providers() if not any([not_shown in x.get_metadata()['subject']
for not_shown in ['external', 'hidden']])
]
scheme_id = self.request.matchdict['scheme_id']
provider = self.request.skos_registry.get_provider(scheme_id)
conceptscheme = provider.concept_scheme
title = conceptscheme.label(self.request.locale_name).label if (conceptscheme.label(self.request.locale_name)) else scheme_id
scheme = {
'scheme_id': scheme_id,
'title': title,
'uri': conceptscheme.uri,
'labels': conceptscheme.labels,
'notes': conceptscheme.notes,
'top_concepts': provider.get_top_concepts()
}
return {'conceptscheme': scheme, 'conceptschemes': conceptschemes}
@audit
@view_config(route_name='concept', renderer='atramhasis:templates/concept.jinja2')
def concept_view(self):
"""
This view displays the concept details
"""
conceptschemes = [
{'id': x.get_metadata()['id'],
'conceptscheme': x.concept_scheme}
for x in self.skos_registry.get_providers() if not any([not_shown in x.get_metadata()['subject']
for not_shown in ['external', 'hidden']])
]
scheme_id = self.request.matchdict['scheme_id']
c_id = self.request.matchdict['c_id']
provider = self.request.skos_registry.get_provider(scheme_id)
if not provider:
raise ConceptSchemeNotFoundException(scheme_id)
try:
c = self.skos_manager.get_thing(c_id, provider.conceptscheme_id)
if isinstance(c, Concept):
concept_type = "Concept"
elif isinstance(c, Collection):
concept_type = "Collection"
else:
return Response('Thing without type: ' + str(c_id), status_int=500)
url = self.request.route_url('concept', scheme_id=scheme_id, c_id=c_id)
update_last_visited_concepts(self.request, {'label': c.label(self.request.locale_name).label, 'url': url})
return {'concept': c, 'conceptType': concept_type, 'scheme_id': scheme_id,
'conceptschemes': conceptschemes, 'provider': provider}
except NoResultFound:
raise ConceptNotFoundException(c_id)
@view_config(route_name='search_result', renderer='atramhasis:templates/search_result.jinja2')
def search_result(self):
"""
This view displays the search results
"""
conceptschemes = [
{'id': x.get_metadata()['id'],
'conceptscheme': x.concept_scheme}
for x in self.skos_registry.get_providers() if not any([not_shown in x.get_metadata()['subject']
for not_shown in ['external', 'hidden']])
]
scheme_id = self.request.matchdict['scheme_id']
label = self._read_request_param('label')
ctype = self._read_request_param('ctype')
provider = self.skos_registry.get_provider(scheme_id)
if provider:
if label is not None:
concepts = provider.find({'label': label, 'type': ctype}, language=self.request.locale_name, sort='label')
elif (label is None) and (ctype is not None):
concepts = provider.find({'type': ctype}, language=self.request.locale_name, sort='label')
else:
concepts = provider.get_all(language=self.request.locale_name, sort='label')
return {'concepts': concepts, 'scheme_id': scheme_id, 'conceptschemes': conceptschemes}
return Response(content_type='text/plain', status_int=404)
@view_config(route_name='locale')
def set_locale_cookie(self):
"""
This view will set a language cookie
"""
settings = get_current_registry().settings
default_lang = settings.get('pyramid.default_locale_name')
available_languages = settings.get('available_languages', default_lang).split()
[x.lower() for x in available_languages]
language = self.request.GET.get('language', default_lang).lower()
if language not in available_languages:
language = default_lang
referer = self.request.referer
if referer is not None:
response = HTTPFound(location=referer)
else:
response = HTTPFound(location=self.request.route_url('home'))
response.set_cookie('_LOCALE_',
value=language,
max_age=31536000) # max_age = year
return response
@audit
@view_config(route_name='search_result_export', renderer='csv')
def results_csv(self):
header = ['conceptscheme', 'id', 'uri', 'type', 'label', 'prefLabels', 'altLabels', 'definition', 'broader',
'narrower', 'related']
rows = []
scheme_id = self.request.matchdict['scheme_id']
label = self._read_request_param('label')
ctype = self._read_request_param('ctype')
provider = self.skos_registry.get_provider(scheme_id)
if provider:
if label is not None:
concepts = self.conceptscheme_manager.find(provider.conceptscheme_id, {'label': label, 'type': ctype})
elif (label is None) and (ctype is not None):
concepts = self.conceptscheme_manager.find(provider.conceptscheme_id, {'type': ctype})
else:
concepts = self.conceptscheme_manager.get_all(provider.conceptscheme_id)
for concept in concepts:
if concept.type == 'concept':
rows.append((
scheme_id, concept.concept_id, concept.uri, concept.type,
concept.label(self.request.locale_name).label,
labels_to_string(concept.labels, 'prefLabel'), labels_to_string(concept.labels, 'altLabel'),
get_definition(concept.notes), [c.concept_id for c in concept.broader_concepts],
[c.concept_id for c in concept.narrower_concepts],
[c.concept_id for c in concept.related_concepts]))
else:
rows.append((
scheme_id, concept.concept_id, concept.uri, concept.type,
concept.label(self.request.locale_name).label,
labels_to_string(concept.labels, 'prefLabel'), labels_to_string(concept.labels, 'altLabel'),
get_definition(concept.notes), '', [c.concept_id for c in concept.members], ''))
return {
'header': header,
'rows': rows,
'filename': 'atramhasis_export'
}
@view_config(route_name='scheme_tree', renderer='json', accept='application/json')
def results_tree_json(self):
scheme_id = self.request.matchdict['scheme_id']
locale = self.request.locale_name
dicts = self.get_results_tree(scheme_id, locale)
if dicts:
return dicts
else:
return Response(status_int=404)
@tree_region.cache_on_arguments()
def get_results_tree(self, scheme_id, locale):
skostree = self.get_scheme(scheme_id, locale)
return [self.parse_thing(thing, None) for thing in skostree]
def get_scheme(self, scheme, locale):
scheme_tree = []
provider = self.skos_registry.get_provider(scheme)
if provider:
conceptscheme_id = provider.conceptscheme_id
tco = self.conceptscheme_manager.get_concepts_for_scheme_tree(conceptscheme_id)
tcl = self.conceptscheme_manager.get_collections_for_scheme_tree(conceptscheme_id)
scheme_tree = sorted(tco, key=lambda child: child.label(locale).label.lower()) + \
sorted(tcl, key=lambda child: child.label(locale).label.lower())
return scheme_tree
def parse_thing(self, thing, parent_tree_id):
tree_id = self.create_treeid(parent_tree_id, thing.concept_id)
locale = self.request.locale_name
if thing.type and thing.type == 'collection':
cs = [member for member in thing.members] if hasattr(thing, 'members') else []
else:
cs = [c for c in thing.narrower_concepts]
cs = cs + [c for c in thing.narrower_collections]
sortedcs = sorted(cs, key=lambda child: child.label(locale).label.lower())
children = [self.parse_thing(c, tree_id) for index, c in enumerate(sortedcs, 1)]
dict_thing = {
'id': tree_id,
'concept_id': thing.concept_id,
'type': thing.type,
'label': thing.label(locale).label,
'children': children
}
return dict_thing
@staticmethod
def create_treeid(parent_tree_id, concept_id):
if parent_tree_id is None:
return str(concept_id)
else:
return parent_tree_id + "." + str(concept_id)
@view_config(route_name='scheme_root', renderer='atramhasis:templates/concept.jinja2')
def results_tree_html(self):
scheme_id = self.request.matchdict['scheme_id']
return {'concept': None, 'conceptType': None, 'scheme_id': scheme_id}
@view_defaults(accept='application/json', renderer='json')
class AtramhasisListView(object):
"""
This object groups list views part for the user interface.
"""
def __init__(self, request):
self.request = request
self.skos_manager = self.request.data_managers['skos_manager']
self.localizer = request.localizer
self._ = TranslationStringFactory('atramhasis')
@view_config(route_name='labeltypes')
def labeltype_list_view(self):
return self.get_list(LabelType)
@view_config(route_name='notetypes')
def notetype_list_view(self):
return self.get_list(NoteType)
@list_region.cache_on_arguments()
def get_list(self, listtype):
return [{"key": ltype.name, "label": self.localizer.translate(self._(ltype.name))}
for ltype in self.skos_manager.get_by_list_type(listtype)]
@view_defaults(accept='text/html')
class AtramhasisAdminView(object):
"""
This object groups HTML views part of the admin user interface.
"""
def __init__(self, request):
self.request = request
self.logged_in = request.authenticated_userid
if hasattr(request, 'skos_registry') and request.skos_registry is not None:
self.skos_registry = self.request.skos_registry
else:
raise SkosRegistryNotFoundException()
@view_config(route_name='admin', renderer='atramhasis:templates/admin.jinja2', permission='edit')
def admin_view(self):
return {'admin': None}
@view_config(route_name='scheme_tree_invalidate', renderer='json', accept='application/json', permission='edit')
def invalidate_scheme_tree(self):
scheme_id = self.request.matchdict['scheme_id']
invalidate_scheme_cache(scheme_id)
return Response(status_int=200)
@view_config(route_name='tree_invalidate', renderer='json', accept='application/json', permission='edit')
def invalidate_tree(self):
invalidate_cache()
return Response(status_int=200)