django-admin-charts 1.3.1__py3-none-any.whl

admin_tools_stats/__init__.py

@@ -0,0 +1,20 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (C) 2011-2014 Star2Billing S.L.
+#
+# The Initial Developer of the Original Code is
+# Arezqui Belaid <info@star2billing.com>
+#
+
+# edit also docs/source/conf.py and update requirements.txt
+__version__ = "1.3.1"
+__author__ = "Petr Dlouhy"
+__contact__ = "petr.dlouhy@emai.cz"
+__homepage__ = "https://github.com/PetrDlouhy"
+__docformat__ = "restructuredtext"

admin_tools_stats/admin.py

@@ -0,0 +1,186 @@
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (C) 2011-2014 Star2Billing S.L.
+#
+# The Initial Developer of the Original Code is
+# Arezqui Belaid <info@star2billing.com>
+#
+
+from django import forms
+from django.contrib import admin
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.translation import gettext_lazy as _
+
+from admin_tools_stats.app_label_renamer import AppLabelRenamer
+from admin_tools_stats.models import (
+    CachedValue,
+    CriteriaToStatsM2M,
+    DashboardStats,
+    DashboardStatsCriteria,
+)
+
+
+AppLabelRenamer(native_app_label="admin_tools_stats", app_label=_("Admin Tools Stats")).main()
+
+
+@admin.register(DashboardStatsCriteria)
+class DashboardStatsCriteriaAdmin(admin.ModelAdmin):
+    """
+    Allows the administrator to view and modify certain attributes
+    of a DashboardStats.
+    """
+
+    list_display = (
+        "id",
+        "criteria_name",
+        "criteria_name",
+        "dynamic_criteria_field_name",
+        "criteria_dynamic_mapping_preview",
+    )
+    list_filter = ["created_date"]
+    readonly_fields = (
+        "created_date",
+        "updated_date",
+    )
+    search_fields = ("criteria_name",)
+    ordering = ("id",)
+    save_as = True
+
+
+class DashboardStatsCriteriaInline(admin.TabularInline):
+    model = CriteriaToStatsM2M
+    readonly_fields = (
+        "criteria__dynamic_criteria_field_name",
+        "criteria__criteria_dynamic_mapping_preview",
+    )
+    fields = (
+        "criteria",
+        "order",
+        "use_as",
+        "default_option",
+        "choices_based_on_time_range",
+        "recalculate",
+        "count_limit",
+        "prefix",
+        "criteria__dynamic_criteria_field_name",
+        "criteria__criteria_dynamic_mapping_preview",
+    )
+    autocomplete_fields = ("criteria",)
+    extra = 0
+
+    def criteria__dynamic_criteria_field_name(self, obj):
+        return format_html(
+            "<strong>{}</strong>{}",
+            str(obj.prefix or ""),
+            str(obj.criteria.dynamic_criteria_field_name or ""),
+        )
+
+    def criteria__criteria_dynamic_mapping_preview(self, obj):
+        return obj.criteria.criteria_dynamic_mapping_preview()
+
+
+class DashboardStatsForm(forms.ModelForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance.pk:
+            self.fields["default_multiseries_criteria"].queryset = (
+                CriteriaToStatsM2M.objects.filter(
+                    stats=self.instance,
+                )
+            )
+
+
+@admin.register(DashboardStats)
+class DashboardStatsAdmin(admin.ModelAdmin):
+    """
+    Allows the administrator to view and modify certain attributes
+    of a DashboardStats.
+    """
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "graph_key",
+                    "graph_title",
+                    ("model_app_name", "model_name", "date_field_name"),
+                    ("operation_field_name", "distinct"),
+                    ("user_field_name", "show_to_users"),
+                    ("allowed_type_operation_field_name", "type_operation_field_name"),
+                    ("allowed_chart_types", "default_chart_type"),
+                    (
+                        "allowed_time_scales",
+                        "default_time_scale",
+                        "default_time_period",
+                    ),
+                    "y_axis_format",
+                    "default_multiseries_criteria",
+                    "is_visible",
+                    "cache_values",
+                ),
+            },
+        ),
+    )
+    list_display = (
+        "id",
+        "graph_key",
+        "analytics_link",
+        "graph_title",
+        "model_name",
+        "distinct",
+        "type_operation_field_name",
+        "is_visible",
+        "show_to_users",
+        "cache_values",
+        "created_date",
+        "date_field_name",
+        "operation_field_name",
+        "default_chart_type",
+    )
+    list_filter = [
+        "created_date",
+        "is_visible",
+        "show_to_users",
+        "cache_values",
+    ]
+    exclude = ("criteria",)
+    inlines = [DashboardStatsCriteriaInline]
+    save_as = True
+    form = DashboardStatsForm
+
+    def analytics_link(self, obj):
+        return format_html(
+            "<a href='{url}?show={key}' target='_blank'>A</a>",
+            url=reverse("chart-analytics"),
+            key=obj.graph_key,
+        )
+
+
+@admin.register(CachedValue)
+class CachedValueAdmin(admin.ModelAdmin):
+    list_display = (
+        "stats",
+        "date",
+        "value",
+        "operation",
+        "operation_field_name",
+        "filtered_value",
+        "time_scale",
+        "multiple_series_choice",
+        "is_final",
+    )
+    list_filter = (
+        "stats",
+        "operation",
+        "operation_field_name",
+        "filtered_value",
+        "time_scale",
+        "is_final",
+        "multiple_series_choice",
+        "stats__cache_values",
+    )

admin_tools_stats/app_label_renamer.py

@@ -0,0 +1,93 @@
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# Copyright (C) 2011-2014 Star2Billing S.L.
+#
+# The Initial Developer of the Original Code is
+# Arezqui Belaid <info@star2billing.com>
+#
+from django.contrib import admin
+from django.db.models.base import ModelBase
+from django.urls import resolve
+
+
+# TODO: Follow evolution of https://code.djangoproject.com/ticket/3591
+
+
+# Source link : http://django-notes.blogspot.in/2011/07/django-app-name-breadcrumbs-l10n.html
+class AppLabelRenamer(object):
+    """
+    Rename app label and app breadcrumbs in admin
+    """
+
+    def __init__(self, native_app_label, app_label):
+        self.native_app_label = native_app_label
+        self.app_label = app_label
+        self.module = ".".join([native_app_label, "models"])
+
+    class StringWithRealoadedTitle(str):
+        """
+        thanks to Ionel Maries Cristian for
+        http://ionelmc.wordpress.com/2011/06/24/custom-app-names-in-the-django-admin/
+        """
+
+        def __new__(cls, value, title):
+            instance = str.__new__(cls, value)
+            instance._title = title
+            return instance
+
+        def title(self):
+            return self._title
+
+        def __copy__(self):
+            return self
+
+        def __deepcopy__(self, memodict):
+            return self
+
+    def rename_app_label(self, f):
+        app_label = self.app_label
+
+        def rename_breadcrumbs(f):
+            def wrap(self, *args, **kwargs):
+                extra_context = kwargs.get("extra_context", {})
+                extra_context["app_label"] = app_label
+                kwargs["extra_context"] = extra_context
+                return f(self, *args, **kwargs)
+
+            return wrap
+
+        def wrap(model_or_iterable, admin_class=None, **option):
+            if isinstance(model_or_iterable, ModelBase):
+                model_or_iterable = [model_or_iterable]
+            for model in model_or_iterable:
+                if model.__module__ != self.module:
+                    continue
+                if admin_class is None:
+                    admin_class = type(model.__name__ + "Admin", (admin.ModelAdmin,), {})
+                admin_class.add_view = rename_breadcrumbs(admin_class.add_view)
+                admin_class.change_view = rename_breadcrumbs(admin_class.change_view)
+                admin_class.changelist_view = rename_breadcrumbs(admin_class.changelist_view)
+                model._meta.app_label = self.StringWithRealoadedTitle(
+                    self.native_app_label, self.app_label
+                )
+            return f(model, admin_class, **option)
+
+        return wrap
+
+    def rename_app_index(self, f):
+        def wrap(request, app_label, extra_context=None):
+            requested_app_label = resolve(request.path).kwargs.get("app_label", "")
+            if requested_app_label and requested_app_label == self.native_app_label:
+                app_label = self.StringWithRealoadedTitle(self.native_app_label, self.app_label)
+            else:
+                app_label = requested_app_label
+            return f(request, app_label, extra_context=None)
+
+        return wrap
+
+    def main(self):
+        admin.site.register = self.rename_app_label(admin.site.register)
+        admin.site.app_index = self.rename_app_index(admin.site.app_index)

admin_tools_stats/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AdminChartsConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "admin_tools_stats"

admin_tools_stats/fixtures/10_dashboardstatscriteria_status.json

@@ -0,0 +1,17 @@
+[
+   {
+      "pk":1,
+      "model":"admin_tools_stats.dashboardstatscriteria",
+      "fields":{
+         "criteria_fix_mapping":{
+            "is_active":"1"
+         },
+         "updated_date":"2011-09-01 09:06:12",
+         "criteria_name":"status",
+         "criteria_dynamic_mapping":{
+
+         },
+         "created_date":"2011-09-01 09:01:40"
+      }
+   }
+]

admin_tools_stats/fixtures/20_dashboardstatscriteria_call_type.json

@@ -0,0 +1,26 @@
+[
+   {
+      "pk":2,
+      "model":"admin_tools_stats.dashboardstatscriteria",
+      "fields":{
+         "criteria_fix_mapping":null,
+         "updated_date":"2011-09-02 05:51:41",
+         "criteria_name":"call_type",
+         "dynamic_criteria_field_name":"disposition",
+         "criteria_dynamic_mapping":{
+            "INVALIDARGS":"INVALIDARGS",
+            "BUSY":"BUSY",
+            "TORTURE":"TORTURE",
+            "ANSWER":"ANSWER",
+            "DONTCALL":"DONTCALL",
+            "FORBIDDEN":"FORBIDDEN",
+            "NOROUTE":"NOROUTE",
+            "CHANUNAVAIL":"CHANUNAVAIL",
+            "NOANSWER":"NOANSWER",
+            "CONGESTION":"CONGESTION",
+            "CANCEL":"CANCEL"
+         },
+         "created_date":"2011-09-02 05:51:41"
+      }
+   }
+]

admin_tools_stats/fixtures/initial_data.json

@@ -0,0 +1,37 @@
+[
+   {
+      "pk":1,
+      "model":"admin_tools_stats.dashboardstatscriteria",
+      "fields":{
+         "criteria_fix_mapping":{
+            "is_active":"1"
+         },
+         "updated_date":"2011-09-01 09:06:12",
+         "criteria_name":"status",
+	 "dynamic_criteria_field_name":"",
+         "criteria_dynamic_mapping":{
+
+         },
+         "created_date":"2011-09-01 09:01:40"
+      }
+   },
+   {
+      "pk":1,
+      "model":"admin_tools_stats.dashboardstats",
+      "fields":{
+         "updated_date":"2011-09-01 09:11:56",
+         "is_visible":true,
+         "graph_key":"user_graph",
+	      "graph_title":"User graph",
+         "criteria":[
+            1
+         ],
+         "date_field_name":"date_joined",
+         "operation_field_name":"",
+         "type_operation_field_name":"",
+         "model_name":"User",
+         "created_date":"2011-09-01 08:56:45",
+         "model_app_name":"auth"
+      }
+   }
+]

admin_tools_stats/forms.py

@@ -0,0 +1,97 @@
+from datetime import timedelta
+
+from django import forms
+from django.utils.timezone import now
+
+
+class ChartSettingsForm(forms.Form):
+    def __init__(self, stats, user=None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        for ch_filter in stats.criteriatostatsm2m_set.filter(use_as="chart_filter").order_by(
+            "order"
+        ):
+            dy_map = ch_filter.get_dynamic_choices(user=user)
+            if dy_map:
+                self.fields[f"select_box_dynamic_{ch_filter.id}"] = forms.ChoiceField(
+                    choices=[("", "-------")] + list(dy_map.values()),
+                    label=ch_filter.criteria.criteria_name,
+                    initial=ch_filter.default_option,
+                )
+                self.fields[f"select_box_dynamic_{ch_filter.id}"].widget.attrs[
+                    "class"
+                ] = "chart-input"
+
+        self.fields["graph_key"] = forms.CharField(
+            initial=stats.graph_key,
+            widget=forms.HiddenInput(attrs={"class": "hidden_graph_key"}),
+        )
+
+        multiple_series = stats.criteriatostatsm2m_set.filter(use_as="multiple_series")
+        if multiple_series.exists():
+            choices = (
+                multiple_series.select_related("stats__default_multiseries_criteria", "criteria")
+                .order_by("order")
+                .values_list("id", "criteria__criteria_name")
+            )
+            self.fields["select_box_multiple_series"] = forms.ChoiceField(
+                label="Divide",
+                choices=[("", "-------")] + list(choices),
+                initial=(
+                    stats.default_multiseries_criteria.id
+                    if stats.default_multiseries_criteria
+                    else None
+                ),
+            )
+            self.fields["select_box_multiple_series"].widget.attrs[
+                "class"
+            ] = "chart-input select_box_multiple_series"
+
+        if len(stats.allowed_type_operation_field_name) > 1:
+            self.fields["select_box_operation"] = forms.ChoiceField(
+                choices=stats.allowed_type_operation_field_name_choices(),
+                label="Operation",
+                initial=stats.type_operation_field_name,
+            )
+            self.fields["select_box_operation"].widget.attrs["class"] = "chart-input"
+
+        operations_list = stats.get_operations_list()
+        if operations_list and len(operations_list) > 1:
+            self.fields["select_box_operation_field"] = forms.ChoiceField(
+                choices=[("", "(divide all)")] + [(o, o) for o in operations_list],
+                label="Field",
+                initial=operations_list[0],
+            )
+            self.fields["select_box_operation_field"].widget.attrs["class"] = "chart-input"
+
+        if len(stats.allowed_time_scales) > 1:
+            self.fields["select_box_interval"] = forms.ChoiceField(
+                choices=stats.allowed_time_scales_choices(),
+                label="Scale",
+                initial=stats.default_time_scale,
+            )
+            self.fields["select_box_interval"].widget.attrs["class"] = "chart-input"
+
+        if len(stats.allowed_chart_types) > 1:
+            self.fields["select_box_chart_type"] = forms.ChoiceField(
+                choices=stats.allowed_chart_types_choices(),
+                label="Chart",
+                initial=stats.default_chart_type,
+            )
+            self.fields["select_box_chart_type"].widget.attrs[
+                "class"
+            ] = "chart-input select_box_chart_type"
+
+        self.fields["time_since"] = forms.DateField(
+            label="Since",
+            initial=(now() - timedelta(days=stats.default_time_period)).strftime("%Y-%m-%d"),
+            widget=forms.TextInput(
+                attrs={"type": "date", "class": "chart-input select_box_date_since"}
+            ),
+        )
+        self.fields["time_until"] = forms.DateField(
+            label="Until",
+            initial=now().strftime("%Y-%m-%d"),
+            widget=forms.TextInput(
+                attrs={"type": "date", "class": "chart-input select_box_date_until"}
+            ),
+        )

admin_tools_stats/management/commands/recalculate_charts.py

@@ -0,0 +1,130 @@
+from datetime import datetime, timedelta
+
+from blenderhub.apps.accounts.models import UserProfile
+from datetime_truncate import truncate
+from django.core.management import BaseCommand
+
+from admin_tools_stats.models import (
+    DashboardStats,
+    Interval,
+    get_charts_timezone,
+    truncate_ceiling,
+)
+
+
+class Command(BaseCommand):
+    help = "Recalculate all charts with cached values"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "graph_key",
+            nargs="*",
+            type=str,
+            help="Recalculate only specified charts",
+        )
+        parser.add_argument(
+            "--exclude",
+            help="Exclude graph keys from recalculation separated by comma",
+        )
+        parser.add_argument(
+            "--all-criteria",
+            help="Run for all multiseries criteria",
+            action="store_true",
+        )
+        parser.add_argument(
+            "--reload-all",
+            help="Recalculate all data in range",
+            action="store_true",
+        )
+        parser.add_argument(
+            "--dry-run",
+            help="Only print what would be recalculated",
+            action="store_true",
+        )
+        parser.add_argument(
+            "--time-ranges",
+            help="Override time ranges (hours, days, months, quarters, years); Separated by comma",
+        )
+        parser.add_argument(
+            "--periods-count",
+            help="Incerease recalculation of charts by more of default periods",
+            default=1,
+            type=int,
+        )
+
+    def get_all_multiseries_criteria(self, stats, options):
+        all_multiseries_criteria = list(
+            stats.criteriatostatsm2m_set.filter(use_as="multiple_series", recalculate=True)
+        )
+        all_multiseries_criteria.append("")
+        return all_multiseries_criteria
+
+    def handle(self, *args, **options):
+        stats_query = DashboardStats.objects.filter(cache_values=True, show_to_users=False)
+        if options.get("graph_key", None):
+            stats_query = stats_query.filter(graph_key__in=options["graph_key"])
+        if options.get("exclude", None):
+            stats_query = stats_query.exclude(graph_key__in=options["exclude"].split(","))
+
+        chart_string = "\n".join(
+            f"\t{k.ljust(30)}\t{v}"
+            for (k, v) in stats_query.values_list("graph_key", "graph_title")
+        )
+        print(f"recalculating charts: \n{chart_string}")
+        for stats in stats_query:
+            operation = stats.type_operation_field_name
+            user = UserProfile.objects.get(email="petr.dlouhy@email.cz")
+            configuration = {
+                "select_box_chart_type": stats.default_chart_type,
+                "reload": "True",
+                "reload_all": str(options["reload_all"]),
+            }
+            for criteria in stats.criteriatostatsm2m_set.filter(
+                use_as="chart_filter",
+                criteria__dynamic_criteria_field_name__isnull=False,
+            ):
+                configuration[f"select_box_dynamic_{criteria.id}"] = criteria.default_option
+
+            all_multiseries_criteria = self.get_all_multiseries_criteria(stats, options)
+
+            print(f"recalculating {stats} controls")
+            if not options["dry_run"]:
+                stats.get_control_form_raw(user=user)
+
+            for multiseries_criteria in all_multiseries_criteria:
+                if multiseries_criteria:
+                    configuration["select_box_multiple_series"] = multiseries_criteria.id
+
+                if options.get("time_ranges", None):
+                    time_scales = options["time_ranges"].split(",")
+                else:
+                    time_scales = stats.allowed_time_scales
+
+                chart_tz = get_charts_timezone()
+                for operation_field in stats.operation_field_name.split(","):
+                    for selected_interval in time_scales:
+                        print(
+                            f"recalculating chart {stats} with {multiseries_criteria} on "
+                            f"{operation_field} criteria in {selected_interval}"
+                        )
+                        time_since = datetime.now() - timedelta(
+                            days=stats.default_time_period
+                        ) * options.get("periods_count", 1)
+                        time_since = truncate(time_since, Interval(selected_interval).val())
+                        time_since = time_since.astimezone(chart_tz)
+
+                        time_until = datetime.now()
+                        time_until = truncate_ceiling(time_until, Interval(selected_interval).val())
+                        time_until = time_until.astimezone(chart_tz)
+
+                        configuration["select_box_interval"] = selected_interval
+                        if not options["dry_run"]:
+                            stats.get_multi_time_series_cached(
+                                configuration=configuration,
+                                time_since=time_since,
+                                time_until=time_until,
+                                interval=Interval(selected_interval),
+                                operation_choice=operation,
+                                operation_field_choice=operation_field,
+                                user=user,
+                            )