-
Notifications
You must be signed in to change notification settings - Fork 1
/
views.py
944 lines (730 loc) · 37.5 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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
# -*- coding: utf-8 -*-
from dal import autocomplete
import logging
import django_rq
from django.conf import settings
from django.contrib import messages
from django.contrib.auth.decorators import login_required
from django.core.exceptions import ObjectDoesNotExist, PermissionDenied
from django.urls import reverse, reverse_lazy
from django.http import Http404, JsonResponse
from django.shortcuts import get_object_or_404
from django.utils.decorators import method_decorator
from django.views.generic import ListView
from django.views.generic.base import TemplateView, RedirectView
from django.views.generic.detail import DetailView
from django.views.generic.edit import CreateView, UpdateView, FormView, DeleteView
from django.contrib.auth.models import User
from django.contrib.auth import logout
from browser.forms import OvidMedLineFileUploadForm, PubMedFileUploadForm, TermSelectorForm, FilterForm
from browser.models import SearchCriteria, SearchResult, MeshTerm, Upload, Message
from browser.matching import perform_search
from browser.utils import delete_user_content
logger = logging.getLogger(__name__)
class HomeView(TemplateView):
template_name = "home.html"
def get_context_data(self, **kwargs):
context = super(HomeView, self).get_context_data(**kwargs)
context['active'] = 'home'
return context
class CreditsView(TemplateView):
template_name = "credits.html"
def get_context_data(self, **kwargs):
context = super(CreditsView, self).get_context_data(**kwargs)
context['active'] = 'credits'
return context
class HelpView(TemplateView):
template_name = "help.html"
def get_context_data(self, **kwargs):
context = super(HelpView, self).get_context_data(**kwargs)
context['active'] = 'help'
return context
class PrivacyPolicyView(TemplateView):
template_name = "privacy.html"
def get_context_data(self, **kwargs):
context = super(PrivacyPolicyView, self).get_context_data(**kwargs)
context['active'] = 'privacy'
return context
class SelectSearchTypeView(TemplateView):
template_name = "select_search_type.html"
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
""" Ensure user logs in before viewing the search form
"""
return super(SelectSearchTypeView, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(SelectSearchTypeView, self).get_context_data(**kwargs)
context['active'] = 'search'
context['system_messages'] = Message.objects.get_current_messages()
return context
class ReuseSearchView(TemplateView):
template_name = "reuse_search.html"
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing the reuse search list."""
return super(ReuseSearchView, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(ReuseSearchView, self).get_context_data(**kwargs)
context['active'] = 'search'
context['uploads'] = Upload.objects.filter(user_id=self.request.user.id)
context['criteria'] = SearchCriteria.objects.filter(upload__user_id=self.request.user.id).order_by('-created')
context['system_messages'] = Message.objects.get_current_messages()
return context
class SearchOvidMEDLINE(CreateView):
form_class = OvidMedLineFileUploadForm
template_name = "search.html"
def get_success_url(self):
"""Redirect to newly create search criteria tied to uploaded file."""
# Create a new SearchCriteria object
self.search_criteria = SearchCriteria(upload=self.object, mesh_terms_year_of_release=MeshTerm.get_latest_mesh_term_release_year())
self.search_criteria.save()
return reverse('exposure_selector',
kwargs={'pk': self.search_criteria.id})
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing the search form."""
return super(SearchOvidMEDLINE, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(SearchOvidMEDLINE, self).get_context_data(**kwargs)
context['active'] = 'search'
context['form_action'] = reverse('search_ovid_medline')
context['file_type'] = "Ovid MEDLINE®"
context['system_messages'] = Message.objects.get_current_messages()
return context
def get_initial(self):
return {'user': self.request.user}
def form_valid(self, form):
self.object = form.save(commit=False)
self.object.user = self.request.user
self.object.save()
return super(SearchOvidMEDLINE, self).form_valid(form)
class SearchPubMedView(SearchOvidMEDLINE):
form_class = PubMedFileUploadForm
def get_context_data(self, **kwargs):
context = super(SearchPubMedView, self).get_context_data(**kwargs)
context['file_type'] = "PubMed MEDLINE®"
context['form_action'] = reverse('search_pubmed')
context['system_messages'] = Message.objects.get_current_messages()
return context
class TermSelectorAbstractUpdateView(UpdateView):
template_name = "term_selector.html"
model = SearchCriteria
form_class = TermSelectorForm
move_type = 'progress'
# Required implementations
# type = None
# def set_terms(self, node_terms)
def get_form_kwargs(self):
kwargs = super(TermSelectorAbstractUpdateView, self).get_form_kwargs()
kwargs['request'] = self.request
kwargs['type'] = self.type
return kwargs
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing the form."""
# Prevent one user viewing data for another
scid = int(kwargs['pk'])
if SearchCriteria.objects.filter(pk=scid).exists():
sccheck = SearchCriteria.objects.get(pk=scid)
if not request.user.is_superuser and request.user.id != sccheck.upload.user.id:
raise PermissionDenied
else:
raise Http404("Not found")
self.tree_number = kwargs.get('tree_number', None)
return super(TermSelectorAbstractUpdateView, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
"""Sub class should define type, term_selector_url, term_selector_by_family_url."""
context = super(TermSelectorAbstractUpdateView, self).get_context_data(**kwargs)
context['active'] = 'search'
context['type'] = self.type
context['pre_selected_term_names'] = "; ".join(self.object.get_wcrf_input_variables(self.type))
context['json_url'] = reverse('mesh_terms_as_json_for_criteria', kwargs={'pk': self.object.id, 'type': self.type})
context['json_search_url'] = reverse("mesh_terms_search_json")
context['pre_selected'] = ",".join(self.object.get_form_codes(self.type))
return context
def form_valid(self, form):
"""Auto select any children of selected nodes."""
if form.is_valid():
cleaned_data = form.cleaned_data
if 'btn_submit' in cleaned_data:
self.move_type = cleaned_data['btn_submit']
if 'mesh_term_ids' in cleaned_data:
self.set_terms(cleaned_data['mesh_term_ids'])
return super(TermSelectorAbstractUpdateView, self).form_valid(form)
class ExposureSelector(TermSelectorAbstractUpdateView):
type = 'exposure'
def get_success_url(self):
if self.move_type in ('choose', 'replace',):
return reverse('exposure_selector', kwargs={'pk': self.object.id})
else:
return reverse('mediator_selector', kwargs={'pk': self.object.id})
def get_context_data(self, **kwargs):
context = super(ExposureSelector, self).get_context_data(**kwargs)
context['form_title'] = 'Select exposures'
context['next_type'] = 'mediators'
context['next_url'] = reverse('mediator_selector', kwargs={'pk': self.object.id})
return context
def set_terms(self, node_terms):
# NB: Any selected nodes should have all children included in selected set
self.object.exposure_terms.clear()
self.object.exposure_terms.add(*node_terms)
class MediatorSelector(TermSelectorAbstractUpdateView):
type = 'mediator'
def get_success_url(self):
if self.move_type in ('choose', 'replace',):
return reverse('mediator_selector', kwargs={'pk': self.object.id})
else:
return reverse('outcome_selector', kwargs={'pk': self.object.id})
def get_context_data(self, **kwargs):
context = super(MediatorSelector, self).get_context_data(**kwargs)
context['form_title'] = 'Select mediators'
context['next_type'] = 'outcomes'
context['next_url'] = reverse('outcome_selector', kwargs={'pk': self.object.id})
return context
def set_terms(self, node_terms):
# NB: Any selected nodes should have all children included in selected set
self.object.mediator_terms.clear()
self.object.mediator_terms.add(*node_terms)
class OutcomeSelector(TermSelectorAbstractUpdateView):
type = 'outcome'
def get_success_url(self):
if self.move_type in ('choose', 'replace',):
return reverse('outcome_selector', kwargs={'pk': self.object.id})
else:
return reverse('filter_selector', kwargs={'pk': self.object.id})
def get_context_data(self, **kwargs):
context = super(OutcomeSelector, self).get_context_data(**kwargs)
context['form_title'] = 'Select outcomes'
context['next_type'] = 'Genes and Filters'
context['next_url'] = reverse('filter_selector', kwargs={'pk': self.object.id})
return context
def set_terms(self, node_terms):
# NB: Any selected nodes should have all children included in selected set
self.object.outcome_terms.clear()
self.object.outcome_terms.add(*node_terms)
class SearchExistingUpload(RedirectView):
permanent = False
def get_redirect_url(self, *args, **kwargs):
upload = get_object_or_404(Upload, pk=kwargs['pk'])
criteria = SearchCriteria(upload=upload, mesh_terms_year_of_release=MeshTerm.get_latest_mesh_term_release_year())
criteria.save()
return reverse('exposure_selector', kwargs={'pk': criteria.pk})
class SearchExisting(RedirectView):
"""TODO: (Improvement) TMMA-139 Change to allow separate term collection reuse
Create new search criteria based on existing one and pass to
ExposureSelector view """
permanent = False
def get_redirect_url(self, *args, **kwargs):
"""Copy across existing search criteria and allow user to amend."""
original_criteria = get_object_or_404(SearchCriteria, pk=kwargs['pk'])
# NB: Need to deep copy to ensure Many to Many relationships are captured
current_year = MeshTerm.get_latest_mesh_term_release_year()
criteria_copy = SearchCriteria(upload=original_criteria.upload, mesh_terms_year_of_release=current_year)
criteria_copy.save()
criteria_copy.genes.set(original_criteria.genes.all())
original_exposures = original_criteria.exposure_terms.all()
original_mediators = original_criteria.mediator_terms.all()
original_outcomes = original_criteria.outcome_terms.all()
original_year = original_criteria.mesh_terms_year_of_release
if original_year != current_year:
messages.add_message(self.request, messages.INFO, "Converting search from MeshTerm Terms released in %s" % str(original_criteria.mesh_terms_year_of_release))
criteria_copy.exposure_terms.set(MeshTerm.convert_terms_to_current_year(original_exposures, original_year, current_year))
criteria_copy.mediator_terms.set(MeshTerm.convert_terms_to_current_year(original_mediators, original_year, current_year))
criteria_copy.outcome_terms.set(MeshTerm.convert_terms_to_current_year(original_outcomes, original_year, current_year))
# Report any differences via messages.
term_types = ('exposure', 'mediator', 'outcome', )
for term_type in term_types:
old_terms = set(getattr(criteria_copy, '%s_terms' % term_type).all().values_list("term", flat=True).order_by("term"))
new_terms = set(getattr(original_criteria, '%s_terms' % term_type).all().values_list("term", flat=True).order_by("term"))
if (old_terms != new_terms):
diff_terms = ", ".join(sorted(list(new_terms - old_terms)))
messages.add_message(self.request, messages.WARNING, "The following %s term(s) could not be translated into current MeSH Term equivalents: %s" % (term_type, diff_terms, ))
else:
criteria_copy.exposure_terms.set(original_exposures)
criteria_copy.mediator_terms.set(original_mediators)
criteria_copy.outcome_terms.set(original_outcomes)
criteria_copy.save()
return reverse('exposure_selector', kwargs={'pk': criteria_copy.pk})
class FilterSelector(UpdateView):
template_name = "filter_selector.html"
form_class = FilterForm
model = SearchCriteria
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing the form."""
# Prevent one user viewing data for another
scid = int(kwargs['pk'])
if SearchCriteria.objects.filter(pk=scid).exists():
sccheck = SearchCriteria.objects.get(pk=scid)
if not request.user.is_superuser and request.user.id != sccheck.upload.user.id:
raise PermissionDenied
else:
raise Http404("Not found")
return super(FilterSelector, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(FilterSelector, self).get_context_data(**kwargs)
context['form_title'] = 'Select a filter'
context['active'] = 'search'
context['type'] = 'filter'
return context
def form_valid(self, form):
"""Store genes and filter."""
# Save genes to search criteria
response = super(FilterSelector, self).form_valid(form)
# Create search result object and save mesh filter term
search_result = SearchResult(criteria=self.object)
mesh_filter = form.cleaned_data['mesh_filter']
search_result.mesh_filter = mesh_filter
search_result.save()
# Run the search via message queue
django_rq.enqueue(perform_search, search_result.id)
return response
def get_success_url(self):
return reverse('results_listing')
class ResultsView(TemplateView):
"""Need to define chart_js and either sankey_active or bubble_active as "active" in views"""
template_name = "results.html"
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing the results pages."""
# Prevent user viewing data for another user
self.id = int(kwargs['pk'])
if SearchResult.objects.filter(pk=self.id).exists():
self.search_result = SearchResult.objects.select_related('criteria__upload').get(pk=self.id)
if not request.user.is_superuser and request.user.id != self.search_result.criteria.upload.user.id:
raise PermissionDenied
else:
raise Http404("Not found")
return super(ResultsView, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(ResultsView, self).get_context_data(**kwargs)
context['active'] = 'results'
# TODO: (Improvment) TMMA-30 Add tabular version of results table as per PDF
context['search_result'] = self.search_result
context['json_url'] = reverse('json_data', kwargs=kwargs)
context['score_csv_url'] = reverse('count_data', kwargs=kwargs)
context['abstract_ids_csv_url'] = reverse('abstracts_data', kwargs=kwargs)
context['json_url_v1'] = reverse('json_data_v1', kwargs=kwargs)
context['score_csv_url_v1'] = reverse('count_data_v1', kwargs=kwargs)
context['abstract_ids_csv_url_v1'] = reverse('abstracts_data_v1', kwargs=kwargs)
context['json_url_v3'] = reverse('json_data_v3', kwargs=kwargs)
context['score_csv_url_v3'] = reverse('count_data_v3', kwargs=kwargs)
context['abstract_ids_csv_url_v3'] = reverse('abstracts_data_v3', kwargs=kwargs)
context['criteria_url'] = reverse('criteria', kwargs={'pk': self.search_result.criteria.id})
context['results_sankey_url'] = reverse('results', kwargs=kwargs)
context['results_bubble_url'] = reverse('results_bubble', kwargs=kwargs)
# To be overridden in sub chart type class
context['chart_js'] = ''
context['sankey_is_active'] = False
context['bubble_is_active'] = False
context['results_page_title'] = 'TeMMPo: Results'
context['system_messages'] = Message.objects.get_current_messages()
return context
class ResultsBubbleView(ResultsView):
def get_context_data(self, **kwargs):
context = super(ResultsBubbleView, self).get_context_data(**kwargs)
context['chart_js'] = 'includes/results_bubble_chart_js.html'
context['bubble_is_active'] = True
context['results_page_title'] = 'TeMMPo: Results as a Bubble chart'
return context
class ResultsSankeyView(ResultsView):
def get_context_data(self, **kwargs):
context = super(ResultsSankeyView, self).get_context_data(**kwargs)
context['chart_js'] = 'includes/results_sankey_chart_js.html'
context['sankey_is_active'] = True
context['results_page_title'] = 'TeMMPo: Results as a Sankey diagram'
return context
class ResultsListingView(ListView):
template_name = "results_listing.html"
context_object_name = "results"
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing the results listing page."""
return super(ResultsListingView, self).dispatch(request, *args, **kwargs)
def get_queryset(self):
# Ensure only listing users results and no stub search results that have not been started.
return SearchResult.objects.filter(criteria__upload__user=self.request.user).filter(has_completed=True)
def get_context_data(self, **kwargs):
context = super(ResultsListingView, self).get_context_data(**kwargs)
context['active'] = 'results'
context['unprocessed'] = SearchResult.objects.filter(criteria__upload__user=self.request.user).filter(has_completed=False).order_by("-criteria__created")
context['system_messages'] = Message.objects.get_current_messages()
return context
class CriteriaView(DetailView):
template_name = "criteria.html"
model = SearchCriteria
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing."""
# Prevent user viewing data for another user
criteria_id = int(kwargs['pk'])
try:
criteria = SearchCriteria.objects.get(pk=criteria_id)
if not request.user.is_superuser and request.user.id != criteria.upload.user.id:
raise PermissionDenied
except ObjectDoesNotExist:
raise Http404("Not found")
return super(CriteriaView, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(CriteriaView, self).get_context_data(**kwargs)
context['exposures'] = "; ".join(self.object.get_wcrf_input_variables('exposure'))
context['mediators'] = "; ".join(self.object.get_wcrf_input_variables('mediator'))
context['outcomes'] = "; ".join(self.object.get_wcrf_input_variables('outcome'))
context['genes'] = ", ".join(self.object.get_wcrf_input_variables('gene'))
context['upload'] = self.object.upload
context['reuse_criteria_url'] = reverse('edit_search', kwargs={'pk': self.object.id})
context['reuse_abstract_url'] = reverse('reuse_upload', kwargs={'pk': self.object.upload.id})
results = SearchResult.objects.filter(criteria=self.object)
if results:
context['results_sankey_url'] = reverse('results', kwargs={'pk': results[0].id})
context['results_bubble_url'] = reverse('results_bubble', kwargs={'pk': results[0].id})
return context
class CountDataView(RedirectView):
permanent = True
query_string = False
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing."""
# Prevent user viewing data for another user
# Pretty dirty but OK for now...
srid = int(kwargs['pk'])
if SearchResult.objects.filter(pk=srid).exists():
srcheck = SearchResult.objects.get(pk=srid)
if not request.user.is_superuser and request.user.id != srcheck.criteria.upload.user.id:
raise PermissionDenied
else:
raise Http404("Not found")
return super(CountDataView, self).dispatch(request, *args, **kwargs)
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL + '%s_edge.csv' % search_result.filename_stub
return url
class CountDataViewV1(CountDataView):
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL_V1 + '%s_edge.csv' % search_result.filename_stub
return url
class CountDataViewV3(CountDataView):
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL_V3 + '%s_edge.csv' % search_result.filename_stub
return url
class AbstractDataView(RedirectView):
permanent = True
query_string = False
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing."""
# Prevent user viewing data for another user
# Pretty dirty but OK for now...
srid = int(kwargs['pk'])
if SearchResult.objects.filter(pk=srid).exists():
srcheck = SearchResult.objects.get(pk=srid)
if not request.user.is_superuser and request.user.id != srcheck.criteria.upload.user.id:
raise PermissionDenied
else:
raise Http404("Not found")
return super(AbstractDataView, self).dispatch(request, *args, **kwargs)
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL + '%s_abstracts.csv' % search_result.filename_stub
return url
class AbstractDataViewV1(AbstractDataView):
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL_V1 + '%s_abstracts.csv' % search_result.filename_stub
return url
class AbstractDataViewV3(AbstractDataView):
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL_V3 + '%s_abstracts.csv' % search_result.filename_stub
return url
class JSONDataView(RedirectView):
permanent = True
query_string = False
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user logs in before viewing."""
# Prevent user viewing data for another user
# Pretty dirty but OK for now...
srid = int(kwargs['pk'])
if SearchResult.objects.filter(pk=srid).exists():
srcheck = SearchResult.objects.get(pk=srid)
if not request.user.is_superuser and request.user.id != srcheck.criteria.upload.user.id:
raise PermissionDenied
else:
raise Http404("Not found")
return super(JSONDataView, self).dispatch(request, *args, **kwargs)
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL + '%s.json' % search_result.filename_stub
return url
class JSONDataViewV1(JSONDataView):
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL_V1 + '%s.json' % search_result.filename_stub
return url
class JSONDataViewV3(JSONDataView):
def get_redirect_url(self, *args, **kwargs):
search_result = get_object_or_404(SearchResult, pk=kwargs['pk'])
url = settings.RESULTS_URL_V3 + '%s.json' % search_result.filename_stub
return url
class MeshTermsAsJSON(TemplateView):
"""Used with the JSTrees to represent MeshTerms."""
def node_to_dict(self, node):
result = {
'id': "mtid_" + str(node.id),
'text': node.term,
}
if self.selected and node in self.selected:
result['state'] = {'selected': True}
elif self.ancestor_ids and node.id in self.ancestor_ids:
# Get parent nodes to be partially shaded in trees
result['state'] = {'undetermined': True}
if node.get_descendant_count():
result['children'] = True
return result
def _get_int_id(self):
id_part = self.requested_node_id[5:]
result = ''
try:
result = int(id_part)
except ValueError:
raise Exception("Problem generating MeSH Term JSON file for %s" % self.requested_node_id)
return result
def dispatch(self, request, *args, **kwargs):
"""Return JSON tree structure of MeshTerms and selected term status."""
# When selecting root nodes # is sent; otherwise node id prefixed with mtid_
self.requested_node_id = request.GET.get('id', '#')
self.search_criteria_id = kwargs.get('pk', None)
self.type = kwargs.get('type', None)
self.selected = None
self.ancestor_ids = []
nodes = []
if self.search_criteria_id:
sc = get_object_or_404(SearchCriteria, id=self.search_criteria_id)
# TMMA-131 filter by year root node
year = sc.mesh_terms_year_of_release
if self.requested_node_id == '#':
try:
nodes = MeshTerm.get_top_level_mesh_terms(year)
except ObjectDoesNotExist:
raise Exception("Problem generating year %s MeSH Term JSON file." % year)
else:
nodes = get_object_or_404(MeshTerm, id=self._get_int_id()).get_children()
self.selected = getattr(sc, self.type + '_terms').all()
for node in self.selected:
self.ancestor_ids.extend(node.get_ancestors().values_list("id", flat=True))
dicts = []
for n in nodes:
dicts.append(self.node_to_dict(n))
return JsonResponse(dicts, safe=False)
class MeshTermsAllAsJSON(TemplateView):
"""Return MeshTerms from the most recent release recorded."""
def recursive_node_to_dict(self, node):
"""Recursive."""
node_id = "mtid_" + str(node.id)
result = {
'id': node_id,
'text': node.term,
}
children = [self.recursive_node_to_dict(c) for c in node.get_children()]
if children:
result['children'] = children
return result
def dispatch(self, request, *args, **kwargs):
"""Return JSON representation of the latest MeshTerm release."""
# TMMA-131 filter by year and return children
top_level_terms = MeshTerm.get_top_level_mesh_terms()
dicts = []
for n in top_level_terms:
dicts.append(self.recursive_node_to_dict(n))
return JsonResponse(dicts, safe=False)
class MeshTermSearchJSON(TemplateView):
"""Return MeshTerms related to a search of the most recent release recorded."""
# def node_to_dict_with_ancestors(self, node):
# nodes = node.get_ancestors(ascending=True, include_self=True)
# chain = {}
# for n in nodes:
# link = {'id': "mtid_" + str(n.id), 'text': n.term, }
# if chain:
# link['children'] = copy.copy(chain)
# elif n.get_descendant_count():
# link['children'] = True
# chain = link
# return chain
def dispatch(self, request, *args, **kwargs):
"""Support JSTree search functionality."""
search_term = request.GET.get("str", "").strip()
results = []
if search_term:
# TMMA-131 filter by year and search for term
found_terms = MeshTerm.objects.filter(year=MeshTerm.get_latest_mesh_term_release_year(), term__istartswith=search_term)
for n in found_terms:
results.extend(n.get_ancestors(include_self=True).values_list("id", flat=True)) # self.node_to_dict_with_ancestors(n)
# Remove the year filter
year_filter_term_id = MeshTerm.get_latest_mesh_term_filter_year_term().id
results = [x for x in results if x != year_filter_term_id]
results = ["mtid_%d" % x for x in results]
return JsonResponse(results, safe=False)
class DeleteSearch(DeleteView):
""" Confirm deletion of search terms and associated records"""
model = SearchResult
template_name = 'searchresult_confirm_delete.html'
success_url = reverse_lazy('results_listing')
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
""" Delete search terms """
# Check it exists
if not SearchResult.objects.filter(pk=int(kwargs['pk'])).exists():
raise PermissionDenied
result_set = SearchResult.objects.get(pk=int(kwargs['pk']))
if result_set.criteria.upload.user.id != request.user.id:
# User that owns results set is not the logged in user!
raise PermissionDenied
return super(DeleteSearch, self).dispatch(request, *args, **kwargs)
def get_context_data(self, *args, **kwargs):
context = super(DeleteSearch, self).get_context_data(*args, **kwargs)
# Check number of searches that use abstract
result_set = SearchResult.objects.get(pk = kwargs['object'].id)
upload_count = SearchResult.objects.filter(criteria__upload=result_set.criteria.upload).count()
context['delete_upload'] = True
if upload_count > 1:
context['delete_upload'] = False
return context
def form_valid(self, *args, **kwargs):
messages.add_message(self.request, messages.INFO, "Search results deleted")
logger.info('User: %s deleted search: %s' % (self.request.user.id, self.get_object().id))
return super(DeleteSearch, self).form_valid(*args, **kwargs)
class UserAccountView(TemplateView):
template_name = "user_account.html"
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
return super(UserAccountView, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(UserAccountView, self).get_context_data(**kwargs)
context['active'] = 'account'
return context
class CloseAccount(DeleteView):
""" Confirm that a user wants to close their account"""
model = User
template_name = 'user_confirm_close_account.html'
success_url = reverse_lazy('account_closed')
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
""" Check that all no user searches are still running """
# Check user matches pk
if int(kwargs['pk']) != request.user.id:
raise PermissionDenied
if request.method == 'POST':
all_user_searches = SearchResult.objects.filter(criteria__upload__user=request.user)
# Check we can delete all search results
for user_search in all_user_searches:
if not user_search.is_deletable:
# Search still running
raise PermissionDenied
return super(CloseAccount, self).dispatch(request, *args, **kwargs)
def get_context_data(self, *args, **kwargs):
context = super(CloseAccount, self).get_context_data(*args, **kwargs)
# Check that no user searches are still running
all_user_searches = SearchResult.objects.filter(criteria__upload__user=self.request.user)
context['search_still_running'] = False
# Delete searches
for user_search in all_user_searches:
if not user_search.is_deletable:
# Search still running
context['search_still_running'] = True
break
return context
def form_valid(self, *args, **kwargs):
""" When deleting a user we also need to delete all their uploads and searches """
# Find all searches and uploads
all_user_searches = SearchResult.objects.filter(criteria__upload__user=self.request.user)
total_searches = len(all_user_searches)
delete_user_content(user_id=self.request.user.id)
logger.info('User: %s closed their account and deleted %s searches' % (self.request.user.id, total_searches))
# Force logout
logout(self.request)
return super(CloseAccount, self).form_valid(*args, **kwargs)
class AccountClosedConfirmation(TemplateView):
template_name = "account_closed.html"
class UsersListingView(ListView):
template_name = "user_listing.html"
context_object_name = "user_list"
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
"""Ensure user is a super user."""
# Check super user
if (not request.user.is_superuser):
raise PermissionDenied
return super(UsersListingView, self).dispatch(request, *args, **kwargs)
def get_queryset(self):
return User.objects.all()
def get_context_data(self, **kwargs):
context = super(UsersListingView, self).get_context_data(**kwargs)
context['active'] = 'account'
return context
class DeleteUser(DeleteView):
""" Get confirmation and then delete a user"""
model = User
template_name = 'superuser_confirm_user_delete.html'
success_url = reverse_lazy('manage_users')
@method_decorator(login_required)
def dispatch(self, request, *args, **kwargs):
""" Check perms and that all no user searches are still running """
# Check requesting user is a superuser
if (not request.user.is_superuser):
raise PermissionDenied
# Check user isn't yourself
if int(kwargs['pk']) == request.user.id:
raise PermissionDenied
# Check user isn't superuser
user_to_delete = User.objects.get(id=int(kwargs['pk']))
if user_to_delete.is_superuser:
raise PermissionDenied
if request.method == 'POST':
all_user_searches = SearchResult.objects.filter(criteria__upload__user=user_to_delete)
# Delete searches
for user_search in all_user_searches:
if not user_search.is_deletable:
# Search still running
raise PermissionDenied
return super(DeleteUser, self).dispatch(request, *args, **kwargs)
def get_context_data(self, *args, **kwargs):
context = super(DeleteUser, self).get_context_data(*args, **kwargs)
# Check that no user searches are still running
user_to_delete = kwargs['object']
all_user_searches = SearchResult.objects.filter(criteria__upload__user=user_to_delete)
context['search_still_running'] = False
context['user_to_delete'] = user_to_delete.username
# Delete searches
for user_search in all_user_searches:
if not user_search.is_deletable:
# Search still running
context['search_still_running'] = True
break
return context
def form_valid(self, *args, **kwargs):
""" When deleting a user we also need to delete all their uploads and searches """
# Find all searches and uploads
user_to_delete = self.get_object()
all_user_searches = SearchResult.objects.filter(criteria__upload__user=user_to_delete)
total_searches = len(all_user_searches)
delete_user_content(user_id=user_to_delete.id)
logger.info('User: %s deleted user %s and their %s searches' % (self.request.user.id, user_to_delete.id, total_searches))
messages.add_message(self.request, messages.INFO, "User '%s' deleted" % user_to_delete.username)
return super(DeleteUser, self).form_valid(*args, **kwargs)
class MeSHTermAutocomplete(autocomplete.Select2QuerySetView):
def get_queryset(self):
if not self.request.user.is_authenticated:
return MeshTerm.objects.none()
qs = MeshTerm.objects.filter(year=MeshTerm.get_latest_mesh_term_release_year()).exclude(parent=None)
if self.q:
qs = qs.filter(term__istartswith=self.q)
return qs
def get_result_label(self, obj):
# Custom label to denote parent path so user can differentiate between duplicated MeSH terms
return '%s' % " > ".join([x.term for x in obj.get_ancestors(include_self=True) if x.parent != None])
def get_selected_result_label(self, obj):
# Only show/use MeSH term once selected
return obj.term