mirror of
https://github.com/shlinkio/shlink.git
synced 2026-03-11 17:44:44 +08:00
Extract logic to send visits to Matomo to its own service
This commit is contained in:
@@ -7,11 +7,11 @@ namespace Shlinkio\Shlink\Core\Matomo;
|
||||
use MatomoTracker;
|
||||
use Shlinkio\Shlink\Core\Exception\RuntimeException;
|
||||
|
||||
class MatomoTrackerBuilder implements MatomoTrackerBuilderInterface
|
||||
readonly class MatomoTrackerBuilder implements MatomoTrackerBuilderInterface
|
||||
{
|
||||
public const MATOMO_DEFAULT_TIMEOUT = 10; // Time in seconds
|
||||
|
||||
public function __construct(private readonly MatomoOptions $options)
|
||||
public function __construct(private MatomoOptions $options)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
60
module/Core/src/Matomo/MatomoVisitSender.php
Normal file
60
module/Core/src/Matomo/MatomoVisitSender.php
Normal file
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Shlinkio\Shlink\Core\Matomo;
|
||||
|
||||
use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
|
||||
use Shlinkio\Shlink\Core\Visit\Entity\Visit;
|
||||
|
||||
readonly class MatomoVisitSender implements MatomoVisitSenderInterface
|
||||
{
|
||||
public function __construct(
|
||||
private MatomoTrackerBuilderInterface $trackerBuilder,
|
||||
private ShortUrlStringifier $shortUrlStringifier,
|
||||
) {
|
||||
}
|
||||
|
||||
public function sendVisitToMatomo(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);
|
||||
|
||||
$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);
|
||||
}
|
||||
}
|
||||
12
module/Core/src/Matomo/MatomoVisitSenderInterface.php
Normal file
12
module/Core/src/Matomo/MatomoVisitSenderInterface.php
Normal file
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Shlinkio\Shlink\Core\Matomo;
|
||||
|
||||
use Shlinkio\Shlink\Core\Visit\Entity\Visit;
|
||||
|
||||
interface MatomoVisitSenderInterface
|
||||
{
|
||||
public function sendVisitToMatomo(Visit $visit, ?string $originalIpAddress = null): void;
|
||||
}
|
||||
Reference in New Issue
Block a user