Merge pull request #647 from getformwork/feature/statistics-sources-d…

…evices

Improve Statistics with sources, devices and consecutive visits limiter

composer.json

@@ -26,7 +26,8 @@
         "symfony/yaml": "^7.0.3",
         "league/commonmark": "^2.4",
         "jaybizzle/crawler-detect": "^1.2",
-        "masterminds/html5": "^2.9"
+        "masterminds/html5": "^2.9",
+        "mobiledetect/mobiledetectlib": "^4.8"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",

formwork/config/site.yaml

@@ -13,3 +13,20 @@ metadata: []
 path: '${%ROOT_PATH%}/site'
 
 routeAliases: []
+
+statistics:
+    enabled: true
+    trackLocalhost: false
+    visitsDelay: 15
+    path: '${site.path}/statistics'
+    registries:
+        sessions: 'sessions.json'
+        visits: 'visits.json'
+        uniqueVisits: 'uniqueVisits.json'
+        visitors: 'visitors.json'
+        pageViews: 'pageViews.json'
+        sources: 'sources.json'
+        devices: 'devices.json'
+    cleanup:
+        ttl: 86400
+        probability: 5

formwork/config/system.yaml

@@ -101,10 +101,6 @@ schemes:
         system: '${%SYSTEM_PATH%}/schemes'
         site: '${%ROOT_PATH%}/site/schemes'
 
-statistics:
-    enabled: true
-    path: '${%ROOT_PATH%}/site/statistics'
-
 templates:
     path: '${%ROOT_PATH%}/site/templates'
     extension: .php

formwork/src/Cms/App.php

@@ -233,7 +233,7 @@ private function loadServices(Container $container): void
             ->alias('templates');
 
         $container->define(Statistics::class)
-            ->parameter('path', fn(Config $config) => $config->get('system.statistics.path'))
+            ->parameter('options', fn(Config $config) => $config->get('site.statistics'))
             ->parameter('translation', fn(Translations $translations) => $translations->getCurrent())
             ->alias('statistics');
 

formwork/src/Controllers/PageController.php

@@ -31,7 +31,7 @@ public function __construct(
      */
     public function load(RouteParams $routeParams, Statistics $statistics): Response
     {
-        $trackable = $this->config->get('system.statistics.enabled');
+        $trackable = $this->config->get('site.statistics.enabled');
 
         if ($this->site->get('maintenance.enabled') && !$this->app->panel()->isLoggedIn()) {
             $trackable = false;

formwork/src/Http/Utils/DeviceType.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Formwork\Http\Utils;
+
+enum DeviceType: string
+{
+    case Mobile = 'mobile';
+    case Tablet = 'tablet';
+    case Desktop = 'desktop';
+}

formwork/src/Http/Utils/Visitor.php

@@ -2,6 +2,7 @@
 
 namespace Formwork\Http\Utils;
 
+use Detection\MobileDetect;
 use Formwork\Http\Request;
 use Formwork\Traits\StaticClass;
 use Jaybizzle\CrawlerDetect\CrawlerDetect;
@@ -27,11 +28,29 @@ public static function isBrowser(Request $request): bool
         return !self::isBot($request);
     }
 
-    /**
-     * Detect whether current visitor prefers not to be tracked
-     */
-    public static function isTrackable(Request $request): bool
+    public static function getDeviceType(Request $request): DeviceType
+    {
+        static $mobileDetect = new MobileDetect(config: ['autoInitOfHttpHeaders' => false]);
+        $mobileDetect->setUserAgent($request->userAgent() ?? '');
+        return match (true) {
+            $mobileDetect->isMobile() => DeviceType::Mobile,
+            $mobileDetect->isTablet() => DeviceType::Tablet,
+            default                   => DeviceType::Desktop,
+        };
+    }
+
+    public static function isMobile(Request $request): bool
+    {
+        return self::getDeviceType($request) === DeviceType::Mobile;
+    }
+
+    public static function isTablet(Request $request): bool
+    {
+        return self::getDeviceType($request) === DeviceType::Tablet;
+    }
+
+    public static function isDesktop(Request $request): bool
     {
-        return $request->headers()->get('Dnt') !== '1';
+        return self::getDeviceType($request) === DeviceType::Desktop;
     }
 }