nk20/note/admin.py

# -*- mode: python; coding: utf-8 -*-
# Copyright (C) 2018-2019 by BDE ENS Paris-Saclay
# SPDX-License-Identifier: GPL-3.0-or-later

from django.contrib import admin

from .models.notes import Alias, Note, NoteClub, NoteSpecial, NoteUser
from .models.transactions import MembershipTransaction, Transaction, \
    TransactionTemplate


class AliasInlines(admin.TabularInline):
    """
    Define user and club aliases when editing their note
    """
    extra = 0
    model = Alias


class NoteClubAdmin(admin.ModelAdmin):
    """
    Admin customisation for NoteClub
    """
    inlines = (AliasInlines,)
    list_display = ('club', 'balance', 'is_active')
    list_filter = ('is_active',)
    search_fields = ['club__name']

    # We can't change club after creation or the balance
    readonly_fields = ('club', 'balance')

    def has_add_permission(self, request):
        """
        A club note should not be manually added
        """
        return False

    def has_delete_permission(self, request, obj=None):
        """
        A club note should not be manually removed
        """
        return False


class NoteSpecialAdmin(admin.ModelAdmin):
    """
    Admin customisation for NoteSpecial
    """
    list_display = ('special_type', 'balance', 'is_active')


class NoteUserAdmin(admin.ModelAdmin):
    """
    Admin customisation for NoteUser
    """
    inlines = (AliasInlines,)
    list_display = ('user', 'balance', 'is_active')
    list_filter = ('is_active',)
    search_fields = ['user__username']

    # Organize note by registration date
    date_hierarchy = 'user__date_joined'
    ordering = ['-user__date_joined']

    # We can't change user after creation or the balance
    readonly_fields = ('user', 'balance')

    def has_add_permission(self, request):
        """
        An user note should not be manually added
        """
        return False

    def has_delete_permission(self, request, obj=None):
        """
        An user note should not be manually removed
        """
        return False


class TransactionTemplateAdmin(admin.ModelAdmin):
    """
    Admin customisation for TransactionTemplate
    """
    list_display = ('name', 'destination', 'amount', 'template_type')
    list_filter = ('destination', 'template_type',)


# Register your models here.
admin.site.register(NoteClub, NoteClubAdmin)
admin.site.register(NoteSpecial, NoteSpecialAdmin)
admin.site.register(NoteUser, NoteUserAdmin)
admin.site.register(MembershipTransaction)
admin.site.register(Transaction)
admin.site.register(TransactionTemplate, TransactionTemplateAdmin)