Merge pull request #21 from DonAsako/feat/analytics

Feat/analytics

Author: DonAsako

apps/analytics/metrics.py

@@ -1,7 +1,7 @@
-"""Aggregations feeding the admin dashboard analytics panels.
+"""Aggregations feeding the dedicated Analytics admin page.
 
-Exposes ``add_dashboard_metrics(context)``, called by the core dashboard
-callback. Kept here so all page-view logic lives in the analytics app.
+Exposes ``full_metrics(context)``, called by the analytics view. Kept here so
+all page-view logic lives in the analytics app.
 """
 
 from datetime import timedelta
@@ -16,6 +16,13 @@
 from apps.analytics.models import PageView
 
 
+def _pct_change(current, previous):
+    """Signed % change vs the previous equal-length window."""
+    if not previous:
+        return None
+    return round((current - previous) / previous * 100)
+
+
 def _daily_series(views, days=30):
     """Zero-filled daily counts (oldest -> newest) with bar heights as a
     percentage of the busiest day, for the sparkline / bar chart."""
@@ -37,6 +44,24 @@ def _daily_series(views, days=30):
     return series, peak
 
 
+def _realtime_series(views, minutes=60, bucket=5):
+    """Counts grouped into bucket -minute slots over the last minutes."""
+    now = timezone.now()
+    cur = now.replace(second=0, microsecond=0)
+    start = cur - timedelta(minutes=minutes - 1)
+    nslots = -(-minutes // bucket)  # ceil
+    slots = [0] * nslots
+    for ts in views.filter(created_at__gte=start).values_list("created_at", flat=True):
+        mi = int((ts - start).total_seconds() // 60)
+        if 0 <= mi < minutes:
+            slots[mi // bucket] += 1
+    series = [{"min": start + timedelta(minutes=i * bucket), "span": bucket, "count": c} for i, c in enumerate(slots)]
+    peak = max(slots, default=0) or 1
+    for s in series:
+        s["pct"] = max(round(s["count"] / peak * 100), 3) if s["count"] else 0
+    return series, peak
+
+
 def _top_content(views, since, limit=10):
     """Most-viewed content objects (resolved to title + admin/site links)."""
     rows = (
@@ -60,47 +85,50 @@ def _top_content(views, since, limit=10):
     return items
 
 
-def add_dashboard_metrics(context):
-    """Compact analytics for the admin dashboard landing page."""
-    now = timezone.now()
-    d7 = now - timedelta(days=7)
-    d30 = now - timedelta(days=30)
-    views = PageView.objects.all()
-
-    context["metrics"] = {
-        "views_7d": views.filter(created_at__gte=d7).count(),
-        "views_30d": views.filter(created_at__gte=d30).count(),
-        "uniques_7d": views.filter(created_at__gte=d7).values("visitor_hash").distinct().count(),
-    }
-    context["top_pages"] = list(
-        views.filter(created_at__gte=d30).values("path").annotate(n=Count("id")).order_by("-n")[:8]
-    )
-    context["views_series"], context["views_peak"] = _daily_series(views, days=30)
-
-
 def full_metrics(context):
     """Richer analytics for the dedicated Analytics admin page."""
     now = timezone.now()
     d7 = now - timedelta(days=7)
+    d14 = now - timedelta(days=14)
     d30 = now - timedelta(days=30)
+    d60 = now - timedelta(days=60)
     views = PageView.objects.all()
 
+    v7 = views.filter(created_at__gte=d7).count()
+    v7_prev = views.filter(created_at__gte=d14, created_at__lt=d7).count()
+    v30 = views.filter(created_at__gte=d30).count()
+    v30_prev = views.filter(created_at__gte=d60, created_at__lt=d30).count()
+    u7 = views.filter(created_at__gte=d7).values("visitor_hash").distinct().count()
+    u7_prev = views.filter(created_at__gte=d14, created_at__lt=d7).values("visitor_hash").distinct().count()
+    u30 = views.filter(created_at__gte=d30).values("visitor_hash").distinct().count()
+    u30_prev = views.filter(created_at__gte=d60, created_at__lt=d30).values("visitor_hash").distinct().count()
+
     metrics = {
-        "views_7d": views.filter(created_at__gte=d7).count(),
-        "views_30d": views.filter(created_at__gte=d30).count(),
+        "views_7d": v7,
+        "views_30d": v30,
         "views_all": views.count(),
-        "uniques_7d": views.filter(created_at__gte=d7).values("visitor_hash").distinct().count(),
-        "uniques_30d": views.filter(created_at__gte=d30).values("visitor_hash").distinct().count(),
+        "uniques_7d": u7,
+        "uniques_30d": u30,
     }
     context["metrics"] = metrics
+    # (label, value, delta%) — delta is None for the all-time card (no baseline).
     context["cards"] = [
-        (_("Views (7 days)"), metrics["views_7d"]),
-        (_("Views (30 days)"), metrics["views_30d"]),
-        (_("Views (all time)"), metrics["views_all"]),
-        (_("Unique visitors (7 days)"), metrics["uniques_7d"]),
-        (_("Unique visitors (30 days)"), metrics["uniques_30d"]),
+        (_("Views (7 days)"), v7, _pct_change(v7, v7_prev)),
+        (_("Views (30 days)"), v30, _pct_change(v30, v30_prev)),
+        (_("Views (all time)"), metrics["views_all"], None),
+        (_("Unique visitors (7 days)"), u7, _pct_change(u7, u7_prev)),
+        (_("Unique visitors (30 days)"), u30, _pct_change(u30, u30_prev)),
     ]
     context["views_series"], context["views_peak"] = _daily_series(views, days=30)
+
+    rt = views.filter(created_at__gte=now - timedelta(hours=1))
+    context["realtime"] = {
+        "views_1h": rt.count(),
+        "uniques_1h": rt.values("visitor_hash").distinct().count(),
+    }
+    context["realtime_series"], context["realtime_peak"] = _realtime_series(views, minutes=60, bucket=5)
+    context["realtime_pages"] = list(rt.values("path").annotate(n=Count("id")).order_by("-n")[:5])
+
     context["top_content"] = _top_content(views, d30, limit=10)
     context["top_pages"] = list(
         views.filter(created_at__gte=d30).values("path").annotate(n=Count("id")).order_by("-n")[:15]
@@ -112,3 +140,10 @@ def full_metrics(context):
         .annotate(n=Count("id"))
         .order_by("-n")[:10]
     )
+    context["top_campaigns"] = list(
+        views.filter(created_at__gte=d30)
+        .exclude(utm_source="")
+        .values("utm_source", "utm_medium", "utm_campaign")
+        .annotate(n=Count("id"))
+        .order_by("-n")[:10]
+    )

apps/analytics/middleware.py

@@ -37,7 +37,7 @@ def _record(self, request, response):
         if any(path.startswith(p) for p in self._excluded):
             return
 
-        from apps.analytics.tracking import is_bot, visitor_hash
+        from apps.analytics.tracking import external_referrer, is_bot, visitor_hash
 
         if is_bot(request.META.get("HTTP_USER_AGENT", "")):
             return
@@ -61,5 +61,8 @@ def _record(self, request, response):
             object_id=getattr(obj, "pk", None),
             path=path[:512],
             visitor_hash=vhash,
-            referrer=(request.META.get("HTTP_REFERER", "") or "")[:512],
+            referrer=external_referrer(request)[:512],
+            utm_source=request.GET.get("utm_source", "")[:128],
+            utm_medium=request.GET.get("utm_medium", "")[:128],
+            utm_campaign=request.GET.get("utm_campaign", "")[:128],
         )

apps/analytics/migrations/0002_pageview_utm_campaign_pageview_utm_medium_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 6.0.4 on 2026-06-08 15:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("analytics", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="pageview",
+            name="utm_campaign",
+            field=models.CharField(blank=True, max_length=128),
+        ),
+        migrations.AddField(
+            model_name="pageview",
+            name="utm_medium",
+            field=models.CharField(blank=True, max_length=128),
+        ),
+        migrations.AddField(
+            model_name="pageview",
+            name="utm_source",
+            field=models.CharField(blank=True, max_length=128),
+        ),
+    ]

apps/analytics/models.py

@@ -7,8 +7,8 @@
 class PageView(models.Model):
     """A single (de-duplicated) page visit.
 
-    Recorded server-side by ``PageViewMiddleware`` so it is immune to ad
-    blockers. No personal data is stored: ``visitor_hash`` is a non-reversible,
+    Recorded server-side by `PageViewMiddleware` so it is immune to ad
+    blockers. No personal data is stored: `visitor_hash` is a non-reversible,
     daily-rotating hash of IP + user-agent used only to estimate unique
     visitors. When the visited page is a content object (article, writeup…),
     the generic FK links the view to it for per-object counts.
@@ -21,6 +21,9 @@ class PageView(models.Model):
     path = models.CharField(max_length=512, db_index=True)
     visitor_hash = models.CharField(max_length=64, db_index=True)
     referrer = models.CharField(max_length=512, blank=True)
+    utm_source = models.CharField(max_length=128, blank=True)
+    utm_medium = models.CharField(max_length=128, blank=True)
+    utm_campaign = models.CharField(max_length=128, blank=True)
     created_at = models.DateTimeField(auto_now_add=True, db_index=True)
 
     class Meta:

apps/analytics/tracking.py

@@ -8,6 +8,7 @@
 
 import hashlib
 import re
+from urllib.parse import urlsplit
 
 from django.conf import settings
 from django.utils import timezone
@@ -24,6 +25,14 @@ def is_bot(user_agent):
     return not user_agent or bool(_BOT_RE.search(user_agent))
 
 
+def external_referrer(request):
+    """HTTP referer, blanked when it points back at our own host"""
+    ref = request.META.get("HTTP_REFERER", "") or ""
+    if ref and urlsplit(ref).netloc == request.get_host():
+        return ""
+    return ref
+
+
 def client_ip(request):
     xff = request.META.get("HTTP_X_FORWARDED_FOR")
     if xff:

apps/core/dashboard.py

@@ -9,7 +9,6 @@
 from django.urls import NoReverseMatch, reverse
 from django.utils.translation import gettext_lazy as _
 
-from apps.analytics.metrics import add_dashboard_metrics
 from apps.core.models import SiteSettings
 from apps.core.updates import get_update_info
 
@@ -33,8 +32,6 @@ def _change_url(entry):
 
 
 def dashboard_callback(request, context):
-    add_dashboard_metrics(context)
-
     site_settings = SiteSettings.objects.first()
     if site_settings and site_settings.check_for_updates:
         context["update_info"] = get_update_info()

eskoz/settings/base.py

@@ -158,12 +158,6 @@ def _unfold_account_links(request):
                         "icon": "rocket_launch",
                         "link": reverse_lazy("admin:blog_project_changelist"),
                     },
-                    {
-                        "title": _("Categories"),
-                        "icon": "category",
-                        "link": reverse_lazy("admin:blog_category_changelist"),
-                    },
-                    {"title": _("Tags"), "icon": "label", "link": reverse_lazy("admin:blog_articletag_changelist")},
                 ],
             },
             {
@@ -172,24 +166,12 @@ def _unfold_account_links(request):
                 "collapsible": True,
                 "items": [
                     {"title": _("Writeups"), "icon": "flag", "link": reverse_lazy("admin:infosec_writeup_changelist")},
-                    {"title": _("CTF"), "icon": "emoji_events", "link": reverse_lazy("admin:infosec_ctf_changelist")},
                     {"title": _("CVE"), "icon": "bug_report", "link": reverse_lazy("admin:infosec_cve_changelist")},
                     {
                         "title": _("Certifications"),
                         "icon": "workspace_premium",
                         "link": reverse_lazy("admin:infosec_certification_changelist"),
                     },
-                    {
-                        "title": _("Issuers"),
-                        "icon": "business",
-                        "link": reverse_lazy("admin:infosec_issuer_changelist"),
-                    },
-                    {
-                        "title": _("Categories"),
-                        "icon": "category",
-                        "link": reverse_lazy("admin:infosec_category_changelist"),
-                    },
-                    {"title": _("Tags"), "icon": "label", "link": reverse_lazy("admin:infosec_writeuptag_changelist")},
                 ],
             },
             {
@@ -246,18 +228,21 @@ def _unfold_account_links(request):
     "TABS": [
         # CTF-related content
         {
-            "models": ["infosec.writeup", "infosec.ctf"],
+            "models": ["infosec.writeup", "infosec.ctf", "infosec.category", "infosec.writeuptag"],
             "items": [
                 {"title": _("Writeups"), "link": reverse_lazy("admin:infosec_writeup_changelist")},
                 {"title": _("CTF"), "link": reverse_lazy("admin:infosec_ctf_changelist")},
+                {"title": _("Categories"), "link": reverse_lazy("admin:infosec_category_changelist")},
+                {"title": _("Tags"), "link": reverse_lazy("admin:infosec_writeuptag_changelist")},
             ],
         },
         # Blog content
         {
-            "models": ["blog.article", "blog.project"],
+            "models": ["blog.article", "blog.category", "blog.articletag"],
             "items": [
                 {"title": _("Articles"), "link": reverse_lazy("admin:blog_article_changelist")},
-                {"title": _("Projects"), "link": reverse_lazy("admin:blog_project_changelist")},
+                {"title": _("Categories"), "link": reverse_lazy("admin:blog_category_changelist")},
+                {"title": _("Article Tags"), "link": reverse_lazy("admin:blog_articletag_changelist")},
             ],
         },
         # Certifications & Issuers
@@ -270,21 +255,12 @@ def _unfold_account_links(request):
         },
         # Blog taxonomy
         {
-            "models": ["blog.category", "blog.articletag", "blog.projecttag"],
+            "models": ["blog.project", "blog.projecttag"],
             "items": [
-                {"title": _("Categories"), "link": reverse_lazy("admin:blog_category_changelist")},
-                {"title": _("Article Tags"), "link": reverse_lazy("admin:blog_articletag_changelist")},
+                {"title": _("Projects"), "link": reverse_lazy("admin:blog_project_changelist")},
                 {"title": _("Project Tags"), "link": reverse_lazy("admin:blog_projecttag_changelist")},
             ],
         },
-        # Infosec taxonomy
-        {
-            "models": ["infosec.category", "infosec.writeuptag"],
-            "items": [
-                {"title": _("Categories"), "link": reverse_lazy("admin:infosec_category_changelist")},
-                {"title": _("Tags"), "link": reverse_lazy("admin:infosec_writeuptag_changelist")},
-            ],
-        },
     ],
 }