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

advanced_report_builder/views/line_charts.py

@@ -0,0 +1,415 @@
+import base64
+import json
+from datetime import datetime
+
+from crispy_forms.layout import Div
+from date_offset.date_offset import DateOffset
+from django.forms import BooleanField, CharField, ChoiceField
+from django.shortcuts import get_object_or_404
+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.exceptions import ReportError
+from advanced_report_builder.globals import (
+    ANNOTATION_VALUE_DAY,
+    ANNOTATION_VALUE_MONTH,
+    ANNOTATION_VALUE_QUARTER,
+    ANNOTATION_VALUE_WEEK,
+    ANNOTATION_VALUE_YEAR,
+)
+from advanced_report_builder.models import LineChartReport, ReportType
+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,
+    ChartJSTable,
+)
+from advanced_report_builder.views.modals_base import (
+    QueryBuilderModalBase,
+    QueryBuilderModalBaseMixin,
+)
+from advanced_report_builder.views.query_modal.mixin import MultiQueryModalMixin
+
+
+class LineChartJSTable(ChartJSTable):
+    def get_table_array(self, request, results):
+        results = super().get_table_array(request, results)
+        if len(results) == 0:
+            return results
+
+        date_offset = DateOffset()
+        record_count = len(results[0]) - 1
+        try:
+            next_date = datetime.strptime(results[0][0], '%Y-%m-%d').date()
+        except ValueError as e:
+            raise ReportError(e)
+
+        new_results = []
+        for record in results:
+            if record[0] == '' or record[0] is None:
+                continue
+            current_date = datetime.strptime(record[0], '%Y-%m-%d').date()
+            if current_date != next_date:
+                while next_date < current_date:
+                    row = [next_date.strftime('%Y-%m-%d')] + ['0' for _ in range(record_count)]
+                    new_results.append(row)
+                    next_date = self.get_next_date(date_offset, date_in=next_date)
+
+            row = [record[0]]
+            for x in record[1:]:
+                if x == '':
+                    row.append('')
+                else:
+                    row.append(x)
+            new_results.append(row)
+            next_date = self.get_next_date(date_offset, date_in=next_date)
+
+        return new_results
+
+    def get_next_date(self, date_offset, date_in):
+        if self.axis_scale == ANNOTATION_VALUE_YEAR:
+            next_date = date_offset.get_offset('1y', start_date_time=date_in)
+        elif self.axis_scale == ANNOTATION_VALUE_QUARTER:
+            next_date = date_offset.get_offset('3m', start_date_time=date_in)
+        elif self.axis_scale == ANNOTATION_VALUE_MONTH:
+            next_date = date_offset.get_offset('1m', start_date_time=date_in)
+        elif self.axis_scale == ANNOTATION_VALUE_WEEK:
+            next_date = date_offset.get_offset('1w', start_date_time=date_in)
+        elif self.axis_scale == ANNOTATION_VALUE_DAY:
+            next_date = date_offset.get_offset('1d', start_date_time=date_in)
+        else:
+            raise AssertionError()
+        return next_date
+
+
+class LineChartView(ChartBaseView):
+    chart_js_table = LineChartJSTable
+
+    def dispatch(self, request, *args, **kwargs):
+        self.report = kwargs.get('report')
+        self.chart_report = self.report.linechartreport
+        return super().dispatch(request, *args, **kwargs)
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        self.table.line_chart_report = self.chart_report
+        self.table.datatable_template = self.get_report_template()
+        context['line_chart_report'] = self.chart_report
+        return context
+
+    def set_extra_number_field_kwargs(self, data_attr, options, multiple_index, additional_options):
+        line_colour = None
+        if additional_options is not None:
+            line_colour = additional_options.get('positive_colour')
+        if line_colour is None or line_colour == '':
+            line_colour = data_attr.get('line_colour') or '801C70'
+            line_colour = self.add_colour_offset(line_colour, multiple_index=multiple_index)
+        options.update({'colour': line_colour})
+
+    def edit_report_menu(self, request, chart_report_id, slug_str):
+        return [
+            MenuItem(
+                f'advanced_report_builder:line_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 setup_table(self, base_model):
+        axis_scale = self.chart_report.axis_scale
+        targets = None
+
+        if getattr(self.chart_report, 'has_targets', False):
+            targets = self.chart_report.targets
+        self.table = self.chart_js_table(model=base_model, axis_scale=axis_scale, targets=targets)
+
+
+class LineChartModal(MultiQueryModalMixin, QueryBuilderModalBase):
+    template_name = 'advanced_report_builder/charts/modal.html'
+    process = PROCESS_EDIT_DELETE
+    permission_delete = PERMISSION_OFF
+    model = LineChartReport
+    show_order_by = False
+
+    widgets = {
+        'line_colour': ColourPickerWidget,
+        'show_totals': RBToggle,
+        'has_targets': RBToggle,
+        'report_tags': Select2Multiple,
+        'targets': Select2Multiple,
+    }
+
+    form_fields = [
+        'name',
+        'notes',
+        'report_type',
+        'report_tags',
+        'axis_value_type',
+        'axis_scale',
+        'date_field',
+        'fields',
+        'x_label',
+        'y_label',
+        'show_totals',
+        'has_targets',
+        'targets',
+    ]
+
+    def form_setup(self, form, *_args, **_kwargs):
+        form.add_trigger(
+            'has_targets',
+            'onchange',
+            [
+                {
+                    'selector': '#div_id_targets',
+                    'values': {'checked': 'show'},
+                    'default': 'hide',
+                },
+            ],
+        )
+
+        if 'data' in _kwargs and len(_kwargs['data']) > 0:
+            date_field = _kwargs['data'].get('date_field')
+            report_type_id = _kwargs['data'].get('report_type')
+            report_type = get_object_or_404(ReportType, id=report_type_id)
+        else:
+            date_field = form.instance.date_field
+            report_type = form.instance.report_type
+
+        self.setup_field(
+            field_type='date',
+            form=form,
+            field_name='date_field',
+            selected_field_id=date_field,
+            report_type=report_type,
+        )
+
+        form.fields['notes'].widget.attrs['rows'] = 3
+
+        url = reverse(
+            'advanced_report_builder:line_chart_field_modal',
+            kwargs={'slug': 'selector-99999-data-FIELD_INFO-report_type_id-REPORT_TYPE_ID'},
+        )
+
+        fields = [
+            'name',
+            'notes',
+            'report_type',
+            'report_tags',
+            'axis_scale',
+            'axis_value_type',
+            'date_field',
+            FieldEx(
+                'fields',
+                template='advanced_report_builder/select_column.html',
+                extra_context={'select_column_url': url, 'command_prefix': ''},
+            ),
+            'x_label',
+            'y_label',
+            'show_totals',
+            'has_targets',
+            'targets',
+        ]
+        if self.object.id:
+            self.add_extra_queries(form=form, fields=fields)
+        return fields
+
+    def select2_date_field(self, **kwargs):
+        return self.get_fields_for_select2(
+            field_type='date',
+            report_type=kwargs['report_type'],
+            search_string=kwargs.get('search'),
+        )
+
+
+class LineChartFieldForm(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['line_colour'] = CharField(required=False, widget=ColourPickerWidget)
+        self.fields['line_colour'].initial = data_attr.get('line_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='Line 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'line_colour-{self.cleaned_data["line_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 LineChartFieldModal(QueryBuilderModalBaseMixin, FormModal):
+    form_class = LineChartFieldForm
+    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',
+            'line_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/modals_base.py

@@ -0,0 +1,213 @@
+import json
+
+from django.conf import settings
+from django.forms import JSONField
+from django.http import JsonResponse
+from django.shortcuts import get_object_or_404
+from django.urls import reverse
+from django_modals.modals import ModelFormModal
+from django_modals.widgets.select2 import Select2
+
+from advanced_report_builder.column_types import NUMBER_FIELDS
+from advanced_report_builder.field_types import FieldTypes
+from advanced_report_builder.field_utils import ReportBuilderFieldUtils
+from advanced_report_builder.globals import FieldType
+from advanced_report_builder.models import ReportQuery, ReportType
+from advanced_report_builder.utils import get_report_builder_class
+
+
+class QueryBuilderModalBaseMixin(ReportBuilderFieldUtils):
+    @staticmethod
+    def get_report_builder_class(report_type_id):
+        if not report_type_id:
+            return None, None
+
+        report_type = get_object_or_404(ReportType, pk=report_type_id)
+        base_model = report_type.content_type.model_class()
+        report_builder_class = get_report_builder_class(model=base_model, report_type=report_type)
+        return report_builder_class, base_model
+
+    def get_query_builder_report_type_field(self, report_type_id):
+        report_builder_class, base_model = self.get_report_builder_class(report_type_id=report_type_id)
+        if report_builder_class is None:
+            # noinspection PyUnresolvedReferences
+            return self.command_response()
+        query_builder_filters = []
+        self._get_query_builder_fields(
+            base_model=base_model,
+            query_builder_filters=query_builder_filters,
+            report_builder_class=report_builder_class,
+        )
+
+        return query_builder_filters
+
+    def _get_query_builder_fields(
+        self,
+        base_model,
+        query_builder_filters,
+        report_builder_class,
+    ):
+        field_types = FieldTypes()
+        field_results = []
+        field_results_types = {
+            FieldType.NULL_FIELD: {},
+            FieldType.ABSTRACT_USER: {},
+            FieldType.FILTER_FOREIGN_KEY: {},
+            FieldType.STRING: {},
+            FieldType.NUMBER: {},
+            FieldType.BOOLEAN: {},
+            FieldType.DATE: {},
+            FieldType.MANY_TO_MANY: {},
+        }
+        field_types.get_field_types(
+            field_results=field_results,
+            field_results_types=field_results_types,
+            base_model=base_model,
+            report_builder_class=report_builder_class,
+        )
+
+        field_types.get_filters(
+            fields=field_results, query_builder_filters=query_builder_filters, field_results_types=field_results_types
+        )
+
+    def ajax_get_fields(self, **kwargs):
+        report_type_id = kwargs['report_type']
+        report_builder_class, base_model = self.get_report_builder_class(report_type_id=report_type_id)
+        fields = []
+        tables = []
+        self._get_fields(
+            base_model=base_model,
+            fields=fields,
+            tables=tables,
+            report_builder_class=report_builder_class,
+            field_types=NUMBER_FIELDS,
+            extra_fields=report_builder_class.extra_chart_field,
+        )
+        return self.command_response('report_fields', data=json.dumps({'fields': fields, 'tables': tables}))
+
+    def get_fields_for_select2(self, field_type, report_type, search_string):
+        fields = []
+        if report_type != '':
+            report_builder_fields, base_model = self.get_report_builder_class(report_type_id=report_type)
+            fields = []
+            if field_type == 'date':
+                self._get_date_fields(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    search_string=search_string,
+                )
+            elif field_type == 'number':
+                self._get_number_fields(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    search_string=search_string,
+                )
+            elif field_type == 'link':
+                self._get_column_link_fields(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    search_string=search_string,
+                )
+            elif field_type == 'colour':
+                self._get_colour_fields(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    search_string=search_string,
+                )
+            elif field_type == 'all':
+                self._get_fields(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    for_select2=True,
+                    search_string=search_string,
+                )
+            elif field_type in ('order', 'django_order'):
+                self._get_fields(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    for_select2=True,
+                    search_string=search_string,
+                    show_order_by_fields=True,
+                    must_have_django_field=field_type == 'django_order',
+                )
+            elif field_type == 'include_names':
+                self._get_include_names(
+                    base_model=base_model,
+                    fields=fields,
+                    report_builder_class=report_builder_fields,
+                    search_string=search_string,
+                )
+
+        return JsonResponse({'results': fields})
+
+    def setup_field(self, field_type, form, field_name, selected_field_id, report_type):
+        _fields = []
+        if selected_field_id:
+            form.fields[field_name].initial = selected_field_id
+            base_model = report_type.content_type.model_class()
+            report_builder_class = get_report_builder_class(model=base_model, report_type=report_type)
+            self.get_field_display_value(
+                field_type=field_type,
+                fields_values=_fields,
+                base_model=base_model,
+                report_builder_class=report_builder_class,
+                selected_field_value=selected_field_id,
+                for_select2=True,
+            )
+
+        form.fields[field_name].widget = Select2(attrs={'ajax': True})
+        form.fields[field_name].widget.select_data = _fields
+
+
+class QueryBuilderModalBase(QueryBuilderModalBaseMixin, ModelFormModal):
+    size = 'xl'
+
+    def __init__(self, *args, **kwargs):
+        self.report_query = None
+        self.show_query_name = False
+        super().__init__(*args, **kwargs)
+
+    def ajax_get_query_builder_fields(self, **kwargs):
+        report_type_id = kwargs['report_type']
+
+        field_auto_id = kwargs['field_auto_id']
+        if 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))
+        else:
+            return self.command_response()
+
+    def add_query_data(self, form):
+        form.fields['extra_query_data'] = JSONField(required=False, label='Numerator filter')
+        if self.object.id:
+            query_id = self.slug.get('query_id')
+            if query_id:
+                self.report_query = get_object_or_404(ReportQuery, id=query_id)
+            else:
+                self.report_query = self.object.reportquery_set.first()
+            if self.report_query:
+                form.fields['extra_query_data'].initial = self.report_query.extra_query
+
+    def form_valid(self, form):
+        org_id = self.object.id if hasattr(self, 'object') else None
+        chart_report = form.save(commit=False)
+        chart_report._current_user = self.request.user
+        chart_report.save()
+        form.save_m2m()
+
+        self.post_save(created=org_id is None, form=form)
+        if not self.response_commands:
+            url_name = getattr(settings, 'REPORT_BUILDER_DETAIL_URL_NAME', '')
+            if org_id is None and url_name:
+                url = reverse(url_name, kwargs={'slug': chart_report.slug})
+                self.add_command('redirect', url=url)
+            else:
+                self.add_command('reload')
+        return self.command_response()