from django.db.models import Q from django.core.cache import cache from django.urls import reverse from django.utils.translation import ugettext as _ from base64 import b64encode from base64 import b64decode import json from model_utils import Choices from helpdesk.serializers import DatatablesTicketSerializer def query_to_base64(query): """ Converts a query dict object to a base64-encoded bytes object. """ return b64encode(json.dumps(query).encode('UTF-8')).decode("ascii") def query_from_base64(b64data): """ Converts base64-encoded bytes object back to a query dict object. """ query = {'search_string': ''} query.update(json.loads(b64decode(b64data).decode('utf-8'))) if query['search_string'] is None: query['search_string'] = '' return query def query_to_dict(results, descriptions): """ Replacement method for cursor.dictfetchall() as that method no longer exists in psycopg2, and I'm guessing in other backends too. Converts the results of a raw SQL query into a list of dictionaries, suitable for use in templates etc. """ output = [] for data in results: row = {} i = 0 for column in descriptions: row[column[0]] = data[i] i += 1 output.append(row) return output def get_search_filter_args(search): if search.startswith('queue:'): return Q(queue__title__icontains=search[len('queue:'):]) if search.startswith('priority:'): return Q(priority__icontains=search[len('priority:'):]) filter = Q() for subsearch in search.split("OR"): subsearch = subsearch.strip() filter = ( filter | Q(id__icontains=subsearch) | Q(title__icontains=subsearch) | Q(description__icontains=subsearch) | Q(priority__icontains=subsearch) | Q(resolution__icontains=subsearch) | Q(submitter_email__icontains=subsearch) | Q(assigned_to__email__icontains=subsearch) | Q(ticketcustomfieldvalue__value__icontains=subsearch) | Q(created__icontains=subsearch) | Q(due_date__icontains=subsearch) ) return filter DATATABLES_ORDER_COLUMN_CHOICES = Choices( ('0', 'id'), ('2', 'priority'), ('3', 'title'), ('4', 'queue'), ('5', 'status'), ('6', 'created'), ('7', 'due_date'), ('8', 'assigned_to') ) def get_query_class(): from django.conf import settings def _get_query_class(): return __Query__ return getattr(settings, 'HELPDESK_QUERY_CLASS', _get_query_class)() class __Query__: def __init__(self, huser, base64query=None, query_params=None): self.huser = huser self.params = query_params if query_params else query_from_base64(base64query) self.base64 = base64query if base64query else query_to_base64(query_params) self.result = None def get_search_filter_args(self): search = self.params.get('search_string', '') return get_search_filter_args(search) def __run__(self, queryset): """ Apply a dict-based set of filters & parameters to a queryset. queryset is a Django queryset, eg MyModel.objects.all() or MyModel.objects.filter(user=request.user) params is a dictionary that contains the following: filtering: A dict of Django ORM filters, eg: {'user__id__in': [1, 3, 103], 'title__contains': 'foo'} search_string: A freetext search string sorting: The name of the column to sort by """ for key in self.params.get('filtering', {}).keys(): filter = {key: self.params['filtering'][key]} queryset = queryset.filter(**filter) queryset = queryset.filter(self.get_search_filter_args()) sorting = self.params.get('sorting', None) if sorting: sortreverse = self.params.get('sortreverse', None) if sortreverse: sorting = "-%s" % sorting queryset = queryset.order_by(sorting) return queryset def get_cache_key(self): return str(self.huser.user.pk) + ":" + self.base64 def refresh_query(self): tickets = self.huser.get_tickets_in_queues().select_related() ticket_qs = self.__run__(tickets) cache.set(self.get_cache_key(), ticket_qs, timeout=3600) return ticket_qs def get(self): # Prefilter the allowed tickets objects = cache.get(self.get_cache_key()) if objects is not None: return objects return self.refresh_query() def get_datatables_context(self, **kwargs): """ This function takes in a list of ticket objects from the views and throws it to the datatables on ticket_list.html. If a search string was entered, this function filters existing dataset on search string and returns a filtered filtered list. The `draw`, `length` etc parameters are for datatables to display meta data on the table contents. The returning queryset is passed to a Serializer called DatatablesTicketSerializer in serializers.py. """ objects = self.get() order_by = '-date_created' draw = int(kwargs.get('draw', None)[0]) length = int(kwargs.get('length', None)[0]) start = int(kwargs.get('start', None)[0]) search_value = kwargs.get('search[value]', None)[0] order_column = kwargs.get('order[0][column]', None)[0] order = kwargs.get('order[0][dir]', None)[0] order_column = DATATABLES_ORDER_COLUMN_CHOICES[order_column] # django orm '-' -> desc if order == 'desc': order_column = '-' + order_column queryset = objects.all().order_by(order_by) total = queryset.count() if search_value: queryset = queryset.filter(get_search_filter_args(search_value)) count = queryset.count() queryset = queryset.order_by(order_column)[start:start + length] return { 'data': DatatablesTicketSerializer(queryset, many=True).data, 'recordsFiltered': count, 'recordsTotal': total, 'draw': draw } def get_timeline_context(self): events = [] for ticket in self.get(): for followup in ticket.followup_set.all(): event = { 'start_date': self.mk_timeline_date(followup.date), 'text': { 'headline': ticket.title + ' - ' + followup.title, 'text': (followup.comment if followup.comment else _('No text')) + '
%s' % (reverse('helpdesk:view', kwargs={'ticket_id': ticket.pk}), _("View ticket")), }, 'group': _('Messages'), } events.append(event) return { 'events': events, } def mk_timeline_date(self, date): return { 'year': date.year, 'month': date.month, 'day': date.day, 'hour': date.hour, 'minute': date.minute, 'second': date.second, 'second': date.second, }