django-advanced-report-builder 1.2.9__py3-none-any.whl

advanced_report_builder/views/pie_charts.py

@@ -0,0 +1,290 @@
+import base64
+import json
+
+from crispy_forms.layout import Div
+from django.forms import BooleanField, CharField, ChoiceField
+from django.urls import reverse
+from django_menus.menu import MenuItem
+from django_modals.fields import FieldEx
+from django_modals.form_helpers import HorizontalNoEnterHelper
+from django_modals.modals import FormModal
+from django_modals.processes import PERMISSION_OFF, PROCESS_EDIT_DELETE
+from django_modals.widgets.colour_picker import ColourPickerWidget
+from django_modals.widgets.select2 import Select2Multiple
+
+from advanced_report_builder.models import PieChartReport
+from advanced_report_builder.toggle import RBToggle
+from advanced_report_builder.utils import (
+    decode_attribute,
+    encode_attribute,
+    get_report_builder_class,
+    split_attr,
+)
+from advanced_report_builder.views.charts_base import ChartBaseFieldForm, ChartBaseView
+from advanced_report_builder.views.modals_base import (
+    QueryBuilderModalBase,
+    QueryBuilderModalBaseMixin,
+)
+from advanced_report_builder.views.query_modal.mixin import MultiQueryModalMixin
+
+
+class PieChartView(ChartBaseView):
+    use_annotations = False
+
+    def dispatch(self, request, *args, **kwargs):
+        self.report = kwargs.get('report')
+        self.chart_report = self.report.piechartreport
+        return super().dispatch(request, *args, **kwargs)
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        self.table.pie_chart_report = self.chart_report
+        self.table.datatable_template = self.get_report_template()
+        context['pie_chart_report'] = self.chart_report
+        return context
+
+    def set_extra_number_field_kwargs(self, data_attr, options, multiple_index, additional_options):
+        pie_colour = None
+        if additional_options is not None:
+            pie_colour = additional_options.get('positive_colour')
+        if pie_colour is None or pie_colour == '':
+            pie_colour = data_attr.get('pie_colour') or '801C70'
+            pie_colour = self.add_colour_offset(pie_colour, multiple_index=multiple_index)
+        options.update({'colour': pie_colour})
+
+    def edit_report_menu(self, request, chart_report_id, slug_str):
+        return [
+            MenuItem(
+                f'advanced_report_builder:pie_chart_modal,pk-{chart_report_id}{slug_str}',
+                menu_display='Edit',
+                font_awesome='fas fa-pencil-alt',
+                css_classes=['btn-primary'],
+            ),
+            *self.duplicate_menu(request=request, report_id=chart_report_id),
+        ]
+
+    def get_date_field(self, index, fields, base_model, table):
+        return None
+
+
+class PieChartModal(MultiQueryModalMixin, QueryBuilderModalBase):
+    template_name = 'advanced_report_builder/charts/modal.html'
+    process = PROCESS_EDIT_DELETE
+    permission_delete = PERMISSION_OFF
+    model = PieChartReport
+    show_order_by = False
+
+    form_fields = [
+        'name',
+        'notes',
+        'report_type',
+        'report_tags',
+        'axis_value_type',
+        'style',
+        'fields',
+    ]
+
+    widgets = {'report_tags': Select2Multiple}
+
+    def form_setup(self, form, *_args, **_kwargs):
+        url = reverse(
+            'advanced_report_builder:pie_chart_field_modal',
+            kwargs={'slug': 'selector-99999-data-FIELD_INFO-report_type_id-REPORT_TYPE_ID'},
+        )
+        form.fields['notes'].widget.attrs['rows'] = 3
+        fields = [
+            'name',
+            'notes',
+            'report_type',
+            'report_tags',
+            'axis_value_type',
+            'style',
+            FieldEx(
+                'fields',
+                template='advanced_report_builder/select_column.html',
+                extra_context={'select_column_url': url, 'command_prefix': ''},
+            ),
+        ]
+        if self.object.id:
+            self.add_extra_queries(form=form, fields=fields)
+        return fields
+
+
+class PieChartFieldForm(ChartBaseFieldForm):
+    def setup_modal(self, *args, **kwargs):
+        data = json.loads(base64.b64decode(self.slug['data']))
+        report_type, base_model = self.get_report_type_details()
+
+        data_attr = split_attr(data)
+
+        self.fields['title'] = CharField(initial=data['title'])
+
+        self.fields['pie_colour'] = CharField(required=False, widget=ColourPickerWidget)
+        self.fields['pie_colour'].initial = data_attr.get('pie_colour')
+
+        self.fields['has_filter'] = BooleanField(required=False, widget=RBToggle())
+        self.fields['filter'] = CharField(required=False)
+
+        if data_attr.get('has_filter') == '1':
+            self.fields['has_filter'].initial = True
+            if 'filter' in data_attr:
+                self.fields['filter'].initial = decode_attribute(data_attr['filter'])
+
+        self.fields['multiple_columns'] = BooleanField(required=False, widget=RBToggle())
+        self.fields['append_column_title'] = BooleanField(required=False, widget=RBToggle())
+        report_builder_class = get_report_builder_class(model=base_model, report_type=report_type)
+
+        self.setup_colour_field(
+            form_fields=self.fields,
+            base_model=base_model,
+            report_builder_class=report_builder_class,
+            name='positive_colour_field',
+            data_attr=data_attr,
+            label='Pie colour field',
+        )
+
+        multiple_column_field = []
+        self._get_query_builder_foreign_key_fields(
+            base_model=base_model,
+            report_builder_class=report_builder_class,
+            fields=multiple_column_field,
+        )
+
+        self.fields['multiple_column_field'] = ChoiceField(choices=multiple_column_field, required=False)
+
+        if data_attr.get('multiple_columns') == '1':
+            self.fields['multiple_columns'].initial = True
+            self.fields['multiple_column_field'].initial = data_attr.get('multiple_column_field')
+            if data_attr.get('append_column_title') == '1':
+                self.fields['append_column_title'].initial = True
+
+        super().setup_modal(*args, **kwargs)
+
+    def get_additional_attributes(self):
+        attributes = []
+        self.get_report_type_details()
+
+        attributes.append(f'pie_colour-{self.cleaned_data["pie_colour"]}')
+
+        if self.cleaned_data['has_filter']:
+            attributes.append('has_filter-1')
+
+            if self.cleaned_data['filter']:
+                b64_filter = encode_attribute(self.cleaned_data['filter'])
+                attributes.append(f'filter-{b64_filter}')
+            if self.cleaned_data['multiple_columns']:
+                attributes.append('multiple_columns-1')
+                if self.cleaned_data['positive_colour_field']:
+                    attributes.append(f'positive_colour_field-{self.cleaned_data["positive_colour_field"]}')
+                attributes.append(f'multiple_column_field-{self.cleaned_data["multiple_column_field"]}')
+                if self.cleaned_data['append_column_title']:
+                    attributes.append('append_column_title-1')
+
+        if attributes:
+            return '-'.join(attributes)
+        return None
+
+
+class PieChartFieldModal(QueryBuilderModalBaseMixin, FormModal):
+    form_class = PieChartFieldForm
+    size = 'xl'
+    template_name = 'advanced_report_builder/charts/modal_field.html'
+    no_header_x = True
+    helper_class = HorizontalNoEnterHelper
+
+    @property
+    def modal_title(self):
+        data = json.loads(base64.b64decode(self.slug['data']))
+        return f'Edit {data["title"]}'
+
+    def form_valid(self, form):
+        selector = self.slug['selector']
+
+        _attr = form.get_additional_attributes()
+        self.add_command(
+            {
+                'function': 'set_attr',
+                'selector': f'#{selector}',
+                'attr': 'data-attr',
+                'val': _attr,
+            }
+        )
+
+        self.add_command(
+            {
+                'function': 'html',
+                'selector': f'#{selector} span',
+                'html': form.cleaned_data['title'],
+            }
+        )
+        self.add_command({'function': 'update_selection'})
+        return self.command_response('close')
+
+    # noinspection PyMethodMayBeStatic
+    def form_setup(self, form, *_args, **_kwargs):
+        form.add_trigger(
+            'has_filter',
+            'onchange',
+            [
+                {
+                    'selector': '#filter_fields_div',
+                    'values': {'checked': 'show'},
+                    'default': 'hide',
+                }
+            ],
+        )
+
+        form.add_trigger(
+            'multiple_columns',
+            'onchange',
+            [
+                {
+                    'selector': '#multiple_columns_fields_div',
+                    'values': {'checked': 'show'},
+                    'default': 'hide',
+                },
+            ],
+        )
+
+        return [
+            'title',
+            'pie_colour',
+            Div(
+                FieldEx(
+                    'has_filter',
+                    template='django_modals/fields/label_checkbox.html',
+                    field_class='col-6 input-group-sm',
+                ),
+                Div(
+                    FieldEx(
+                        'filter',
+                        template='advanced_report_builder/datatables/fields/single_query_builder.html',
+                    ),
+                    FieldEx(
+                        'multiple_columns',
+                        template='django_modals/fields/label_checkbox.html',
+                        field_class='col-6 input-group-sm',
+                    ),
+                    Div(
+                        FieldEx(
+                            'append_column_title',
+                            template='django_modals/fields/label_checkbox.html',
+                            field_class='col-6 input-group-sm',
+                        ),
+                        FieldEx('multiple_column_field'),
+                        FieldEx('positive_colour_field'),
+                        css_id='multiple_columns_fields_div',
+                    ),
+                    css_id='filter_fields_div',
+                ),
+                css_id='annotations_fields_div',
+            ),
+        ]
+
+    def ajax_get_query_builder_fields(self, **kwargs):
+        field_auto_id = kwargs['field_auto_id']
+
+        report_type_id = self.slug['report_type_id']
+        query_builder_filters = self.get_query_builder_report_type_field(report_type_id=report_type_id)
+
+        return self.command_response(f'query_builder_{field_auto_id}', data=json.dumps(query_builder_filters))

advanced_report_builder/views/query_modal/mixin.py

@@ -0,0 +1,161 @@
+from crispy_forms.layout import HTML, Div
+from django.conf import settings
+from django.forms import CharField
+from django.urls import reverse
+from django_datatables.columns import MenuColumn
+from django_datatables.widgets import DataTableReorderWidget
+from django_menus.menu import HtmlMenu, MenuItem
+
+from advanced_report_builder.models import ReportQuery
+from advanced_report_builder.utils import get_query_js
+
+
+class MultiQueryModalMixin:
+    show_order_by = True
+    show_target = False
+
+    ajax_commands = ['datatable', 'button', 'ajax']
+
+    def datatable_sort(self, **kwargs):
+        form = self.get_form()
+        widget = form.fields[kwargs['table_id'][3:]].widget
+        _model = widget.attrs['table_model']
+        current_sort = dict(_model.objects.filter(report_id=self.object.id).values_list('id', 'order'))
+        for s in kwargs['sort']:
+            if current_sort[s[1]] != s[0]:
+                o = _model.objects.get(id=s[1])
+                o.order = s[0]
+                o.save()
+        return self.command_response('null')
+
+    def get_query_slug(self, slug, **_kwargs):
+        report_type = self.get_report_type(**_kwargs)
+        show_order_by = 1 if self.show_order_by else 0
+        show_target = 1 if self.show_target else 0
+        slug += f'-report_type-{report_type}-show_order_by-{show_order_by}-show_target-{show_target}'
+        return slug
+
+    def get_report_type(self, **_kwargs):
+        return _kwargs['report_type']
+
+    def button_duplicate_query(self, **_kwargs):
+        query_id = _kwargs['query_id'][1:]
+        report_query = ReportQuery.objects.get(pk=query_id)
+        report_query_orders = report_query.reportqueryorder_set.all()
+        report_query.slug = None
+        report_query.pk = None
+        report_query.order = None
+        report_query.save()
+
+        for report_query_order in report_query_orders:
+            report_query_order.pk = None
+            report_query_order.report_query = report_query
+            report_query_order.save()
+
+        report_type = self.get_report_type(**_kwargs)
+        url = reverse(
+            'advanced_report_builder:query_modal',
+            kwargs={'slug': f'pk-{report_query.id}-report_type-{report_type}'},
+        )
+        return self.command_response('show_modal', modal=url)
+
+    def button_add_query(self, **_kwargs):
+        slug = self.get_query_slug(f'report_id-{self.object.id}', **_kwargs)
+        url = reverse(
+            'advanced_report_builder:query_modal',
+            kwargs={'slug': slug},
+        )
+        return self.command_response('show_modal', modal=url)
+
+    def button_edit_query(self, **_kwargs):
+        query_id = _kwargs['query_id'][1:]
+        slug = self.get_query_slug(f'pk-{query_id}', **_kwargs)
+        url = reverse(
+            'advanced_report_builder:query_modal',
+            kwargs={'slug': slug},
+        )
+        return self.command_response('show_modal', modal=url)
+
+    def query_menu(self):
+        edit_query_js = get_query_js('edit_query', 'query_id')
+        duplicate_query_js = get_query_js('duplicate_query', 'query_id')
+
+        description_edit_menu_items = [
+            MenuItem(
+                duplicate_query_js.replace('"', '"'),
+                menu_display='Duplicate',
+                css_classes='btn btn-sm btn-outline-dark',
+                font_awesome='fas fa-clone',
+                link_type=MenuItem.HREF,
+            ),
+            MenuItem(
+                edit_query_js.replace('"', '"'),
+                menu_display='Edit',
+                css_classes='btn btn-sm btn-outline-dark',
+                font_awesome='fas fa-pencil',
+                link_type=MenuItem.HREF,
+            ),
+        ]
+        return description_edit_menu_items
+
+    def add_extra_queries(self, form, fields):
+        add_query_js = (
+            'django_modal.process_commands_lock([{"function": "post_modal", "button": {"button": "add_query"}}])'
+        )
+
+        description_add_menu_items = [
+            MenuItem(
+                add_query_js.replace('"', '"'),
+                menu_display='Add Query Version',
+                css_classes='btn btn-primary',
+                font_awesome='fas fa-pencil',
+                link_type=MenuItem.HREF,
+            )
+        ]
+
+        menu = HtmlMenu(self.request, 'advanced_report_builder/datatables/onclick_menu.html').add_items(
+            *description_add_menu_items
+        )
+
+        fields.append(Div(HTML(menu.render()), css_class='form-buttons'))
+        description_edit_menu_items = self.query_menu()
+
+        form.fields['queries'] = CharField(
+            required=False,
+            label='Queries Versions',
+            widget=DataTableReorderWidget(
+                model=ReportQuery,
+                order_field='order',
+                fields=[
+                    '_.index',
+                    '.id',
+                    *self.query_fields(),
+                    MenuColumn(
+                        column_name='menu',
+                        field='id',
+                        column_defs={'orderable': False, 'className': 'dt-right'},
+                        menu=HtmlMenu(
+                            self.request,
+                            'advanced_report_builder/datatables/onclick_menu.html',
+                        ).add_items(*description_edit_menu_items),
+                    ),
+                ],
+                attrs={'filter': {'report__id': self.object.id}},
+            ),
+        )
+        fields.append('queries')
+
+    def query_fields(self):
+        return ['name']
+
+    def post_save(self, created, form):
+        if created:
+            self.modal_redirect(
+                self.request.resolver_match.view_name,
+                slug=f'pk-{self.object.id}-new-True',
+            )
+        else:
+            url_name = getattr(settings, 'REPORT_BUILDER_DETAIL_URL_NAME', '')
+            if url_name and self.slug.get('new'):
+                url = reverse(url_name, kwargs={'slug': self.object.slug})
+                self.command_response('redirect', url=url)