Add tracking widgets

2024-12-25 17:06:09 +01:00 · 2020-02-23 22:41:41 +01:00 · 2020-02-23 22:41:41 +01:00 · b1a7226ed8
commit b1a7226ed8
parent 005140d6f1
5 changed files with 251 additions and 0 deletions
--- a/Classes/Dashboard/Widgets/PageViewsBar.php
+++ b/Classes/Dashboard/Widgets/PageViewsBar.php
@ -0,0 +1,102 @@
+<?php
+
+namespace DanielSiepmann\Tracking\Dashboard\Widgets;
+
+/*
+ * Copyright (C) 2020 Daniel Siepmann <coding@daniel-siepmann.de>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+use TYPO3\CMS\Core\Database\Connection;
+use TYPO3\CMS\Core\Database\ConnectionPool;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Dashboard\Widgets\AbstractBarChartWidget;
+
+class PageViewsBar extends AbstractBarChartWidget
+{
+    protected $title = 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widgets.pageViewsBar.title';
+
+    protected $description = 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widgets.pageViewsBar.description';
+
+    protected $width = 2;
+
+    protected $height = 4;
+
+    protected function prepareChartData(): void
+    {
+        list($labels, $data) = $this->calculateDataForLastDays(31);
+
+        $this->chartData = [
+            'labels' => $labels,
+            'datasets' => [
+                [
+                    'label' => $this->getLanguageService()->sL(
+                        'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:widgets.pageViewsBar.chart.dataSet.0'
+                    ),
+                    'backgroundColor' => $this->chartColors[0],
+                    'border' => 0,
+                    'data' => $data
+                ]
+            ]
+        ];
+    }
+
+    protected function getPageViewsInPeriod(int $start, int $end): int
+    {
+        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
+            ->getQueryBuilderForTable('tx_tracking_pageview');
+
+        return (int)$queryBuilder
+            ->count('*')
+            ->from('tx_tracking_pageview')
+            ->where(
+                $queryBuilder->expr()->gte('tstamp', $start),
+                $queryBuilder->expr()->lte('tstamp', $end),
+                $queryBuilder->expr()->notIn(
+                    'tx_tracking_pageview.pid',
+                    $queryBuilder->createNamedParameter([
+                        1,
+                        11,
+                        38,
+                    ], Connection::PARAM_INT_ARRAY)
+                )
+            )
+            ->execute()
+            ->fetchColumn();
+    }
+
+    protected function calculateDataForLastDays(int $days): array
+    {
+        $labels = [];
+        $data = [];
+
+        $format = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] ?: 'Y-m-d';
+
+        for ($daysBefore = $days; $daysBefore > 0; $daysBefore--) {
+            $labels[] = date($format, strtotime('-' . $daysBefore . ' day'));
+            $startPeriod = strtotime('-' . $daysBefore . ' day 0:00:00');
+            $endPeriod =  strtotime('-' . $daysBefore . ' day 23:59:59');
+
+            $data[] = $this->getPageViewsInPeriod($startPeriod, $endPeriod);
+        }
+
+        return [
+            $labels,
+            $data,
+        ];
+    }
+}
--- a/Classes/Dashboard/Widgets/PageViewsPerPageDoughnut.php
+++ b/Classes/Dashboard/Widgets/PageViewsPerPageDoughnut.php
@ -0,0 +1,99 @@
+<?php
+
+namespace DanielSiepmann\Tracking\Dashboard\Widgets;
+
+/*
+ * Copyright (C) 2020 Daniel Siepmann <coding@daniel-siepmann.de>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+use Doctrine\DBAL\ParameterType;
+use TYPO3\CMS\Core\Database\Connection;
+use TYPO3\CMS\Core\Database\ConnectionPool;
+use TYPO3\CMS\Core\Database\Query\QueryBuilder;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Dashboard\Widgets\AbstractDoughnutChartWidget;
+
+class PageViewsPerPageDoughnut extends AbstractDoughnutChartWidget
+{
+    protected $title = 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widgets.pageViewsPerPageDoughnut.title';
+
+    protected $description = 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widgets.pageViewsPerPageDoughnut.description';
+
+    protected function prepareChartData(): void
+    {
+        list($labels, $data) = $this->getPageViewsPerPage(31);
+
+        $this->chartData = [
+            'labels' => $labels,
+            'datasets' => [
+                [
+                    'backgroundColor' => $this->chartColors,
+                    'data' => $data,
+                ]
+            ],
+        ];
+    }
+
+    private function getPageViewsPerPage(int $period): array
+    {
+        $labels = [];
+        $data = [];
+        $queryBuilder = $this->getQueryBuilder();
+
+        $result = $queryBuilder
+            ->selectLiteral('count(tx_tracking_pageview.pid) as total')
+            ->addSelect('pages.title', 'pages.uid')
+            ->from('tx_tracking_pageview')
+            ->leftJoin(
+                'tx_tracking_pageview',
+                'pages',
+                'pages',
+                $queryBuilder->expr()->eq('tx_tracking_pageview.pid', $queryBuilder->quoteIdentifier('pages.uid'))
+            )
+            ->where(
+                $queryBuilder->expr()->notIn(
+                    'tx_tracking_pageview.pid',
+                    $queryBuilder->createNamedParameter([
+                        1,
+                        11,
+                        38,
+                    ], Connection::PARAM_INT_ARRAY)
+                )
+            )
+            ->groupBy('tx_tracking_pageview.pid')
+            ->orderBy('total', 'desc')
+            ->setMaxResults(6) // Because 6 colors are defined
+            ->execute()
+            ->fetchAll();
+
+        foreach ($result as $row) {
+            $labels[] = $row['title'] . ' [' . $row['uid'] . ']';
+            $data[] = $row['total'];
+        }
+
+        return [
+            $labels,
+            $data,
+        ];
+    }
+
+    private function getQueryBuilder(): QueryBuilder
+    {
+        return GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tx_tracking_pageview');
+    }
+}
--- a/Configuration/Backend/DashboardWidgetGroups.php
+++ b/Configuration/Backend/DashboardWidgetGroups.php
@ -0,0 +1,6 @@
+<?php
+return [
+    'tracking' => [
+        'title' => 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widget.group.tracking',
+    ],
+];
--- a/Configuration/Services.yaml
+++ b/Configuration/Services.yaml
@ -26,3 +26,21 @@ services:
          not (context.getAspect("backend.user").isLoggedIn())
          and not (request.getHeader("User-Agent")[0] matches "/^Wget|TYPO3|TYPO3 linkvalidator/")
          and not (request.getHeader("User-Agent")[0] matches "/Googlebot|Bingbot|Slurp|DuckDuckBot|Baiduspider|YandexBot|Sogou|Exabot|NextCloud-News|Feedly|XING FeedReader|CCBot/")
+
+  # Dashboard Widgets
+
+  DanielSiepmann\Tracking\Dashboard\Widgets\PageViewsBar:
+    class: DanielSiepmann\Tracking\Dashboard\Widgets\PageViewsBar
+    arguments: [pageViewsBar]
+    tags:
+      - name: dashboard.widget
+        identifier: pageViewsBar
+        widgetGroups: tracking
+
+  DanielSiepmann\Tracking\Dashboard\Widgets\PageViewsPerPageDoughnut:
+    class: DanielSiepmann\Tracking\Dashboard\Widgets\PageViewsPerPageDoughnut
+    arguments: [pageViewsPerPageDoughnut]
+    tags:
+      - name: dashboard.widget
+        identifier: pageViewsPerPageDoughnut
+        widgetGroups: tracking
--- a/Resources/Private/Language/locallang.xlf
+++ b/Resources/Private/Language/locallang.xlf
@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xliff version="1.0" xmlns:t3="http://typo3.org/schemas/xliff">
+    <file source-language="en" datatype="plaintext">
+        <header/>
+        <body>
+            <trans-unit id="dashboard.widget.group.tracking">
+                <source>Tracking</source>
+            </trans-unit>
+            <trans-unit id="dashboard.widgets.pageViewsBar.title">
+                <source>Page Views / Day</source>
+            </trans-unit>
+            <trans-unit id="dashboard.widgets.pageViewsBar.description">
+                <source>Displays total page views per day.</source>
+            </trans-unit>
+            <trans-unit id="dashboard.widgets.pageViewsBar.chart.dataSet.0">
+                <source>Total Page Views</source>
+            </trans-unit>
+            <trans-unit id="dashboard.widgets.pageViewsPerPageDoughnut.title">
+                <source>Page Views / Page</source>
+            </trans-unit>
+            <trans-unit id="dashboard.widgets.pageViewsPerPageDoughnut.description">
+                <source>Displays total page views per page.</source>
+            </trans-unit>
+        </body>
+    </file>
+</xliff>