forked from CenterForOpenScience/osf.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathviews.py
More file actions
376 lines (290 loc) · 15.2 KB
/
views.py
File metadata and controls
376 lines (290 loc) · 15.2 KB
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
import json
from dateutil.parser import isoparse
from django.contrib import messages
from django.contrib.auth.mixins import PermissionRequiredMixin
from django.contrib.auth.models import Group
from django.core import serializers
from django.forms.models import model_to_dict
from django.http import Http404, HttpResponse, JsonResponse
from django.shortcuts import redirect
from django.urls import reverse_lazy, reverse
from django.views.generic import ListView, DetailView, View, CreateView, UpdateView, DeleteView, TemplateView
from django.views.generic.edit import FormView
from admin.base import settings
from admin.base.forms import ImportFileForm
from admin.institutions.forms import InstitutionForm, InstitutionalMetricsAdminRegisterForm
from osf.models import Institution, Node, OSFUser
from osf.metrics.utils import YearMonth
from osf.metrics.reporters import AllMonthlyReporters
from osf.management.commands.monthly_reporters_go import monthly_reporter_do
class InstitutionList(PermissionRequiredMixin, ListView):
paginate_by = 25
template_name = 'institutions/list.html'
ordering = 'name'
permission_required = 'osf.view_institution'
raise_exception = True
model = Institution
def get_queryset(self):
return Institution.objects.get_all_institutions().order_by(self.ordering)
def get_context_data(self, **kwargs):
query_set = kwargs.pop('object_list', self.object_list)
page_size = self.get_paginate_by(query_set)
paginator, page, query_set, is_paginated = self.paginate_queryset(query_set, page_size)
kwargs.setdefault('institutions', query_set)
kwargs.setdefault('page', page)
kwargs.setdefault('logohost', settings.OSF_URL)
return super().get_context_data(**kwargs)
class InstitutionDisplay(PermissionRequiredMixin, DetailView):
model = Institution
template_name = 'institutions/detail.html'
permission_required = 'osf.view_institution'
raise_exception = True
def get_object(self, queryset=None):
return Institution.objects.get_all_institutions().get(id=self.kwargs.get('institution_id'))
def get_context_data(self, *args, **kwargs):
institution = self.get_object()
institution_dict = model_to_dict(institution)
kwargs.setdefault('page_number', self.request.GET.get('page', '1'))
kwargs['institution'] = institution_dict
kwargs['cas_login_url'] = institution.cas_login_url
kwargs['logo_path'] = institution.logo_path
kwargs['banner_path'] = institution.banner_path
fields = institution_dict
kwargs['change_form'] = InstitutionForm(initial=fields)
kwargs['import_form'] = ImportFileForm()
kwargs['node_count'] = institution.nodes.count()
return kwargs
class InstitutionDetail(PermissionRequiredMixin, View):
permission_required = 'osf.view_institution'
raise_exception = True
def get(self, request, *args, **kwargs):
view = InstitutionDisplay.as_view()
return view(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
view = InstitutionChangeForm.as_view()
return view(request, *args, **kwargs)
class ImportInstitution(PermissionRequiredMixin, View):
permission_required = 'osf.change_institution'
raise_exception = True
def post(self, request, *args, **kwargs):
form = ImportFileForm(request.POST, request.FILES)
if form.is_valid():
file_str = self.parse_file(request.FILES['file'])
file_json = json.loads(file_str)
return JsonResponse(file_json[0]['fields'])
def parse_file(self, f):
parsed_file = ''
for chunk in f.chunks():
if isinstance(chunk, bytes):
chunk = chunk.decode()
parsed_file += chunk
return parsed_file
class InstitutionChangeForm(PermissionRequiredMixin, UpdateView):
template_name = 'institutions/detail.html'
permission_required = 'osf.change_institution'
raise_exception = True
model = Institution
form_class = InstitutionForm
def get_object(self, queryset=None):
provider_id = self.kwargs.get('institution_id')
return Institution.objects.get_all_institutions().get(id=provider_id)
def get_context_data(self, *args, **kwargs):
kwargs['import_form'] = ImportFileForm()
return super().get_context_data(*args, **kwargs)
def get_success_url(self, *args, **kwargs):
return reverse_lazy('institutions:detail', kwargs={'institution_id': self.kwargs.get('institution_id')})
class InstitutionExport(PermissionRequiredMixin, View):
permission_required = 'osf.view_institution'
raise_exception = True
def get(self, request, *args, **kwargs):
institution = Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id'])
data = serializers.serialize('json', [institution])
filename = f'{institution.name}_export.json'
response = HttpResponse(data, content_type='text/json')
response['Content-Disposition'] = f'attachment; filename={filename}'
return response
class InstitutionMonthlyReporterDo(PermissionRequiredMixin, View):
permission_required = 'osf.view_institution'
raise_exception = True
def post(self, request, *args, **kwargs):
institution_id = self.kwargs.get('institution_id')
try:
institution = Institution.objects.get_all_institutions().get(id=institution_id)
except Institution.DoesNotExist:
raise Http404(f"Institution with id {institution_id} is not found or deactivated.")
monthly_report_date = request.POST.get('monthly_report_date', None)
if monthly_report_date:
try:
monthly_report_date = isoparse(monthly_report_date).date()
except ValueError as exc:
messages.error(request, str(exc))
return redirect('institutions:detail', institution_id=institution.id)
else:
messages.error(request, 'Report date cannot be none.')
return redirect('institutions:detail', institution_id=institution.id)
monthly_reporter_do.apply_async(kwargs={
'yearmonth': str(YearMonth.from_date(monthly_report_date)),
'reporter_key': request.POST.get('monthly_reporter', None),
'report_kwargs': {'institution_pk': institution.id},
})
messages.success(request, 'Monthly reporter successfully went.')
return redirect('institutions:detail', institution_id=institution.id)
class CreateInstitution(PermissionRequiredMixin, CreateView):
permission_required = 'osf.change_institution'
raise_exception = True
template_name = 'institutions/create.html'
success_url = reverse_lazy('institutions:list')
model = Institution
form_class = InstitutionForm
def get_context_data(self, *args, **kwargs):
kwargs['import_form'] = ImportFileForm()
return super().get_context_data(*args, **kwargs)
def form_valid(self, form):
response = super().form_valid(form)
# Make a report after Institution is created
monthly_reporter_do.apply_async(kwargs={
'yearmonth': str(YearMonth.from_date(self.object.created)),
'reporter_key': AllMonthlyReporters.INSTITUTIONAL_SUMMARY.name,
'report_kwargs': {'institution_pk': self.object.id},
})
return response
class InstitutionNodeList(PermissionRequiredMixin, ListView):
template_name = 'institutions/node_list.html'
paginate_by = 25
ordering = 'modified'
permission_required = 'osf.view_node'
raise_exception = True
model = Node
def get_queryset(self):
inst = self.kwargs['institution_id']
return Node.objects.filter(affiliated_institutions=inst).order_by(self.ordering)
def get_context_data(self, **kwargs):
query_set = kwargs.pop('object_list', self.object_list)
page_size = self.get_paginate_by(query_set)
paginator, page, query_set, is_paginated = self.paginate_queryset(query_set, page_size)
kwargs.setdefault('nodes', query_set)
kwargs.setdefault('institution', Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id']))
kwargs.setdefault('page', page)
kwargs.setdefault('logohost', settings.OSF_URL)
return super().get_context_data(**kwargs)
class InstitutionAdminAndModeratorBaseView(PermissionRequiredMixin, ListView):
permission_required = 'osf.change_institution'
template_name = 'institutions/edit_admins.html'
raise_exception = True
def get_queryset(self):
return Institution.objects.get(id=self.kwargs['institution_id'])
def get_context_data(self, **kwargs):
institution = Institution.objects.get(id=self.kwargs['institution_id'])
context = super().get_context_data(**kwargs)
admin_group = Group.objects.filter(name=f'institution_{institution._id}_institutional_admins').first()
context['institution'] = institution
context['admins'] = admin_group.user_set.all()
return context
class InstitutionListAndAddAdmin(InstitutionAdminAndModeratorBaseView):
def get_permission_required(self):
if self.request.method == 'GET':
return ('osf.view_institution',)
return (self.permission_required,)
def post(self, request, *args, **kwargs):
institution = Institution.objects.get(id=self.kwargs['institution_id'])
data = dict(request.POST)
del data['csrfmiddlewaretoken'] # just to remove the key from the form dict
target_user = OSFUser.load(data['add-admins-form'][0])
if target_user is None:
messages.error(request, f'User for guid: {data["add-admins-form"][0]} could not be found')
return redirect('institutions:list_and_add_admin', institution_id=institution.id)
admin_group = Group.objects.filter(name=f'institution_{institution._id}_institutional_admins').first()
admin_group.user_set.add(target_user)
messages.success(request, f'The following admin was successfully added: {target_user.fullname} ({target_user.username})')
return redirect('institutions:list_and_add_admin', institution_id=institution.id)
class InstitutionRemoveAdmin(InstitutionAdminAndModeratorBaseView):
def post(self, request, *args, **kwargs):
institution = Institution.objects.get(id=self.kwargs['institution_id'])
data = dict(request.POST)
del data['csrfmiddlewaretoken'] # just to remove the key from the form dict
to_be_removed = list(data.keys())
removed_admins = [admin.replace('Admin-', '') for admin in to_be_removed if 'Admin-' in admin]
admins = OSFUser.objects.filter(id__in=removed_admins)
admin_group = Group.objects.filter(name=f'institution_{institution._id}_institutional_admins').first()
admin_group.user_set.remove(*admins)
if admins:
admin_names = ' ,'.join(admins.values_list('fullname', flat=True))
messages.success(request, f'The following admins were successfully removed: {admin_names}')
return redirect('institutions:list_and_add_admin', institution_id=institution.id)
class DeleteInstitution(PermissionRequiredMixin, DeleteView):
permission_required = 'osf.delete_institution'
raise_exception = True
template_name = 'institutions/confirm_delete.html'
success_url = reverse_lazy('institutions:list')
def delete(self, request, *args, **kwargs):
institution = Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id'])
if institution.nodes.count() > 0:
return redirect('institutions:cannot_delete', institution_id=institution.pk)
return super().delete(request, *args, **kwargs)
def get(self, request, *args, **kwargs):
institution = Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id'])
if institution.nodes.count() > 0:
return redirect('institutions:cannot_delete', institution_id=institution.pk)
return super().get(request, *args, **kwargs)
def get_object(self, queryset=None):
institution = Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id'])
return institution
class DeactivateInstitution(PermissionRequiredMixin, UpdateView):
template_name = 'institutions/confirm_deactivate.html'
permission_required = 'osf.change_institution'
raise_exception = True
model = Institution
form_class = InstitutionForm
def get_object(self, queryset=None):
return Institution.objects.get_all_institutions().get(id=self.kwargs.get('institution_id'))
def post(self, request, *args, **kwargs):
institution = self.get_object()
institution.deactivate()
return redirect('institutions:detail', institution_id=institution.id)
class ReactivateInstitution(PermissionRequiredMixin, UpdateView):
template_name = 'institutions/confirm_reactivate.html'
permission_required = 'osf.change_institution'
raise_exception = True
model = Institution
form_class = InstitutionForm
def get_object(self, queryset=None):
return Institution.objects.get_all_institutions().get(id=self.kwargs.get('institution_id'))
def post(self, request, *args, **kwargs):
institution = self.get_object()
institution.reactivate()
return redirect('institutions:detail', institution_id=institution.id)
class CannotDeleteInstitution(TemplateView):
template_name = 'institutions/cannot_delete.html'
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['institution'] = Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id'])
return context
class InstitutionalMetricsAdminRegister(PermissionRequiredMixin, FormView):
permission_required = 'osf.change_institution'
raise_exception = True
template_name = 'institutions/register_institutional_admin.html'
form_class = InstitutionalMetricsAdminRegisterForm
def get_form_kwargs(self):
kwargs = super().get_form_kwargs()
kwargs['institution_id'] = self.kwargs['institution_id']
return kwargs
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
context['institution_name'] = Institution.objects.get_all_institutions().get(id=self.kwargs['institution_id']).name
return context
def form_valid(self, form):
kwargs = self.get_form_kwargs()
user_id = form.cleaned_data.get('user_id')
osf_user = OSFUser.load(user_id)
institution_id = kwargs['institution_id']
target_institution = Institution.objects.filter(id=institution_id).first()
if not osf_user:
raise Http404(f'OSF user with id "{user_id}" not found. Please double check.')
group = Group.objects.filter(name=f'institution_{target_institution._id}_institutional_admins').first()
group.user_set.add(osf_user)
group.save()
osf_user.save()
messages.success(self.request, f'Permissions update successful for OSF User {osf_user.username}!')
return super().form_valid(form)
def get_success_url(self):
return reverse('institutions:register_metrics_admin', kwargs={'institution_id': self.kwargs['institution_id']})