extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2025-03-03 09:41:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #801 from koriaf/master

Browse Source 
fix<public>: Public ticket creation form improvements
This commit is contained in:
Garret Wassermann 2020-02-06 15:50:33 -05:00 committed by GitHub
commit 4236c649c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 82 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
helpdesk/forms.py
View File

@ -6,11 +6,10 @@ django-helpdesk - A Django powered ticket tracker for small enterprise.
forms.py - Definitions of newforms-based forms for creating and maintaining forms.py - Definitions of newforms-based forms for creating and maintaining
tickets. tickets.
""" """
import logging
from django.core.exceptions import ObjectDoesNotExist from django.core.exceptions import ObjectDoesNotExist
from django import forms from django import forms
from django.forms import widgets
from django.conf import settings from django.conf import settings
from django.utils.translation import ugettext_lazy as _ from django.utils.translation import ugettext_lazy as _
from django.contrib.auth import get_user_model from django.contrib.auth import get_user_model
@ -21,6 +20,7 @@ from helpdesk.models import (Ticket, Queue, FollowUp, IgnoreEmail, TicketCC,
CustomField, TicketCustomFieldValue, TicketDependency, UserSettings, KBItem) CustomField, TicketCustomFieldValue, TicketDependency, UserSettings, KBItem)
from helpdesk import settings as helpdesk_settings from helpdesk import settings as helpdesk_settings
logger = logging.getLogger(__name__)
User = get_user_model() User = get_user_model()
CUSTOMFIELD_TO_FIELD_DICT = { CUSTOMFIELD_TO_FIELD_DICT = {
@ -158,7 +158,7 @@ class AbstractTicketForm(CustomFieldMixin, forms.Form):
widget=forms.Select(attrs={'class': 'form-control'}), widget=forms.Select(attrs={'class': 'form-control'}),
choices=Ticket.PRIORITY_CHOICES, choices=Ticket.PRIORITY_CHOICES,
required=True, required=True,
initial='3', initial=getattr(settings, 'HELPDESK_PUBLIC_TICKET_PRIORITY', '3'),
label=_('Priority'), label=_('Priority'),
help_text=_("Please select a priority carefully. If unsure, leave it as '3'."), help_text=_("Please select a priority carefully. If unsure, leave it as '3'."),
) )
@ -203,25 +203,32 @@ class AbstractTicketForm(CustomFieldMixin, forms.Form):
self.customfield_to_field(field, instanceargs) self.customfield_to_field(field, instanceargs)
def _get_queue(self): def _get_queue(self):
# this procedure is re-defined for anon submission form # this procedure is re-defined for public submission form
return Queue.objects.get(id=int(self.cleaned_data['queue'])) return Queue.objects.get(id=int(self.cleaned_data['queue']))
def _create_ticket(self): def _create_ticket(self):
queue = Queue.objects.get(id=int(self.cleaned_data['queue'])) queue = self._get_queue()
kbitem = None kbitem = None
if 'kbitem' in self.cleaned_data: if 'kbitem' in self.cleaned_data:
kbitem = KBItem.objects.get(id=int(self.cleaned_data['kbitem'])) kbitem = KBItem.objects.get(id=int(self.cleaned_data['kbitem']))
ticket = Ticket(title=self.cleaned_data['title'], ticket = Ticket(
submitter_email=self.cleaned_data['submitter_email'], title=self.cleaned_data['title'],
created=timezone.now(), submitter_email=self.cleaned_data['submitter_email'],
status=Ticket.OPEN_STATUS, created=timezone.now(),
queue=queue, status=Ticket.OPEN_STATUS,
description=self.cleaned_data['body'], queue=queue,
priority=self.cleaned_data['priority'], description=self.cleaned_data['body'],
due_date=self.cleaned_data['due_date'], priority=self.cleaned_data.get(
kbitem=kbitem, 'priority',
) getattr(settings, "HELPDESK_PUBLIC_TICKET_PRIORITY", "3")
),
due_date=self.cleaned_data.get(
'due_date',
getattr(settings, "HELPDESK_PUBLIC_TICKET_DUE_DATE", None)
) or None,
kbitem=kbitem,
)
return ticket, queue return ticket, queue
@ -281,7 +288,11 @@ class TicketForm(AbstractTicketForm):
'updates to this ticket.'), 'updates to this ticket.'),
) )
assigned_to = forms.ChoiceField( assigned_to = forms.ChoiceField(
widget=forms.Select(attrs={'class': 'form-control'}) if not helpdesk_settings.HELPDESK_CREATE_TICKET_HIDE_ASSIGNED_TO else forms.HiddenInput(), widget=(
forms.Select(attrs={'class': 'form-control'})
if not helpdesk_settings.HELPDESK_CREATE_TICKET_HIDE_ASSIGNED_TO
else forms.HiddenInput()
),
required=False, required=False,
label=_('Case owner'), label=_('Case owner'),
help_text=_('If you select an owner other than yourself, they\'ll be ' help_text=_('If you select an owner other than yourself, they\'ll be '
@ -364,15 +375,42 @@ class PublicTicketForm(AbstractTicketForm):
'due_date': 'HELPDESK_PUBLIC_TICKET_DUE_DATE', 'due_date': 'HELPDESK_PUBLIC_TICKET_DUE_DATE',
} }
for field in self.fields.keys(): for field_name, field_setting_key in field_hide_table.items():
setting = field_hide_table.get(field, None) has_settings_default_value = getattr(settings, field_setting_key, None)
if (setting and hasattr(settings, setting)) or field in hidden_fields: if has_settings_default_value is not None:
self.fields[field].widget = forms.HiddenInput() hidden_fields += (field_name,)
if field in readonly_fields:
self.fields[field].disabled = True
self.fields['queue'].choices = [('', '--------')] + [ for field in hidden_fields:
(q.id, q.title) for q in Queue.objects.filter(allow_public_submission=True)] if field in self.fields:
del self.fields[field]
public_queues = Queue.objects.filter(allow_public_submission=True)
if len(public_queues) == 0:
logger.warning(
"There are no public queues defined - public ticket creation is impossible"
)
if 'queue' in self.fields:
self.fields['queue'].choices = [('', '--------')] + [
(q.id, q.title) for q in public_queues]
def _get_queue(self):
if getattr(settings, 'HELPDESK_PUBLIC_TICKET_QUEUE', None) is not None:
# force queue to be the pre-defined one
# (only for public submissions)
public_queue = Queue.objects.filter(
slug=settings.HELPDESK_PUBLIC_TICKET_QUEUE
).first()
if not public_queue:
logger.fatal(
"Public queue '%s' is configured as default but can't be found",
settings.HELPDESK_PUBLIC_TICKET_QUEUE
)
return public_queue
else:
# get the queue user entered
return Queue.objects.get(id=int(self.cleaned_data['queue']))
def save(self): def save(self):
""" """

27
helpdesk/views/public.py
View File

@ -6,9 +6,13 @@ django-helpdesk - A Django powered ticket tracker for small enterprise.
views/public.py - All public facing views, eg non-staff (no authentication views/public.py - All public facing views, eg non-staff (no authentication
required) views. required) views.
""" """
from django.core.exceptions import ObjectDoesNotExist, PermissionDenied import logging
from django.core.exceptions import (
ObjectDoesNotExist, PermissionDenied, ImproperlyConfigured,
)
from django.urls import reverse from django.urls import reverse
from django.http import HttpResponseRedirect, HttpResponse from django.http import HttpResponseRedirect
from django.shortcuts import render from django.shortcuts import render
from django.utils.http import urlquote from django.utils.http import urlquote
from django.utils.translation import ugettext as _ from django.utils.translation import ugettext as _
@ -26,6 +30,8 @@ from helpdesk.forms import PublicTicketForm
from helpdesk.lib import text_is_spam from helpdesk.lib import text_is_spam
from helpdesk.models import CustomField, Ticket, Queue, UserSettings, KBCategory, KBItem from helpdesk.models import CustomField, Ticket, Queue, UserSettings, KBCategory, KBItem
logger = logging.getLogger(__name__)
def create_ticket(request, *args, **kwargs): def create_ticket(request, *args, **kwargs):
if is_helpdesk_staff(request.user): if is_helpdesk_staff(request.user):
@ -55,16 +61,22 @@ class BaseCreateTicketView(abstract_views.AbstractCreateTicketMixin, FormView):
return super().dispatch(*args, **kwargs) return super().dispatch(*args, **kwargs)
def get_initial(self): def get_initial(self):
request = self.request
initial_data = super().get_initial() initial_data = super().get_initial()
# add pre-defined data for public ticket # add pre-defined data for public ticket
if hasattr(settings, 'HELPDESK_PUBLIC_TICKET_QUEUE'): if hasattr(settings, 'HELPDESK_PUBLIC_TICKET_QUEUE'):
# get the requested queue; return an error if queue not found # get the requested queue; return an error if queue not found
try: try:
initial_data['queue'] = Queue.objects.get(slug=settings.HELPDESK_PUBLIC_TICKET_QUEUE).id initial_data['queue'] = Queue.objects.get(
except Queue.DoesNotExist: slug=settings.HELPDESK_PUBLIC_TICKET_QUEUE,
return HttpResponse(status=500) allow_public_submission=True
).id
except Queue.DoesNotExist as e:
logger.fatal(
"Public queue '%s' is configured as default but can't be found",
settings.HELPDESK_PUBLIC_TICKET_QUEUE
)
raise ImproperlyConfigured("Wrong public queue configuration") from e
if hasattr(settings, 'HELPDESK_PUBLIC_TICKET_PRIORITY'): if hasattr(settings, 'HELPDESK_PUBLIC_TICKET_PRIORITY'):
initial_data['priority'] = settings.HELPDESK_PUBLIC_TICKET_PRIORITY initial_data['priority'] = settings.HELPDESK_PUBLIC_TICKET_PRIORITY
if hasattr(settings, 'HELPDESK_PUBLIC_TICKET_DUE_DATE'): if hasattr(settings, 'HELPDESK_PUBLIC_TICKET_DUE_DATE'):
@ -73,7 +85,8 @@ class BaseCreateTicketView(abstract_views.AbstractCreateTicketMixin, FormView):
def get_form_kwargs(self, *args, **kwargs): def get_form_kwargs(self, *args, **kwargs):
kwargs = super().get_form_kwargs(*args, **kwargs) kwargs = super().get_form_kwargs(*args, **kwargs)
kwargs['hidden_fields'] = self.request.GET.get('_hide_fields_', '').split(',') if '_hide_fields_' in self.request.GET:
kwargs['hidden_fields'] = self.request.GET.get('_hide_fields_', '').split(',')
kwargs['readonly_fields'] = self.request.GET.get('_readonly_fields_', '').split(',') kwargs['readonly_fields'] = self.request.GET.get('_readonly_fields_', '').split(',')
return kwargs return kwargs