Skip to content

Reduce statistics visits and visitors identifiability #863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
giuscris merged 2 commits into from
Mar 1, 2026
Merged

Reduce statistics visits and visitors identifiability #863

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2c1e9d
Reduce statistics visits and visitors identifiability
giuscris Mar 1, 2026
8bc309f
Introduce delimiters to avoid hash collisions
giuscris Mar 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions formwork/src/Statistics/Statistics.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,15 @@ public function trackVisit(): void
return;
}

$timestamp = time();
$date = date(self::DATE_FORMAT, $timestamp);

$ip = IpAnonymizer::anonymize($this->request->ip());
$uri = Str::append(Uri::make(['query' => '', 'fragment' => ''], $this->request->uri()), '/');
$userAgent = $this->request->userAgent();

// Prefer speed over security for hashing, as it's not a security-critical operation
$hash = hash('xxh3', "{$ip}@{$uri}");

$timestamp = time();
$hash = hash('xxh3', "{$date}|{$ip}|{$uri}|{$userAgent}");

if (
$this->registries['sessions']->has($hash)
Expand All @@ -79,18 +81,27 @@ public function trackVisit(): void

$this->registries['sessions']->set($hash, $timestamp);

$date = date(self::DATE_FORMAT, $timestamp);

$todayVisits = $this->registries['visits']->has($date) ? (int) $this->registries['visits']->get($date) : 0;
$this->registries['visits']->set($date, $todayVisits + 1);

$todayUniqueVisits = $this->registries['uniqueVisits']->has($date) ? (int) $this->registries['uniqueVisits']->get($date) : 0;
if (!$this->registries['visitors']->has($ip) || $this->registries['visitors']->get($ip) !== $date) {

$visitor = hash('xxh3', "{$date}|{$ip}|{$userAgent}");

// Remove legacy trackable visitor key based on IP
/** @todo remove this logic in Formwork 3.0.0 */
if ($this->registries['visitors']->has($ip)) {
$lastVisit = $this->registries['visitors']->get($ip);
$this->registries['visitors']->remove($ip);
$this->registries['visitors']->set($visitor, $lastVisit);
}

if (!$this->registries['visitors']->has($visitor) || $this->registries['visitors']->get($visitor) !== $date) {
$this->registries['uniqueVisits']->set($date, $todayUniqueVisits + 1);
$this->registries['uniqueVisits']->save();
}

$this->registries['visitors']->set($ip, $date);
$this->registries['visitors']->set($visitor, $date);

$pageViews = $this->registries['pageViews']->has($uri) ? (int) $this->registries['pageViews']->get($uri) : 0;
$this->registries['pageViews']->set($uri, $pageViews + 1);
Expand Down