shlink/module/Core/src/Matomo/MatomoVisitSender.php

<?php

declare(strict_types=1);

namespace Shlinkio\Shlink\Core\Matomo;

use Shlinkio\Shlink\Common\Util\DateRange;
use Shlinkio\Shlink\Core\Matomo\Model\SendVisitsResult;
use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
use Shlinkio\Shlink\Core\Visit\Entity\Visit;
use Shlinkio\Shlink\Core\Visit\Repository\VisitIterationRepositoryInterface;
use Throwable;

readonly class MatomoVisitSender implements MatomoVisitSenderInterface
{
    public function __construct(
        private MatomoTrackerBuilderInterface $trackerBuilder,
        private ShortUrlStringifier $shortUrlStringifier,
        private VisitIterationRepositoryInterface $visitIterationRepository,
    ) {
    }

    /**
     * Sends all visits in provided date range to matomo, and returns the amount of affected visits
     */
    public function sendVisitsInDateRange(
        DateRange $dateRange,
        VisitSendingProgressTrackerInterface|null $progressTracker = null,
    ): SendVisitsResult {
        $visitsIterator = $this->visitIterationRepository->findAllVisits($dateRange);
        $successfulVisits = 0;
        $failedVisits = 0;

        foreach ($visitsIterator as $index => $visit) {
            try {
                $this->sendVisit($visit);
                $progressTracker?->success($index);
                $successfulVisits++;
            } catch (Throwable $e) {
                $progressTracker?->error($index, $e);
                $failedVisits++;
            }
        }

        return new SendVisitsResult($successfulVisits, $failedVisits);
    }

    public function sendVisit(Visit $visit, ?string $originalIpAddress = null): void
    {
        $tracker = $this->trackerBuilder->buildMatomoTracker();

        $tracker
            ->setUrl($this->resolveUrlToTrack($visit))
            ->setCustomTrackingParameter('type', $visit->type->value)
            ->setUserAgent($visit->userAgent)
            ->setUrlReferrer($visit->referer)
            ->setForceVisitDateTime($visit->date->setTimezone('UTC')->toDateTimeString());

        $location = $visit->getVisitLocation();
        if ($location !== null) {
            $tracker
                ->setCity($location->cityName)
                ->setCountry($location->countryName)
                ->setLatitude($location->latitude)
                ->setLongitude($location->longitude);
        }

        // Set not obfuscated IP if possible, as matomo handles obfuscation itself
        $ip = $originalIpAddress ?? $visit->remoteAddr;
        if ($ip !== null) {
            $tracker->setIp($ip);
        }

        if ($visit->isOrphan()) {
            $tracker->setCustomTrackingParameter('orphan', 'true');
        }

        // Send the short URL title or an empty document title to avoid different actions to be created by matomo
        $tracker->doTrackPageView($visit->shortUrl?->title() ?? '');
    }

    private function resolveUrlToTrack(Visit $visit): string
    {
        $shortUrl = $visit->shortUrl;
        if ($shortUrl === null) {
            return $visit->visitedUrl ?? '';
        }

        return $this->shortUrlStringifier->stringify($shortUrl);
    }
}