Merge pull request #16 from Astylodon/extend-visit

Add more info to visits

Author: TheIndra55

.env.example

@@ -1,3 +1,5 @@
 DB_DSN=mysql:host=localhost;dbname=shika
 DB_USERNAME=
 DB_PASSWORD=
+
+MAXMIND_PATH=

bootstrap/dependencies.php

@@ -3,6 +3,7 @@
 use DI\ContainerBuilder;
 use Dotenv\Dotenv;
 use Shika\Database\Database;
+use Shika\Helpers\GeoLocation;
 use Shika\Helpers\Session;
 use Shika\Repositories\ApiKeyRepository;
 use Shika\Repositories\SiteRepository;
@@ -31,6 +32,8 @@
 
             Twig::class => autowire(Twig::class),
             Session::class => autowire(Session::class),
+
+            GeoLocation::class => autowire(GeoLocation::class)->constructor(env("MAXMIND_PATH", "")),
         ]
     );
 };

composer.json

@@ -9,7 +9,8 @@
         "twig/twig": "^3.0",
         "maxmind-db/reader": "^1.11",
         "astylodon/migrations": "^1.0",
-        "vlucas/phpdotenv": "^5.6"
+        "vlucas/phpdotenv": "^5.6",
+        "matomo/device-detector": "^6.4"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -0,0 +1,15 @@
+<?php
+
+use Astylodon\Migrations\Database\DatabaseInterface;
+use Astylodon\Migrations\Migration;
+
+return new class implements Migration
+{
+    public function up(DatabaseInterface $database)
+    {
+        $database->exec("ALTER TABLE visits ADD country_code VARCHAR(2)");
+        $database->exec("ALTER TABLE visits ADD browser VARCHAR(50)");
+        $database->exec("ALTER TABLE visits ADD operating_system VARCHAR(50)");
+        $database->exec("ALTER TABLE visits ADD device_type VARCHAR(8)");
+    }
+};

migrations/mysql/0004_extend_visits.php

@@ -0,0 +1,15 @@
+<?php
+
+use Astylodon\Migrations\Database\DatabaseInterface;
+use Astylodon\Migrations\Migration;
+
+return new class implements Migration
+{
+    public function up(DatabaseInterface $database)
+    {
+        $database->exec("ALTER TABLE visits ADD country_code TEXT");
+        $database->exec("ALTER TABLE visits ADD browser TEXT");
+        $database->exec("ALTER TABLE visits ADD operating_system TEXT");
+        $database->exec("ALTER TABLE visits ADD device_type TEXT");
+    }
+};

migrations/sqlite/0004_extend_visits.php

@@ -4,6 +4,8 @@
 
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
+use Shika\Helpers\DeviceInfo;
+use Shika\Helpers\GeoLocation;
 use Shika\Helpers\JsonResponse;
 use Shika\Repositories\SiteRepository;
 use Shika\Repositories\VisitRepository;
@@ -14,11 +16,13 @@ class AnalyticsController
 
     private VisitRepository $visits;
     private SiteRepository $sites;
+    private GeoLocation $location;
 
-    public function __construct(VisitRepository $visits, SiteRepository $sites)
+    public function __construct(VisitRepository $visits, SiteRepository $sites, GeoLocation $location)
     {
         $this->visits = $visits;
         $this->sites = $sites;
+        $this->location = $location;
     }
 
     public function send(Request $request, Response $response)
@@ -62,13 +66,25 @@ public function send(Request $request, Response $response)
             return $response->withStatus(204);
         }
 
+        // get the agent info
+        $device = new DeviceInfo($request);
+
+        if (!$device->isBrowser())
+        {
+            return $response->withStatus(204);
+        }
+
         // build the visit
         $visit = [
             "site_id" => $site->id,
             "visit_at" => gmdate("Y-m-d H:i:s"),
 
             "visit_host" => $location["host"],
             "visit_path" => $location["path"],
+
+            "browser" => $device->getBrowser(),
+            "operating_system" => $device->getOperatingSystem(),
+            "device_type" => $device->getDeviceType(),
         ];
 
         // add the referrer if we have one
@@ -82,6 +98,18 @@ public function send(Request $request, Response $response)
             }
         }
 
+        // add location info
+        if ($this->location->isAvailable())
+        {
+            $address = $request->getServerParams()["REMOTE_ADDR"];
+            $country = $this->location->getCountry($address);
+
+            if ($country !== null)
+            {
+                $visit["country_code"] = $country["iso_code"];
+            }
+        }
+
         // insert the visit
         $this->visits->addVisit($visit);
 

src/Controllers/AnalyticsController.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Shika\Helpers;
+
+use DeviceDetector\DeviceDetector;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Helper for getting information about the agent/device
+ */
+class DeviceInfo
+{
+    private DeviceDetector $detector;
+
+    /**
+     * Constructs a new device info from a request
+     */
+    public function __construct(RequestInterface $request)
+    {
+        $userAgent = $request->getHeaderLine("User-Agent");
+
+        $detector = new DeviceDetector($userAgent);
+        $detector->parse();
+
+        $this->detector = $detector;
+    }
+
+    /**
+     * Gets the device operating system
+     */
+    public function getOperatingSystem(): string
+    {
+        return $this->detector->getOs("name");
+    }
+
+    /**
+     * Gets the browser name
+     */
+    public function getBrowser(): string
+    {
+        $browser = $this->detector->getClient("name");
+
+        switch ($browser)
+        {
+            case "Chrome Mobile":
+            case "Chrome Mobile iOS":
+                return "Chrome";
+
+            case "Firefox Mobile":
+            case "Firefox Mobile iOS":
+                return "Firefox";
+
+            case "Mobile Safari":
+                return "Safari";
+
+            case "Opera Mobile":
+                return "Opera";
+
+            case "Opera Mini iOS":
+                return "Opera Mini";
+
+            case "Huawei Browser Mobile":
+                return "Huawei Browser";
+
+            default:
+                return $browser;
+        }
+    }
+
+    /**
+     * Gets the device type (phone, tablet, desktop)
+     */
+    public function getDeviceType(): string
+    {
+        return ($this->detector->isTablet() ? "tablet" : ($this->detector->isMobile() ? "phone" : "desktop"));
+    }
+
+    /**
+     * Gets whether the agent is a browser
+     */
+    public function isBrowser():  bool
+    {
+        return $this->detector->isBrowser();
+    }
+}