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

from django import forms
from django.urls import re_path as url
from django.contrib import admin
from django.urls import reverse
from django.db import models
from django.http import HttpResponse
from django.shortcuts import get_object_or_404
from django.utils.html import format_html, strip_tags
from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _
from markdown import markdown

from orchestra.admin import ExtendedModelAdmin
from orchestra.admin.utils import admin_link, admin_colored, wrap_admin_view, admin_date
from orchestra.contrib.contacts.models import Contact

from .actions import (reject_tickets, resolve_tickets, take_tickets, close_tickets,
        mark_as_unread, mark_as_read, set_default_queue)
from .filters import MyTicketsListFilter, TicketStateListFilter
from .forms import MessageInlineForm, TicketForm
from .helpers import get_ticket_changes, markdown_formated_changes, filter_actions
from .models import Ticket, Queue, Message


PRIORITY_COLORS = {
    Ticket.HIGH: 'red',
    Ticket.MEDIUM: 'darkorange',
    Ticket.LOW: 'green',
}


STATE_COLORS = {
    Ticket.NEW: 'grey',
    Ticket.IN_PROGRESS: 'darkorange',
    Ticket.FEEDBACK: 'purple',
    Ticket.RESOLVED: 'green',
    Ticket.REJECTED: 'firebrick',
    Ticket.CLOSED: 'grey',
}


class MessageReadOnlyInline(admin.TabularInline):
    model = Message
    extra = 0
    can_delete = False
    fields = ('content_html',)
    readonly_fields = ('content_html',)

    class Media:
        css = {
            'all': ('orchestra/css/hide-inline-id.css',)
        }

    @admin.display(
        description=_("Content")
    )
    @mark_safe
    def content_html(self, msg):
        context = {
            'number': msg.number,
            'time': admin_date('created_at')(msg),
            'author': admin_link('author')(msg) if msg.author else msg.author_name,
        }
        summary = _("#%(number)i Updated by %(author)s about %(time)s") % context
        header = '<strong style="color:#666;">%s</strong><hr />' % summary

        content = markdown(msg.content)
        content = content.replace('>\n', '>')
        content = '<div style="padding-left:20px;">%s</div>' % content

        return header + content

    def has_add_permission(self, request, obj):
        return False

    def has_delete_permission(self, request, obj=None):
        return False


class MessageInline(admin.TabularInline):
    model = Message
    extra = 1
    max_num = 1
    form = MessageInlineForm
    can_delete = False
    fields = ('content',)

    def get_formset(self, request, obj=None, **kwargs):
        """ hook request.user on the inline form """
        self.form.user = request.user
        return super(MessageInline, self).get_formset(request, obj, **kwargs)

    def get_queryset(self, request):
        """ Don't show any message """
        qs = super(MessageInline, self).get_queryset(request)
        return qs.none()


class TicketInline(admin.TabularInline):
    fields = (
        'ticket_id', 'subject', 'creator_link', 'owner_link', 'colored_state',
        'colored_priority', 'created', 'updated'
    )
    readonly_fields = (
        'ticket_id', 'subject', 'creator_link', 'owner_link', 'colored_state',
        'colored_priority', 'created', 'updated'
    )
    model = Ticket
    extra = 0
    max_num = 0

    creator_link = admin_link('creator')
    owner_link = admin_link('owner')
    created = admin_link('created_at')
    updated = admin_link('updated_at')
    colored_state = admin_colored('state', colors=STATE_COLORS, bold=False)
    colored_priority = admin_colored('priority', colors=PRIORITY_COLORS, bold=False)

    @admin.display(
        description='#'
    )
    @mark_safe
    def ticket_id(self, instance):
        return '<b>%s</b>' % admin_link()(instance)


@admin.register(Ticket)
class TicketAdmin(ExtendedModelAdmin):
    list_display = (
        'unbold_id', 'bold_subject', 'display_creator', 'display_owner',
        'display_queue', 'display_priority', 'display_state', 'updated'
    )
    list_display_links = ('unbold_id', 'bold_subject')
    list_filter = (
        MyTicketsListFilter, 'queue', 'priority', TicketStateListFilter,
    )
    default_changelist_filters = (
        ('state', 'OPEN'),
    )
    date_hierarchy = 'created_at'
    search_fields = (
        'id', 'subject', 'creator__username', 'creator__email', 'queue__name',
        'owner__username'
    )
    actions = (
        mark_as_unread, mark_as_read, reject_tickets,
        resolve_tickets, close_tickets, take_tickets
    )
    sudo_actions = ('delete_selected',)
    change_view_actions = (
        resolve_tickets, close_tickets, reject_tickets, take_tickets
    )
#    change_form_template = "admin/orchestra/change_form.html"
    form = TicketForm
    add_inlines = ()
    inlines = (MessageReadOnlyInline, MessageInline)
    readonly_fields = (
        'display_summary', 'display_queue', 'display_owner', 'display_state',
        'display_priority'
    )
    readonly_fieldsets = (
        (None, {
            'fields': ('display_summary',
                       ('display_queue', 'display_owner'),
                       ('display_state', 'display_priority'),
                       'display_description')
        }),
    )
    fieldsets = readonly_fieldsets + (
        ('Update', {
            'classes': ('collapse',),
            'fields': ('subject',
                      ('queue', 'owner',),
                      ('state', 'priority'),
                       'description')
        }),
    )
    add_fieldsets = (
        (None, {
            'fields': ('subject',
                      ('queue', 'owner',),
                      ('state', 'priority'),
                      'description')
        }),
    )
    list_select_related = ('queue', 'owner', 'creator')

    class Media:
        css = {
            'all': ('issues/css/ticket-admin.css',)
        }
        js = (
            'issues/js/ticket-admin.js',
        )

    display_creator = admin_link('creator')
    display_queue = admin_link('queue')
    display_owner = admin_link('owner')
    updated = admin_date('updated_at')
    display_state = admin_colored('state', colors=STATE_COLORS, bold=False)
    display_priority = admin_colored('priority', colors=PRIORITY_COLORS, bold=False)

    @admin.display(
        description='Summary'
    )
    @mark_safe
    def display_summary(self, ticket):
        context = {
            'creator': admin_link('creator')(self, ticket) if ticket.creator else ticket.creator_name,
            'created': admin_date('created_at')(ticket),
            'updated': '',
        }
        msg = ticket.messages.last()
        if msg:
            context.update({
                'updated': admin_date('created_at')(msg),
                'updater': admin_link('author')(self, msg) if msg.author else msg.author_name,
            })
            context['updated'] = '. Updated by %(updater)s about %(updated)s' % context
        return '<h4>Added by %(creator)s about %(created)s%(updated)s</h4>' % context

    @admin.display(
        description="#",
        ordering='id',
    )
    def unbold_id(self, ticket):
        """ Unbold id if ticket is read """
        if ticket.is_read_by(self.user):
            return format_html('<span style="font-weight:normal;font-size:11px;">{}</span>', ticket.pk)
        return ticket.pk

    @admin.display(
        description=_("Subject"),
        ordering='subject',
    )
    def bold_subject(self, ticket):
        """ Bold subject when tickets are unread for request.user """
        if ticket.is_read_by(self.user):
            return ticket.subject
        return format_html("<strong class='unread'>{}</strong>", ticket.subject)

    def formfield_for_dbfield(self, db_field, **kwargs):
        """ Make value input widget bigger """
        if db_field.name == 'subject':
            kwargs['widget'] = forms.TextInput(attrs={'size':'120'})
        return super(TicketAdmin, self).formfield_for_dbfield(db_field, **kwargs)

    def save_model(self, request, obj, *args, **kwargs):
        """ Define creator for new tickets """
        if not obj.pk:
            obj.creator = request.user
        super(TicketAdmin, self).save_model(request, obj, *args, **kwargs)
        obj.mark_as_read_by(request.user)

    def get_urls(self):
        """ add markdown preview url """
        return [
            url(r'^preview/$',
                wrap_admin_view(self, self.message_preview_view))
        ] + super(TicketAdmin, self).get_urls()

    def add_view(self, request, form_url='', extra_context=None):
        """ Do not sow message inlines """
        return super(TicketAdmin, self).add_view(request, form_url, extra_context)

    def change_view(self, request, object_id, form_url='', extra_context=None):
        """ Change view actions based on ticket state """
        ticket = get_object_or_404(Ticket, pk=object_id)
        # Change view actions based on ticket state
        self.change_view_actions = filter_actions(self, ticket, request)
        if request.method == 'POST':
            # Hack: Include the ticket changes on the request.POST
            #       other approaches get really messy
            changes = get_ticket_changes(self, request, ticket)
            if changes:
                content = markdown_formated_changes(changes)
                content += request.POST['messages-2-0-content']
                request.POST['messages-2-0-content'] = content
        ticket.mark_as_read_by(request.user)
        context = {'title': "Issue #%i - %s" % (ticket.id, ticket.subject)}
        context.update(extra_context or {})
        return super(TicketAdmin, self).change_view(request, object_id, form_url=form_url,
            extra_context=context)

    def changelist_view(self, request, extra_context=None):
        # Hook user for bold_subject
        self.user = request.user
        return super(TicketAdmin,self).changelist_view(request, extra_context=extra_context)

    def message_preview_view(self, request):
        """ markdown preview render via ajax """
        data = request.POST.get("data")
        data_formated = markdown(strip_tags(data))
        return HttpResponse(data_formated)


@admin.register(Queue)
class QueueAdmin(admin.ModelAdmin):
    list_display = ('name', 'default', 'num_tickets')
    actions = (set_default_queue,)
    inlines = (TicketInline,)
    ordering = ('name',)

    class Media:
        css = {
            'all': ('orchestra/css/hide-inline-id.css',)
        }

    @admin.display(
        description=_("Tickets"),
        ordering='tickets__count',
    )
    def num_tickets(self, queue):
        num = queue.tickets__count
        url = reverse('admin:issues_ticket_changelist')
        url += '?queue=%i' % queue.pk
        return format_html('<a href="{}">{}</a>', url, num)

    def get_list_display(self, request):
        """ show notifications """
        list_display = list(self.list_display)
        for value, verbose in Contact.EMAIL_USAGES:
            def display_notify(queue, notify=value):
                return notify in queue.notify
            display_notify.short_description = verbose
            display_notify.boolean = True
            list_display.append(display_notify)
        return list_display

    def get_queryset(self, request):
        qs = super(QueueAdmin, self).get_queryset(request)
        qs = qs.annotate(models.Count('tickets'))
        return qs