/
admin.py
646 lines (548 loc) · 18.7 KB
/
admin.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
from urllib.parse import urljoin
from django import forms
from django.conf import settings
from django.contrib import admin, messages
from django.contrib.admin import ModelAdmin, StackedInline
from django.contrib.admin.utils import model_ngettext
from django.contrib.auth import get_user_model
from django.core.exceptions import PermissionDenied
from django.templatetags.static import static
from django.urls import reverse
from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _
from openwisp_users.admin import OrganizationAdmin, UserAdmin
from openwisp_users.multitenancy import MultitenantAdminMixin, MultitenantOrgFilter
from openwisp_utils.admin import (
AlwaysHasChangedMixin,
ReadOnlyAdmin,
TimeReadonlyAdminMixin,
)
from . import settings as app_settings
from .base.admin_filters import RegisteredUserFilter
from .base.forms import ModeSwitcherForm, RadiusBatchForm
from .settings import RADIUS_API_BASEURL, RADIUS_API_URLCONF
from .utils import load_model
Nas = load_model('Nas')
RadiusAccounting = load_model('RadiusAccounting')
RadiusToken = load_model('RadiusToken')
RadiusBatch = load_model('RadiusBatch')
RadiusCheck = load_model('RadiusCheck')
RadiusGroup = load_model('RadiusGroup')
RadiusPostAuth = load_model('RadiusPostAuth')
RadiusReply = load_model('RadiusReply')
PhoneToken = load_model('PhoneToken')
RadiusGroupCheck = load_model('RadiusGroupCheck')
RadiusGroupReply = load_model('RadiusGroupReply')
RadiusUserGroup = load_model('RadiusUserGroup')
RegisteredUser = load_model('RegisteredUser')
OrganizationRadiusSettings = load_model('OrganizationRadiusSettings')
User = get_user_model()
OPTIONAL_SETTINGS = app_settings.OPTIONAL_REGISTRATION_FIELDS
class OrganizationFirstMixin(MultitenantAdminMixin):
def get_fields(self, request, obj=None):
fields = super().get_fields(request, obj=None)
fields.remove('organization')
fields.insert(0, 'organization')
return fields
class TimeStampedEditableAdmin(TimeReadonlyAdminMixin, ModelAdmin):
ordering = ['created']
class AlwaysHasChangedForm(AlwaysHasChangedMixin, forms.ModelForm):
pass
@admin.register(RadiusCheck)
class RadiusCheckAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
form = ModeSwitcherForm
list_display = [
'username',
'organization',
'attribute',
'op',
'value',
'created',
'modified',
]
search_fields = ['username', 'value']
list_filter = [
MultitenantOrgFilter,
'created',
'modified',
]
fields = [
'mode',
'organization',
'user',
'username',
'op',
'attribute',
'value',
'created',
'modified',
]
autocomplete_fields = ('user',)
@admin.register(RadiusReply)
class RadiusReplyAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
form = ModeSwitcherForm
list_display = [
'username',
'organization',
'attribute',
'op',
'value',
'created',
'modified',
]
list_filter = (MultitenantOrgFilter,)
fields = [
'mode',
'organization',
'user',
'username',
'attribute',
'op',
'value',
'created',
'modified',
]
autocomplete_fields = ('user',)
BaseAccounting = ReadOnlyAdmin if not app_settings.EDITABLE_ACCOUNTING else ModelAdmin
@admin.register(RadiusAccounting)
class RadiusAccountingAdmin(OrganizationFirstMixin, BaseAccounting):
list_display = [
'session_id',
'organization',
'username',
'session_time',
'input_octets',
'output_octets',
'calling_station_id',
'called_station_id',
'start_time',
'stop_time',
]
search_fields = [
'unique_id',
'username',
'calling_station_id',
'called_station_id',
'nas_ip_address',
]
list_filter = ['start_time', 'stop_time', MultitenantOrgFilter]
ordering = ['-start_time']
@admin.register(Nas)
class NasAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
fieldsets = (
(
None,
{
'fields': (
'organization',
'name',
'short_name',
'type',
'ports',
'secret',
'server',
'community',
'description',
)
},
),
)
search_fields = ['name', 'short_name', 'server']
list_display = [
'name',
'organization',
'short_name',
'type',
'secret',
'created',
'modified',
]
list_filter = (MultitenantOrgFilter,)
class RadiusGroupCheckInline(TimeReadonlyAdminMixin, StackedInline):
model = RadiusGroupCheck
exclude = ['groupname']
extra = 0
class RadiusGroupReplyInline(TimeReadonlyAdminMixin, StackedInline):
model = RadiusGroupReply
exclude = ['groupname']
extra = 0
@admin.register(RadiusGroup)
class RadiusGroupAdmin(OrganizationFirstMixin, TimeStampedEditableAdmin):
list_display = [
'get_group_name',
'organization',
'name',
'description',
'default',
'created',
'modified',
]
search_fields = ['name']
list_filter = (MultitenantOrgFilter,)
inlines = [RadiusGroupCheckInline, RadiusGroupReplyInline]
select_related = ('organization',)
def get_group_name(self, obj):
return obj.name.replace(f'{obj.organization.slug}-', '')
get_group_name.short_description = _('Group name')
def has_delete_permission(self, request, obj=None):
if not request.user.is_superuser and obj and obj.default:
return False
return super().has_delete_permission(request, obj)
def delete_selected_groups(self, request, queryset):
if self.get_default_queryset(request, queryset).exists():
msg = _(
'Cannot proceed with the delete operation because '
'the batch of items contains the default group, '
'which cannot be deleted'
)
self.message_user(request, msg, messages.ERROR)
return False
if not self.has_delete_permission(request):
raise PermissionDenied
n = queryset.count()
if n:
queryset.delete()
self.message_user(
request,
_('Successfully deleted %(count)d %(items)s.')
% {'count': n, 'items': model_ngettext(self.opts, n)},
messages.SUCCESS,
)
return None
delete_selected_groups.allowed_permissions = ('delete',)
def get_actions(self, request):
actions = super().get_actions(request)
if 'delete_selected' in actions:
del actions['delete_selected']
return actions
actions = ['delete_selected_groups']
def get_default_queryset(self, request, queryset):
"""overridable"""
return queryset.filter(default=True)
if app_settings.USERGROUP_ADMIN:
@admin.register(RadiusUserGroup)
class RadiusUserGroupAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
list_display = ['username', 'groupname', 'priority', 'created', 'modified']
autocomplete_fields = ['user', 'group']
form = ModeSwitcherForm
fields = [
'mode',
'user',
'username',
'group',
'groupname',
'priority',
'created',
'modified',
]
multitenant_parent = 'group'
class RadGroupMixin(object):
list_display = ['groupname', 'attribute', 'op', 'value', 'created', 'modified']
autocomplete_fields = ['group']
form = ModeSwitcherForm
fields = [
'mode',
'group',
'groupname',
'attribute',
'op',
'value',
'created',
'modified',
]
if app_settings.GROUPCHECK_ADMIN:
@admin.register(RadiusGroupCheck)
class RadiusGroupCheckAdmin(
MultitenantAdminMixin, RadGroupMixin, TimeStampedEditableAdmin
):
multitenant_parent = 'group'
if app_settings.GROUPREPLY_ADMIN:
@admin.register(RadiusGroupReply)
class RadiusGroupReplyAdmin(
MultitenantAdminMixin, RadGroupMixin, TimeStampedEditableAdmin
):
multitenant_parent = 'group'
BasePostAuth = ReadOnlyAdmin if not app_settings.EDITABLE_POSTAUTH else ModelAdmin
@admin.register(RadiusPostAuth)
class RadiusPostAuthAdmin(OrganizationFirstMixin, BasePostAuth):
list_display = [
'username',
'organization',
'reply',
'calling_station_id',
'called_station_id',
'date',
]
list_filter = [
'date',
'reply',
MultitenantOrgFilter,
]
search_fields = ['username', 'reply', 'calling_station_id', 'called_station_id']
exclude = ['id']
ordering = ['-date']
@admin.register(RadiusBatch)
class RadiusBatchAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
change_form_template = 'openwisp-radius/admin/rad_batch_users_change_form.html'
add_form_template = 'openwisp-radius/admin/rad_batch_users_add_form.html'
list_display = [
'name',
'organization',
'strategy',
'expiration_date',
'created',
'modified',
]
fields = [
'strategy',
'organization',
'name',
'csvfile',
'prefix',
'number_of_users',
'users',
'expiration_date',
'created',
'modified',
]
list_filter = [
'strategy',
MultitenantOrgFilter,
]
search_fields = ['name']
form = RadiusBatchForm
help_text = {
'text': _(
'Users imported or generated through this form will be flagged '
'as verified if the organization requires identity verification, '
'otherwise the generated users would not be able to log in. '
'If this organization requires identity verification, make sure '
'the identity of the users is verified before before '
'giving out the credentials.'
),
'documentation_url': (
'https://openwisp-radius.readthedocs.io/en/latest/user/importing_users.html'
),
}
class Media:
js = [
'admin/js/jquery.init.js',
'openwisp-radius/js/strategy-switcher.js',
]
css = {
'all': (
'openwisp-radius/css/radiusbatch.css',
'admin/css/help-text-stacked.css',
)
}
def number_of_users(self, obj):
return obj.users.count()
number_of_users.short_description = _('number of users')
def get_fields(self, request, obj=None):
fields = super().get_fields(request, obj)[:]
if not obj:
fields.remove('users')
return fields
def save_model(self, request, obj, form, change):
data = form.cleaned_data
strategy = data.get('strategy')
if not change:
if strategy == 'csv':
if data.get('csvfile', False):
csvfile = data.get('csvfile')
obj.csvfile_upload(csvfile)
elif strategy == 'prefix':
prefix = data.get('prefix')
n = data.get('number_of_users')
obj.prefix_add(prefix, n)
else:
obj.save()
def delete_model(self, request, obj):
obj.users.all().delete()
super(RadiusBatchAdmin, self).delete_model(request, obj)
def change_view(self, request, object_id, form_url='', extra_context=None):
extra_context = extra_context or {}
radbatch = self.get_object(request, object_id)
if radbatch is None:
# This is an internal Django method that redirects the
# user to the admin index page with a message that points
# out that the requested object does not exist.
return self._get_obj_does_not_exist_redirect(
request, self.model._meta, object_id
)
if radbatch.strategy == 'prefix':
batch_pdf_api_url = reverse(
'radius:download_rad_batch_pdf',
urlconf=RADIUS_API_URLCONF,
args=[radbatch.organization.slug, object_id],
)
if RADIUS_API_BASEURL:
batch_pdf_api_url = urljoin(RADIUS_API_BASEURL, batch_pdf_api_url)
extra_context['download_rad_batch_pdf_url'] = batch_pdf_api_url
return super().change_view(
request,
object_id,
form_url,
extra_context=extra_context,
)
def add_view(self, request, form_url='', extra_context=None):
extra_context = extra_context or {}
extra_context['help_text'] = self.help_text
return super().add_view(request, form_url, extra_context)
def get_actions(self, request):
actions = super().get_actions(request)
if 'delete_selected' in actions:
del actions['delete_selected']
return actions
actions = ['delete_selected_batches']
def delete_selected_batches(self, request, queryset):
for obj in queryset:
obj.delete()
delete_selected_batches.short_description = _('Delete selected batches')
def get_readonly_fields(self, request, obj=None):
readonly_fields = super(RadiusBatchAdmin, self).get_readonly_fields(
request, obj
)
if obj:
return (
'strategy',
'prefix',
'csvfile',
'number_of_users',
'users',
'expiration_date',
) + readonly_fields
return readonly_fields
# Inlines for UserAdmin & OrganizationAdmin
class RadiusUserGroupInline(StackedInline):
model = RadiusUserGroup
exclude = ['username', 'groupname', 'created', 'modified']
ordering = ('priority',)
autocomplete_fields = ('group',)
verbose_name = _('radius user group')
verbose_name_plural = _('radius user groups')
extra = 0
class PhoneTokenInline(TimeReadonlyAdminMixin, StackedInline):
model = PhoneToken
extra = 0
readonly_fields = ('verified', 'valid_until', 'attempts', 'phone_number', 'ip')
def has_add_permission(self, request, obj):
return False
def has_delete_permission(self, request, obj=None):
return False
def has_change_permission(self, request, obj=None):
return False
class RegisteredUserInline(StackedInline):
model = RegisteredUser
form = AlwaysHasChangedForm
extra = 0
readonly_fields = ('modified',)
def has_delete_permission(self, request, obj=None):
return False
UserAdmin.inlines.insert(0, RegisteredUserInline)
UserAdmin.inlines += [
RadiusUserGroupInline,
PhoneTokenInline,
]
UserAdmin.list_filter += (RegisteredUserFilter, 'registered_user__method')
def get_is_verified(self, obj):
try:
value = 'yes' if obj.registered_user.is_verified else 'no'
except Exception:
value = 'unknown'
icon_url = static(f'admin/img/icon-{value}.svg')
return mark_safe(f'<img src="{icon_url}" alt="{value}">')
UserAdmin.get_is_verified = get_is_verified
UserAdmin.get_is_verified.short_description = _('Verified')
UserAdmin.list_display.insert(3, 'get_is_verified')
UserAdmin.list_select_related = ('registered_user',)
class OrganizationRadiusSettingsInline(admin.StackedInline):
model = OrganizationRadiusSettings
form = AlwaysHasChangedForm
fieldsets = (
(
None,
{
'fields': (
'token',
'freeradius_allowed_hosts',
'coa_enabled',
'registration_enabled',
'saml_registration_enabled',
'social_registration_enabled',
'mac_addr_roaming_enabled',
'needs_identity_verification',
'first_name',
'last_name',
'birth_date',
'location',
'login_url',
'status_url',
'password_reset_url',
)
},
),
(
_('SMS options'),
{
'fields': (
'sms_verification',
'sms_sender',
'sms_message',
'allowed_mobile_prefixes',
'sms_cooldown',
'sms_meta_data',
),
'classes': ('org-sms-options',),
},
),
)
class Media:
js = [
'admin/js/jquery.init.js',
'openwisp-radius/js/organization-setting-inline.js',
]
OrganizationAdmin.save_on_top = True
OrganizationAdmin.inlines.insert(2, OrganizationRadiusSettingsInline)
# avoid cluttering the admin with too many models, leave only the
# minimum required to configure social login and check if it's working
if app_settings.SOCIAL_REGISTRATION_CONFIGURED:
from allauth.socialaccount.admin import SocialAccount, SocialApp, SocialAppAdmin
class SocialAccountInline(admin.StackedInline):
model = SocialAccount
extra = 0
readonly_fields = ('provider', 'uid', 'extra_data')
def has_add_permission(self, request, obj):
return False
def has_delete_permission(self, request, obj=None):
return False
UserAdmin.inlines += [SocialAccountInline]
admin.site.register(SocialApp, SocialAppAdmin)
if app_settings.USER_ADMIN_RADIUSTOKEN_INLINE:
class RadiusTokenInline(TimeReadonlyAdminMixin, admin.StackedInline):
model = RadiusToken
extra = 0
def get_exclude(self, request, obj=None):
fields = super().get_exclude(request, obj) or []
if not hasattr(obj, 'radius_token'):
return fields + ['key']
return fields
def get_formset(self, request, obj=None, **kwargs):
kwargs['widgets'] = kwargs.get('widgets', {})
kwargs['widgets'].update(
{
'key': forms.widgets.TextInput(
attrs={'class': 'readonly vTextField', 'readonly': True}
)
}
)
return super().get_formset(request, obj, **kwargs)
UserAdmin.inlines.insert(0, RadiusTokenInline)
if settings.DEBUG:
@admin.register(RadiusToken)
class RadiusTokenAdmin(MultitenantAdminMixin, TimeStampedEditableAdmin):
list_display = ['key', 'user', 'created']
fields = ['user', 'organization', 'can_auth']
ordering = ('-created',)
list_filter = [MultitenantOrgFilter]
autocomplete_fields = ('user',)