django-orchestra/orchestra/contrib/accounts/admin.py

345 lines
14 KiB
Python
Raw Normal View History

2014-10-20 15:51:24 +00:00
import copy
import re
2015-04-05 10:46:24 +00:00
from urllib.parse import parse_qsl
2014-10-20 15:51:24 +00:00
2014-05-08 16:59:35 +00:00
from django import forms
from django.conf.urls import patterns, url
from django.contrib import admin, messages
from django.contrib.admin.util import unquote
from django.contrib.auth import admin as auth
2014-05-08 16:59:35 +00:00
from django.http import HttpResponseRedirect
from django.utils.safestring import mark_safe
from django.utils.translation import ugettext_lazy as _
2014-10-06 14:57:02 +00:00
from orchestra.admin import ExtendedModelAdmin, ChangePasswordAdminMixin
from orchestra.admin.actions import SendEmail
from orchestra.admin.utils import wrap_admin_view, admin_link, set_url_query, change_url
from orchestra.core import services, accounts
2014-10-06 14:57:02 +00:00
from orchestra.forms import UserChangeForm
2014-05-08 16:59:35 +00:00
2015-04-04 17:44:07 +00:00
from .actions import disable, list_contacts, service_report, delete_related_services
2014-05-08 16:59:35 +00:00
from .filters import HasMainUserListFilter
2014-10-06 14:57:02 +00:00
from .forms import AccountCreationForm
2014-05-08 16:59:35 +00:00
from .models import Account
2014-10-06 14:57:02 +00:00
class AccountAdmin(ChangePasswordAdminMixin, auth.UserAdmin, ExtendedModelAdmin):
2014-11-09 10:16:07 +00:00
list_display = ('username', 'full_name', 'type', 'is_active')
2014-05-08 16:59:35 +00:00
list_filter = (
'type', 'is_active', HasMainUserListFilter
)
add_fieldsets = (
(_("User"), {
'fields': ('username', 'password1', 'password2',),
}),
(_("Personal info"), {
2014-10-27 14:31:04 +00:00
'fields': ('short_name', 'full_name', 'email', ('type', 'language'), 'comments'),
}),
(_("Permissions"), {
2014-09-30 14:46:29 +00:00
'fields': ('is_superuser',)
2014-05-08 16:59:35 +00:00
}),
)
fieldsets = (
(_("User"), {
2014-10-24 10:16:46 +00:00
'fields': ('username', 'password', 'main_systemuser_link')
}),
(_("Personal info"), {
2014-10-27 14:31:04 +00:00
'fields': ('short_name', 'full_name', 'email', ('type', 'language'), 'comments'),
2014-05-08 16:59:35 +00:00
}),
(_("Permissions"), {
'fields': ('is_superuser', 'is_active')
}),
(_("Important dates"), {
2014-09-30 14:46:29 +00:00
'classes': ('collapse',),
'fields': ('last_login', 'date_joined')
2014-05-08 16:59:35 +00:00
}),
)
2014-11-09 10:16:07 +00:00
search_fields = ('username', 'short_name', 'full_name')
2014-05-08 16:59:35 +00:00
add_form = AccountCreationForm
2014-10-06 14:57:02 +00:00
form = UserChangeForm
filter_horizontal = ()
2014-10-24 10:16:46 +00:00
change_readonly_fields = ('username', 'main_systemuser_link')
2014-08-22 11:28:46 +00:00
change_form_template = 'admin/accounts/account/change_form.html'
2015-04-04 17:44:07 +00:00
actions = [disable, list_contacts, service_report, SendEmail(), delete_related_services]
2014-11-21 17:18:59 +00:00
change_view_actions = [disable, service_report]
2014-10-23 15:38:46 +00:00
list_select_related = ('billcontact',)
2014-11-09 10:16:07 +00:00
ordering = ()
2014-05-08 16:59:35 +00:00
2014-10-24 10:16:46 +00:00
main_systemuser_link = admin_link('main_systemuser')
2014-05-08 16:59:35 +00:00
def formfield_for_dbfield(self, db_field, **kwargs):
""" Make value input widget bigger """
if db_field.name == 'comments':
kwargs['widget'] = forms.Textarea(attrs={'cols': 70, 'rows': 4})
return super(AccountAdmin, self).formfield_for_dbfield(db_field, **kwargs)
def change_view(self, request, object_id, form_url='', extra_context=None):
if request.method == 'GET':
account = self.get_object(request, unquote(object_id))
if not account.is_active:
messages.warning(request, 'This account is disabled.')
context = {
'services': sorted(
2015-04-05 10:46:24 +00:00
[model._meta for model in services.get() if model is not Account],
2014-05-08 16:59:35 +00:00
key=lambda i: i.verbose_name_plural.lower()
),
'accounts': sorted(
2015-04-05 10:46:24 +00:00
[model._meta for model in accounts.get() if model is not Account],
key=lambda i: i.verbose_name_plural.lower()
2014-05-08 16:59:35 +00:00
)
}
context.update(extra_context or {})
return super(AccountAdmin, self).change_view(request, object_id,
form_url=form_url, extra_context=context)
2014-10-20 15:51:24 +00:00
def get_fieldsets(self, request, obj=None):
fieldsets = super(AccountAdmin, self).get_fieldsets(request, obj)
2014-10-20 15:51:24 +00:00
if not obj:
fields = AccountCreationForm.create_related_fields
if fields:
fieldsets = copy.deepcopy(fieldsets)
fieldsets = list(fieldsets)
fieldsets.insert(1, (_("Related services"), {'fields': fields}))
return fieldsets
def save_model(self, request, obj, form, change):
if not change:
2014-10-24 10:16:46 +00:00
form.save_model(obj)
2014-10-20 15:51:24 +00:00
form.save_related(obj)
2014-10-24 10:16:46 +00:00
else:
super(AccountAdmin, self).save_model(request, obj, form, change)
2014-05-08 16:59:35 +00:00
admin.site.register(Account, AccountAdmin)
class AccountListAdmin(AccountAdmin):
""" Account list to allow account selection when creating new services """
2014-11-09 10:16:07 +00:00
list_display = ('select_account', 'username', 'type', 'username')
2014-05-08 16:59:35 +00:00
actions = None
def select_account(self, instance):
# TODO get query string from request.META['QUERY_STRING'] to preserve filters
2014-05-08 16:59:35 +00:00
context = {
'url': '../?account=' + str(instance.pk),
'name': instance.username
2014-05-08 16:59:35 +00:00
}
return '<a href="%(url)s">%(name)s</a>' % context
select_account.short_description = _("account")
select_account.allow_tags = True
select_account.order_admin_field = 'username'
2014-05-08 16:59:35 +00:00
def changelist_view(self, request, extra_context=None):
original_app_label = request.META['PATH_INFO'].split('/')[-5]
original_model = request.META['PATH_INFO'].split('/')[-4]
context = {
'title': _("Select account for adding a new %s") % (original_model),
'original_app_label': original_app_label,
'original_model': original_model,
}
context.update(extra_context or {})
return super(AccountListAdmin, self).changelist_view(request,
extra_context=context)
class AccountAdminMixin(object):
""" Provide basic account support to ModelAdmin and AdminInline classes """
readonly_fields = ('account_link',)
filter_by_account_fields = []
change_list_template = 'admin/accounts/account/change_list.html'
change_form_template = 'admin/accounts/account/change_form.html'
2014-10-03 14:02:11 +00:00
account = None
2014-10-23 15:38:46 +00:00
list_select_related = ('account',)
2014-05-08 16:59:35 +00:00
def display_active(self, instance):
if not instance.is_active:
return '<img src="/static/admin/img/icon-no.gif" alt="False">'
elif not instance.account.is_active:
msg = _("Account disabled")
return '<img src="/static/admin/img/icon-unknown.gif" alt="False" title="%s">' % msg
return '<img src="/static/admin/img/icon-yes.gif" alt="True">'
display_active.short_description = _("active")
display_active.allow_tags = True
display_active.admin_order_field = 'is_active'
2014-05-08 16:59:35 +00:00
def account_link(self, instance):
account = instance.account if instance.pk else self.account
2014-09-18 15:07:39 +00:00
url = change_url(account)
2014-09-14 09:52:45 +00:00
return '<a href="%s">%s</a>' % (url, str(account))
2014-05-08 16:59:35 +00:00
account_link.short_description = _("account")
account_link.allow_tags = True
account_link.admin_order_field = 'account__username'
2014-05-08 16:59:35 +00:00
2015-03-27 19:50:54 +00:00
def get_form(self, request, obj=None, **kwargs):
""" Warns user when object's account is disabled """
2015-03-27 19:50:54 +00:00
form = super(AccountAdminMixin, self).get_form(request, obj, **kwargs)
try:
2015-03-27 19:50:54 +00:00
field = form.base_fields['is_active']
except KeyError:
pass
else:
help_text = (
"Designates whether this account should be treated as active. "
"Unselect this instead of deleting accounts."
)
if obj and not obj.account.is_active:
help_text += "<br><b style='color:red;'>This user's account is dissabled</b>"
field.help_text = _(help_text)
2015-03-27 19:50:54 +00:00
return form
2015-03-04 21:06:16 +00:00
def get_fields(self, request, obj=None):
""" remove account or account_link depending on the case """
fields = super(AccountAdminMixin, self).get_fields(request, obj)
fields = list(fields)
if obj is not None or getattr(self, 'account_id', None):
try:
fields.remove('account')
except ValueError:
pass
else:
try:
fields.remove('account_link')
except ValueError:
pass
return fields
2014-09-04 15:55:43 +00:00
def get_readonly_fields(self, request, obj=None):
""" provide account for filter_by_account_fields """
if obj:
self.account = obj.account
return super(AccountAdminMixin, self).get_readonly_fields(request, obj)
2014-09-04 15:55:43 +00:00
2014-05-08 16:59:35 +00:00
def formfield_for_dbfield(self, db_field, **kwargs):
""" Filter by account """
2014-05-08 16:59:35 +00:00
formfield = super(AccountAdminMixin, self).formfield_for_dbfield(db_field, **kwargs)
if db_field.name in self.filter_by_account_fields:
2014-10-03 14:02:11 +00:00
if self.account:
2014-05-08 16:59:35 +00:00
# Hack widget render in order to append ?account=id to the add url
old_render = formfield.widget.render
def render(*args, **kwargs):
output = old_render(*args, **kwargs)
output = output.replace('/add/"', '/add/?account=%s"' % self.account.pk)
2014-10-20 15:51:24 +00:00
output = re.sub(r'/add/\?([^".]*)"', r'/add/?\1&account=%s"' % self.account.pk, output)
2014-05-08 16:59:35 +00:00
return mark_safe(output)
formfield.widget.render = render
# Filter related object by account
formfield.queryset = formfield.queryset.filter(account=self.account)
2014-10-03 14:02:11 +00:00
elif db_field.name == 'account':
if self.account:
formfield.initial = self.account.pk
elif Account.objects.count() == 1:
formfield.initial = 1
2014-05-08 16:59:35 +00:00
return formfield
2015-03-23 15:36:51 +00:00
def get_formset(self, request, obj=None, **kwargs):
""" provides form.account for convinience """
formset = super(AccountAdminMixin, self).get_formset(request, obj, **kwargs)
2015-03-23 15:36:51 +00:00
formset.form.account = self.account
formset.account = self.account
return formset
def get_account_from_preserve_filters(self, request):
preserved_filters = self.get_preserved_filters(request)
preserved_filters = dict(parse_qsl(preserved_filters))
cl_filters = preserved_filters.get('_changelist_filters')
if cl_filters:
return dict(parse_qsl(cl_filters)).get('account')
def changeform_view(self, request, object_id=None, form_url='', extra_context=None):
account_id = self.get_account_from_preserve_filters(request)
if not object_id:
if account_id:
# Preselect account
set_url_query(request, 'account', account_id)
context = {
'from_account': bool(account_id),
'account': not account_id or Account.objects.get(pk=account_id),
'account_opts': Account._meta,
}
context.update(extra_context or {})
return super(AccountAdminMixin, self).changeform_view(request,
object_id=object_id, form_url=form_url, extra_context=context)
def changelist_view(self, request, extra_context=None):
account_id = request.GET.get('account')
context = {}
if account_id:
opts = self.model._meta
account = Account.objects.get(pk=account_id)
context = {
'account': not account_id or Account.objects.get(pk=account_id),
'account_opts': Account._meta,
'all_selected': True,
}
if not request.GET.get('all'):
context.update({
'all_selected': False,
'title': _("Select %s to change for %s") % (
opts.verbose_name, account.username),
})
else:
request_copy = request.GET.copy()
request_copy.pop('account')
request.GET = request_copy
context.update(extra_context or {})
return super(AccountAdminMixin, self).changelist_view(request,
extra_context=context)
2014-05-08 16:59:35 +00:00
class SelectAccountAdminMixin(AccountAdminMixin):
""" Provides support for accounts on ModelAdmin """
def get_inline_instances(self, request, obj=None):
inlines = super(AccountAdminMixin, self).get_inline_instances(request, obj)
2014-10-03 14:02:11 +00:00
if self.account:
2014-05-08 16:59:35 +00:00
account = self.account
else:
account = Account.objects.get(pk=request.GET['account'])
[ setattr(inline, 'account', account) for inline in inlines ]
return inlines
def get_urls(self):
""" Hooks select account url """
urls = super(AccountAdminMixin, self).get_urls()
admin_site = self.admin_site
opts = self.model._meta
2014-07-08 15:19:15 +00:00
info = opts.app_label, opts.model_name
2014-05-08 16:59:35 +00:00
account_list = AccountListAdmin(Account, admin_site).changelist_view
select_urls = patterns("",
url("/select-account/$",
wrap_admin_view(self, account_list),
name='%s_%s_select_account' % info),
)
return select_urls + urls
def add_view(self, request, form_url='', extra_context=None):
""" Redirects to select account view if required """
if request.user.is_superuser:
from_account_id = self.get_account_from_preserve_filters(request)
if from_account_id:
set_url_query(request, 'account', from_account_id)
account_id = request.GET.get('account')
if account_id or Account.objects.count() == 1:
2014-05-08 16:59:35 +00:00
kwargs = {}
if account_id:
kwargs = dict(pk=account_id)
2014-05-08 16:59:35 +00:00
self.account = Account.objects.get(**kwargs)
opts = self.model._meta
context = {
'title': _("Add %s for %s") % (opts.verbose_name, self.account.username),
'from_account': bool(from_account_id),
'account': self.account,
'account_opts': Account._meta,
2014-05-08 16:59:35 +00:00
}
context.update(extra_context or {})
return super(AccountAdminMixin, self).add_view(request,
form_url=form_url, extra_context=context)
return HttpResponseRedirect('./select-account/?%s' % request.META['QUERY_STRING'])
2014-05-08 16:59:35 +00:00
def save_model(self, request, obj, form, change):
"""
Given a model instance save it to the database.
"""
if not change:
obj.account_id = self.account.pk
obj.save()